Home

Plugins

Document

PCH System

材料协作收集与项目进度管理，联动 Web 后台

tool
information

Installation command

!!MCDR plugin install pch_system

Author

YuShen

Repository

YuShenLiu06/PCHSystem

Homepage

YuShenLiu06/PCHSystem @ main

Synced at

...

Last update

...

Latest version

0.10.2

Total downloads

143

Back to catalogue

PCHSystem

PCH System · MCDR 插件

PCHSystem 的游戏内端 · MCDReforged 客户端插件

玩家在游戏里登录 Web 后台、协作项目、认领 / 上交材料、（将来）赚取积分——大量命令可点击，免手打。

Plugin Version MCDR Release Stars License Wiki

游戏内 · 材料清单施工贡献统计
游戏内材料清单施工贡献图表

⚠️ 非即装即用 · 强依赖后端：本插件是 PCHSystem（FastAPI + PostgreSQL）的游戏内客户端，必须先部署后端才能工作；插件市场 / !!MCDR plugin install 不等于完整部署——见部署。

⚠️ 仍在开发中：归档自动结算、称号等核心玩法尚未落地——见开发状态。

完整文档见 PCHSystem Wiki 与主仓库 Docs/。

功能特性

核心特性

  • 后端分离 — 游戏内端与后端完全分离，后端独立部署，插件仅作客户端
  • 跨服协作 — 身份锚定 Web 账号，一个账号可绑多个游戏身份，跨服 / 改名后积分与贡献不丢
  • 独立前端 — 配套 Web 端不进游戏也能协作；游戏端或 MCDR 重启时，Web 端仍可独立访问
  • 兼容性强 — 基于 MCDR，几乎所有 Minecraft 版本均可运行

已实现功能

登录与身份绑定

  • !!PCH login 一键生成登录链接，点击直达 Web 页面
  • !!PCH bind 把游戏身份绑到 Web 账号；支持网页端密码登录、临时账号转永久、项目协管员授权

项目协作（在线表格）

完整的项目材料清单协作——认领材料、多人累计上交、交付确认、打回返工、解除锁定，Web 端与游戏端对等操作。

  • 一键提交：扫描背包（含潜影盒内物品）上报进度，回执自动折叠无关行
  • 箱子提交：!!submitc 准星 / 坐标扫箱提交
  • 快捷命令：游戏内大量命令可点击交互，尽量免手打
  • 智能换算：自动将数量换算为可读性更高的 个 / 组 / 盒
  • 手持读取：读取手持物品 registry-id，直接更改 / 新增所需物品，免手打 ID
  • 协管员：项目拥有者可授予 / 撤销协管员，分担行级管理
  • 投影 / 蓝图建表：上传 .litematic / Create .nbt 自动生成材料清单（仅 Web 端，见主仓库）

项目协作（施工阶段）

统计施工阶段各参与者的贡献。

  • 开放统计层：面向客户端 / 服务端两种鉴权方式的 API，复用 JWT 与 service-token
  • 默认追踪器：自动轮询在线玩家 stats 文件做 diff，统计并上报施工贡献；config.json 设 "construction_enabled": false 可关闭
  • 多种图表：多种图表直观、准确地显示项目进度，前端预留接口随时切换

项目归档

项目完结自动生成归档文档 + 贡献占比饼图，精确记录每位参与者的贡献。

积分管理

  • 积分记账：批量入账 / 出账，流水不可篡改、每笔附记账后余额，可完整审计回溯
  • 管理员调分：管理员 / 拥有者调增调减玩家积分，原因必填，记入审计日志
  • 管理面板（Web）：「积分流水 / 玩家积分」双 tab，调分弹窗、余额排名、账号流水下钻抽屉
  • 积分通知：记账 / 调分自动附站内通知，游戏内即时收到积分变动提醒

通知投递

认领 / 交付 / 打回 / 项目状况变化 / 上交等事件游戏内自动通知，离线期间的通知上线补推。

效果一览

游戏内 · 登录链接游戏内 · 一键扫背包提交
游戏内登录一键扫背包提交
游戏内 · 可点击快捷命令游戏内 · 手持读取 registry-id
可点击快捷命令手持读取 registry-id
游戏内 · 智能数量换算通知投递
数量换算通知投递
查看更多截图
项目归档与贡献占比通知投递
项目归档与贡献占比通知投递
通知投递游戏内 · 提交回执
通知投递一键提交回执

规划中

  • 积分闭环 — 项目归档自动结算（settle）+ 玩家消耗积分 + 公开榜单
  • 指数增长称号 — 积分达标自动解锁，聊天前缀差异化，高阶全服公告
  • 施工阶段 — 真正校验建造放置（主体已完成）+ 实时计分板进度
  • Wiki 归档同步 — 归档内容双向同步到 wiki.js + 项目权限继承
  • 管理员面板 — 服务器管理面板

玩法一览

