Skip to content

Latest commit

 

History

History
105 lines (69 loc) · 2.83 KB

README.md

File metadata and controls

105 lines (69 loc) · 2.83 KB
Raw

Game Service

Overview

Up to three players on a board made of as tiles. Objective for each player is to control every hexagon on the board or be the last player in the game.

Example Board

Board

A players goal is to either control the entire board, or enough of the board that their opponent surrenders.

Boards are constructed out of hexagons called tiles. The properties of a tile are listed below.

The way a player controls the board is by moving 'tokens' on to an adjoining tile. A player controls a tile when they leave a minimum of one token on a tile.

Tiles on the board are contestable. Where an opponent owns an adjacent tile to a neutral tile or a tile owned by another player, they may attempt to take control of that adjacent tile. The number of tokens on a tile determines the success of one player attempting to gain control of a tile. This is discussed further in the 'Rules' section.

Tiles

Tiles have the following properties:

  • have two states. Owned and neutral
  • hold n number of tokens
  • must be adjacent to at least one other tile

Starting state

A board begins with every tile in the neutral state, except for the tile a player starts on.

Rules

A tile that is adjacent to another tile can attack the adjoining tile.

Win Conditions

Development

python3.8 -m venv venv . venv/bin/activate

Install the dependencies with make install.

Docker

Because none of the services images have been uploaded to a cloud hosted registry you will need to build the dependency images yourself before being able to run this service. Run make build in each of the following repositories:

  • player-api
  • board-api
  • combat-api

Now run make up. You may have to wait until the MySQL instance comes up before the other containers will stay alive. To check whether the MySQL database has finished coming up, run docker logs risk-db and look for text similar to ready for connections. Version: '8.0.20' socket: '/var/run/mysqld/mysqld.sock' port: 3306 MySQL Community Server - GPL.. Once the MySQL container has finished coming up run make up again. You can check that all expected containers are up by running docker ps.

Important

Remember to keep your local images up to date.

Soon images will be hosted so remembering to update images will no longer be an issue.

Database

To connect to the mysql database running in a the docker container run the following command.

mysql --host={HOST} --port={PORT} --protocol=TCP --user={USER} risk --password={PASSWORD}

Using the API

GET

/v0/attack/

    curl localhost:8000/v0/attack?attacker={"territory_id"}&defender={"territory_id"}

POST

`v0/randomly-assign-players

    curl -x POST localhost:8000/v0/randomly-assing-players -d '{"player1_id": 1, "player2_id": 2}'