---
hide:
- navigation
---
HydroRollCore'水系核心
## 🎁 Getting
1. 安装库
在命令行输入。
``` shell
git clone https://github.com/HydroRoll-Team/HydroRollCore.git
cd HydroRollCore
pdm install
# 或者使用pip
# pip install HydroRollCore
```
2. 创建规则包实例
``` shell
mkdir myrules && cd myrules && mkdir rule1
echo.> config.toml
echo.> __init__.py
```
在 `__init__.py` 创建一个 `rule` 实例并继承 `Rule` 基类, 通过编写合适的相关方法与类注册规则包实现规则的自定义。
``` python
from HydroRollCore import Rule
class Myrule(Rule):
"""自设规则包，继承 Rule 基类"""
```
3. 合理修改你的 `config.toml` 配置文件，完成注册!
## 📄 License
[MIT](https://github.com/HydroRoll-Team/HydroRollCore/blob/master/LICENSE) © 2023-PRESENT [简律纯](https://github.com/HsiangNianian)