From 8e92c375fc5ce1605c268cf8f7fae57cf5574e6b Mon Sep 17 00:00:00 2001 From: 苏向夜 Date: Sat, 9 Dec 2023 21:48:48 +0800 Subject: :memo: 更新文档 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 93 ++++++++++++++++++++++++++++++++++++--------------------------- 1 file changed, 54 insertions(+), 39 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index aa8cb626..1092a1ac 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,78 @@

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) + + + + + pypi + + + hydro + + +[![.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 +## 🎁 Getting hydro 1. 安装库 -> [!IMPORTANT] -> -> 强烈推荐使用`pdm`管理你的`Bot`项目。 + > [!IMPORTANT] + > + > 强烈推荐使用`pdm`管理你的`Bot`项目。 -在命令行输入。 + 在终端中执行： -``` shell -git clone https://github.com/HydroRoll-Team/HydroRollCore.git -cd HydroRollCore -pdm install -# 或者使用pip -# pip install HydroRollCore -``` + ```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 -``` + ``` shell + mkdir myrules && cd myrules && mkdir rule1 + echo.> config.toml + echo.> __init__.py + ``` + + 在 `__init__.py` 创建一个 `rule` 实例并继承 `Rule` 基类, 通过编写合适的相关方法与类注册规则包实现规则的自定义。 -在 `__init__.py` 创建一个 `rule` 实例并继承 `Rule` 基类, 通过编写合适的相关方法与类注册规则包实现规则的自定义。 + ``` python + from HydroRollCore import Rule, Result, Dice -``` python -from HydroRollCore import Rule + class MyRule(Rule): + """自设规则包""" -class Myrule(Rule): - """自设规则包，继承 Rules 基类""" -``` + name = "MyRule" + priority: int = 0 + + def __init__(self) -> None: + """初始化你的规则包""" + + def check(self, dice: Dice) -> Result: + """声明规则包检定方式""" + return Result("myevent.event1", True) + ``` 3. 合理修改你的 `config.toml` 配置文件，完成注册! ### 🎍Sites -https://grps.hydroroll.team _(recommend)_ -https://grps-v1.netlify.app -~~https://hydroroll-team.github.io/HydroRollCore/~~ + + _(recommend)_ + +~~~~ ## 📄 License -- cgit v1.2.3-70-g09d2