docs/RulePackage/intro.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

---
title: 概述
---

!!! abstract
    此章节涉及到真正的 Python 规范问题，因此请认真阅读并多加练习，方能写出漂亮的代码。


### 安装规则包

水系规则包可以通过 `pip` Pyhton 包管理工具直接下载，但是为了方便，我们推荐以下两个安装方案。

=== "使用`pdm`管理器"

    ```shell
    pdm install MyRule
    ```

    如果你使用`pdm`管理自己的规则包或开启自己的水系骰子，那么非常推荐使用这种方案来集成形如 `infini-Rule-The_Pool`这般包名的规则。

=== "使用`hrc`管理器"

    ```shell
    hrc install MyRule
    ``` 
    
    一般来说推荐使用`hrc`管理器来安装和调试规则包。 (1)

    1.  这样会无视虚拟环境规则而直接找到当前使用的文件路径，而不需要像`pdm`那样只能用在`pdm`本身创建的虚拟环境内了。


`HRC`管理器的原理是使用`pip`获取包后`cp`到当前所指定的目录(或者默认目录)。对于不熟悉命令行的用户来说，一个`webui`或许是更适合的方案。

### 编写规则包

要编写规则包，需要懂得`Python`相关的知识以及一些计算机常识。在接下来的好几个章节里你将会被一步一引导学习如何制作一个规则包。