batamiaou 0.1.0

Simulator of the child variant of the War card game

batamiaou

Battle game simulator

Introduction

Bata-Miaou (or similarly Bata-Waf) is a child variant of the "War" card game where there is actually no strategy to win (players can’t do anything).

This project implements a game simulator through a python C extension (limited C API).

Installation

pip install batamiaou

Usage

from batamiaou import BatamiaouGame

# create a new game instance
game = BatamiaouGame()
# run a whole game (it stops when a player has no more cards)
# and returns the number of rounds
rounds = game.run()
# reset the game
game.reset()
# run a single round and returns 1 or 2 (the winning player)
round_winner = game.play()

Deck

A BatamiaouGame embeds a deck attribute that an array of bytes of size 36 (char[36]), that represents the 36 cards of the game.

The value of the i-th card is (i % 6) + 1 (value between 1 and 6).

The elements of deck are used as follows:

Content of deck[i]	Value	Meaning
0b0001	1	The card i is the player 1 main deck
0b0010	2	The card i is the player 2 main deck
0b0101	5	The card i is the player 1 discard deck
0b0110	6	The card i is the player 1 discard deck
0b0000	0	The card i is currently involved in a battle (generally not seen)

This deck can be read at any time between hands.

# deck is a `bytes` object of length 36
deck = game.deck()
# to get the integers
values = [v for v in map(int, deck)]

You can also use numpy to ease further deck analysis:

import numpy as np

deck = np.frombuffer(game.deck(), dtype=np.uint8)