PCHSystem 面向白名单生电社区服，围绕「项目制协作 + 积分作为目标驱动」组织玩法，游戏内端是这套体系的操作入口：

  • 项目制协作：玩家发起或参与工程项目——负责人导入投影生成材料清单，参与者认领、上交 / 放置，系统跟踪进度，完结后归档沉淀
  • 黄皮子积分（规划中）：项目设固定积分池，按玩家交付 / 贡献占比分配；负责人享额外奖励
  • 荣誉激励（规划中）：总榜 / 赛季榜 / 项目榜；积分达标解锁指数增长的称号，高阶称号解锁社区权益

完整玩法设计见 Docs/guide.md。

依赖

MCDR 插件依赖

插件版本 / 来源用途
MCDReforged>= 2.14.0运行时
chest_scanner_lib>= 1.0.1箱子扫描（!!submitc：RCON 读箱 + 准星检测 + SNBT 解析）
uuid_api_remake—离线模式 UUID 推导
minecraft_data_apiMCDR 插件市场搜索 MinecraftDataAPI物品 / NBT 查询（一键提交依赖）

前置插件经 MCDR 原生 pim CLI 安装（自动装包内声明的 Python 依赖）：

mcdreforged pim download chest_scanner_lib uuid_api_remake minecraft_data_api -o <MCDR>/plugins
mcdreforged pim pipi <MCDR>/plugins/*.mcdr
!!MCDR reload plugin

游戏内等价：!!MCDR plugin install chest_scanner_lib -y（含依赖解析与自动 reload）。

⚠️ 后端服务（必需）

本插件强依赖 PCHSystem 后端（FastAPI + PostgreSQL）：

  • 所有 !!PCH / !!sheet / !!submit 命令经 HTTP 调用后端
  • 插件不存储业务数据——积分、项目、权限全在后端 PostgreSQL

后端部署见下方部署。

部署

「部署插件」=「部署 PCHSystem 全栈 + 把插件放进 MCDR」。两条路：

A. 快速部署（一键脚本 · 推荐）

git clone https://github.com/YuShenLiu06/PCHSystem.git

# 也可以使用 Gitee 镜像
git clone https://gitee.com/yushenliu03/PCHSystem.git

cd PCHSystem
bash Scripts/install.sh

自动完成：检测 / 安装 Docker、国内网络镜像自适应、生成配置（含强随机密钥）、起容器 + 跑数据库迁移、构建前端、把 pch_system 拷到你的 MCDR plugins/ 并填好 service_token。完整选项与边界见 Scripts/README.md。

部署自检：游戏内执行 !!PCH status，四探针（plugin / backend / token / frontend）全绿即部署正确。

B. 手动部署

要点：Docker Compose 起后端（postgres + backend + web）→ 把插件目录拷进 MCDR plugins/ → 参照 config.json.example 配好 api_url 与 service_token → !!MCDR reload plugin。完整步骤见 Docs/runbook.md。

游戏内命令

命令说明
!!PCH login申请 Web 登录，回显可点击链接
!!PCH bind / !!PCH bind <短码>发起 / 确认绑定，把游戏身份挂到 Web 账号
!!PCH status前后端连接自检（四探针）
!!PCH sheet <子命令>项目协作全套：list（旗标 -m / -c / -t / -a / -l 可组合）/ view / add / claim / deliver / contribute / advance / …
!!PCH sheet manager <编号> add / remove / list <玩家名>项目协管员授予 / 撤销 / 查看
!!sheet / !!sheet <id>快速重开上次 / 指定项目
!!submit / !!submit <id>一键扫背包提交到上次打开 / 指定项目
!!submitc [id] [x y z]扫箱子提交（准星 / 坐标模式）
!!PCH construction status / join [编号] / leave / current施工进度：状态 / 加入 / 退出 / 当前

完整命令树（含开发中命令）见 Docs/architecture/services/mcdr-plugin.md。

开发状态

状态模块
已交付登录鉴权（Web 账号绑多身份 + 密码登录）、项目协作（在线表格 + 协管员角色）、投影 / 蓝图解析、材料上交、施工进度追踪 / 上报、项目归档、积分记账 / 调分 / 管理面板、通知投递、一键部署
规划中归档自动结算、指数称号、Wiki 同步、风控告警、社区自治

已交付变更见 CHANGELOG.md，待办见 TODO.md。

相关链接

内容路径
主仓库https://github.com/YuShenLiu06/PCHSystem
Wiki 文档https://yushenliu06.github.io/PCHSystem-wiki/
玩法设计Docs/guide.md
工程架构总览Docs/architecture.md
本插件架构（权威）Docs/architecture/services/mcdr-plugin.md
部署脚本说明Scripts/README.md
运维手册Docs/runbook.md
变更日志CHANGELOG.md
待办清单TODO.md

Built for the HTCMC community

README source: McdrPlugin/README.md