Skip to content

Commit

Permalink
updated optional parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
Lorne Cyr authored Aug 23, 2022
1 parent 75df303 commit 32474dc
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,11 @@ http://127.0.0.1:3000/?engine=[ENGINE_URL]&game=[GAME_ID]
- `autoplay` - start game playback immediately. Values true / false. Defaults to false.
- `boardTheme` - the theme of the board. Values dark / light. Defaults to light.
- `frameRate` - the maximum frame rate used for playback. Takes an integer value equal to FPS. Defaults to 6 FPS. (medium speed)
- `hideScoreboard` - remove the scoreboard for embedding cool games. Values true false. Defaults to false.
- `hideLogo` - hides battlesnake logo. Values true / false. Defaults to true.
- `hideMediaControls` - remove the controls for embedding cool games. Values true / false. Defaults to false.
- `showFrameScrubber` - should show the scrubbable range. Values true / false. Defaults to false.
- `hideScoreboard` - remove the scoreboard for embedding cool games. Values true false. Defaults to false.
- `loop` - restart playback immediately once game completes. Values true / false. Defaults to false.
- `showFrameScrubber` - should show the scrubbable range. Values true / false. Defaults to false.
- `title` - show a title string on the game board. Takes a string. Defaults to empty string.
- `turn` - load game to a specific turn. Takes an integer. Defaults to 0.

Expand Down

0 comments on commit 32474dc

Please sign in to comment.