rchess 2.3.0

A Chess Library Written In Rust
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

# rchess

A Chess Library Written in Rust

---

**rchess** is a Rust-based library designed for applications that need to work with chess games or boards, such as UCI GUIs or online chess platforms.

If you encounter any bugs, have suggestions for improving code readability or performance, or would like to contribute, we encourage you to create a pull request. For significant API changes or feature requests, please open an issue on GitHub.

---

## Getting Started

Documentation for **rchess** can be found [here](https://docs.rs/rchess/2.0.0/rchess/).

### Installation

Add the following to your `Cargo.toml`:

```toml
[dependencies]
rchess = "2.3.0"
```

### Usage Example

```rust
use rchess::ChessGame;

fn main() {
    // Create a new chess game.
    let mut game = ChessGame::new();
    
    // Get the legal moves for the current position.
    let moves = game.moves();
    
    // Make a move.
    game.make_move(moves[0]);
}
```

### Features

By default, no features are enabled.

To use magic bitboards for sliding piece move generation, enable the `magic-table` feature. On my device, this feature speeds up the benches by around 18%.

Build times will be faster without the `magic-table` feature enabled.

Use the `serde` feature to enable serialization and deserialization.

### Improving Build Time
To improve the slow build time when the `magic-table` is enabled, set your build override opt-level to 3.
```toml
[profile.dev.build-override]
opt-level = 3

[profile.test.build-override]
opt-level = 3

[profile.release.build-override]
opt-level = 3
```

---

## Contributing

We welcome contributions! Please adhere to the following guidelines:

- **Bug Reports & Feature Requests:** Open an issue on the [GitHub Issues](https://github.com/Shadowcat650/rchess/issues) page.
- **Code Contributions:** Fork the repository and create a pull request.

---

## License

This project is dual-licensed under the [MIT](https://github.com/Shadowcat650/rchess/blob/main/LICENSE-MIT) and [APACHE 2.0](https://github.com/Shadowcat650/rchess/blob/main/LICENSE-APACHE) licenses.

---