README
¶
YAHTZEE!
A Go implementation of an optimal Yahtzee player on the Raspberry Pi. See more about this project on my blog, or play along online.
Installation
Score tables
You will need to build the score tables first, using the compute_scores tool:
$ go get github.com/timpalpant/yahtzee
$ cd cmd/compute_scores
$ go build
Build the expected value score tables:
$ ./compute_scores -logtostderr -observable expected_value -output expected-value.gob.gz
Build the high score tables:
$ ./compute_scores -logtostderr -observable score_distribution -output score-distribution.gob.gz
The expected value tables are 5.7 MB and the high score tables are 1.8 GB on disk.
Web server
Build and run the web server, passing the location of the score data tables:
$ go install github.com/timpalpant/yahtzee/cmd/yahtzee_server
$ yahtzee_server -logtostderr -port 8080 -expected_scores expected-scores.gob.gz -score_distributions score-distributions.gob.gz
The server will take a few minutes (and GB of RAM) to load the score tables at startup. Navigate to http://localhost:8080.
Image processing server
The image processing web service is written in Python. The easiest way to build and run it is with Docker:
$ cd image_processor
$ docker build -t yahtzee-image-processor:latest .
$ docker run -p 8080:8080 yahtzee-image-processor:latest
A pre-built image is also available at: docker.io/timpalpant/yahtzee-image-processor:latest.
Raspberry Pi Player
First install GoCV, as described here: https://gocv.io/getting-started/
Then build the RPi player with:
$ cd cmd/rpi
$ go build
and run with:
$ ./rpi -logtostderr -v 3 -yahtzee_uri http://localhost:8085 -image_processing_uri http://localhost.local:8080 -score_to_beat 300
It is recommended to run the yahtzee server and image processing service on a separate machine, since they require more memory and computational resources than available on the pi.
License
This package is released under the GNU Lesser General Public License, Version 3.0
Yahtzee is a registered trademark owned by Hasbro. Hasbro is not affiliated with this project.
Documentation
¶
Index ¶
- Constants
- func IsYahtzee(roll Roll) bool
- type Box
- type GameState
- func (game GameState) AddUpperHalfScore(score int) GameState
- func (game GameState) AvailableBoxes() []Box
- func (game GameState) BonusEligible() bool
- func (game GameState) BoxFilled(b Box) bool
- func (game GameState) FillBox(box Box, roll Roll) (GameState, int)
- func (game GameState) GameOver() bool
- func (game GameState) IsValid() bool
- func (game GameState) SetBonusEligible() GameState
- func (game GameState) SetBoxFilled(box Box) GameState
- func (game GameState) String() string
- func (game GameState) Turn() int
- func (game GameState) TurnsRemaining() int
- func (game GameState) UpperHalfScore() int
- type Roll
- func (r Roll) Add(die int) Roll
- func (r Roll) CountOf(side int) int
- func (r Roll) Counts() []int
- func (r Roll) Dice() []int
- func (r Roll) HasNInARow(n int) bool
- func (r Roll) HasNOfAKind(n int) bool
- func (r Roll) IsFullHouse() bool
- func (r Roll) NumDice() int
- func (r Roll) One() int
- func (r Roll) PossibleHolds() []Roll
- func (r Roll) Probability() float32
- func (r Roll) Remove(die int) Roll
- func (r Roll) String() string
- func (r Roll) SubsequentRolls() []Roll
- func (r Roll) SumOfDice() int
- type TurnStep
Constants ¶
const ( MaxGame = 64 << shiftUHS NumTurns = int(Yahtzee + 1) UpperHalfBonusThreshold = 63 UpperHalfBonus = 35 YahtzeeBonus = 100 MaxScore = 1500 )
const ( NDice = 5 NSides = 6 // The largest possible roll integer (+1). This can be used // to pre-allocate arrays indexed by roll. MaxRoll = (NDice << (bitsPerSide * (NSides - 1))) + 1 )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Box ¶
type Box uint
func (Box) IsUpperHalf ¶
type GameState ¶
type GameState uint
Each distinct game is represented by an integer as follows:
- The lowest 13 bits represent whether a box has been filled. Bits 0-5 are the Upper half (ones, twos, ... sixes). Bits 6-12 are the Lower half (three of a kind ... yahtzee)
- Bit 13 represents whether you are eligible for the bonus, meaning that you have previously filled the Yahtzee for points. Therefore bit 13 can only be set if bit 12 is also set.
- Bits 14-19 represent the upper half score in the range [0, 63]. Since for all upper half scores >= 63 you get the upper half bonus, they are equivalent and the upper half score is capped at 63.
This means that all games are represented by an integer < 6.4mm (MaxGame).
func (GameState) AddUpperHalfScore ¶
func (GameState) AvailableBoxes ¶
func (GameState) BonusEligible ¶
func (GameState) SetBonusEligible ¶
func (GameState) SetBoxFilled ¶
func (GameState) TurnsRemaining ¶
func (GameState) UpperHalfScore ¶
type Roll ¶
type Roll uint
Type Roll encodes an unordered roll of five dice as the concatenation of 6 octal integers. Each 3 bits represent the number of ones, the number of twos, etc.
func AllDistinctRolls ¶
func AllDistinctRolls() []Roll
func NewRollFromBase10Counts ¶
Construct a new roll from the given counts in base-10 (as opposed to the canonical representation in base-8).
func NewRollFromDice ¶
Construct a new Roll from the given dice.
func NewRollOfDie ¶
Construct a new Roll with count of the given die.
func (Roll) HasNInARow ¶
HasNInARow checks whether there is a sequence of N sides in a row.
func (Roll) HasNOfAKind ¶
HasNOfAKind checks whether there are at least N of any side in this roll.
func (Roll) IsFullHouse ¶
func (Roll) PossibleHolds ¶
Return all possible distict kept subsets of this roll.
func (Roll) Probability ¶
func (Roll) SubsequentRolls ¶
Return all possible subsequent rolls starting from this one. If this roll contains two dice, it will return all possible combinations of these two with three others rolled. The returned rolls will always contain NDice.
Source Files
Directories