uncleBlobby/new-ts-snake

Battlesnake TypeScript Starter Project

An official Battlesnake template written in TypeScript. Get started at play.battlesnake.com.

This project is a great starting point for anyone wanting to program their first Battlesnake in TypeScript. It can be run locally or easily deployed to a cloud provider of your choosing. See the Battlesnake API Docs for more detail.

Technologies Used

This project uses TypeScript, Node.js, and Express. It also comes with an optional Dockerfile to help with deployment.

Run Your Battlesnake

Install dependencies using npm

npm install

Start your Battlesnake

npm run start

You should see the following output once it is running

Running Battlesnake at http://0.0.0.0:8000

Open localhost:8000 in your browser and you should see

{"apiversion":"1","author":"","color":"#888888","head":"default","tail":"default"}

Play a Game Locally

Install the Battlesnake CLI

• You can download compiled binaries here
• or install as a go package (requires Go 1.18 or higher)

Command to run a local game

battlesnake play -W 11 -H 11 --name 'TypeScript Starter Project' --url http://localhost:8000 -g solo --browser

Next Steps

Continue with the Battlesnake Quickstart Guide to customize and improve your Battlesnake's behavior.

Note: To play games on play.battlesnake.com you'll need to deploy your Battlesnake to a live web server OR use a port forwarding tool like ngrok to access your server locally.