Games
==========================

general
-------------------
This section provides an overview of the game mechanics, including how to start a game, 
manage quests, and handle player interactions.

games
-------------------

.. important::

   Currently only only one game is available with the name "Fast and hungry, task hunt".
   But there are plans to add more games in the future and the merge of game ``The great base-off`` 
   from a past tournament.

+----------------------------+-------------+----------------------------------------------------------------------------------------------+
| Name                       | Status      | Description                                                                                  |
+============================+=============+==============================================================================================+
| Fast and hungry, task hunt | In progress | Complete all tasks and survive. The game ends as soon as one player has completed all tasks. |
+----------------------------+-------------+----------------------------------------------------------------------------------------------+
| The great base-off         | In progress | Survive for a year and earn points for upgrading your base.                                  |
+----------------------------+-------------+----------------------------------------------------------------------------------------------+
| Mixed martial starves      | Idea        |                                                                                              |       
+----------------------------+-------------+----------------------------------------------------------------------------------------------+


game status workflow
--------------------

.. mermaid ::
   flowchart TD
    A([start]) -->|automatic| CREATED
    CREATED --> |manuelly| RUNNING
    CREATED --> |manuelly| PAUSED
    CREATED --> |automatic| FAILURE
    FAILURE --> |automatic| Z
    RUNNING --> |manuelly| PAUSED
    PAUSED --> |manuelly| RUNNING
    PAUSED --> |manuelly| STOPPED
    STOPPED --> |automatic| FINISHED
    FINISHED --> Z([end])


functions
------------------
.. automodule:: src.game
    :members:
    :exclude-members: MissingGameConfig