readme

README.md

-# Koishi Plugin Ygocard
+# koishi-plugin-ygocard
 
-Koishi Plugin for YGOPro card query
\ No newline at end of file
+Koishi.js 上的 YGOPro 卡查插件。
+
+## 安装
+
+### npm
+
+```bash
+npm install koishi-plugin-ygocard
+```
+
+## 配置
+
+下列配置均为可选。
+
+* `commandName`: 命令名称，默认 `card` 。
+
+* `databasePaths`: `string[]` YGOPro 卡片数据库目录，支持多个路径，每个路径可以放置多个 cdb 文件。默认 `["./cdb"]` 。
+
+* `lang`: `cn | en` 种族/属性显示语言。默认 `cn` 。
+
+* `matchCount`: 查询结果的最大数量。默认 `100` 。
+
+* `displayPic`: 是否展示卡图。默认 `true` .
+
+* `picUrl`: 卡图 URL 路径，使用 `{{id}}` 填充卡片密码。例如 `http://example.com/{{id}}.jpg` 。默认使用 [MyCard](https://mycard.moe/) 提供的卡图。