aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: e76aeb59bfb172e65b31c320bdbafb6a17bf5f99 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# goffel - the golang Kniffel/Yahtzee implementation

If you don't know what [Yahtzee](https://en.wikipedia.org/wiki/Yahtzee) is you don't
need goffel.

Goffel includes a library, which implements the game logic of Yahtzee,
as well as some game implementations.

## Installation

To install goffel just run:

```go get muhq.space/go/muhq/goffel```

## Usage

Goffel has a command line utility to start the various game interfaces.

```goffel -h```

will present the available options.

An example how to use goffel's library can be found in uis/interactive.go.
It implements a simple terminal based yahtzee game.