Stratego Game Engine

The main library is written in Rust. The AI part is using Python. Please, I'm new to Rust, and we are studiants who are learning. Feel free to make review or reach us if you see garbage code, I would be happy to learn !

Stratego article

Overleaf Links : https://www.overleaf.com/2628549423ydfggscvpgbr

WIP :

• Templating
• Abstract English and French
• introduction (almost done)

TODO

• Evolve Python api to Rust api
• Implementing warp for client REST calls

Python AIs

dependencies

We use this amazing crate pyo3 for python and rust to easily commute, please make sure you can use it before.

Install python dependencies with pip3 install -r requirements.txt

Build engine project

  make lib-build

You should put all AI files in ai_python folder. Please, make sure this file compile, or Rust will throw an uncomprehensible error. I have searched for almost 3hours. :(

Your AIs should depend on interface class StrategoAI(abc.ABC):

In rust_bind, thoses functions are needed for Rust to call your AI care with the name of this one. e.g.: ask_next_move_ + ai name (ask_next_move_test) def ask_next_move_test() -> Tuple[Tuple[int, str], Tuple[int, str]]:

The Rust interface is located there it will ask your AI if everything is correctly set up his next move.

This file controls Python using Rust code, to move pieces, ask for board state or available moves.

Run simulations

Run

python3 analyzes.py to simulate game between two chosen AI, you can also choose the number of thread to run this simulation

• filename must be a CSV

AI analyzes

You can use ./analyzes to automatically compare two ai.

It takes 5 parameters:

• file_name : output file with the winner of each game
• number_of_parties : how many parties to execute (please make sure that it is dividable by the number_of_thread)
• first_ai_name : It is give as a player for the game
• second_ai_name

./analyzes data-r-r-1.csv 8 random random

How to play

In stratego-exec, the main function defines a game with a AI.

    let engine = StrategoEngine::new(
        create_stratego_board(),
        (
            HumanPlayer::new(Color::Red, String::from("Tigran")),
            //HumanPlayer::new(Color::Blue, String::from("Cassiopee")),
            AIPlayer::new(Color::Blue, String::from("test")),
        ),
    );

The engine controls board and players. He asks them to enter position to play. (e.g: 0A)

How to use Stratego Library

The object StrategoBoardWrapper is available to be used in Python.

    import stratego_engine as se
    from ai_python.src.utils import basic_material_values

    board = se.StrategoBoardWrapper(cases) #constructor

    board.moving((1, "A"), (2, "A")) # move a case
    
    board.display_by_color("Blue") 

    board.at((1, "A"))
    board.place("Full", (1, "A"), 1, "Red") # place a piece at coordinate

    board.get_available_moves()
    board.get_available_moves_by_color('Red')

    # maybe parsed in python with parse_moves() in ai.py file 
    board.basic_evaluation() # return color of the winner, if one there is *Yoda*
    board.material_evaluation(basic_material_values()) # return 

    clone = board.clone_board() # Clone a board

    # result should be parsed with methods in ai_python.src.utils sort_evals()
    sim = board.simulate_games_material(basic_material_values(), range(0, 100), 30, 'Red', 4)

The others three, are made to be displayed Case, Piece, Coordinate

    case.py_get_state()
    case.py_get_content()

The following function are there to help you build content for the board:

    import stratego_engine as se

    se.rust_create_stratego_board() # to get a stratego board randomlly filed

    # you can also build an empty board and fill it yourself

    se.rust_create_empty_stratego_board() 

    piece = se.rust_create_piece(1, "Blue") # 1 correspond to the number in Rust enum

    case = se.rust_create_full_case((1, "A"), piece)
    se.rust_create_empty_case((1, "A")) # without content
    se.rust_create_unreachable_case((1, "A")) # water

    last_coup = board.get_last_coup()# return last played coup (None at the first coup)

Web API

Run web api, with make api-build, the app should run on localhost

Found swagger on localhost

Routes:

• Create a game with 2 players (p1 is red)

  http://127.0.0.1:8000/create-game
  {
      "player_id_1": "Tigran",
      "player_id_2": "random",
      "type": "h",
      "board": [
          [
              "your initilized board"
          ]
      ]
  }
  

• Get state of a game

  http://127.0.0.1:8000/game/{uuid}]/{color}
  
  
  

• Watch a game

  http://127.0.0.1:8000/watcher/{uuid}]
  
  
  

• Get all available moves on a game

  http://127.0.0.1:8000/moves/{color}/{uuid}
  
  

• Move a piece on a game

http://127.0.0.1:8000/moves
 {
   "uuid": "uuid",
   "player_id": "Red", # I know, we fucked that one :D
   "coordinate_from": [
       6,
       "A"
   ],
   "coordinate_to": [
       5,
       "A"
   ]
 }

• Use an AI as a player

  http://127.0.0.1:8000/ai
  {
    "uuid": "uuid",
    "color": "Red",
    "ai_name": "random"
  }
  
  

• Check if a game is finished

  http://127.0.0.1:8000/end_game/{uuid}]