Documentation / Getting started
git clone git@github.com:CoderOneHQ/bomberland.git
(You'll also need the base-compose.yml
and docker-compose.yml
files in the root folder)
Docker is used to start the game engine and connect both agents in a single command. It's also used to ensure the same performance of your agent locally versus on our servers.
The Docker flow is used for the rest of this guide. You can also access the engine binary below:
Make sure Docker is running.
From the root directory of your starter kit, run in your terminal:
docker-compose up --abort-on-container-exit --force-recreate
It may take a few minutes to run the first time. This will build the game server, and connect your starter agent.
Once the game server is running, you should see:
game-server_1 | [1] 2021-10-28T02:57:47.701Z - Agent [defaultName](b) connected to the server
Since Bomberland is a 2-player environment, the game engine will wait for a second agent to connect.
↑
/ ↓
/ ←
/ →
- arrows to moveSPACE
- place a bombYou can submit an agent to compete against others in 1v1 matches. Matches run weekly and top agents are displayed on the leaderboard.
To submit:
docker.io/coderonehq/hello-world
. This image contains a basic starter agent that takes random actions.You've now submitted your first agent to the competition! Check back regularly to see your results from the Matches page.
You're now all set up to compete in Bomberland.
If you need help, please reach out on Discord.
Here are some tasks to try:
docker-compose.yml
specifies which agents to connect. Try switching which character you play as, or playing your agent against itself.docker-compose.yml
> game-server
> environment
. See ⚙️ Environment Flags for a full list of available settings.Tip: Add a
--build
flag in yourdocker-compose up
command whenever you make a change to thedocker-compose.yml
orbase-compose.yml
files. i.e.:docker-compose up --abort-on-container-exit --force-recreate --build