Hanabi AI

Runner for an AI competition based on the card game Hanabi

Status of Python 3 Migration

Getting Started

To run the example simulation

sample.sh

To get help info for running your own simulations

python hanabi_ai/playgame.py -h
python hanabi_ai/playgame.py single -h

Tournament Mode

Hanabi has a tournament mode, which runs combinations of all listed players. To run the example tournament

sample_tournament.sh

to get help info for setting up your own tournament

python hanabi_ai/playgame.py tournament -h

Variants

Hanabi has 3 variants to increase difficulty, included in the rules sheet. They are:

1 - Adds the multicolor suit as a 6th suit to the game. It is not a wildcard suit

2 - Same as Variant 1, but only 1 card from each rank of the multicolor suit is used

3 - Adds the 6th suit to the game and these cards are wild. In this variant, you cannot call out the mutlicolor suit. Instead, the multicolor cards always count as the color in your clue. When playing the card, it counts and builds as the 6th color

Prerequisites

Python 3.7

Installing

A step by step series of examples that tell you how to get a development env running

1. Install required packages

pip install -r requirements.txt

2. Install hanabi_ai as an editable package

   pip install --editable .

Running the tests

All tests are written as unit tests and can be run with nose

nosetests

To run an individual test, provide the filepath

nosetests path_to_test.py

To run pylint on the project

pylint hanabi_ai