Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pambrose/battlesnake-examples
Battlesnake Quickstart Snake Examples
https://github.com/pambrose/battlesnake-examples
battlesnake battlesnakeio java kotlin
Last synced: 3 months ago
JSON representation
Battlesnake Quickstart Snake Examples
- Host: GitHub
- URL: https://github.com/pambrose/battlesnake-examples
- Owner: pambrose
- License: apache-2.0
- Created: 2019-03-09T18:58:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-10T01:15:07.000Z (over 2 years ago)
- Last Synced: 2024-04-08T02:25:59.038Z (7 months ago)
- Topics: battlesnake, battlesnakeio, java, kotlin
- Language: Kotlin
- Homepage:
- Size: 280 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Battlesnake Quickstart Snake Examples
[](https://travis-ci.org/pambrose/battlesnake-examples)
[](https://www.codacy.com/app/pambrose/battlesnake-examples?utm_source=github.com&utm_medium=referral&utm_content=pambrose/battlesnake-examples&utm_campaign=Badge_Grade)
A collection of simple [Battlesnakes](http://battlesnake.io) written in Kotlin and Java using
the [Battlesnake Quickstart](https://github.com/pambrose/battlesnake-quickstart) framework.
Visit [Battlesnake.io](https://docs.battlesnake.io) for API documentation and instructions for creating a game.
[](https://gitpod.io/#https://github.com/pambrose/battlesnake-examples)
[](https://heroku.com/deploy?template=https://github.com/pambrose/battlesnake-examples)
[](https://repl.it/github/pambrose/battlesnake-examples)
## Snake Definitions
Visit [Battlesnake Quickstart](https://github.com/pambrose/battlesnake-quickstart) for a description
of how to define kotlin and java snakes.
## Snake Examples
### Kotlin
* [SimpleSnake](src/main/kotlin/io/battlesnake/examples/kotlin/SimpleSnake.kt)
* [PerimeterSnakeWithLists](src/main/kotlin/io/battlesnake/examples/kotlin/PerimeterSnakeWithLists.kt)
* [PerimeterSnakeWithSequences](src/main/kotlin/io/battlesnake/examples/kotlin/PerimeterSnakeWithSequences.kt)
* [CenterSquareSnake](src/main/kotlin/io/battlesnake/examples/kotlin/CenterSquareSnake.kt)
* [StripedSnake](src/main/kotlin/io/battlesnake/examples/kotlin/StripedSnake.kt)
### Java
* [SimpleSnake](src/main/java/io/battlesnake/examples/java/SimpleSnake.java)
* [PerimeterSnake](src/main/java/io/battlesnake/examples/java/PerimeterSnake.java)
## Clone your own snake
Use the [Battlesnake Template](https://github.com/pambrose/battlesnake-template) to clone the code for your own snake.
## Snake Execution
A server can support running multiple snakes, but they must be the same snake object type.
Assign the `mainName` variable in [build.gradle](./build.gradle#L36) to the desired fully qualified
snake classname. For example:
```groovy
def mainName = 'io.battlesnake.examples.kotlin.PerimeterSnakeWithLists'
```
You can run a snake with a script or as an uberjar:
* Build and run the script **build/install/battlesnake-examples/bin/snake** with: `make script`.
* Build and run the uberjar **build/libs/snake.jar** with: `make uber`.
## Deployment Options
### localhost
Use [localtunnel](https://theboroer.github.io/localtunnel-www/) to make a locally running snake visible to the
Battlesnake server.
1) Run localtunnel with: `lt --port 8080`
2) Use the URL returned as your snake URL.
3) Follow the [Snake Execution](#snake-execution) instructions to run a snake.
You can also use [ngrok](https://ngrok.com), but unpaid users may experience "429 Too Many Requests" errors, which will
cause your snake to move UP.
1) Run ngrok with: `ngrok http 8080`
2) Use either of the `Forwarding` URLs displayed in the ngrok console as your snake URL.
3) Follow the [Snake Execution](#snake-execution) instructions to run a snake.
### [Gitpod](https://gitpod.io)
1) Click on the [Open in Gitpod](https://gitpod.io/#https://github.com/pambrose/battlesnake-examples)
badge above.
2) Follow the [Snake Execution](#snake-execution) instructions to run a snake.
3) After starting the snake, click on **Open Preview** on the pop-up window.
4) Use the URL displayed in the Gitpod browser window as your snake URL. You can
also visit the **/info** endpoint for more information.
### [repl.it](https://repl.it)
1) Click on the [run on repl.it](https://repl.it/github/pambrose/battlesnake-examples)
badge above.
2) Follow the [Snake Execution](#snake-execution) instructions to run a snake.
3) Use the URL displayed in the repl.it browser window as your snake URL.
You can also visit the **/info** endpoint for more information.
### [Heroku](https://www.heroku.com)
1) Create a new Heroku app with: `heroku create [APP_NAME]`
2) Deploy code to Heroku with: `git push heroku master`
3) Open the Heroku app in a browser with: `heroku open`
or visit [http://APP_NAME.herokuapp.com](http://APP_NAME.herokuapp.com).
4) Use the Heroku URL address as your snake URL. You can
also visit the **/info** endpoint for more information.
5) View the server logs with: `heroku logs --tail`