docs: update config docs

This commit is contained in:
Shigma 2022-11-14 02:05:54 +08:00
parent 093f29690a
commit ad8485ca51
4 changed files with 37 additions and 16 deletions

View File

@ -12,7 +12,7 @@ jobs:
- name: Check out
uses: actions/checkout@v3
- name: Setup Node
uses: actions/setup-node@v2
uses: actions/setup-node@v3
with:
node-version: 16
- name: Install

View File

@ -6,8 +6,8 @@ export default defineConfig({
description: '基于 NovelAI 的画图机器人',
head: [
['link', { rel: 'icon', href: '/logo.png' }],
['link', { rel: 'manifest', href: '/manifest.json' }],
['link', { rel: 'icon', href: 'https://koishi.chat/logo.png' }],
['link', { rel: 'manifest', href: 'https://koishi.chat/manifest.json' }],
['meta', { name: 'theme-color', content: '#5546a3' }],
],

View File

@ -129,15 +129,34 @@ API 服务器地址。如果你搭建了私服,可以将此项设置为你的
`before` 模式下,用户仍然可以通过 `-O, --override` 选项手动忽略默认标签;而在 `after` 模式下,用户仍然可以通过将基础标签写在前面的方式手动提高基础标签的优先级。
### translator
- 类型:`boolean`
- 默认值:`true`
是否启用自动翻译。安装任意 [翻译插件](https://translator.koishi.chat) 后即可自动将用户输入转换为英文。
### latinOnly
- 类型:`boolean`
- 默认值:`false`
是否只接受英文单词。启用后将对于非拉丁字母的输入进行错误提示。
::: tip
[自动翻译](#translator) 会转化用户输入,因此不建议与此选项同时启用。
:::
### maxWords
- 类型:`number`
- 默认值:`0`
用户输入的最大词数 (设置为 `0` 时无限制)。
用户输入的最大词数 (设置为 `0` 时无限制)。下面是一些细节设定:
- 这个配置项限制的是词数而不是标签数或字符数 (`girl, pleated skirt` 的词数为 3)
- 正向标签和反向标签分别计数,每种均不能超出此限制,但总词数可以达到限制的两倍
- 如果开启了 [自动翻译](#translator),此限制将作用于翻译后的结果
- 默认附加的正向和反向标签均不计入此限制
## 高级设置

View File

@ -85,6 +85,19 @@ export interface PromptConfig {
maxWords?: number
}
export const PromptConfig: Schema<PromptConfig> = Schema.object({
basePrompt: Schema.string().role('textarea').description('默认附加的标签。').default('masterpiece, best quality'),
negativePrompt: Schema.string().role('textarea').description('默认附加的反向标签。').default(ucPreset),
forbidden: Schema.string().role('textarea').description('违禁词列表。含有违禁词的请求将被拒绝。').default(''),
placement: Schema.union([
Schema.const('before' as const).description('置于最前'),
Schema.const('after' as const).description('置于最后'),
]).description('默认附加标签的位置。').default('after'),
translator: Schema.boolean().description('是否启用自动翻译。').default(true),
latinOnly: Schema.boolean().description('是否只接受英文输入。').default(false),
maxWords: Schema.natural().description('允许的最大单词数量。').default(0),
}).description('输入设置')
export interface Config extends PromptConfig {
type: 'token' | 'login' | 'naifu' | 'sd-webui'
token?: string
@ -176,18 +189,7 @@ export const Config = Schema.intersect([
maxResolution: Schema.natural().description('生成图片的最大尺寸。').default(0),
}),
Schema.object({
basePrompt: Schema.string().role('textarea').description('默认附加的标签。').default('masterpiece, best quality'),
negativePrompt: Schema.string().role('textarea').description('默认附加的反向标签。').default(ucPreset),
forbidden: Schema.string().role('textarea').description('违禁词列表。含有违禁词的请求将被拒绝。').default(''),
placement: Schema.union([
Schema.const('before' as const).description('置于最前'),
Schema.const('after' as const).description('置于最后'),
]).description('默认附加标签的位置。').default('after'),
translator: Schema.boolean().description('是否启用标签翻译。').default(true),
latinOnly: Schema.boolean().description('是否只接受英文输入。').default(false),
maxWords: Schema.natural().description('允许的最大单词数量。').default(0),
}).description('输入设置'),
PromptConfig,
Schema.object({
output: Schema.union([