diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 76 |
1 files changed, 76 insertions, 0 deletions
@@ -59,3 +59,79 @@ ## 📄 License
[MIT](https://github.com/retrofor/ChienDice/blob/main/LICENSE) © 2023-PRESENT [简律纯](https://github.com/HsiangNianian)
+
+
+
+
+
+
+### 第一个娘
+
+**pip部署**
+
+命令行输入
+
+``` shell
+pip install ChienDice
+```
+
+**创建main.py**
+
+``` py
+from ChienDice import Bot
+bot = Bot()
+
+if __name__ == "__main__":
+ bot.run()
+```
+
+**开启go-cqhttp**
+
+``` shell
+./go-cqhttp
+```
+
+**认主**
+
+输入`.get married`
+
+如此简单。
+
+
+### 轻松入门
+
+> 只需要记住两个命令即可轻松驾驭九只娘！
+
+**入栈**
+
+`.set` 用于设置一切！
+
+**出栈**
+
+`.get` 用于获取一切！
+
+#### 快速举例
+
+**认主**: `.get married`
+**退群**: `.get lost`
+**获取`jrrp`**: `.get jrrp`
+**设置欢淫语**: `.set welcome [欢迎~] 可选添加 [{at}] [{nickname}] [{avatar}] [{id}]`
+
+## 命令列表
+
+> 还在为繁琐命令感到烦恼？使用简系，小学生都能记住的固定词组！
+
+### get
+
+**class `get`(self, *, config_file = 'config.toml', config_dict = None, hot_reload = False)**
+Bases: `object`
+
+读取并储存配置 `Config`，加载适配器 `Adapter` 和插件 `Plugin`，并进行事件分发。
+
+Arguments
+
+config_file (Optional[str]) - 配置文件，如不指定则使用默认的 config.toml。 若指定为 None，则不加载配置文件。
+
+config_dict (Optional[Dict]) - 配置字典，默认为 None。 若指定字典，则会忽略 config_file 配置，不再读取配置文件。
+
+hot_reload (bool) - 热重载。 启用后将自动检查 plugin_dir 中的插件文件更新，并在更新时自动重新加载。
\ No newline at end of file |