magpie 0.12.0

High-performance Othello library built with bitboards
Documentation 
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

[![CI status](https://github.com/LimeEng/magpie/actions/workflows/ci.yaml/badge.svg)](https://github.com/LimeEng/magpie/actions/workflows/ci.yaml)
[![Latest version](https://img.shields.io/crates/v/magpie?color=blue)](https://crates.io/crates/magpie)

# Magpie

<img src="https://cdn.github.emileng.se/repo/magpie/logo.svg" width="200" alt="Magpie logo" align="right">

Magpie is a high-performance [Othello](https://en.wikipedia.org/wiki/Reversi) library built with bitboards and zero dependencies.

Magpie offers two abstraction levels:

- **Game API**: rule-checked, turn-aware game logic and state management. Enforces legal moves and tracks turns.
- **Board API**: lower-level, unchecked board operations for maximum performance.  Useful when building engines.

## Getting Started

```rust
use magpie::othello::{Game, Status, Stone};

let mut game = Game::new();
// Black moves first in Othello
assert_eq!(game.current_turn(), Stone::Black);

// Pick the first available move and play it
let pos = game.moves().hot_bits().next().unwrap();
game.play(pos)?;

println!("{}", game.display());

assert_eq!(game.current_turn(), Stone::White);
assert_eq!(game.status(), Status::Progressing);
```

## Installation

```sh
cargo add magpie
# Serde support is available through the serde feature flag.
cargo add magpie -F serde
```

## Examples

Examples are [described here](/examples).

Curious to play? One example features a functional Othello game with a random AI opponent. Run `cargo run --example human_vs_ai` to start a game!

## Benchmarks

Benchmarks are [described here](/benches)

Run the benchmarks with `cargo bench`.