yatzy

Yatzy game framework


Keywords
python, python-c-extension, python3, yatzy, yatzy-game
License
MIT
Install
pip install yatzy==0.2.0

Documentation

Yatzy

Python framework for playing Yatzy (Yahtzee).

Types

Roll

init(die1, die2, die3, die4, die5)

Initialize Roll with five specific die values. Must include all five dice. Arguments must be int values 1-6.

classmethod: roll()

Create a Roll object with random die values.

hold(die...)

Re-roll with indicated die held from previous roll. Returns new Roll. Does not mutate previous Roll object.

Scorecard

Object for scoring rolls.

TODO

  • Add str/repr methods to Scorecard.
  • Add Scorecard methods for accessing individual score slots.
  • Retrieve available scoring slots.
  • Fill out Scorcard API documentation.