Преглед изворни кода

docs(README): 添加模块管理的常用命令说明

dzp пре 3 година
родитељ
комит
2bd5156c84
1 измењених фајлова са 33 додато и 0 уклоњено
  1. 33 0
      README.md

+ 33 - 0
README.md

@@ -98,3 +98,36 @@ ID 配置文件和数据配置文件可分别放置在 `$HOME/my-paotin/ids/` 
 ## 本地运行方式
 
 你可以在 `plugins/` 目录下编写你的插件。插件代码格式可参考样板插件 `plugins/EXAMPLE.tin` 及其它已有插件。
+
+# 特性介绍
+
+## 实用命令
+
+大部分自定义功能都采用 TinTin++ 的别名来实现,也有一部分是函数。考虑到命令行下也有手动输入的需要,
+因此部分别名有长名称和短名称两个版本。长名称用来在代码中使用以增加可读性。短名称在命令行下则可以简化输入。
+
+### 模块管理
+
+* `load-module` (短名称 `LM`),可以加载模块。例如 `load-module foo` 或者 `LM foo`(下面不再为短名称单独举例)。
+
+PaoTin++ 下的模块分「弱模块」、「纯模块」与「混合模块」三类。对纯模块和混合模块而言,`load-module` 还可以在加载时提供配置参数。例如:
+
+```
+load-module fullskill {
+    {eat}       {gan liang}
+    {drink}     {niurou tang}
+    {sleep}     {e;e;sleep}
+    {wakeup}    {w;w;lian sword 10}
+};
+```
+
+相信不难看出这是一个名叫 `fullskill` 的练功模块,渴了就喝牛肉汤,饿了就吃干粮,睡觉去东边,醒来了去西边。
+通过这种方式可以提高模块的通用性。
+
+* `kill-module` (短名称 `KM`),用来卸载模块。例如 `kill-module foo`。
+* `reload-module` (短名称 `RLM`),重新载入模块。例如 `reload-module foo`。
+* `disable-module` (短名称 `DM`),禁用已加载的模块。例如 `disable-module foo`。模块被禁用之后,就像是尚未被加载一样,不会影响游戏的其它部分。
+* `enable-module`(短名称 `EM`),重新启用已加载但被禁用的模块。例如 `enable-moudle foo`。
+* `list-modules`(短名称 `MODS`),查看所有已加载的模块清单。该命令无参数。
+* `look-module`(短名称 `MOD`),查看指定模块的详细说明。例如 `look-module foo`。
+* `load-lib`(短名称 `LL`),加载 library。例如 `load-lib event`,相当于 `load-module lib/event`。library 是一类更加基础的插件模块。一般在代码中使用 `load-lib` 来加载本模块所依赖的 library。