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

Remove old API v0 Y-Axis warnings and FAQ

Browse source 
Fixes #29
This commit is contained in:
Brad Van Vugt 2021-02-12 13:51:25 -08:00 • committed by GitHub
parent d62807774b
commit f98b1e38ec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -38,20 +38,12 @@ For more details, see the [CLI README](cli/README.md).
## FAQ ## FAQ
### Can I run games locally?
Yes! [See the included CLI](cli/README.md).
### How is this different from the old Battlesnake engine? ### How is this different from the old Battlesnake engine?
The [old game engine](https://github.com/battlesnakeio/engine) was re-written in early 2020 to handle a higher volume of concurrent games. As part of that rebuild we moved the game logic into a separate Go module that gets compiled into the production engine. The [old game engine](https://github.com/battlesnakeio/engine) was re-written in early 2020 to handle a higher volume of concurrent games. As part of that rebuild we moved the game logic into a separate Go module that gets compiled into the production engine.
This provides two benefits: it makes it much simpler/easier to build new game modes, and it allows the community to get more involved in game development (without the maintenance overhead of the entire game engine). This provides two benefits: it makes it much simpler/easier to build new game modes, and it allows the community to get more involved in game development (without the maintenance overhead of the entire game engine).
### Can I run games locally?
Yes! [See the included CLI](cli/README.md).
### The Y-Axis appears to be implemented incorrectly!?!?
This is because the game rules implement an inverted Y-Axis. Older versions of the Battlesnake API operated this way, and several highly competitive Battlesnakes still rely on this behaviour. The current game engine accounts for this by translating the Y-Axis (or not) based on which version of the API each Battlesnake implements. [More info here](https://docs.battlesnake.com/guides/migrating-to-api-version-1) and [here](https://github.com/BattlesnakeOfficial/rules/issues/18).
In the future we might switch this to make the rules easier to develop? But until we drop support for the older API version it doesn't make sense to make that change.