Rust Universal Chess Interface.
This crate parses and creates UCI messages.
It follows the UCI protocol and uses shakmaty
for relevant types.
The UCI protocol is the most widely used way for GUI's to communicate with engines and vice versa.
#![no_std]
compatible.
See the examples for a demo on how to send and receive messages.
You can run each one with cargo run --package <example-name>
.
There's two other crates that I'm aware of which serve a similar purpose. Keep in mind that this is a shallow comparison, I haven't looked extensively and I am not an expert.
vampirc-uci
:- Doesn't use
shakmaty
, which AFAIK is the go-to chess crate now. - Doesn't separate the two types of messages (engine, GUI) and specific messages. It just has one big enum which mostly uses enum fields for message data. This is really inconvenient because you can't represent specific messages, only the whole
Message
enum. Doesn't provide IO communication with an engine.There isvampirc-io
, but the API is lacking and it uses the deprecatedasync-std
crate.- More dependencies;
pest
andchrono
.ruci
only has shakmaty and two macros, which don't get included in the final binary. - Not
#![no_std]
compatible. - More tests, but I don't know about the coverage.
- Doesn't use
shakmaty-uci
: this library is based on/inspired byvampirc-uci
, so all of the above bullet points apply, except:- Uses
shakmaty
. - Uses
nom
instead ofpest
and doesn't usechrono
. - Is
#![no_std]
compatible.
- Uses
ruci
might also faster since it doesn't use a parsing library, but I'm not making any claims or showing results because I only have some
toy benchmarks (but yes, they do technically favor ruci
).
default
: no features are enabled by default.engine-sync
: adds theEngine
struct for communicating with an engine. Requiresstd
.engine-async
: adds theEngineAsync
struct for communicating with an engine usingtokio
. Also enables theengine-sync
feature because of shared error types.serde
: enables serde support for most types. All implementations are derived with no parameters. Requiresstd
.