enhance: improve writing for README

This commit is contained in:
lanvent
2023-03-25 02:55:07 +08:00
parent e071b6c1b4
commit 63701c182a
7 changed files with 161 additions and 75 deletions

View File

@@ -1,18 +1,14 @@
用于让Bot扮演指定角色的聊天插件触发方法如下
- `$角色/$role help/帮助` - 打印目前支持的角色列表。
- `$角色/$role <角色名>` - 让AI扮演该角色角色名支持模糊匹配。
- `$停止扮演` - 停止角色扮演。
添加自定义角色请在`roles/roles.json`中添加。
(大部分prompt来自https://github.com/rockbenben/ChatGPT-Shortcut/blob/main/src/data/users.tsx)
以下为例子
- `title`是角色名。
- `description`是使用`$role`触发的英语prompt。
- `descn`是使用`$角色`触发的中文prompt。
- `wrapper`用于包装你的消息,可以起到强调的作用。
- `remark`简短的描述该角色,在打印帮助时显示。
以下为例子:
```json
{
"title": "写作助理",
@@ -22,3 +18,9 @@
"remark": "最常使用的角色,用于优化文本的语法、清晰度和简洁度,提高可读性。"
}
```
- `title`: 角色名。
- `description`: 使用`$role`触发时使用英语prompt。
- `descn`: 使用`$角色`触发时使用中文prompt。
- `wrapper`: 用于包装用户消息,可起到强调作用,避免回复离题。
- `remark`: 简短描述该角色,在打印帮助文档时显示。