README.md

August 21, 2026 · View on GitHub

zmd-plugin（TRSS-Yunzai）

适用于 TRSS-Yunzai 的终末地（Endfield）/ 森空岛（Skland）插件。
提供登录绑定、每日查询、卡片 / 面板、基建、公告、活动日历 / 提醒、抽卡记录、Wiki 图鉴，以及 #fz 明日方舟功能。

项目	说明
主命令前缀	`#zmd` / `#终末地`
方舟命令前缀	`#fz`
配置文件	`config/zmd-plugin.yaml`
反馈 / 交流群	`1084459856`（指令：`#反馈`）
Issue 提交	GitHub Issues

快速导航

点击下方分组可直接跳转到对应章节或小节。

开始使用功能概览快速开始首次使用示例安装安装前确认 Git 安装手动安装	数据与配置角色数据接口数据源说明切换数据源配置统一后端配置本地接口配置说明
命令与功能指令速查账号查询终末地抽卡记录方舟功能（#fz） Wiki 图鉴	说明与排障数据与隐私存储说明本地目录常见问题问题反馈 / Issue 依赖缺失统一后端 401
补充内容终末地能力明日方舟能力辅助能力公告签到 / 其他免责声明	仓库信息仓库与参考仓库参考项目 GitHub 仓库 Star 页面 Release 页面

功能概览

终末地能力

账号：私聊扫码登录（可由主人开启群聊扫码）/ 手动绑定 cred 或 token / 仅绑定 UID（面板查询）
查询：每日、卡片、面板、基建 / 飞船、公告、活动日历
抽卡记录：更新 / 全量更新 / 查看 / 导入 / 导出 / 删除
活动提醒：订阅 / 取消订阅 / 查看当前会话提醒状态
图鉴：角色列表、武器列表、卡池、角色 / 武器图鉴、技能 / 天赋 / 潜能分项查询

明日方舟能力（`#fz`）

森空岛签到 / 全部签到 / 自动签到
活动速览：查看进行中、即将结束、即将开启的活动
抽卡记录工具链：更新、全量更新、导入、导出、删除、查看
抽卡记录按具体卡池分开展示，并保留限定 / 常驻 / 中坚的类型标识
抽卡分析：整体统计与指定卡池统计

辅助能力

统一后端 / 本地 Friend API 切换
公告订阅与定时推送
状态统计、更新日志、环境诊断

返回导航

快速开始

如果你只想最快跑起来，按下面顺序即可：

安装插件并补齐依赖
重启机器人
私聊执行 #zmd登录 绑定账号
执行 #zmd刷新 同步卡片数据
开始使用常用命令：
- #zmd每日
- #zmd卡片
- #管理员面板
- #zmd抽卡记录
查看完整帮助：#zmd帮助

新手建议：

第一次绑定账号请优先使用私聊：#zmd登录
只想查面板、不想登录时，可直接绑定 UID：#zmd绑定<UID>
想查更完整的 UID-only 面板数据，再继续看 角色数据接口 一节

首次使用示例

方案一：正常登录后使用（推荐）

先私聊机器人：

#zmd登录

绑定完成后再使用：

#zmd刷新
#zmd每日
#zmd卡片
#管理员面板
#zmd抽卡记录

方案二：只想查面板，不登录

#zmd绑定123456789
#管理员面板

说明：这种方式适合临时查面板，但是否能查到目标角色，取决于 Friend API 是否返回该 UID 的展示位角色。

方案三：使用明日方舟功能（`#fz`）

#fz 复用森空岛绑定，不需要单独再绑一次：

#fz签到
#fz更新抽卡记录
#fz抽卡记录

返回导航

安装

安装前确认

开始前建议确认下面几项：

你已经有可正常运行的 TRSS-Yunzai
Redis 已正常连接，否则账号绑定和部分缓存功能会异常
环境里能使用 Node.js 与 pnpm
如果你只使用基础功能，先不配置 Friend API 也可以启动
如果你要查更完整的 UID-only 面板，后面再补统一后端 / 本地 API 配置

方式一：Git 安装（推荐）

