rchess

Crates.iorchess
lib.rsrchess
version1.0.1
sourcesrc
created_at2024-08-24 19:47:20.670162
updated_at2024-08-24 19:53:52.536798
descriptionA Chess Library Written In Rust
homepage
repositoryhttps://github.com/Shadowcat650/rchess
max_upload_size
id1350523
size185,463
(Shadowcat650)

documentation

https://docs.rs/rchess/1.0.1/rchess/

README


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.

Note: RChess is currently under active development, with many more features planned. The API is subject to change.

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.

Installation

Add the following to your Cargo.toml:

[dependencies]
rchess = "1.0.0"

Usage Example

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]);
}

Contributing

We welcome contributions! Please adhere to the following guidelines:

  • Bug Reports & Feature Requests: Open an issue on the GitHub Issues page.
  • Code Contributions: Fork the repository and create a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.


Commit count: 0

cargo fmt