https://github.com/mr-destructive/destructive-battlesnake
My attempt in learning Golang by creating battlesnake
https://github.com/mr-destructive/destructive-battlesnake
battlesnake golang
Last synced: 29 days ago
JSON representation
My attempt in learning Golang by creating battlesnake
- Host: GitHub
- URL: https://github.com/mr-destructive/destructive-battlesnake
- Owner: Mr-Destructive
- License: mit
- Created: 2022-06-15T16:04:18.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-16T11:18:13.000Z (almost 3 years ago)
- Last Synced: 2025-01-29T20:37:31.444Z (3 months ago)
- Topics: battlesnake, golang
- Language: Go
- Homepage: https://play.battlesnake.com/u/mr_destructive/destructive/
- Size: 3.47 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Getting started with [Battlesnake](http://play.battlesnake.com?utm_source=github&utm_medium=readme&utm_campaign=go_starter&utm_content=homepage) and Go
This is a basic implementation of the [Battlesnake API](https://docs.battlesnake.com/references/api) in Go. It's a great starting point for anyone wanting to program their first Battlesnake using Go, and comes ready to deploy with [Replit](https://repl.it) and [Heroku](https://heroku.com), or you can use any other cloud provider you'd like.
## Technologies Used
* [Go 1.13 (or later)](https://golang.org/)
## Quickstart
The [Quick Start Coding Guide](https://docs.battlesnake.com/guides/getting-started) provides the full set of instructions to customize, register, and create your first games with your Battlesnake! While the guide uses [Repl.it](https://repl.it) as an example host, the instructions can be modified to work with any hosting provider. You can also find advice on other hosting providers on our [Hosting Suggestions](https://docs.battlesnake.com/references/hosting-suggestions) page.
### Prerequisites
* A free [Battlesnake Account](https://play.battlesnake.com/?utm_source=github&utm_medium=readme&utm_campaign=go_starter&utm_content=homepage)
---
## Customizing Your Battlesnake
Locate the `info` function inside [logic.go](logic.go#L18). Inside that function you should see a line that looks like this:
```go
return BattlesnakeInfoResponse{
APIVersion: "1",
Author: "", // TODO: Your Battlesnake username
Color: "#888888", // TODO: Personalize
Head: "default", // TODO: Personalize
Tail: "default", // TODO: Personalize
}
```
This function is called by the game engine periodically to make sure your Battlesnake is healthy, responding correctly, and to determine how your Battlesnake will appear on the game board. See [Battlesnake Personalization](https://docs.battlesnake.com/references/personalization) for how to customize your Battlesnake's appearance using these values.
Whenever you update these values, go to the page for your Battlesnake and select 'Refresh Metadata' from the option menu. This will update your Battlesnake to use your latest configuration and those changes should be reflected in the UI as well as any new games created.
## Changing Behavior
On every turn of each game your Battlesnake receives information about the game board and must decide its next move.
Locate the `move` function inside [logic.go](logic.go#L45). Possible moves are "up", "down", "left", or "right". To start your Battlesnake will choose a move randomly. Your goal as a developer is to read information sent to you about the board (available in the `GameState` struct found in [main.go](main.go#L10)) and decide where your Battlesnake should move next. Your Battlesnakes move logic lives in [logic.go](logic.go#L45). This is the code you will want to edit.
See the [Battlesnake Game Rules](https://docs.battlesnake.com/references/rules) for more information on playing the game, moving around the board, and improving your algorithm.
## (Optional) Running Your Battlesnake Locally
Eventually you might want to run your Battlesnake server locally for faster testing and debugging. You can do this by installing [Go 1.13](https://golang.org/dl/) and running:
```shell
go run main.go logic.go
```
**Note:** You cannot create games on [play.battlesnake.com](https://play.battlesnake.com) using a locally running Battlesnake unless you install and use a port forwarding tool like [ngrok](https://ngrok.com/). See [Hosting Suggestions.](https://docs.battlesnake.com/references/hosting-suggestions#local)
## Running Tests
This Starter Project comes with a very simple test suite for you to expand! Located in `logic_test.go` you can run them using the following command:
```shell
go test
```
---
## Playing Battlesnake
### Completing Challenges
If you're looking for the Single Player Mode of Battlesnake, or something to practice with between events, check out [Challenges.](https://docs.battlesnake.com/guides/quick-start-challenges-guide)
### Joining a Battlesnake Arena
Once you've made your Battlesnake behave and survive on its own, you can enter it into the [Global Battlesnake Arena](https://play.battlesnake.com/arena/global) to see how it performs against other Battlesnakes worldwide.
Arenas will regularly create new games and rank Battlesnakes based on their results. They're a good way to get regular feedback on how well your Battlesnake is performing, and a fun way to track your progress as you develop your algorithm.
### Joining a Battlesnake League
Want to get out there to compete and win prizes? Check out the [Quick Start League Guide](https://docs.battlesnake.com/guides/quick-start-league-guide) for information on the how and when of our competitive seasons.
---
## Resources
All documentation is available at [docs.battlesnake.com](https://docs.battlesnake.com), including detailed Guides, API References, and Tips.
You can also join the Battlesnake Developer Community on [Discord](https://play.battlesnake.com/discord?utm_source=github&utm_medium=readme&utm_campaign=go_starter&utm_content=discord). We have a growing community of Battlesnake developers of all skill levels wanting to help everyone succeed and have fun with Battlesnake :)
Check out live Battlesnake events on [Twitch](https://www.twitch.tv/battlesnakeofficial) and see what is happening when on the [Calendar.](https://play.battlesnake.com/calendar?utm_source=github&utm_medium=readme&utm_campaign=go_starter&utm_content=calendar)
Want to contribute to Battlesnake? We have a number of open-source codebases and would love for you to get involved! Check out our page on [Contributing.](https://docs.battlesnake.com/guides/contributing)
## Feedback
**Do you have an issue or suggestions for this repository?** Head over to our [Feedback Repository](https://play.battlesnake.com/feedback?utm_source=github&utm_medium=readme&utm_campaign=go_starter&utm_content=feedback) today and let us know!