YSYL

You Stack You Lose, The project for Group G 2022

Running the game

Run game

$ make

Installing the environment

This repo uses conda for handling virtual environments. If you are using a command line version of conda, use the environment.yml file to create an environment with conda env create -f environment.yml and activate the environment with conda activate ysyl.

Move functionality

Moving is done by selecting the type of move in the options menu to the right, and then clicking squares in the game board on the left of the view. A move alters the 2d-array of Square objects that represents the game board. This is done by collecting the x-y coordinates of the clicked square and then addressing the corrseponding square. All of the high-level input processing is done in the function move_handler which is a member of the Board class. The moves that are currently supported are described in more detail below.

Place lying or standing piece

When the option for placing a lying or standing piece is selected, a click on the game board will collect the coordinates of the selected square and call a member function of the corresponding Square object which adds a piece to it. The coordinates are fetched in the move_handler function of the Board class.

Move a piece

When the option for moving a piece is selected, two clicks on the game board are required to make a move. First, the player clicks on the square from which a piece shall be moved. After this, the player clicks the square to which the piece shall be moved. The coordinates of both these squares are collected and processed in the move_handler function of the Board class.

Move a stack

When the option for moving a stack is selected, the first click on the game board will result in the player picking up the stack. The following clicks on the game board will place pieces at the selected locations until the stack on hand is empty. The coordinates from which the player picks up a stack and places pieces are processed and accessible in the move_handler function of the Board class.

Project Structure

All application code should be placed in src/ and the test in tests/ where the test file is prefixed with test_.... Example:

src/StateValidator/state.py
tests/test_state.py

Contributing

All changes to the main branch are made through pull requests on GitHub. In order to contribute, create a branch with your changes and submit a pull request to main. Include a title that refers to the task in trello together with a description of your changes to help reviewers understand your changes.

Feature: Save a state in the statemanager

Added a function to save a new state in the statemanager component. 

Important Never commit and push directly to the main branch!

When naming branches start off with a "tag" describing what kind of changes the branch includes (feature, fix, hotfix, etc..) and follow with a description of what you are working on. It is also a good idea to mention what part of the system the changes are related to if it helps identifying the purpose of the branch. The branch naming convention exists to make it easier figuring out what a branch contains and to force the author to keep his/her changes coherent with the naming. Try to avoid being overly specific to keep the names to a reasonable length, common sense is more important than any convention!

feat-validator
feat-savestate
feat-io-processfile
fix-validator
hotfix-imports
feat-alphabetapruning

All changes should be reviewed by a minimum of 1 other person after submitting a pull request to ensure that other members can weigh in on the changes. Try to avoid having people that are involved with the changes review their own pull request, even if this is tempting.

When merging pull requests we Squash and merge to the main branch. Squashing combines all the commits in the pull request and allows us to use our own format for individual commits on individual branches and still keep the history of the main branch in a coherent format.

Reviewing

When reviewing a pull request, make sure that it meets the most important guidelines before merging:

• Is the feature/fix well defined and only solve a single or narrow group of problems?

• Are tests written?

• No magic constants, misleading variable names etc..

• Are the changes in the correct component?

Here are some more detailed checks: PR checklist

Using the AI

The AI is run in a separate process in order to not block the UI.

Usage: python -m src.GameEngine.GameAI [OPTION] [INPUT FILE] [OUTPUT FILE]
Options:
	--diff= : a difficulty level from 1 to 3
	--color= : the color for the AI (black or white)
	--config= : the file path to a config

Write a move to the input file and the AI will return the following in the output:

• Outcome from input move as a number
  • 0 = invalid move
  • 1 = valid move
  • 2 = White wins
  • 3 = Black wins
• Id, an unique identifier for each move to help avoid reading duplicates
• The move, see below for an example

{
    "outcome": 1,
    "id": "09f1b621-7b60-4696-865f-9f4fa119a1e6",
    "move": {...}
}

Format of a move

• Source
  • Is it from the pile?
  • Position
• Destination
  • Position
  • Orientation of the piece at the top as a number (0 = flat | 1 = standing)
• The amount of pieces
• Color of the player as a number (0 = white | 1 = black)
• Is it the first turn in the game?

Example of a move input

{
    "src": {
        "pile": true,
        "pos_x": 0,
        "pos_y": 0,
    },
    "des": {
        "pos_x": 0,
        "pos_y": 0,
        "orientation": 0
    },
    "pieces": 1,
    "color": 0,
    "first_turn": false
}

Config

A path to a config can be passed as an argument which will overwrite any inputed options, the config can be used to change any values after the game is started by changing the corresponding fields.

Currently there is the following options:

{
	difficulty: 1
}

Format of the board

[[[0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]]

 [[0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]]

 [[0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]]

 [[0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]]

 [[0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]
  [0 0 0 ... 0 0 0]]]

shape(x = 5, y = 5, z = 42)

The maximum pieces in a stack is 42