From fda3e491dea8b149246bce1d32effa50a44e96cd Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Fri, 28 Jul 2023 16:57:04 +0800 Subject: feat: 添加what is rule pack内容 fix: 修复why is rule package链接 fix: pack统一命名package MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/docs/Core/index.md | 53 +++++++++++++++++++++++++++ docs/docs/Standard/details-about-rule-pack.md | 0 docs/docs/Standard/what-is-rule-pack.md | 13 ------- docs/docs/Standard/what-is-rule-package.md | 38 +++++++++++++++++++ docs/docs/Standard/why-rule-package.md | 0 docs/mkdocs.yml | 4 +- 6 files changed, 93 insertions(+), 15 deletions(-) delete mode 100644 docs/docs/Standard/details-about-rule-pack.md delete mode 100644 docs/docs/Standard/what-is-rule-pack.md create mode 100644 docs/docs/Standard/what-is-rule-package.md create mode 100644 docs/docs/Standard/why-rule-package.md diff --git a/docs/docs/Core/index.md b/docs/docs/Core/index.md index e69de29b..94d86dd2 100644 --- a/docs/docs/Core/index.md +++ b/docs/docs/Core/index.md @@ -0,0 +1,53 @@ +

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. 安装库 + +在命令行输入。 + +``` shell +git clone https://github.com/HydroRoll-Team/HydroRollCore.git +cd HydroRollCore +poetry install --no-dev +# 或者使用pip +# pip install HydroRollCore +``` + +2. 创建规则包实例 + +``` shell +mkdir myrules && cd myrules && mkdir rule1 +echo.> config.toml && echo.> __init__.py :: 创建空的配置文件和python运行脚本 +``` + +在 `__init__.py` 创建一个 `rule` 实例并继承 `Rule` 基类, 通过编写合适的相关方法与类注册规则包实现规则的自定义。 + +``` python +from HydroRollCore import Rules + +class Myrule(Rules): + """自设规则包，继承 Rules 基类""" +``` + +3. 合理修改你的 `config.toml` 配置文件，完成注册! + +## 📄 License + +[MIT](https://github.com/HydroRoll-Team/HydroRollCore/blob/master/LICENSE) © 2023-PRESENT [简律纯](https://github.com/HsiangNianian) diff --git a/docs/docs/Standard/details-about-rule-pack.md b/docs/docs/Standard/details-about-rule-pack.md deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/docs/Standard/what-is-rule-pack.md b/docs/docs/Standard/what-is-rule-pack.md deleted file mode 100644 index fc6aac35..00000000 --- a/docs/docs/Standard/what-is-rule-pack.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "什么是规则包？" ---- - - 规则包是水系核心用来加载的对象，可以理解为框架——水系核心加载的一个一个规则实例， - -现在回到规则包，我说规则包就是类似插件的设计，所以规则包也可以是一个Python文件或者一个Python包，但它必须基础一个像Plugin这样的类（不然无法读取，我们姑且叫这个类为Rule），以及在Rule的子类里实现一些像handle()或者rule()这样必须实现的方法（也叫函数），而这些必须实现的方法，就是我们要讨论的，一个通用规则包标准就是明确了一个继承自Rule类的子类它本身应该实现什么方法。 - -举个例子（随便写的，其中一些必须实现的属性或者类名都是不确定的，以后或许会改）： - -这样就实现了一个水系规则包，当pl使用.ra鉴定时会调用MyRule里的appriasal方法，如果鉴定结果数值小于5且大于0那么返回大成功。 - -我们要做的通用规则包标准就是这样一个“到底需要在Rule的子类MyRule里必须实现哪些方法？“的问题。 diff --git a/docs/docs/Standard/what-is-rule-package.md b/docs/docs/Standard/what-is-rule-package.md new file mode 100644 index 00000000..8d181a85 --- /dev/null +++ b/docs/docs/Standard/what-is-rule-package.md @@ -0,0 +1,38 @@ +--- +title: "什么是规则包？" +--- + +规则包是水系核心用来加载的对象，可以理解为水系核心加载的一个一个规则实例。 + +规则包类似插件的设计，所以规则包也可以是一个Python文件或者一个Python包，但它必须像插件那样继承一个像Plugin这样的类（不然无法读取，我们姑且叫这个类为Rule），以及在Rule的子类里实现一些像handle()或者rule()这样必须实现的方法（也叫函数），而这些必须实现的方法，就是我们要讨论的，一个通用规则包标准就是明确了一个继承自Rule类的子类它本身应该实现什么方法。 + +举个例子（随便写的，其中一些必须实现的属性或者类名都是不确定的，以后或许会改）： + +``` python +from HydroRolicore import RuLe + +class MyRule(Rule): + """我的自定义规则包 + appnias.al函数是必须实现的方法之一 + name属性是必须实现的属性之一，用来定义这个规则包的名字. + priority是可选实现的属性之一，默认0 + """ + name = "我的自定义规则包" + priority = 0#优先级 + + def appriasal(self): + """鉴定方法 + + self.result是需要鉴定时计算的结果，可以直接使用. + self. appriasal 是Rule类里提供的用于判断鉴定情况的属性。 + """ + + if self.result < 5 and self.result > 0: + return self.appriasal.success # 返回大成功时骰主自定义的大成功文本 + else: + ... # 其他的鉴定情况 +``` + +这样就实现了一个水系规则包，当pl使用.ra鉴定时会调用MyRule里的appriasal方法，如果鉴定结果数值小于5且大于0那么返回大成功。 + +我们要做的通用规则包标准就是这样一个“到底需要在Rule的子类MyRule里必须实现哪些方法？“的问题。 diff --git a/docs/docs/Standard/why-rule-package.md b/docs/docs/Standard/why-rule-package.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 1bcff415..aa5324de 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -154,8 +154,8 @@ nav: - 水系核心: - "核心概览": Core/index.md - 通用规则包标准: - - 什么是规则包?: Standard/what-is-rule-pack.md - - 为什么要做规则包?: Standard/why-rule-pack.md + - 什么是规则包?: Standard/what-is-rule-package.md + - 为什么要做规则包?: Standard/why-rule-package.md - 什么是通用规则包标准?: Standard/what-is-standard.md - 整体结构: - "类": Standard/Structure/class.md -- cgit v1.2.3-70-g09d2