快速上手

它是一个基于 Rust 构建的、开源且功能强大的多功能聊天机器人框架。

得益于 Rust 的跨平台能力，sithra-rs 可以轻松部署在 Windows, Linux, macOS 等多种操作系统上。

其核心的插件化设计，让您可以按需扩展，打造专属的机器人。

本篇文档将引导您在几分钟内完成 sithra-rs 的下载、配置和启动。

WebUI

如果你想要使用 WebUI 配置、访问、管理您的机器人，您可以直接跳转到部署 WebUI

为了方便用户，我们为以下主流平台提供了预编译的二进制文件。您可以直接下载并运行，无需手动编译。

其他平台

如果您的操作系统或 CPU 架构不在上述列表内，您需要从源代码手动编译 sithra-rs。请参考下文的从源码编译部分。

前往 GitHub Releases 页面，根据您的操作系统下载最新版本的 sithra-rs 压缩包。

将下载的压缩包解压到一个您喜欢的目录。我们建议您为 sithra-rs 创建一个独立的文件夹，因为程序后续会在其工作目录下生成配置文件和插件数据。

解压后，您的目录结构应该如下所示：

sithra-rs.exe

config.toml

首次运行前，请确保 config.toml 文件存在于 sithra-rs 的运行目录中。sithra-rs 依赖此文件来加载和配置插件。

注意

如果 sithra-rs 在启动时没有找到 config.toml 文件，程序将会自动退出。

关于如何编写配置文件，请参考下一部分：编写配置项。

一切就绪！现在您可以启动 sithra-rs 了。

在终端中执行以下命令：

.\sithra-rs.exe

首先，为文件添加可执行权限，然后运行它：

chmod +x ./sithra-rs
./sithra-rs

如果一切顺利，您将在终端看到 sithra-rs 成功启动的日志信息。

如果您是开发者，或者您需要在非官方支持的平台上运行 sithra-rs，您可以选择从源代码进行编译。

请确保您的系统中已安装 Rust 工具链。如果尚未安装，可以参考 Rust 官方文档进行安装。

使用 Git 克隆 sithra-rs 的代码仓库：

git clone https://github.com/SithraBot/sithra-rs.git
cd sithra-rs

在项目根目录下，执行 cargo build 命令进行编译。我们推荐使用 --release 参数来构建优化后的版本：

cargo build --release

编译完成后，生成的可执行文件将位于 target/release/ 目录下。

SithraBot/sithra-rs

如果您在使用过程中遇到任何问题，或有任何功能建议，欢迎随时在 GitHub Issues 中提出。

您也可以加入我们的 QQ 群获取帮助：948180922