koishi-plugin-ciyi 1.1.2 → 1.2.2

package/lib/render.d.ts

@@ -0,0 +1,7 @@
+import type CanvasService from "@koishijs/canvas";
+import { BoardOptions, IntroOptions, RankOptions, StartOptions, WinOptions } from "./view";
+export declare function renderBoardCard(service: CanvasService, opts: BoardOptions): Promise<Buffer>;
+export declare function renderIntroCard(service: CanvasService, opts: IntroOptions): Promise<Buffer>;
+export declare function renderStartCard(service: CanvasService, opts: StartOptions): Promise<Buffer>;
+export declare function renderWinCard(service: CanvasService, opts: WinOptions): Promise<Buffer>;
+export declare function renderRankCard(service: CanvasService, opts: RankOptions): Promise<Buffer>;

package/lib/view.d.ts

@@ -13,54 +13,37 @@ export interface Tier {
 }
 export declare const TIERS: Tier[];
 export declare function tierOf(rank: number): Tier;
-/**
- * 排名 → 亲近度百分比。
- *
- * 榜单是幂律分布的：#1 与 #50 的差别，远大于 #20000 与 #30000 的差别。
- * 所以取对数刻度，否则前一千名会全部挤在进度条最左端的一根头发丝里。
- */
+/** 排名 → 亲近度百分比（对数刻度，适配幂律分布的榜单）。 */
 export declare function nearness(rank: number, total: number): number;
-export declare function esc(s: any): string;
 export interface BoardRow {
     history: History;
-    /** 本次刚提交的那一条，单独点亮 */
     fresh?: boolean;
-    /** 这一行之前被截断了多少条 */
     gapBefore?: number;
 }
 export interface BoardOptions {
     rows: BoardRow[];
-    /** 榜单总词数，用于换算亲近度 */
     total: number;
-    /** 本局累计猜了多少词（不受截断影响） */
     attempts: number;
     tip: string;
 }
-export declare function boardCard(opts: BoardOptions): string;
 export interface StartOptions {
     total: number;
     words: number;
-    /** 题库里还剩多少道没出过 */
     left: number;
 }
-export declare function startCard(opts: StartOptions): string;
 export interface IntroOptions {
     total: number;
     words: number;
     middleware: boolean;
 }
-export declare function introCard(opts: IntroOptions): string;
 export interface WinOptions {
     answer: string;
     attempts: number;
-    /** 猜中之前最接近的一次排名；首猜即中时为空 */
     closest: number | null;
-    /** 榜单上紧挨着答案的几个词，封题后一并奉上 */
     neighbors: string[];
     username: string;
     score: number;
 }
-export declare function winCard(opts: WinOptions): string;
 export interface RankEntry {
     username: string;
     score: number;
@@ -69,7 +52,5 @@ export interface RankEntry {
 export interface RankOptions {
     entries: RankEntry[];
     hidden: number;
-    /** 上榜总人数 */
     players: number;
 }
-export declare function rankCard(opts: RankOptions): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koishi-plugin-ciyi",
   "description": "Koishi 的词意（猜词游戏）插件。根据词语的含义相似程度，猜测正确的词语。",
-  "version": "1.1.2",
+  "version": "1.2.2",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "files": [
@@ -15,7 +15,7 @@
         "database"
       ],
       "optional": [
-        "puppeteer"
+        "canvas"
       ]
     }
   },
@@ -40,6 +40,9 @@
     "词影",
     "词意"
   ],
+  "dependencies": {
+    "@koishijs/canvas": "^0.2.0"
+  },
   "peerDependencies": {
     "koishi": "^4.18.9",
     "koishi-plugin-puppeteer": "^3.9.0"
@@ -48,8 +51,5 @@
     "koishi-plugin-puppeteer": {
       "optional": true
     }
-  },
-  "devDependencies": {
-    "koishi-plugin-puppeteer": "^3.9.0"
   }
 }

package/readme.md

@@ -23,22 +23,27 @@ Koishi 的词意（猜词游戏）插件。根据词语的含义相似程度，
 
 ## 图片
 
-安装 `puppeteer` 服务后，玩法、开局、猜测板、揭晓与排行榜都会渲染成「墨与纸」
-风格的卡片：宣纸底、古籍双线框、朱砂印，每个字住在自己的田字格里，隐去的字
-只留空格与虚线中缝。猜测按名次由近及远排列，配六档亲疏色阶 ——
-咫尺 / 毗邻 / 相近 / 沾边 / 疏远 / 天涯。
+启用 Koishi Canvas 服务后渲染「墨与纸」风格卡片：宣纸底、古籍双线框、
+朱砂印，每个字住在自己的田字格里，隐去的字只留空格与虚线中缝。猜测按名次由近及远
+排列，配六档亲疏色阶 —— 咫尺 / 毗邻 / 相近 / 沾边 / 疏远 / 天涯。
 
-未安装、渲染失败或在配置里关掉「渲染图片」时，自动回退为排版等价的文本，
+插件复用 Koishi 的通用 `canvas` 服务。`koishi-plugin-puppeteer` 已经自带服务实现，原本启用了
+Puppeteer 的用户无需再安装 `@napi-rs/canvas` 或其他大型原生依赖。
+
+没有 Canvas 服务、渲染失败或在配置里关掉「渲染图片」时，自动回退为排版等价的文本，
 玩法不受影响。
 
+如果需要图片但尚未启用服务，可安装并启用 `koishi-plugin-puppeteer`；它是可选依赖，不会随
+词意插件强制下载。只使用文本玩法时无需安装任何绘图后端。
+
 ## 致谢
 
-* [Koishi](https://koishi.chat/)
-* [词影](https://cy.surprising.studio/)
+- [Koishi](https://koishi.chat/)
+- [词影](https://cy.surprising.studio/)
 
 ## QQ 群
 
-* 956758505
+- 956758505
 
 <br>