[](https://github.com/HydroRoll-Team/HydroRollCore/actions/workflows/python-publish.yml)
[](https://github.com/HydroRoll-Team/HydroRollCore/actions/workflows/codeql.yml)
[](https://app.netlify.com/sites/grps-v1/deploys)
> [!IMPORTANT]
>
> 强烈推荐使用`pdm`管理你的`HydroBot`项目。
1. 安装库
在终端中执行：
```bash
git clone https://github.com/HydroRoll-Team/HydroRollCore.git
cd HydroRollCore
pdm install
```
你可以使用`pip`进行安装：
```bash
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, Result, Dice
class MyRule(Rule):
"""自设规则包"""
name = "MyRule"
priority: int = 0
def __init__(self) -> None:
"""初始化你的规则包"""
def check(self, dice: Dice) -> Result:
"""声明规则包检定方式"""
return Result("myevent.event1", True)
```
3. 合理修改你的 `config.toml` 配置文件，完成注册!
### 🎍Sites