Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
mscroggs committed Jun 6, 2024
1 parent d648b06 commit c816924
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,16 @@ Mathsteroids can be configured by setting values in a file called `config.json`
(see [`config.json.template`](config.json.template)). The following entries can be set
in the configuration JSON:

| Entry | Allowed values | Default | Description |
| --------------------- | ----------------------------------------- | ------------------ | ----------- |
| `"high-scores"` | `true`, `false` | `false` | Toggles high score tables |
| `"controller"` | `"none"`, `"playstation"`, `"mega-drive"` | `"none"` | Allows input from a controller to be used |
| `"game-mode"` | `"lives"`, `"time"` | `"lives"` | Set the game mode. If `"lives"`, player start with 3 lives and games end when lives run out. If `"time", games will last 30 seconds, with negative points given for losing a "life" |
| `"pre-html"` | Any string | `""` | HTML to place above the game |
| `"centered"` | `true`, `false` | `false` | Toggles centering of content |
| `"show-webad"` | `true`, `false` | `false` | Toggles advert below game saying you can play it onling|
| `"show-instructions"` | `true`, `false` | `true` | Toggles instructions that can be displayed beloe the game |
| `"debug"` | `true`, `false` | `false` | Toggles the visibility of debug information |
| `"sound"` | `true`, `false` | `false` | Toggles sound |
| `"sound-dir"` | Any string | `"sounds/default"` | Sets the directory where the sound files are located |
| Entry | Allowed values | Default | Description |
| ------------------------ | -------------------- | ------------------ | ----------- |
| `"high-scores"` | `true`, `false` | `false` | Toggles high score tables |
| `"controller"` | `"none"`, `"playstation"`, `"mega-drive"`, `"emf"` | `"none"` | Allows input from a controller to be used |
| `"game-mode"` | `"lives"`, `"time"` | `"lives"` | Set the game mode. If `"lives"`, player start with 3 lives and games end when lives run out. If `"time", games will last 30 seconds, with negative points given for losing a "life" |
| `"pre-html"` | Any string | `""` | HTML to place above the game |
| `"centered"` | `true`, `false` | `false` | Toggles centering of content |
| `"show-webad"` | `true`, `false` | `false` | Toggles advert below game saying you can play it onling|
| `"show-instructions"` | `true`, `false` | `true` | Toggles instructions that can be displayed below the game |
| `"show-control-buttons"` | `true`, `false` | `true` | Toggles control buttons shown below the game |
| `"debug"` | `true`, `false` | `false` | Toggles the visibility of debug information |
| `"sound"` | `true`, `false` | `false` | Toggles sound |
| `"sound-dir"` | Any string | `"sounds/default"` | Sets the directory where the sound files are located |

0 comments on commit c816924

Please sign in to comment.