diff options
| author |   简律纯 <i@jyunko.cn> | 2023-07-31 15:03:40 +0800 |
|---|---|---|
| committer | 简律纯 <i@jyunko.cn> | 2023-07-31 15:03:40 +0800 |
| commit | bdb8dfa8d2d9ac1668a1a0036d194cb57b168e37 (patch) | |
| tree | 232fad440bee508523e0b8a4f49f021f196ba958 /docs/Core | |
| parent | cfc4a06db1d89d6bfbc75e5dfb46720cb15827da (diff) | |
| download | infini-bdb8dfa8d2d9ac1668a1a0036d194cb57b168e37.tar.gz infini-bdb8dfa8d2d9ac1668a1a0036d194cb57b168e37.zip | |
feat: add commiter
Diffstat (limited to 'docs/Core')
| -rw-r--r-- | docs/Core/index.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/Core/index.md b/docs/Core/index.md new file mode 100644 index 00000000..3f3422b6 --- /dev/null +++ b/docs/Core/index.md @@ -0,0 +1,49 @@ +<h1 align="right">HydroRollCore'水系核心</h1> + +<p align="right"> + <a aria-label="Join the community on GitHub" href="https://github.com/HydroRoll-Team/hydroroll/discussions" target="blank"> + <img alt="" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?logo=data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8CAgL/CgoK/woKCv8GBgb/BgYG/woKCv8KCgr/AgIC/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/BgYG/0ZGRv9MTEz/JiYm/ygoKP9MTEz/RkZG/wYGBv8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP9ycnL/Li4u/1xcXP9eXl7/Li4u/3Jycv8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP88PDz/cnJy/05OTv9OTk7/UFBQ/05OTv9wcHD/Pj4+/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/Kioq/3Jycv9cXFz/TExM/05OTv9aWlr/cHBw/yoqKv8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/Pj4+/zg4OP+AgID/Pj4+/2ZmZv9oaGj/PDw8/4CAgP86Ojr/Pj4+/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/ywsLP9iYmL/enp6/zIyMv90dHT/dHR0/zAwMP98fHz/YmJi/ywsLP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP9SUlL/PDw8/3Jycv9CQkL/UlJS/1RUVP9CQkL/cnJy/zw8PP9SUlL/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/VFRU/yIiIv9aWlr/PDw8/zw8PP8+Pj7/PDw8/1hYWP8iIiL/VFRU/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/zQ0NP9CQkL/ZmZm/yIiIv9WVlb/WFhY/yIiIv9mZmb/QkJC/zY2Nv8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP9QUFD/BgYG/0RERP9KSkr/JCQk/yYmJv9KSkr/RERE/wgICP9QUFD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/CgoK/wICAv8KCgr/CgoK/wYGBv8GBgb/CgoK/woKCv8CAgL/CgoK/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA==&labelColor=000000&logoWidth=20&logoColor=white"> + </a> + <a href="https://pypi.org/project/HydroRollCore"> + <img src="https://img.shields.io/pypi/v/hydrorollcore?labelColor=000000"> + </a> + <a href="https://github.com/HydroRoll-Team/HydroRollCore/blob/master/LICENSE"> + <img alt="" src="https://img.shields.io/pypi/l/hydrorollcore.svg?labelColor=000000&color="> + </a> +</p> + +## 🎁 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) |