Getting started with Battlesnake and TypeScript
This is a basic implementation of the Battlesnake API in TypeScript. It's a great starting point for anyone wanting to program their first Battlesnake using TypeScript, and comes ready to deploy with Replit and Heroku, or you can use any other cloud provider you'd like.
The Quick Start Coding Guide provides the full set of instructions to customize, register, and create your first games with your Battlesnake! While the guide uses 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 page.
- A free Battlesnake Account
Locate the info function inside logic.ts. Inside that function you should see a line that looks like this:
const response: InfoResponse = {
apiversion: "1",
author: "",
color: "#888888",
head: "default",
tail: "default"
}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 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.
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.ts. 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 variable) and decide where your Battlesnake should move next.
See the Battlesnake Game Rules for more information on playing the game, moving around the board, and improving your algorithm.
Eventually you might want to run your Battlesnake server locally for faster testing and debugging. You can do this by installing Node.js and running:
npm install
npm startNote: You cannot create games on play.battlesnake.com using a locally running Battlesnake unless you install and use a port forwarding tool like ngrok. See Hosting Suggestions.
This Starter Project comes with a very simple test suite for you to expand! Located in test/logic.test.ts you can run them using the following command:
npm testIf you're looking for the Single Player Mode of Battlesnake, or something to practice with between events, check out Challenges.
Once you've made your Battlesnake behave and survive on its own, you can enter it into the Global Battlesnake Arena 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.
Want to get out there to compete and win prizes? Check out the Quick Start League Guide for information on the how and when of our competitive seasons.
All documentation is available at docs.battlesnake.com, including detailed Guides, API References, and Tips.
You can also join the Battlesnake Developer Community on 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 and see what is happening when on the 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.
Do you have an issue or suggestions for this repository? Head over to our Feedback Repository today and let us know!
Devious Devin (Beta) Nessegrev-beta RedDragon Kisnake