diff --git a/README.md b/README.md index 593e5eb1..4329ec2a 100644 --- a/README.md +++ b/README.md @@ -117,24 +117,24 @@
-✅支持预设指令文字 +✅支持预设文字 - 支持以自然语言预设文字,自定义机器人人格等信息 - 详见`config.py`中的`default_prompt`部分 - - 支持设置多个预设情景,并通过!reset、!default等指令控制,详细请查看[wiki指令](https://github.com/RockChinQ/QChatGPT/wiki/1-%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E6%9C%BA%E5%99%A8%E4%BA%BA%E6%8C%87%E4%BB%A4) + - 支持设置多个预设情景,并通过!reset、!default等命令控制,详细请查看[wiki命令](https://github.com/RockChinQ/QChatGPT/wiki/1-%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E6%9C%BA%E5%99%A8%E4%BA%BA%E6%8C%87%E4%BB%A4)
✅支持对话、绘图等模型,可玩性更高 - 现已支持OpenAI的对话`Completion API`和绘图`Image API` - - 向机器人发送指令`!draw `即可使用绘图模型 + - 向机器人发送命令`!draw `即可使用绘图模型
-✅支持指令控制热重载、热更新 +✅支持命令控制热重载、热更新 - - 允许在运行期间修改`config.py`或其他代码后,以管理员账号向机器人发送指令`!reload`进行热重载,无需重启 - - 运行期间允许以管理员账号向机器人发送指令`!update`进行热更新,拉取远程最新代码并执行热重载 + - 允许在运行期间修改`config.py`或其他代码后,以管理员账号向机器人发送命令`!reload`进行热重载,无需重启 + - 运行期间允许以管理员账号向机器人发送命令`!update`进行热更新,拉取远程最新代码并执行热重载
✅支持插件加载🧩 @@ -307,7 +307,7 @@ python3 main.py
-**部署完成后必看: [指令说明](https://github.com/RockChinQ/QChatGPT/wiki/1-%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E6%9C%BA%E5%99%A8%E4%BA%BA%E6%8C%87%E4%BB%A4)** +**部署完成后必看: [命令说明](https://github.com/RockChinQ/QChatGPT/wiki/1-%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E6%9C%BA%E5%99%A8%E4%BA%BA%E6%8C%87%E4%BB%A4)** 所有功能查看[Wiki功能使用页](https://github.com/RockChinQ/QChatGPT/wiki/1-%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8) @@ -332,10 +332,8 @@ python3 main.py - [WebwlkrPlugin](https://github.com/RockChinQ/WebwlkrPlugin) - 让机器人能联网!! - [revLibs](https://github.com/RockChinQ/revLibs) - 将ChatGPT网页版、Claude、Bard、Hugging Chat等破解版接入此项目,关于[官方接口和网页版有什么区别](https://github.com/RockChinQ/QChatGPT/wiki/8-%E5%AE%98%E6%96%B9%E6%8E%A5%E5%8F%A3%E3%80%81ChatGPT%E7%BD%91%E9%A1%B5%E7%89%88%E3%80%81ChatGPT-API%E5%8C%BA%E5%88%AB) -- [Switcher](https://github.com/RockChinQ/Switcher) - 支持通过指令切换使用的模型 +- [Switcher](https://github.com/RockChinQ/Switcher) - 支持通过命令切换使用的模型 - [hello_plugin](https://github.com/RockChinQ/hello_plugin) - `hello_plugin` 的储存库形式,插件开发模板 -- [dominoar/QChatPlugins](https://github.com/dominoar/QchatPlugins) - dominoar编写的诸多新功能插件(语音输出、Ranimg、屏蔽词规则等) -- [dominoar/QCP-NovelAi](https://github.com/dominoar/QCP-NovelAi) - NovelAI 故事叙述与绘画 - [oliverkirk-sudo/chat_voice](https://github.com/oliverkirk-sudo/chat_voice) - 文字转语音输出,支持HuggingFace上的[VITS模型](https://huggingface.co/spaces/Plachta/VITS-Umamusume-voice-synthesizer),azure语音合成,vits本地语音合成,sovits语音合成 - [RockChinQ/WaitYiYan](https://github.com/RockChinQ/WaitYiYan) - 实时获取百度`文心一言`等待列表人数 - [chordfish-k/QChartGPT_Emoticon_Plugin](https://github.com/chordfish-k/QChartGPT_Emoticon_Plugin) - 使机器人根据回复内容发送表情包 diff --git "a/res/wiki/1-\345\212\237\350\203\275\344\275\277\347\224\250.md" "b/res/wiki/1-\345\212\237\350\203\275\344\275\277\347\224\250.md" index df469bcf..a7b1c899 100644 --- "a/res/wiki/1-\345\212\237\350\203\275\344\275\277\347\224\250.md" +++ "b/res/wiki/1-\345\212\237\350\203\275\344\275\277\347\224\250.md" @@ -48,12 +48,12 @@
-✅支持预设指令文字 +✅支持预设文字 - 支持以自然语言预设文字,自定义机器人人格等信息 - 详见`config.py`中的`default_prompt`部分 - - 支持设置多个预设情景,并通过!reset、!default等指令控制,详细请查看[wiki指令](https://github.com/RockChinQ/QChatGPT/wiki/%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E6%9C%BA%E5%99%A8%E4%BA%BA%E6%8C%87%E4%BB%A4) - - 支持使用文件存储情景预设文字,并加载: 在`prompts/`目录新建文件写入预设文字,即可通过`!reset <文件名>`指令加载 + - 支持设置多个预设情景,并通过!reset、!default等命令控制,详细请查看[wiki命令](https://github.com/RockChinQ/QChatGPT/wiki/1-%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E6%9C%BA%E5%99%A8%E4%BA%BA%E5%91%BD%E4%BB%A4) + - 支持使用文件存储情景预设文字,并加载: 在`prompts/`目录新建文件写入预设文字,即可通过`!reset <文件名>`命令加载
@@ -61,25 +61,25 @@ - 使用SQLite进行会话内容持久化 - 最后一次对话一定时间后自动保存,请到`config.py`中修改`session_expire_time`的值以自定义时间 - - 运行期间可使用`!reset` `!list` `!last` `!next` `!prompt`等指令管理会话 + - 运行期间可使用`!reset` `!list` `!last` `!next` `!prompt`等命令管理会话
✅支持对话、绘图等模型,可玩性更高 - 现已支持OpenAI的对话`Completion API`和绘图`Image API` - - 向机器人发送指令`!draw `即可使用绘图模型 + - 向机器人发送命令`!draw `即可使用绘图模型
-✅支持指令控制热重载、热更新 +✅支持命令控制热重载、热更新 - - 允许在运行期间修改`config.py`或其他代码后,以管理员账号向机器人发送指令`!reload`进行热重载,无需重启 - - 运行期间允许以管理员账号向机器人发送指令`!update`进行热更新,拉取远程最新代码并执行热重载 + - 允许在运行期间修改`config.py`或其他代码后,以管理员账号向机器人发送命令`!reload`进行热重载,无需重启 + - 运行期间允许以管理员账号向机器人发送命令`!update`进行热更新,拉取远程最新代码并执行热重载
✅支持插件加载🧩 - 自行实现插件加载器及相关支持 - - 详细查看[插件使用页](https://github.com/RockChinQ/QChatGPT/wiki/%E6%8F%92%E4%BB%B6%E4%BD%BF%E7%94%A8) + - 详细查看[插件使用页](https://github.com/RockChinQ/QChatGPT/wiki/5-%E6%8F%92%E4%BB%B6%E4%BD%BF%E7%94%A8)
✅私聊、群聊黑名单机制 @@ -153,14 +153,14 @@ 绘图功能 -### 机器人指令 +### 机器人命令 -目前支持的指令 +目前支持的命令 > `<>` 中的为必填参数,使用时请不要包含`<>` > `[]` 中的为可选参数,使用时请不要包含`[]` -#### 用户级别指令 +#### 用户级别命令 > 可以使用`!help`命令来查看命令说明 @@ -174,7 +174,7 @@ !del all 删除本会话对象的所有历史记录 !last 切换到前一次会话 !next 切换到后一次会话 -!reset [使用预设] 重置对象的当前会话,可指定使用的情景预设值(通过!default指令查看可用的) +!reset [使用预设] 重置对象的当前会话,可指定使用的情景预设值(通过!default命令查看可用的) !prompt 查看对象当前会话的所有记录 !usage 查看api-key的使用量 !draw <提示语> 进行绘图 @@ -184,7 +184,7 @@ !default 查看可用的情景预设值 ``` -#### 管理员指令 +#### 管理员命令 仅管理员私聊机器人时可使用,必须先在`config.py`中的`admin_qq`设置管理员QQ @@ -197,9 +197,9 @@ !delhst all 删除所有会话的所有历史记录 ```
-⚙ !cfg 指令及其简化形式详解 +⚙ !cfg 命令及其简化形式详解 -此指令可以在运行期间由管理员通过QQ私聊窗口修改配置信息,**重启之后会失效**。 +此命令可以在运行期间由管理员通过QQ私聊窗口修改配置信息,**重启之后会失效**。 用法: 1. 查看所有配置项及其值 @@ -239,7 +239,7 @@ 格式:`!~<配置项名称>` 其中`!~`等价于`!cfg ` -则前述三个指令分别可以简化为: +则前述三个命令分别可以简化为: ``` !~all !~default_prompt @@ -290,11 +290,11 @@ sensitive_word_filter = True ### 预设文字(default模式) 编辑`config.py`中的`default_prompt`字段,预设文字不宜过长(建议1000字以内),目前所有会话都会射到预设文字的影响。 -或将情景预设文字写入到`prompts/`目录下,运行期间即可使用`!reset <文件名>`指令加载,或使用`!default <文件名>`指令将其设为默认 +或将情景预设文字写入到`prompts/`目录下,运行期间即可使用`!reset <文件名>`命令加载,或使用`!default <文件名>`命令将其设为默认 ### 预设文字(full_scenario模式) -将JSON情景写入到`scenario/`目录下,运行期间即可使用`!reset <文件名>`指令加载,或使用`!default <文件名>`指令将其设为默认. +将JSON情景写入到`scenario/`目录下,运行期间即可使用`!reset <文件名>`命令加载,或使用`!default <文件名>`命令将其设为默认. JSON情景模板参考`scenario/default_template.json`。 @@ -367,7 +367,7 @@ prompt_submit_length = <模型单次请求token数上限> - 情景预设中token 在运行期间,使用管理员QQ账号私聊机器人,发送`!reload`加载修改后的`config.py`的值或编辑后的代码,无需重启 使用管理员账号私聊机器人,发送`!update`拉取最新代码并进行热更新,无需重启 -详见前述`管理员指令`段落 +详见前述`管理员命令`段落 ### 群内无需@响应规则 diff --git "a/res/wiki/2-\345\212\237\350\203\275\345\270\270\350\247\201\351\227\256\351\242\230.md" "b/res/wiki/2-\345\212\237\350\203\275\345\270\270\350\247\201\351\227\256\351\242\230.md" index fd83dbd5..ecb35580 100644 --- "a/res/wiki/2-\345\212\237\350\203\275\345\270\270\350\247\201\351\227\256\351\242\230.md" +++ "b/res/wiki/2-\345\212\237\350\203\275\345\270\270\350\247\201\351\227\256\351\242\230.md" @@ -4,7 +4,7 @@ #### 自动更新 -由管理员QQ私聊机器人QQ发送`!update`指令 +由管理员QQ私聊机器人QQ发送`!update`命令 #### 手动更新 diff --git "a/res/wiki/7-\346\217\222\344\273\266\345\274\200\345\217\221.md" "b/res/wiki/7-\346\217\222\344\273\266\345\274\200\345\217\221.md" index 7d1508d5..3782192a 100644 --- "a/res/wiki/7-\346\217\222\344\273\266\345\274\200\345\217\221.md" +++ "b/res/wiki/7-\346\217\222\344\273\266\345\274\200\345\217\221.md" @@ -1,7 +1,7 @@ QChatGPT 插件开发Wiki -> 请先阅读[插件使用页](https://github.com/RockChinQ/QChatGPT/wiki/%E6%8F%92%E4%BB%B6%E4%BD%BF%E7%94%A8) -> 请先阅读[技术信息页](https://github.com/RockChinQ/QChatGPT/wiki/%E6%8A%80%E6%9C%AF%E4%BF%A1%E6%81%AF) +> 请先阅读[插件使用页](https://github.com/RockChinQ/QChatGPT/wiki/5-%E6%8F%92%E4%BB%B6%E4%BD%BF%E7%94%A8) +> 请先阅读[技术信息页](https://github.com/RockChinQ/QChatGPT/wiki/4-%E6%8A%80%E6%9C%AF%E4%BF%A1%E6%81%AF) > 建议先阅读本项目源码,了解项目架构 > 问题、需求请到仓库issue发起 @@ -354,18 +354,18 @@ PersonNormalMessageReceived = "person_normal_message_received" """ PersonCommandSent = "person_command_sent" -"""判断为应该处理的私聊指令时触发 +"""判断为应该处理的私聊命令时触发 kwargs: launcher_type: str 发起对象类型(group/person) launcher_id: int 发起对象ID(群号/QQ号) sender_id: int 发送者ID(QQ号) - command: str 指令 + command: str 命令 params: list[str] 参数列表 - text_message: str 完整指令文本 + text_message: str 完整命令文本 is_admin: bool 是否为管理员 returns (optional): - alter: str 修改后的完整指令文本 + alter: str 修改后的完整命令文本 reply: list 回复消息组件列表,元素为YiriMirai支持的消息组件 """ @@ -383,18 +383,18 @@ GroupNormalMessageReceived = "group_normal_message_received" """ GroupCommandSent = "group_command_sent" -"""判断为应该处理的群聊指令时触发 +"""判断为应该处理的群聊命令时触发 kwargs: launcher_type: str 发起对象类型(group/person) launcher_id: int 发起对象ID(群号/QQ号) sender_id: int 发送者ID(QQ号) - command: str 指令 + command: str 命令 params: list[str] 参数列表 - text_message: str 完整指令文本 + text_message: str 完整命令文本 is_admin: bool 是否为管理员 returns (optional): - alter: str 修改后的完整指令文本 + alter: str 修改后的完整命令文本 reply: list 回复消息组件列表,元素为YiriMirai支持的消息组件 """