58 lines
2.1 KiB
Markdown
58 lines
2.1 KiB
Markdown
# Battlesnake Python Starter Project
|
|
|
|
An official Battlesnake template written in Python. Get started at [play.battlesnake.com](https://play.battlesnake.com).
|
|
|
|
|
|
|
|
This project is a great starting point for anyone wanting to program their first Battlesnake in Python. It can be run locally or easily deployed to a cloud provider of your choosing. See the [Battlesnake API Docs](https://docs.battlesnake.com/api) for more detail.
|
|
|
|
## Technologies Used
|
|
|
|
This project uses [Python 3](https://www.python.org/) and [Flask](https://flask.palletsprojects.com/). It also comes with an optional [Dockerfile](https://docs.docker.com/engine/reference/builder/) to help with deployment.
|
|
|
|
## Run Your Battlesnake
|
|
|
|
Install dependencies using pip
|
|
|
|
```sh
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
Start your Battlesnake
|
|
|
|
```sh
|
|
python main.py
|
|
```
|
|
|
|
You should see the following output once it is running
|
|
|
|
```sh
|
|
Running your Battlesnake at http://0.0.0.0:8000
|
|
* Serving Flask app 'My Battlesnake'
|
|
* Debug mode: off
|
|
```
|
|
|
|
Open [localhost:8000](http://localhost:8000) in your browser and you should see
|
|
|
|
```json
|
|
{"apiversion":"1","author":"","color":"#888888","head":"default","tail":"default"}
|
|
```
|
|
|
|
## Play a Game Locally
|
|
|
|
Install the [Battlesnake CLI](https://github.com/BattlesnakeOfficial/rules/tree/main/cli)
|
|
* You can [download compiled binaries here](https://github.com/BattlesnakeOfficial/rules/releases)
|
|
* or [install as a go package](https://github.com/BattlesnakeOfficial/rules/tree/main/cli#installation) (requires Go 1.18 or higher)
|
|
|
|
Command to run a local game
|
|
|
|
```sh
|
|
battlesnake play -W 11 -H 11 --name 'Python Starter Project' --url http://localhost:8000 -g solo --browser
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
Continue with the [Battlesnake Quickstart Guide](https://docs.battlesnake.com/quickstart) to customize and improve your Battlesnake's behavior.
|
|
|
|
**Note:** To play games on [play.battlesnake.com](https://play.battlesnake.com) you'll need to deploy your Battlesnake to a live web server OR use a port forwarding tool like [ngrok](https://ngrok.com/) to access your server locally.
|