ruchess 0.0.12

rust chess
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

# ruchess

rust chess

[docs](https://docs.rs/ruchess)

## features

- highly compact bitboard representations
- zobrist hashing
- magic attack tables
- move generation & validation
- outcome evaluation (checkmate, stalemate, repetition, insufficient material)
- fen parsing
- immutable
- hella [docs](https://docs.rs/ruchess)
- really really really fast (relatively)

i only support standard chess. it is unlikely i will support other variants.

probably check out [shakmaty](https://github.com/niklasf/shakmaty) if you want more features

## quickstart

> [!CAUTION]
> this is library is still at version `0.0.X`
>
> it is very likely that there will be breaking api changes until version `0.1.0`
>
> if you use this library, make sure you pin the version in cargo.toml

```sh
cargo add ruchess
```

or in your `cargo.toml`

```toml
[dependencies]
ruchess = "0.0.4"
```

```rust
use ruchess::game::Game;
use ruchess::square;

// Play 1.e4 from the standard starting position.
let game = Game::new();
let after_e4 = game.mve(square::E2, square::E4).unwrap();
assert!(after_e4.position().board().is_occupied(square::E4));
```

see: [docs](https://docs.rs/ruchess) for more details

see: [examples](https://github.com/zjom/ruchess/tree/main/examples) or [ruchess tui](https://github.com/zjom/ruchess/tree/main/tui) for example applications

## dependencies

- [arrayvec](https://docs.rs/arrayvec/latest/arrayvec/index.html) to allocate generated moves on stack

## roadmap

- [x] benchmarks
  - will move to mutable api if benchmarks are very bad (update: working on performance)
- [ ] parsing
  - [x] fen
  - [ ] pgn
  - [ ] san
  - [ ] uci
- [ ] real uci support
- [ ] finalise public api

## benchmarks

simple and benchmarking using [perft](https://www.chessprogramming.org/Perft) to get an estimation of performance

results in [benchmark_results/](benchmark_results)

code in [examples/perft.rs](examples/perft.rs)

benchmarks were ran on m1 macbook pro

we generate roughly 205 Mn/s

for reference, [shakmaty](https://github.com/niklasf/shakmaty) generates roughly 223 Mn/s

we are currently about 8% slower.

## license

[unlicense](https://unlicense.org/)