koishi-plugin-mcdle 0.0.7 → 0.1.1

package/lib/view.d.ts

@@ -0,0 +1,69 @@
+/** 把字符画转成内联 SVG。`shape-rendering=crispEdges` 保证像素边缘不被抗锯齿糊掉。 */
+export declare function px(name: string, size?: number, cls?: string): string;
+export type Mode = 'mob' | 'item' | 'block';
+export interface ModeMeta {
+    name: string;
+    icon: string;
+    /** 主色，用于卡片高亮与徽记 */
+    accent: string;
+    /** 该模式下的图片是否为小尺寸像素贴图（决定缩放算法） */
+    pixelArt: boolean;
+    tagline: string;
+    total: number;
+}
+export declare const MODES: Record<Mode, ModeMeta>;
+/** 每种模式下参与比对的字段及其展示顺序（数值在前、标签在后、版本收尾）。 */
+export declare const FIELDS: Record<Mode, string[]>;
+export declare function fieldLabel(key: string): string;
+export declare function fieldIcon(key: string): string;
+/** 把原始字段值翻译成中文展示值，数组字段保留逐项结构以便高亮命中项。 */
+export declare function displayValues(key: string, raw: any): {
+    text: string;
+    raw: string;
+}[];
+export type Status = 'true' | 'mixed' | 'false' | 'false_up' | 'false_down' | 'unknown';
+export declare const STATUS_META: Record<Status, {
+    cls: string;
+    icon: string;
+    label: string;
+    emoji: string;
+}>;
+export declare function statusOf(guess: any, key: string): Status;
+export interface ShellOptions {
+    accent: string;
+    /** 固定卡片宽度；棋盘类卡片省略此项，按列数自适应 */
+    width?: number;
+}
+export declare function esc(s: any): string;
+export interface BoardOptions {
+    mode: Mode;
+    guesses: any[];
+    /** 已锁定字段数 / 总字段数，用于进度条 */
+    tip?: string;
+}
+export declare function boardCard(opts: BoardOptions): string;
+export declare function startCard(mode: Mode, played: number, limit: number): string;
+export interface WinOptions {
+    mode: Mode;
+    answer: any;
+    attempts: number;
+    seconds: number;
+    username: string;
+    total: number;
+    played: number;
+    limit: number;
+}
+/** 把秒数说成人话；秒级以内也要有话说，异常才落到破折号。 */
+export declare function formatDuration(seconds: number): string;
+export declare function winCard(o: WinOptions): string;
+export declare function helpCard(dailyLimit: number, allowRepeat: boolean): string;
+export declare function introCard(dailyLimit: number): string;
+export interface RankEntry {
+    username: string;
+    userId: string;
+    mob: number;
+    item: number;
+    block: number;
+    total: number;
+}
+export declare function rankCard(entries: RankEntry[], shown: number): string;

package/package.json

@@ -1,51 +1,64 @@
-{
-  "name": "koishi-plugin-mcdle",
-  "description": "Koishi 的 Minecraft 猜词游戏插件。根据 Minecraft 物品、生物和方块的属性特征，猜测正确的名称。",
-  "version": "0.0.7",
-  "main": "lib/index.js",
-  "typings": "lib/index.d.ts",
-  "files": [
-    "lib",
-    "dist"
-  ],
-  "koishi": {
-    "service": {
-      "required": [
-        "database"
-      ]
-    }
-  },
-  "license": "MIT OR Apache-2.0",
-  "author": "Nawyjx <3373167460@qq.com>",
-  "contributors": [
-    {
-      "name": "VincentZyu233",
-      "email": "1830540513zyu@gmail.com",
-      "url": "https://github.com/VincentZyu233"
-    }
-  ],
-  "homepage": "https://www.npmjs.com/package/koishi-plugin-mcdle?activeTab=readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/araea/koishi-plugin-mcdle.git"
-  },
-  "keywords": [
-    "koishi",
-    "plugin",
-    "chatbot",
-    "mcdle",
-    "minecraft",
-    "game",
-    "guess",
-    "wordle",
-    "猜词",
-    "游戏",
-    "我的世界",
-    "物品",
-    "生物",
-    "方块"
-  ],
-  "peerDependencies": {
-    "koishi": "^4.18.9"
-  }
-}
+{
+  "name": "koishi-plugin-mcdle",
+  "description": "Koishi 的 Minecraft 猜词游戏插件。根据 Minecraft 物品、生物和方块的属性特征，猜测正确的名称。",
+  "version": "0.1.1",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "LICENSE-APACHE",
+    "LICENSE-MIT"
+  ],
+  "koishi": {
+    "service": {
+      "required": [
+        "database"
+      ],
+      "optional": [
+        "puppeteer"
+      ]
+    }
+  },
+  "license": "MIT OR Apache-2.0",
+  "author": "Nawyjx <3373167460@qq.com>",
+  "contributors": [
+    {
+      "name": "VincentZyu233",
+      "email": "1830540513zyu@gmail.com",
+      "url": "https://github.com/VincentZyu233"
+    }
+  ],
+  "homepage": "https://www.npmjs.com/package/koishi-plugin-mcdle?activeTab=readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/araea/koishi-plugin-mcdle.git"
+  },
+  "keywords": [
+    "koishi",
+    "plugin",
+    "chatbot",
+    "mcdle",
+    "minecraft",
+    "game",
+    "guess",
+    "wordle",
+    "猜词",
+    "游戏",
+    "我的世界",
+    "物品",
+    "生物",
+    "方块"
+  ],
+  "peerDependencies": {
+    "koishi": "^4.18.9",
+    "koishi-plugin-puppeteer": "^3.9.0"
+  },
+  "peerDependenciesMeta": {
+    "koishi-plugin-puppeteer": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "koishi-plugin-puppeteer": "^3.9.0"
+  }
+}

package/readme.md

@@ -25,6 +25,29 @@ Koishi 的 Minecraft 猜词游戏插件。根据 Minecraft 物品、生物和方
 | 🟥⬆️ | 答案更大 |
 | 🟥⬇️ | 答案更小 |
 
+部分匹配的字段里，**被点亮的那几个标签**就是与答案重合的值 —— 图片中高亮显示，
+文本中用 `【】` 括起。
+
+## 指令
+
+| 指令 | 说明 |
+|------|------|
+| `mcdle` | 游戏简介与快速上手 |
+| `mcdle.猜 [名称]` | 开始一局，或提交一次猜测 |
+| `mcdle.猜` | 局中直接使用，回看当前棋盘 |
+| `mcdle.帮助` | 完整玩法说明 |
+| `mcdle.排行榜` | 群内战绩 |
+| `mcdle.词库` | 全部候选词条 |
+
+## 图片
+
+安装 [puppeteer](https://www.npmjs.com/package/koishi-plugin-puppeteer) 服务后，
+棋盘、开局、揭晓与排行榜都会渲染成像素风卡片：内联 SVG 像素图标、我的世界式的
+方块斜角，不依赖任何外部字体或图片资源。
+
+puppeteer 是**可选**依赖。未安装、渲染超时或截图失败时，都会自动回退到等价的
+文本形态，玩法与信息量不受影响；配置项 `disableImages` 可以强制只用文本。
+
 ## 致谢
 
 * [Koishi](https://koishi.chat/)