Battlesnake/Byte-snake-engine
Battlesnake/Byte-snake-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add 'map' cli command to provide map information (#100)

Browse source 
* add 'map' cli command

- provides the following map information functions:
  - list all available maps in the global registry
  - display map metadata

- update docs with map command examples

* add list and info subcommands to map cli command

* rename map command list and info factory functions

* add --all flag to map info subcommand

* handle cmd.Help error
This commit is contained in:
Blayne Campbell 2022-08-09 16:06:28 -06:00 • committed by GitHub
parent 91106aec09
commit ffeb401377
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 177 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

19
cli/README.md
View file

@ -78,6 +78,25 @@ Example creating a 7x7 Standard game with two Battlesnakes:
battlesnake play --width 7 --height 7 --name Snake1 --url http://snake1-url-whatever --name Snake2 --url http://snake2-url-whatever
```
### Maps
The `map` command provides map information for use with the `play` command.
List all available maps using the `list` subcommand:
```
battlesnake map list
```
Display map information using the `info` subcommand:
```
battlesnake map info standard
Name: Standard
Author: Battlesnake
Description: Standard snake placement and food spawning
Version: 2
Min Players: 1
Max Players: 16
Board Sizes (WxH): 7x7 9x9 11x11 13x13 15x15 17x17 19x19 21x21 23x23 25x25
```
### Sample Output
```
$ battlesnake play --width 3 --height 3 --url http://redacted:4567/ --url http://redacted:4568/ --name Bob --name Sue