Home

For a general description of the game, instructions on how to setup the repository and the test suite, please refer to the README.

Each of the components described below is detailed on the menu on the right-hand side.

Components

AI:MMO consists of five main components, separated into their own directories. The UI runs in Google App Engine, the others run in Google Container Engine as separate Docker containers under Kubernetes.

• The UI (players directory): a Django app used for the front-end and database interaction (one globally). The UI is in the process of being transitioned to Unity.
• Games: holds and updates the game state (one per game).
• The Game Creator: responsible for creating games (one globally).
• Workers: containers the code for an avatar which is given a game state and returns the avatar's action for that turn.
• The reverse proxy: nginx (behind an Ingress) which allows web browsers to connect to games to receive the game state.

Terminology

• Avatar: a user's in-game representation. A user can have up to one per game.
• User: a single person with an account.

To contributors

The documentation describes the state of the project at the date of 3rd September 2017.

After modifying major parts in the logic, you can document it in the wiki. If you do that, please modify the date below.

Thank you for your work!