<p align="center"> <img src="src/assets/logos/logo.png" alt="RetroSki logo"/> </p>

❄️ RetroSki – A thrilling retro 2D skiing adventure! 🎿

Welcome to RetroSki, a small but exciting game where you can carve down randomly generated alpine ski tracks with your friends! Put on your skis, feel the rush of the slopes, and race to victory!

💻 Play the official game

<a href="https://retro-ski.ch">retro-ski.ch</a>

🎮 Controls – Master Your Ride!

| Action | ⌨️ Keyboard | 🎮 Gamepad (recommended) | 📱 Touch device | |----------------------|-------------------------|------------------------|------------------------| | Start riding (1x) | <img src="src/assets/icons/keyboard_arrow_up.png" valign="bottom"/> | <img src="src/assets/icons/gamepad_a.png" valign="bottom"/> | Touch the screen | | Carve | <img src="src/assets/icons/keyboard_arrow_left.png" valign="bottom"/> <img src="src/assets/icons/keyboard_arrow_right.png" valign="bottom"/> | <img src="src/assets/icons/gamepad_left_stick.png" valign="bottom"/> | Touch left/right | | Brake / slide | <img src="src/assets/icons/keyboard_space.png" valign="bottom"/> | <img src="src/assets/icons/gamepad_b.png" valign="bottom"/> | Touch bottom | | Leave the race | <img src="src/assets/icons/keyboard_exit.png" valign="bottom"/> | <img src="src/assets/icons/gamepad_select.png" valign="bottom"/> | | | Toggle ghosts | <img src="src/assets/icons/keyboard_g.png" valign="bottom"/> | <img src="src/assets/icons/gamepad_left_bumper.png" valign="bottom"/> | | | Toggle debug mode| <img src="src/assets/icons/keyboard_d.png" valign="bottom"/> | | |

📘 Gamer's guide – Conquer the slopes!

Ride local

Create your own race tracks and challenge your friends locally!
Just follow these simple steps:

1. Choose a track or create a new one.
2. Add your rider names.
3. Select the number of races (from 1 to 10).

Ride online

Race against friends and other players online.

1. Set up your community or join one.
2. Race, compete, and share your records with the world.

Race – It’s time to shred!

You’re at the top of the hill, ready to carve your way to the finish line.
Press (1x) ⌨️<img src="src/assets/icons/keyboard_arrow_up.png" valign="bottom"/>, 🎮<img src="src/assets/icons/gamepad_a.png" valign="bottom"/>, or 📱touch to start skiing.
⚠️ Don’t miss any gates or face a penalty of 3 seconds!

Game setup

Click the ⚙️ icon on the top right to access your game settings!
Here, you can adjust a few options for your race:

• 🔊 Sounds
• 🧑‍🤝‍🧑 Spectators
• 👻 Ghosts
• 🫧 Particles (might affect performance)
• 🌲 Decorations

You can also reset everything back to default settings to restore tracks, ghosts, and records.

💡 Tips for mastering the slopes!

Different track styles

Each track type follows unique rules when generating new slopes, mimicking real-world conditions and impacting rider dynamic.
Pro Tip: Giant slalom tracks are perfect for beginners to hone their skills!

Keep your records

Local

RetroSki stores your local records and tracks using localStorage and IndexedDB.

Online

Online records, ghosts, tracks, and events are saved on our servers for you to track your progress.

Follow your path

Ghost mode lets you race against your best times or the best global or event records!

<table> <tr> <th>Ghost</th> <th>Description</th> </tr> <tr> <td><img src="src/assets/icons/global_record_ghost.png" valign="bottom"/></td> <td>Global best time on the track</td> </tr> <tr> <td><img src="src/assets/icons/event_record_ghost.png" valign="bottom"/></td> <td>Event best time on the track</td> </tr> </table>

Performance tips

Retro-Ski is optimized to run smoothly on any modern device with an up-to-date browser.
If you experience lag, try refreshing the game.
For better performance, consider disabling particles and other heavy game objects in the settings.

Crash recovery

In case of a crash, try resetting the game via the settings menu to reload the original content and keep shredding!

👷‍♂️ What’s next?

Check out our roadmap to see the exciting features coming soon!
<a href="roadmap.md">Draft of the roadmap</a>

❤️ Support the project

Enjoying your time on the slopes? Help us keep improving the game!
Consider upgrading to a premium membership or supporting the project. 🙏
<a href="https://donate.stripe.com/7sIaGu2wO52K9S8aEE">Support the project via Stripe</a>

⚫ Developer Guide

1. Run yarn install to install dependencies.
2. Run yarn start to start locally and begin your development journey.
3. And most importantly, have fun!