mirror of
https://github.com/koishijs/novelai-bot
synced 2025-01-05 11:36:44 +08:00
docs: removed deprecated pages
This commit is contained in:
Shigma
parent
e32eb9a8ee
commit
4ef4e487b6
1
.gitignore
vendored
1
.gitignore
vendored
@ -1,5 +1,6 @@
|
||||
lib
|
||||
dist
|
||||
cache
|
||||
|
||||
node_modules
|
||||
npm-debug.log
|
||||
|
||||
@ -7,7 +7,7 @@ export default defineConfig({
|
||||
|
||||
head: [
|
||||
['link', { rel: 'icon', href: 'https://koishi.chat/logo.png' }],
|
||||
['link', { rel: 'manifest', href: 'https://koishi.chat/manifest.json' }],
|
||||
['link', { rel: 'manifest', href: '/manifest.json' }],
|
||||
['meta', { name: 'theme-color', content: '#5546a3' }],
|
||||
],
|
||||
|
||||
@ -41,15 +41,6 @@ export default defineConfig({
|
||||
{ text: '配置项', link: '/config' },
|
||||
{ text: '更多资源', link: '/more' },
|
||||
],
|
||||
}, {
|
||||
text: '进阶',
|
||||
items: [
|
||||
{ text: '配置文件', link: '/advanced/config' },
|
||||
{ text: '指令设置', link: '/advanced/command' },
|
||||
{ text: '上下文过滤', link: '/advanced/filter' },
|
||||
{ text: '自定义回复', link: '/advanced/i18n' },
|
||||
{ text: '部署到公网', link: '/advanced/server' },
|
||||
],
|
||||
}, {
|
||||
text: 'FAQ',
|
||||
items: [
|
||||
|
||||
@ -1,55 +0,0 @@
|
||||
# 指令设置
|
||||
|
||||
打开[配置文件](./config.md)，在 `group:basic` 下找到名为 `commands` 的插件，这也是本节要介绍的主题。你可以在这个插件中设置指令的各项参数，包括指令的可见性、权限管理、速率限制等等。
|
||||
|
||||
## 可见性
|
||||
|
||||
`hidden` 属性用于控制指令的可见性。当设置为 `true` 时，指令将不会在帮助菜单中显示 (但仍然可以被正常调用)。
|
||||
|
||||
```yaml {4}
|
||||
plugins:
|
||||
commands:
|
||||
novelai:
|
||||
hidden: true
|
||||
```
|
||||
|
||||
## 权限管理
|
||||
|
||||
::: tip
|
||||
此功能需要数据库支持。请先自行安装任意数据库插件。
|
||||
:::
|
||||
|
||||
`authority` 属性用于设置指令的调用权限。默认情况下，所有人的权限等级都是 1，而指令的调用权限也是 1。你可以将某个用户的权限等级设置为 0 以限制其对绝大部分功能的访问。你也可以将某个指令的权限等级设置为 2 以限制能够调用该指令的用户。
|
||||
|
||||
```yaml {4}
|
||||
plugins:
|
||||
commands:
|
||||
novelai:
|
||||
authority: 2
|
||||
```
|
||||
|
||||
要修改用户的权限等级，你需要配合 admin 插件使用：
|
||||
|
||||
```text
|
||||
auth 2 -u @user
|
||||
```
|
||||
|
||||
这样就修改了目标用户的权限等级为 2。
|
||||
|
||||
## 速率控制
|
||||
|
||||
::: tip
|
||||
此功能需要数据库支持。请先自行安装任意数据库插件。
|
||||
:::
|
||||
|
||||
`maxUsage` 和 `minInterval` 属性用于控制指令的调用速率。当指令被调用时，如果当天内调用次数超过 `maxUsage` 或调用间隔小于 `minInterval`，则会拒绝执行并输出一条提示信息。
|
||||
|
||||
```yaml {4-7}
|
||||
plugins:
|
||||
commands:
|
||||
novelai:
|
||||
# 每人每天只能调用 100 次
|
||||
maxUsage: 100
|
||||
# 每人每 60 秒只能调用 1 次
|
||||
minInterval: 60000
|
||||
```
|
||||
@ -1,55 +0,0 @@
|
||||
# 配置文件
|
||||
|
||||
每个 Koishi 应用都有一个配置文件，它管理了应用及其插件的全部配置。配置文件的格式为 [YAML](https://en.wikipedia.org/wiki/YAML)，它是一种易于阅读和编辑的文本格式，你可以用任何文本编辑器打开。
|
||||
|
||||
::: tip
|
||||
如果你不了解 YAML 的语法，请不要随意修改配置文件，否则将可能导致 Koishi 应用无法运行。你可以在[这篇教程](https://www.runoob.com/w3cnote/yaml-intro.html)中学习 YAML 的语法。
|
||||
:::
|
||||
|
||||
## 根目录位置
|
||||
|
||||
配置文件所在的目录叫**根目录**。根据你的安装方式，根目录的位置可能不同：
|
||||
|
||||
- zip: 解压目录下 `data/instances/default`
|
||||
- msi: `C:/Users/你的用户名/AppData/Roaming/Koishi/Desktop/data/instances/default`
|
||||
- pkg: `~/Library/Application Support/Koishi/Desktop/data/instances/default`
|
||||
|
||||
配置文件是根目录下名为 `koishi.yml` 的文件。当你遇到问题时，开发者可能会要求你提供配置文件的内容。此时去上面的地方找就好了。
|
||||
|
||||
## 理解配置文件
|
||||
|
||||
尝试打开配置文件，你会发现它的内容大致如下：
|
||||
|
||||
```yaml
|
||||
# 全局设置
|
||||
host: localhost
|
||||
port: 5140
|
||||
|
||||
# 插件列表
|
||||
plugins:
|
||||
# group 表示这是一个插件组
|
||||
group:basic:
|
||||
help:
|
||||
rate-limit:
|
||||
locales:
|
||||
commands:
|
||||
|
||||
# 这是另一个插件组
|
||||
group:adapter:
|
||||
# 波浪线前缀表示一个不启用的插件
|
||||
~adapter-onebot:
|
||||
~adapter-discord:
|
||||
~adapter-telegram:
|
||||
gocqhttp:
|
||||
|
||||
# 你刚刚安装的 NovelAI 插件
|
||||
novelai:
|
||||
```
|
||||
|
||||
你会发现，配置文件的结构与「插件配置」页面基本是一致的。当你启动 Koishi 应用时，Koishi 会读取上述配置文件并加载所需的插件；而当你在「插件配置」页面中修改了某些配置，Koishi 也会自动将这些改动写入配置文件。
|
||||
|
||||
绝大多数的功能都可以通过「插件配置」页面来完成，但目前尚有一些功能没有做好相应的交互界面，这时你就需要手动修改配置文件了。你需要做的有以下几步：
|
||||
|
||||
1. 关闭当前 Koishi 应用
|
||||
2. 打开配置文件进行编辑
|
||||
3. 保存配置文件后再次启动 Koishi 应用
|
||||
@ -1 +0,0 @@
|
||||
# 上下文过滤
|
||||
@ -1,64 +0,0 @@
|
||||
# 自定义回复
|
||||
|
||||
::: tip
|
||||
此功能需要 locales 插件，请先在插件市场中安装并启用。
|
||||
:::
|
||||
|
||||
## 修改回复内容
|
||||
|
||||
在 `locales` 插件的配置中可以看到 `root` 选项，这是存放自定义语言包的根目录。默认值为 `locales`，也就是在你的 Koishi [根目录](./config.md#根目录位置)下的 `locales` 文件夹。
|
||||
|
||||
打开该文件夹，这里空空如也。新建一个 `zh.yml` 文件，复制以下内容到文件中。
|
||||
|
||||
```yaml
|
||||
commands:
|
||||
novelai:
|
||||
messages:
|
||||
expect-prompt: 请输入标签。
|
||||
expect-image: 请输入图片。
|
||||
invalid-input: 只接受英文输入。
|
||||
forbidden-word: 输入含有违禁词。
|
||||
concurrent-jobs: 请稍后再试。
|
||||
waiting: 在画了在画了
|
||||
nickname: AI 画师
|
||||
invalid-size: 增强功能仅适用于被生成的图片。普通的 img2img 请直接使用「约稿」而不是「增强」。
|
||||
unknown-error: 发生未知错误。
|
||||
response-error: 发生未知错误 ({0})。
|
||||
invalid-password: 邮箱或密码错误。
|
||||
invalid-token: 令牌无效或已过期，请联系管理员。
|
||||
unauthorized: 令牌未授权，可能需要续费，请联系管理员。
|
||||
```
|
||||
|
||||
之后修改 `message` 字段下的回复，就可以自定义 NovelAI 的回复内容啦。对于其他的插件你也可以用同样方法操作。
|
||||
|
||||
## 多语言支持
|
||||
|
||||
使用类似的方法，我们也可以在 `locales` 文件夹下新建 `en.yml` 文件，并自定义英文回复。
|
||||
|
||||
```yaml
|
||||
commands:
|
||||
novelai:
|
||||
messages:
|
||||
expect-prompt: Please input a prompt.
|
||||
# add more translations here
|
||||
```
|
||||
|
||||
### 更改默认语言
|
||||
|
||||
你可以在全局设置中修改 `locale` 以更改默认语言。其默认值为 `zh`。当切换语言后，机器人的所有回复也会相应地转换为对应语言 (如果翻译存在)。
|
||||
|
||||
### 切换用户语言
|
||||
|
||||
安装 admin 插件后，任何用户都可以使用 `user.locale` 指令来切换语言。
|
||||
|
||||
```text
|
||||
user.locale en
|
||||
```
|
||||
|
||||
具有权限的管理员可以使用 `channel.locale` 指令来切换频道语言。这在 Discord 等存在群组-频道二级结构的平台上非常有用。
|
||||
|
||||
```text
|
||||
channel.locale en
|
||||
```
|
||||
|
||||
Koishi 的渲染优先级为频道语言 > 用户语言 > 默认语言。
|
||||
@ -1,10 +0,0 @@
|
||||
# 部署到公网
|
||||
|
||||
## 修改网络设置
|
||||
|
||||
- host
|
||||
- selfUrl
|
||||
|
||||
## 设置访问权限
|
||||
|
||||
auth 插件
|
||||
16
docs/public/manifest.json
Normal file
16
docs/public/manifest.json
Normal file
@ -0,0 +1,16 @@
|
||||
{
|
||||
"name": "NovelAI Bot",
|
||||
"short_name": "NovelAI Bot",
|
||||
"description": "基于 NovelAI 的画图机器人",
|
||||
"start_url": "/",
|
||||
"display": "standalone",
|
||||
"background_color": "#ffffff",
|
||||
"theme_color": "#5546a3",
|
||||
"icons": [
|
||||
{
|
||||
"src": "https://koishi.chat/logo.png",
|
||||
"sizes": "384x384",
|
||||
"type": "image/png"
|
||||
}
|
||||
]
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user