在 TRSS-Yunzai 根目录执行：

git clone https://github.com/Anon-deisu/zmd-plugin plugins/zmd-plugin

后续更新：

cd plugins/zmd-plugin
git pull

如果你是机器人主人，也可以直接在机器人内更新：

#zmd更新插件
#zmd强制更新插件

方式二：手动安装

下载 / 解压本仓库到 TRSS-Yunzai/plugins/ 下
建议插件目录名使用：zmd-plugin
在 TRSS-Yunzai 根目录安装依赖：

pnpm add qrcode node-fetch yaml puppeteer

重启机器人

返回导航

角色数据接口（统一后端 / 本地）

面板中的这些详细数据依赖角色数据接口：

生命 / 攻击 / 防御 / 暴击
装备词条
武器基质词条
UID-only 面板补完数据

不配置 API 会怎样？

已登录账号：仍可使用基础卡片 / 面板能力
仅绑定 UID 的账号：面板功能可能不可用或信息不完整
Friend API 通常只返回名片展示位角色，因此 UID-only 面板也可能只能查到展示位角色

当前支持的数据源

统一后端（默认）：通过统一后端提供的 /api/friend/* 接口获取
本地接口：通过本地部署的 Friend API 获取，例如 http://127.0.0.1:18080
统一后端官网登录 / 获取凭证：https://end.shallow.ink/

查看 / 切换数据源

查看当前配置：#数据源
以下切换命令需要机器人主人权限：
- #数据源切换
- #数据源切换本地
- #数据源切换统一后端
- #数据源切换自动

配置统一后端

操作	命令
设置地址	`#统一后端地址 <url>`
设置 Bearer	`#统一后端token <token>`
设置 API Key	`#统一后端apikey <key>`
设置 Framework Token	`#统一后端frameworktoken <token>`
设置匿名令牌	`#统一后端匿名token <token>`

补充说明：

默认地址：https://end-api.shallow.ink
建议在私聊中设置鉴权信息，避免敏感内容出现在群聊记录里
#统一后端token 会自动识别部分前缀：
- ef_... 可能按 API Key 处理
- qr_... 可能按 Framework Token 处理
为减少歧义，推荐优先使用明确命令：#统一后端apikey / #统一后端frameworktoken

配置示例：

friendApi:
  source: auto
  unifiedBaseUrl: "https://end-api.shallow.ink"
  # 以下鉴权任选其一：
  # unifiedBearer: "your_bearer"
  unifiedApiKey: "ef_xxx"
  # unifiedFrameworkToken: "qr_xxx"
  # unifiedAnonymousToken: "your_anon_token"

配置本地接口

操作	命令
设置地址	`#本地数据地址 <url>`
设置 Bearer	`#本地数据token <token>`

配置示例：

friendApi:
  source: local
  baseUrl: "http://127.0.0.1:18080"
  bearer: "your_token"

返回导航

指令速查

默认前缀：#zmd

账号

#zmd登录：扫码登录，默认仅私聊；主人开启群聊扫码后，扫码提示、二维码和登录结果发送到触发命令的群聊
#zmd绑定<cred|token>：手动绑定账号，仅私聊
#zmd群聊扫码登录开启/关闭：允许或禁止群聊发送扫码二维码，仅机器人主人可用（也支持 #zmd开启群聊扫码登录 / #zmd关闭群聊扫码登录）
#zmd绑定<UID>：无需登录，仅用于角色面板查询
#zmd查看：查看已绑定账号
#zmd切换<序号|UID>：切换当前活跃账号
#zmd删除<序号|UID>：删除绑定账号

查询

#zmd每日<@用户>
#zmd刷新
#zmd卡片<@用户>
#<角色>面板<@用户>：推荐用法，例如 #管理员面板
#zmd面板<角色>：兼容旧用法
#zmd基建<@用户>
#zmd日历 / #zmd活动日历 / #zmd活动

终末地抽卡记录

更新：#zmd更新抽卡记录<UID/@他人>
全量：#zmd全量更新抽卡记录<UID/@他人>
查看：#zmd抽卡记录<UID/@他人>
角色池：#zmd角色记录<UID/@他人>
武器池：#zmd武器记录<UID/@他人>
导入：#zmd导入抽卡记录<u8_token/链接/JSON文件>
导出：#zmd导出抽卡记录
删除：#zmd删除抽卡记录
图标补全：#zmd更新武器图标<UID>（可加 强制；全部 模式仅机器人主人可用）

公告

#zmd公告<id>：不填 id 时显示列表
#zmd订阅公告
#zmd取消订阅公告
#zmd订阅活动提醒<小时>：群聊 / 私聊订阅活动开始与结束提醒，小时数可选
#zmd取消订阅活动提醒
#zmd活动提醒列表
#zmd清理公告缓存：仅清理内存缓存，不影响订阅 / 已读；需机器人主人权限

Wiki 图鉴

#zmd角色列表
#zmd武器列表
#zmd卡池
#zmd<名称>图鉴
#zmd<名称>介绍
#zmd<名称>技能
#zmd<名称>天赋
#zmd<名称>潜能
#zmd<名称>专武
#zmd<名称>武器

签到 / 其他

#zmd签到
#zmd开启自动签到 / #zmd关闭自动签到
#zmd全部签到（仅机器人主人）
#zmd状态
#zmd更新日志
#zmd环境
#zmd更新插件（仅机器人主人）
#zmd强制更新插件（仅机器人主人）
#反馈

明日方舟（`#fz`）

说明：复用本插件的森空岛绑定（#zmd登录 / #zmd绑定），命令前缀固定为 #fz。

#fz签到
#fz活动
#fz全部签到（仅机器人主人）
#fz开启自动签到 / #fz关闭自动签到
#fz更新抽卡记录 / #fz更新抽卡记录 @用户
#fz全量更新抽卡记录 / #fz全量更新抽卡记录 @用户
#fz抽卡记录 / #fz抽卡记录 @用户
#fz抽卡分析 / #fz抽卡分析 @用户
#fz卡池分析 <卡池名> / #fz卡池分析 <卡池名> @用户
#fz导入抽卡记录：发送 JSON 文件 / 粘贴 JSON / 文件链接
#fz导出抽卡记录
#fz删除抽卡记录

返回导航

配置说明

首次加载后会自动生成：config/zmd-plugin.yaml

如果你只是日常使用，大多数配置保持默认即可；只有在需要切换数据源、配置统一后端或调整定时任务时，才需要手动修改。

配置项	说明
`cmd.prefix`	仅用于帮助提示，不参与命令正则匹配
`card.cacheSec` / `card.staleCacheSec`	卡片详情缓存
`friendApi.source`	`auto / local / unified`
`friendApi.baseUrl` / `friendApi.bearer`	本地 API 配置
`friendApi.anonymousToken` / `friendApi.apiKey` / `friendApi.frameworkToken`	本地 API 其他鉴权（可选）
`friendApi.unifiedBaseUrl`	统一后端地址
`friendApi.unifiedBearer` / `friendApi.unifiedApiKey` / `friendApi.unifiedFrameworkToken` / `friendApi.unifiedAnonymousToken`	统一后端鉴权（可选）
`activity.enableTask` / `activity.cron` / `activity.listDays` / `activity.remindBeforeHours`	终末地活动日历与提醒配置
`autoSign.*`	终末地自动签到任务配置
`fz.autoSign.*`	明日方舟自动签到任务配置
`security.allowQrLoginInGroup`	是否允许群聊发起扫码登录，默认关闭；建议通过 `#zmd群聊扫码登录开启/关闭` 设置

修改配置后建议重启机器人。

返回导航

数据与隐私

存储说明

账号绑定信息主要存储在 Redis
本插件运行时会写入缓存 / 临时文件，用于加速、容错和渲染
删除这些缓存后，后续使用时会自动重新生成

本地目录

路径	用途
`data/zmd-plugin/gachalog/`	终末地抽卡记录缓存 JSON
`data/zmd-plugin/fz/gachalog/`	明日方舟抽卡记录缓存 JSON
`data/zmd-plugin/wiki/`	Wiki 列表 / 页面缓存
`data/zmd-plugin/card/`	卡片详情持久化缓存
`data/zmd-plugin/friendApi/`	Friend API 的 roleId / detail / computed 缓存
`temp/zmd-plugin/`	二维码等临时文件
`plugins/zmd-plugin/resources/endfield/itemiconbig/`	武器图标缓存
`plugins/zmd-plugin/resources/endfield/charicon/`	角色图标缓存

返回导航

常见问题

1. 提示缺少依赖 `qrcode` / `node-fetch` / `yaml` / `puppeteer`

在 TRSS-Yunzai 根目录执行：

pnpm add qrcode node-fetch yaml puppeteer

然后重启机器人。

2. `#<角色>面板` 与其他插件冲突

仍可使用旧用法：#zmd面板<角色>。

3. UID-only 绑定后查不到想看的角色

Friend API 通常只提供“名片展示位”角色列表。请先把目标角色放到名片展示位，再查询面板。

4. 统一后端提示 401 / 无法获取数据

统一后端可能要求不同鉴权方式：Bearer / API Key / Framework Token / 匿名令牌
推荐按后端要求分别设置：
- #统一后端apikey <key>
- #统一后端frameworktoken <token>
- #统一后端token <token>

返回导航

问题反馈与 Issue

如果你在使用中遇到问题，建议优先选择下面两种方式：

使用 GitHub Issues 提交可复现的问题：https://github.com/Anon-deisu/zmd-plugin/issues
进入交流群沟通使用问题：1084459856

提交 Issue 前，建议先确认

已更新到较新的插件版本
已阅读上面的 快速开始、角色数据接口 和 常见问题
能说明问题是在私聊、群聊，还是某个特定命令下触发
如果问题与面板有关，最好说明是否配置了统一后端 / 本地 API

提交 Issue 时，建议附上这些信息

使用的命令，例如：#zmd卡片、#管理员面板、#fz抽卡记录
你期待的结果，以及实际发生了什么
报错日志、控制台输出或截图
复现步骤：别人怎样操作才能复现同样的问题
运行环境：TRSS-Yunzai 版本、Node.js 版本、系统环境

请不要直接公开发出的敏感信息

cred
token
apikey
frameworktoken
anonymous token
含敏感字段的完整配置文件或后台日志

如果你不确定某段日志能不能公开，建议先打码再发，或先到交流群确认。

返回导航

免责声明

本项目为非官方项目，与鹰角网络（Hypergryph）及其旗下组织 / 团体 / 工作室没有任何关联。游戏图片与数据版权归各自权利人所有。

本插件按“现状”提供，不保证可用性、稳定性或数据准确性；使用过程中造成的任何数据损失、功能异常或经济损失均由用户自行承担。

返回导航

仓库与参考

仓库

主仓库：https://github.com/Anon-deisu/zmd-plugin

参考项目

EndUID：https://github.com/Loping151/EndUID
BeyondUID：https://github.com/baiqwerdvd/BeyondUID/tree/master
miao-plugin：https://github.com/yoimiya-kokomi/miao-plugin
endfield-plugin：https://github.com/Entropy-Increase-Team/endfield-plugin
arknights-plugin：https://github.com/gxy12345/arknights-plugin
biligame wiki：https://wiki.biligame.com/zmd/

如果你准备二次分发或基于本项目继续修改发布，请先确认相关上游项目的许可证要求。

返回导航

开始使用功能概览快速开始首次使用示例安装安装前确认 Git 安装手动安装	数据与配置角色数据接口数据源说明切换数据源配置统一后端配置本地接口配置说明
命令与功能指令速查账号查询终末地抽卡记录方舟功能（#fz） Wiki 图鉴	说明与排障数据与隐私存储说明本地目录常见问题问题反馈 / Issue 依赖缺失统一后端 401
补充内容终末地能力明日方舟能力辅助能力公告签到 / 其他免责声明	仓库信息仓库与参考仓库参考项目 GitHub 仓库 Star 页面 Release 页面