Riverboat

A full-service Go Texas hold'em library, featuring an ultra-fast poker hand evaluation module. Designed specifically to be integrated with whichever communications protocol and persistence layer you desire.

Table of Contents

• Riverboat
  • Table of Contents
  • Features
  • How-To
    • Installation
    • Usage
  • Documentation
  • Contributing
  • License

Features

Riverboat plays No-limit Texas Hold'em. It's a full-service game-management library including:

• Illegal move rejection - disallows illegal plays, including moves out of turn, or raises that don't meet the minimum
• Information hiding - calculates exactly what any player can see at any moment, including edge cases like when all players are all-in
• Winner determination and pot allocation - correctly allocates pots at the end, including arbitrary numbers of sidepots and splits
• Configurable - buy-in limits and blinds can be set on a game-by-game basis
• Broadly compatible - compatible with standard library interfaces, and designed for easy custom serialization to allow easy integration with any stack you use
• Blazing fast - includes an evaluation submodule, which as of July 2020 is the fastest 5-, 6-, and 7-card poker hand evaluator in Go on Github.

How-To

Installation

To install:

$ go get github.com/alexclewontin/riverboat

To use in your project:

import (
    // For the base library:
    "github.com/alexclewontin/riverboat"

    // For direct access to the hand evaluation module:
    "github.com/alexclewontin/riverboat/eval"
)

Usage

Create a game:

    g := riverboat.NewGame()

Add players, buy-in, ready up:

    pNum := g.AddPlayer()

    err = riverboat.BuyIn(g, pNum, 1000)
    if err != nil {
        fmt.Println(err)
    }

    err = riverboat.ToggleReady(g, pNum, 0)
    // ... check for error

Play:

    err = riverboat.Deal(g, pNum, 0)
    // ... check for error
    err = riverboat.Bet(g, pNum, 25)
    // ... check for error
    err = riverboat.Fold(g, pNum, 0)
    // ... check for error

Inspect the game's state:

    // This doesn't contain opponents' cards, or the contents of the deck
    playerView := g.GenerateView(pNum)

    // This is the entire game state, for easy serialization and storage in a persistence layer
    godView := g.GenerateOmniView()

Documentation

Full documentation for Riverboat can be found here.

Full documentation for Riverboat's evaluation module can be found here.

Contributing

Contributions to Riverboat are more than welcome!

• If the contribution is a minor fix, go ahead and open a PR.
• If the contribution is larger (e.g. supporting an additional ruleset or variation like Omaha or limit hold'em) open an issue to coordinate development efforts.

License

Riverboat and its component pieces are provided under the BSD-2-Clause license except where otherwise specified.

Copyright 2020 © Alex Lewontin.