Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mscroggs committed Jun 7, 2024
1 parent 3756c19 commit 7d4c151
Showing 1 changed file with 56 additions and 2 deletions.
58 changes: 56 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Mathsteroids is a game based on asteroids that can be played on a selection of interesting mathematical surfaces.
Press `A` and `D` to steer the ship left and right, `W` to move forwards and `K` to fire. Destroy the asteroids to win points.

You can play mathsteroids at [mscroggs.co.uk/mathsteroids](http://www.mscroggs.co.uk/mathsteroids).
You can play Mathsteroids at [mscroggs.co.uk/mathsteroids](http://www.mscroggs.co.uk/mathsteroids).

## Surfaces
The following surfaces are currently available:
Expand Down Expand Up @@ -48,7 +48,7 @@ The following surfaces are currently available:
* Poincare disk model
* Beltrami-Klein model

# Config.json
# `config.json`
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:
Expand All @@ -66,3 +66,57 @@ in the configuration JSON:
| `"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 |

## Example configurations

The version of Mathsteroids available at [mscroggs.co.uk/mathsteroids](http://www.mscroggs.co.uk/mathsteroids)
uses the following config:

```
{
"high-scores": false,
"controller": "none",
"game-mode": "lives",
"pre-html": "",
"centered": false,
"show-webad": false,
"show-instructions": true,
"show-control-buttons": true,
"sound": true,
"sound-dir": "/mathsteroids-sounds",
"debug": false
}
```

When giving a talk, I use the following config:

```
{
"high-scores": false,
"controller": "mega-drive",
"game-mode": "time",
"pre-html": "<br /><br />",
"centered": true,
"show-webad": true,
"show-instructions": false,
"show-control-buttons": false,
"debug": false,
"sound": true
}
```

To run Mathsteroids on an arcade machine at Electromagnetic Field 2024, I used the following config:

```
{
"controller": "emf",
"high-scores": false,
"pre-html": "<br /><br />",
"centered": true,
"show-webad": false,
"show-control-buttons": false,
"show-instructions": false,
"debug": false,
"sound": false
}
```

0 comments on commit 7d4c151

Please sign in to comment.