aboutsummaryrefslogtreecommitdiff

goffel - the golang Kniffel/Yahtzee implementation

If you don’t know what 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.

A game on a goffel server instance can be played simply through netcat.

> netcat muhq.space 63036
HELO test
test
h

The above example connects to the goffel server running at muhq.space.
It registers a player, named “test”, joins the session “test” and outputs a help message.

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

License

Goffel is licensed under a MIT license found in the LICENSE file.