licheszter

Licheszter 是一个 Rust 库，旨在包装整个 Lichess API。目前，该库正在积极开发中，并正在添加更多功能。目标是最终成为用 Rust 编写的最完整和最佳的 #1 Lichess API 包装器。无论您是寻找第一个开源 Rust 项目来贡献，还是只是对项目感兴趣，请查看 贡献 部分，获取更多信息。

警告

由于无法保证破坏性更改，该项目在版本 1.0.0 之前不适合用于生产。 自行承担风险，并准备面对更多或更少的破坏性更改。 如果您遇到任何意外的错误，请打开一个 GITHUB 问题，描述错误。 由于 Lichess API 不断进化，尤其是反序列化模型可能会不准确并产生错误。 此类错误将尽快修复。

注意

禁止在涉及使用棋盘引擎或其他可解释为作弊的项目中使用棋盘 API（crate 功能 board）。默认启用功能 bot 以防止意外。如果您正在开发不使用外部棋类辅助工具的项目，您可以启用 board 功能，如果 Bot API 不适合您的用例。您也可以选择不使用任何功能，如果您根本不需要该功能，可以通过禁用默认功能来实现。在这种情况下，请注意，您可能还需要手动选择其他默认功能。本项目及其开发人员不对任何因滥用棋盘 API 而可能发生的账户封禁负责。

示例

以下是一个创建 Licheszter 认证实例并使用它的示例

use licheszter::client::Licheszter;
use futures_util::StreamExt;

#[tokio::main]
async fn main() {
    // Create a new Licheszter with your account token
    let client = Licheszter::builder()
        .with_authentication("lip_exampletoken")
        .build();

    // Use the client to fetch online bots, for example...
    let bots = client.bots_online(10).await.unwrap();

    // ...or open the event stream
    let events = client.connect().await.unwrap();
    while let Some(event) = events.next().await.unwrap() {
        // Do something with the event!
    }
}

贡献

所有贡献都受到高度赞赏，无论它们是否提供对代码、文档或其他与项目相关的改进。请在您的提交中遵循 语义提交消息 指南。

愿意贡献但不确定从何开始？请查看仓库问题，以了解哪里最需要您的帮助。如果没有当前开放的问题，请随时通过 [email protected] 发送电子邮件给我。

有关更多信息，请查看官方 Lichess API 文档。