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) [![Netlify Status](https://api.netlify.com/api/v1/badges/ecbe4af3-223f-4fa4-a182-a37a776fd05b/deploy-status)](https://app.netlify.com/sites/grps-v1/deploys)

🎁 Getting

  1. 安装库

在命令行输入。

git clone https://github.com/HydroRoll-Team/HydroRollCore.git
cd HydroRollCore
pdm install
# 或者使用pip
# pip install HydroRollCore
  1. 创建规则包实例
mkdir myrules && cd myrules && mkdir rule1
echo.> config.toml
echo.> __init__.py

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

from HydroRollCore import Rule

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

🎍Sites

https://grps.retrofor.space (recommend)
https://grps-v1.netlify.app
~~https://hydroroll-team.github.io/HydroRollCore/~~

📄 License

MIT © 2023-PRESENT 简律纯