Skip to content

Commit

Permalink
update readme, roadmap, welcome + bump to 0.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mathieuher committed Apr 9, 2024
1 parent 98333a0 commit 84f15ab
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 5 deletions.
22 changes: 22 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,19 @@
Press (1x) ⌨️<img src="src/images/icons/keyboard_arrow_up.png" valign="bottom"/>, 🎮<img src="src/images/icons/gamepad_a.png" valign="bottom"/> or 📱touch to start skiing and see you at the finish line !<br>
⚠️ Don't miss a gate or you'll receive a penalty of 3 seconds
</p>
<div class="section-subtitle">Game setup</div>
<p>
You can access to specific game setup by clicking the ⚙️ on the top right in menus<br>
Here you can enable or disable few settings for your race :
</p>
<ul>
<li>🔊 Sounds</li>
<li>🧑‍🤝‍🧑 Spectators (can affect performance)</li>
<li>👻 Ghosts (can affect performance)</li>
</ul>
<p>
You also have the possibility to reset and restore the game to the default content (tracks, ghosts & record).
</p>
<div class="section-title">💡 Tips</div>
<div class="section-subtitle">Preloaded tracks</div>
<p>By default the game provides 5 tracks, so you can use the same track as your friends even on a different setup.</p>
Expand All @@ -145,6 +158,15 @@
RetroSki use localStorage to persist generated tracks and records.<br>
You can easily export them and share them with friends by using the browser developper tools.
</p>
<div class="section-subtitle">Performance</div>
<p>
Retroski should be playable on any modern device with an updated browser.<br>
In case of performance trouble, you can try to disable via the game setup the display of spectators and ghosts during the race.
</p>
<div class="section-subtitle">Crash</div>
<p>
If your game crash, try to reset & erase all content via the game setup menu to reload original content.
</p>
<div class="table-container">
<table>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "retroski",
"version": "0.6.0",
"version": "0.7.0",
"description": "Retro ski game",
"main": "index.js",
"scripts": {
Expand Down
19 changes: 19 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,15 +81,27 @@ Here you have to provide few informations before starting to ride :
3. Name of the first player
4. Name of the second player
5. Number of races (1 to 10 is recommended)

### Event manager
This screen is the home place before and after each race.<br>
It provides informations about the current event.

### Race
You made it to the top of the hill !<br>
Now it's time to have fun and enjoy some nice carving !<br><br>
Press (1x) ⌨️<img src="src/images/icons/keyboard_arrow_up.png" valign="bottom"/>, 🎮<img src="src/images/icons/gamepad_a.png" valign="bottom"/> or 📱touch to start skiing and see you at the finish line !<br>
⚠️ Don't miss a gate or you'll receive a penalty of <b>3 seconds</b>

### Game setup
You can access to specific game setup by clicking the ⚙️ on the top right in menus<br>
Here you can enable or disable few settings for your race :
<ul>
<li>🔊 Sounds</li>
<li>🧑‍🤝‍🧑 Spectators (can affect performance)</li>
<li>👻 Ghosts (can affect performance)</li>
</ul>
You also have the possibility to reset and restore the game to the default content (tracks, ghosts & record).

## 💡 Tips
### Preloaded tracks
By default the game provides 5 tracks, so you can use the same track as your friends even on a different setup.
Expand Down Expand Up @@ -125,6 +137,13 @@ By default ghost mode is activated and you can see your best times while racing<
</tr>
</table>

### Performance
Retroski should be playable on any modern device with an updated browser.<br>
In case of performance trouble, you can try to disable via the game setup the display of spectators and ghosts during the race.

### Crash
If your game crash, try to reset & erase all content via the game setup menu to reload original content.

## 👷‍♂️ What's next ?
<a href="roadmap.md">Draft of a roadmap</a>

Expand Down
6 changes: 3 additions & 3 deletions roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
- ✔️ ~~Add intro/help page to provide basic informations in-game~~
- ✔️ ~~Improve track and style selection interface to show already generated track and lock style choice~~
- ✔️ ~~Support controller (joystick + 3 buttons)~~
- ✔️~~Add starting gate~~
- ✔️ ~~Add starting gate~~
- ✔️ ~~Improve finish gate~~
- ✔️~~Rework zooming effect to improve graphics~~
- Add spectator and objects
- ✔️ ~~Rework zooming effect to improve graphics~~
- ✔️ ~~Add spectator and objects~~
- ✔️ ~~Add sector time and metadata on ghosts to display during the race~~
- ✔️ ~~Provide by default one ghost with each default track~~
- ✔️ ~~Prefilled interface with data from localStorage (player 1, player 2)~~
Expand Down
2 changes: 1 addition & 1 deletion src/scss/game.scss
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ html body {
font-size: 0.7rem;
}

ol {
ol, ul {
padding-top: 0;
padding-bottom: 0;
margin: 0;
Expand Down

0 comments on commit 84f15ab

Please sign in to comment.