docs: add config reference

package.json

@@ -1,7 +1,7 @@
 {
   "name": "koishi-plugin-novelai",
   "description": "Generate images by NovelAI",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "files": [

readme.md

@@ -14,35 +14,35 @@
 约稿 koishi
 ```
 
-### 更改图片方向
-
-可以用 `-o` 或 `--orient` 更改图片方向，可选值包括：
-
-- `landscape`: 512×768
-- `portrait`: 768×512
-- `square`: 640×640
-
-```
-约稿 -o landscape koishi
-```
-
 ### 切换生成模型
 
 可以用 `-m` 或 `--model` 切换生成模型，可选值包括：
 
-- `safe`: 较安全的图片
-- `nai`: 自由度较高的图片
-- `furry`: 福瑞控特攻
+- `safe`：较安全的图片
+- `nai`：自由度较高的图片 (默认)
+- `furry`：福瑞控特攻
 
 ```
 约稿 -m furry koishi
 ```
 
+### 更改图片方向
+
+可以用 `-o` 或 `--orient` 更改图片方向，可选值包括：
+
+- `portrait`：768×512 (默认)
+- `square`：640×640
+- `landscape`：512×768
+
+```
+约稿 -o landscape koishi
+```
+
 ### 设置采样器
 
 可以用 `-s` 或 `--sampler` 设置采样器，可选值包括：
 
-- `k_euler_ancestral`
+- `k_euler_ancestral` (默认)
 - `k_euler`
 - `k_lms`
 - `plms`
@@ -67,3 +67,54 @@
 ```
 
 你将得到一只缝合怪 (字面意义上)。
+
+## 配置项
+
+### token
+
+- 类型：`string`
+
+授权令牌 (必填)。获取方式如下：
+
+1. 在网页中登录你的 NovelAI 账号
+2. 打开控制台 (F12)，并切换到控制台 (Console) 标签页
+3. 输入下面的代码并按下回车运行
+
+```js
+console.log(JSON.parse(localStorage.session).auth_token)
+```
+
+4. 输出的字符串就是你的授权令牌
+
+### model
+
+- 类型：`'safe' | 'nai' | 'furry'`
+- 默认值：`'nai'`
+
+默认的生成模型。
+
+### orient
+
+- 类型：`'portrait' | 'square' | 'landscape'`
+- 默认值：`'portrait'`
+
+默认的图片方向。
+
+### sampler
+
+- 类型：`'k_euler_ancestral' | 'k_euler' | 'k_lms' | 'plms' | 'ddim'`
+- 默认值：`'k_euler_ancestral'`
+
+### requestTimeout
+
+- 类型：`number`
+- 默认值：`30000`
+
+当请求超过这个时间时会中止并提示超时。
+
+### recallTimeout
+
+- 类型：`number`
+- 默认值：`0`
+
+图片发送后自动撤回的时间 (设置为 `0` 禁用此功能)。

src/index.ts

@@ -43,8 +43,8 @@ export const Config: Schema<Config> = Schema.object({
   sampler: Schema.union(samplers).description('默认的采样器。').default('k_euler_ancestral'),
   forbidden: Schema.array(String).description('全局违禁词列表。'),
   requestTimeout: Schema.number().role('time').description('当请求超过这个时间时会中止并提示超时。').default(Time.minute * 0.5),
-  recallTimeout: Schema.number().role('time').description('图片发送后自动撤回的时间 (设置为 0 禁用此功能)。').default(0),
-  maxConcurrency: Schema.number().description('单个频道下的最大并发数量 (设置为 0 禁用此功能)。').default(0),
+  recallTimeout: Schema.number().role('time').description('图片发送后自动撤回的时间 (设置为 0 以禁用此功能)。').default(0),
+  maxConcurrency: Schema.number().description('单个频道下的最大并发数量 (设置为 0 以禁用此功能)。').default(0),
 })
 
 const UNDESIRED = 'nsfw, lowres, text, cropped, worst quality, low quality, normal quality, jpeg artifacts, signature, watermark, username, blurry'