Byte-snake-engine/README.md
Bhavnoor Singh Saroya 47e71cb13d
Some checks failed
Test / Format (gofmt) (push) Has been cancelled
Test / Lint (golangci-lint) (push) Has been cancelled
Test / Test (go test) (push) Has been cancelled
Test / Build CLI (go install) (push) Has been cancelled
add changelog to readme
2025-08-19 12:05:42 -07:00

2.5 KiB

Custom battlesnake game engine implementation

Battlesnake rules and game logic, implemented as a Go module. This code is used in production at play.battlesnake.com. Issues and contributions welcome!

play.battlesnake.com custom games are not working at the time of this commit, this custom implementation can be hosted and allows for games to be stored to a relational database, it is accompanied by a second server that can read and serve from the db, while maintaining full compatibility with the battlesnake gameboard

Changelog

  • add battlesnake host command for deployent on via web
  • update output files to actually resemble websocket frames for gameboard microservice
  • add db module for automatically writing games to postgres database

CLI for Running Battlesnake Games Locally

This repo provides a simple CLI tool to run games locally against your dev environment.

Installation

Download precompiled binaries here:
https://github.com/BattlesnakeOfficial/rules/releases

Install as a Go package. Requires Go 1.18 or higher. [Download]

go install github.com/BattlesnakeOfficial/rules/cli/battlesnake@latest

Compile from source. Also requires Go 1.18 or higher.

git clone git@github.com:BattlesnakeOfficial/rules.git
cd rules
go build -o battlesnake ./cli/battlesnake/main.go

Usage

Run the hosting with ./battlesnake host

Example command to run a game locally:

battlesnake play -W 11 -H 11 --name <SNAKE_NAME> --url <SNAKE_URL> -g solo -v

For more details, see the CLI README.

FAQ

Can I run games locally?

Yes! See the included CLI. Local games will output different json than the official cli in an effort to improve consistency with the api.

How is this different from the old Battlesnake engine?

The old game 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.

Yet the current implementation is designed around running 1 game at a time, and will require further modification for true concurrency.

Feedback

  • Do you have an issue or suggestions for this repository? Head over to our Feedback Repository today and let us know!