![Maintenance](https://img.shields.io/badge/maintenance-activly--developed-brightgreen.svg)

# backgammon

## Backgammon: The Oldest Board Game in the World
This crate provides a pure, canonical implementation of the game
[*Backgammon.*](https://en.wikipedia.org/wiki/Backgammon)

<img src="https://upload.wikimedia.org/wikipedia/commons/3/30/Backgammon_lg.png" height="100">

### Supported Doubling Cube Rules
The following [`rules`](`crate::rules::Rules`) on the doubling cube are supported:

* Beaver
* Raccoon
* Murphy
* Jacoby
* Crawford
* Holland

### Examples
Start a new backgammon match over the default amount of points and with the default rules, as
defined in [`Rules`](`crate::rules::Rules`):
```rust
use backgammon::r#match::Match;

let mut m = Match::new();

```
Typically, you want to define the points for a match, hence:
```rust
use backgammon::r#match::Match;
use backgammon::rules::MatchRules;

let mut m = Match::new().
with_points(13);

```
Depending on the style of tournament you decide to play, it makes sense to select one or more
rules too:
```rust
use backgammon::r#match::Match;
use backgammon::rules::{MatchRules, GameRules};

let mut m = Match::new().
with_points(13).
with_jacoby();

```

Play a game by calling:
```rust
use backgammon::Game;
use backgammon::rules::{Roll,GameRules};

let mut g = Game::new();

// set rules
g = g.with_beaver().with_raccoon().with_murphy(3).with_jacoby().with_holland();

// roll dices
let g = g.roll();
```
### Design Philosophy
This library is designed to offer completely stateless game functions. This means that it
should be easy to implement wrappers using this library in combination with some databases to
store the game state.

### Discussions and Support
Remember that the APIs are not stable yet. Any support is very welcome. Please open an
[Issue](https://github.com/carlostrub/backgammon/issues) to discuss features or ask for help.

You can also find me on:

IRC: [#backgammon @ libera.chat](ircs://irc.libera.chat/#backgammon) (via
[webchat](https://web.libera.chat/#backgammon))

License: BSD-2-Clause