aboutsummaryrefslogtreecommitdiffstatshomepage

HydroRollCore'水系核心

[![.github/workflows/python-publish.yml](https://github.com/HydroRoll-Team/HydroRollCore/actions/workflows/python-publish.yml/badge.svg)](https://github.com/HydroRoll-Team/HydroRollCore/actions/workflows/python-publish.yml) [![CodeQL](https://github.com/HydroRoll-Team/HydroRollCore/actions/workflows/codeql.yml/badge.svg)](https://github.com/HydroRoll-Team/HydroRollCore/actions/workflows/codeql.yml)

🎁 Getting

  1. 安装库

在命令行输入。

poetry install --no-dev HydroRollCore # 推荐
pnpm install HydroRollCore # 不推荐
pip install HydroRollCore # 不推荐
  1. 创建规则包实例
mkdir myrules && cd myrules && mkdir rule1
echo.> config.toml && echo.> __init__.py :: 创建空的配置文件和python运行脚本

__init__.py 创建一个 rule 实例并继承 Rule 基类, 通过编写合适的相关方法与类注册规则包实现规则的自定义。

from HydroRollCore import Rules

class Myrule(Rules):
  """自设规则包,继承 Rules 基类"""
  1. 合理修改你的 config.toml 配置文件,完成注册!

📄 License

MIT © 2023-PRESENT 简律纯