Lib.rs

快速开始

只需三步即可快速搭建一个符合水系标准的骰子机器人。你还可以在我们的 官方文档 中查看更详细的部署与配置教程。

1. 安装库

推荐局部安装，使用 pdm 创建一个虚拟环境后在命令行输入，

pdm add hydroroll[all]

这将在当前虚拟环境添加 extra 版本的 HydroRoll，包括 自动热重载 (hot-reload)、调度任务 (apscheduler) 与 基础模型 (base-model) 等。

2. 创建机器人实例

在终端中输入执行以下指令，

hydroroll new -b coc_example "HydroRoll"

这将在当前 pwd 环境的根目录下使用内置的 coc_example 规则包 创建一个名为 "HydroRoll" 的骰子文件夹，您的所有骰子相关内容均在此文件夹中。

tree HydroRoll

HydroRoll
├─models
├─config
├─data
├─rules
├─scripts
└─web
    ├─backend
    └─frontend

3. 使用合适的适配器，合理修改你的 config.toml 配置文件，等待连接！

hydroroll run
# 使用 pdm run main.py 同理

贡献

欢迎阅读 CONTRIBUTING.md 对水系的各个模块与标准做出贡献。

社区

HydroRoll'水系 的论坛在 GitHub Discussions，你可以在这里 提出任何问题，分享任何想法。

我们的 行为准则(Code of Conduct) 适用于 HydroRoll'水系 社区内的所有交流渠道。

许可证

MIT © 2023-PRESENT 简律纯 & HydroRoll-Team.