内容
# mcpywrap
**用 Python 标准项目与依赖管理方式开发《我的世界》中国版 Mod 和资源包。**
[](https://pypi.org/project/mcpywrap/)
[](LICENSE)
mcpywrap 使用 `pyproject.toml` 管理开发侧依赖，复用本地 Addon 的代码与资源，并串联构建、游戏测试和 MC Studio 编辑器。Python 包管理用于开发环境，不是游戏内的包安装器。
## 安装
需要 Python 3.9 或更高版本。游戏和编辑器启动功能需要 Windows、MC Studio 及已下载的游戏引擎。
推荐通过 [uv](https://docs.astral.sh/uv/) 安装：
```powershell
uv tool install mcpywrap
```
也可以使用 `pip install mcpywrap`。安装完成后，运行 `mcpy --help` 查看命令。
从 Windows 源码检出安装时，先安装 Visual Studio 的 x86/x64 C++ 构建工具，再运行 `python scripts/build_all_native.py` 一次编译全部原生组件，最后执行 `pip install -e .`。正式发布包由 CI 编译并附带原生组件，普通安装无需本机编译。
## 开始使用
进入你的 Addon 或地图项目目录，按向导初始化：
```powershell
mcpy init
```
之后可以直接运行游戏测试，或在 MC Studio 编辑器中打开项目：
```powershell
mcpy run
mcpy edit
```
需要查看项目和管理依赖时，运行 `mcpy ui` 打开图形界面。
## 复用代码和资源
为 Addon 一键准备 QuMod：`mcpy add --qumod`。新脚本目录自动生成入口，已有业务代码保留；
QuMod 作为通用 Git 项目依赖的预设管理，不进入源码仓库。团队成员克隆后执行 `mcpy sync` 即可恢复框架。
CLI／GUI 向导、官方 GitHub／Gitee 来源和版本依据见 [QuMod 指引](docs/qumod.md)。
其他仓库使用 `mcpy add --git <URL>`；标准导出、递归依赖与共享缓存见 [Git项目依赖](docs/git-dependencies.md)。
将 Python 包安装到 mcpy 所在的工具环境并记录声明：
```powershell
mcpy add "package-name>=1.0"
```
对于本机已有的 Addon，直接引用它的目录：
```powershell
mcpy add --path "../shared-addon"
```
本地 Addon 无需先初始化或安装，可以直接使用 MCS 导出的目录。请选择包含行为包或资源包的 Addon 根目录；相对路径以当前项目目录为基准。
移除依赖使用 `mcpy remove <包名>` 或 `mcpy remove --path <目录>`。移除本地引用不会删除源目录。不带参数运行 `mcpy add` / `mcpy remove` 可进入选择向导。
本地路径适合同机开发；共享项目时需同步这些目录。工具目前通过包的本地安装来源识别 Addon，普通 PyPI 包或 wheel 安装成功不代表能参与组装；未识别到 Addon 的包会标记为“仅开发环境”。目录结构、配置及构建规则见[本地依赖参考](https://github.com/EaseCation/mcpywrap/blob/main/docs/local-dependencies.md)。
**游戏运行边界：** 测试和正式游戏都使用内置 Python，不读取 `dependencies`，也不继承工具环境的 `site-packages`。`add`、`sync --install` 和 ModSDK 安装均不向游戏安装模块。游戏所需代码与资源必须随 Addon 携带，或由用户加载相应 Mod；纯 Python 库也不会自动复制，仍需适配游戏解释器和 ModSDK。原生扩展及依赖外部安装步骤、系统环境的库不能直接用于游戏；包内 `.pyd/.dll/.so/.so.*（版本号）/.dylib` 会阻止构建和启动。
## 构建与日常开发
Git 项目使用 `[[tool.mcpywrap.git_dependencies]]` 声明，支持 Addon 与纯代码导出、递归子依赖及固定提交。
`mcpy sync` 获取并注册，运行与发布时组装；共享源码缓存不提交 Git。
现有 `code_libraries` 声明保持兼容，说明见[代码库依赖](docs/code-libraries.md)。
| 命令 | 用途 |
|---|---|
| `mcpy build` | 将项目和依赖构建到配置的输出目录 |
| `mcpy package` | 构建项目和依赖，在 `dist` 中生成可分发 ZIP |
| `mcpy dev` | 监控 Addon 源码与依赖变化，持续更新构建结果 |
| `mcpy mod` | 通过向导创建 Python Mod 框架 |
| `mcpy modsdk` | 管理网易 ModSDK |
| `mcpy run -n` | 创建新的游戏测试实例 |
| `mcpy run -l` | 查看已有实例 |
| `mcpy run -d <ID前缀>` | 删除指定实例 |
本地世界模式下，`mcpy run` 默认复用最近创建的实例。构建时主项目内容优先于依赖；修改依赖声明后，请重新启动 `mcpy dev`。
### 打包分发
在项目根目录执行 `mcpy package`，会组装项目及已识别的 Addon 依赖，再生成 `dist/<项目名>-<版本>.zip`；仅开发环境的包不会进入 ZIP。名称和版本读取 `pyproject.toml` 的 `[project]`；不需要配置 `target_dir`。
Addon ZIP 内为 `<项目名>_bp/`、`<项目名>_rp/`（仅包含实际构建出的包）；地图 ZIP 根目录直接包含存档数据、行为包、资源包及世界包配置。地图默认保留独立包，使用 `mcpy package --merge`（或 `-m`）按构建规则合并依赖资源。构建产物中的空目录会保留。
重复打包成功后会替换同名 ZIP；失败时保留已有 ZIP，临时文件自动清理。
`publish` 向 PyPI 发布 Python 分发包，与游戏 ZIP 分发不同。本地测试可配置多个独立 Addon，游戏不会解析 Python 依赖图；构建成功不保证兼容，发布前应检查产物并在游戏中验证加载日志。
## 游戏启动与排查
### 运行时 Python 与本地热更
`runtime` 下的命令控制已启动的游戏会话，均需传入启动时返回的会话 ID。游戏内 Python 使用 MC Studio 自带的 Safaia 调试通道，无需安装调试 Mod：
```powershell
mcpy run --no-gui --detach --json
mcpy runtime py --session <id> --side client --code "1+1" --json
mcpy runtime py --session <id> --side server --file .\probe.py --json
mcpy runtime reload python --session <id> --module MyMod.client.logic --json
mcpy runtime reload ui --session <id> --json
mcpy runtime watch --session <id>
```
本地世界支持客户端和服务端执行；联机会话只支持客户端。`py --file` 在调用端读取 UTF-8 内容，返回输出、表达式或 `_result` 的值及异常。执行超时的状态为 `unknown`，游戏内代码可能仍会运行，不应自动重试。
`runtime reload` 支持 `python/ui/shader/material/particle`，资源类型通过 `--file` 指向项目包内目标；`runtime watch` 在成功构建后自动触发。本期热更仅支持 Windows 本地测试世界。推荐先使用 Python 和 JSON UI 热更：Python 要求模块已加载，现有对象或事件订阅不会自动重建；JSON UI 返回 `triggered` 仅表示快捷键已投递，需要用画面确认效果。3.9.0.401155 和 3.10.0.420447 的 Shader 重载已禁用，Material 在这两版没有对应接口。完整实机结果见[运行时调试参考](docs/runtime-debug.md)。
通常不需要手动指定游戏路径。mcpywrap 会优先查找 MC Studio 登记的安装，必要时搜索固定磁盘中的标准下载目录，并跳过不完整的引擎版本。
遇到找不到游戏或缺少资源的提示，先运行：
```powershell
mcpy doctor
```
需要使用特定版本时，可以临时指定：
```powershell
mcpy run --engine-version 3.10.0.420447
```
已有实例默认保留原引擎版本；显式指定版本可以切换。自定义路径、项目级设置和环境变量的用法见[引擎配置参考](https://github.com/EaseCation/mcpywrap/blob/main/docs/engine-discovery.md)。
### 连接服务器（实验性）
临时连接无需项目配置，地址可以是 IP 或主机名，端口默认 `19132`：
```powershell
mcpy connect 192.168.31.101 --port 19132
```
固定目标可写入 `pyproject.toml`，随后在该目录执行 `mcpy run`：
```toml
[tool.mcpywrap.server]
host = "192.168.31.101"
port = 19132
```
空目录只需上述配置，无需执行 `mcpy init`；已有 Addon 项目也可添加此表。默认使用未认证连接，不读取登录身份或 token，不保证服务器允许进服；项目依赖仍会校验，但暂不装配本地 Mod。
网络模式默认前台输出日志，Ctrl+C 结束本次游戏。增加 `--detach --json` 可返回会话，与本地游戏共用 `status/logs/stop` 及 Skill 截图、按键脚本：
```powershell
mcpy --project D:\tests\server --non-interactive connect example.com --detach --json
mcpy --project D:\tests\server status --session <id> --json
mcpy --project D:\tests\server stop --session <id> --json
```
目录须已存在；临时 `connect` 不读取项目配置，只在该目录保存会话。后续操作使用启动返回的 `project` 和 `session`。
网络模式暂不支持 Map、Qt GUI、`--new` 或本地世界实例 ID；进程启动不等于成功进服。
### 使用 MC Studio 登录身份（可选）
单人测试用 `mcpy run --mcs-auth`，网络服用 `mcpy connect <地址> --mcs-auth`；图形管理页可用 `mcpy ui --mcs-auth`。必须先打开并登录 MC Studio，且每次显式加参数，配置文件不会自动启用登录。
发布包自带签名桥接组件，无需编译。程序先尝试启用；若确认为证书信任问题，人工交互模式会说明影响，并在你同意后安装当前用户证书、重试一次。安装证书不保证 Smart App Control 或组织策略放行。`--non-interactive`／`--json` 全程无弹窗、不安装证书，失败返回原因与处理提示。
身份按次读取，日志脱敏，单人世界的长期配置不保存凭据。当前不支持 token 自动刷新和运行期认证代理。信任范围、移除方法及开发构建见[登录组件说明](docs/mcs-auth.md)。
## AI Agent 使用
仓库提供标准 [mcpywrap Skill](https://github.com/EaseCation/mcpywrap/tree/main/skills/mcpywrap)，帮助 Agent 安装工具、管理依赖、
构建打包、启动游戏和检查日志，并通过自带脚本截图、发送组合键与模拟移动。
**安装 Skill**：可对支持 Skill 安装的 Agent 说：
> 请安装 GitHub 仓库 EaseCation/mcpywrap 中 skills/mcpywrap 目录下的 Skill。
也可以下载仓库 ZIP，将完整的 `skills/mcpywrap` 文件夹复制到对应 Agent 的技能目录。
无需从源码安装 Python 项目；CLI 和 Skill 分别安装，`pip/uv install` 不会自动注册 Skill。
两端使用跨平台 `scripts/bootstrap.py` 安装或复用各自的 CLI，Windows 也可用 `bootstrap.ps1`。脚本分别报告本机与远端能力；Skill、CLI 与 Windows 服务需要分别检查，Git／可编辑安装可能缺少登录组件。
`runtime` 命令组需要 mcpywrap 0.3.12 或更高版本，并从 `v0.3.12` 标签安装配套 Skill。实际能力仍以脚本检测为准；更新 Skill 不会自动更新两端 CLI。
安装后可直接描述任务：
- “使用 mcpywrap 为这个 Addon 添加本地依赖，并生成分发 ZIP。”
- “启动这个项目，不弹日志界面，检查客户端和服务端的加载日志。”
- “启动游戏并截图，模拟组合按键移动，检查 F11 输入模式和 F3 调试信息层。”
Agent 通过 CLI 管理项目和操作游戏。连接后用 `runtime install` 一次注入 `mcpy.ui` / `mcpy.player` / `mcpy.api`：UI 支持文字节点观察与操作，玩家层封装移动、转向、攻击、物品使用、吃东西、射箭和带延迟的连续动作。实际支持能力以安装返回结果为准。详见[游戏内 UI 自动化](docs/runtime-ui.md)和[玩家动作与队列](docs/runtime-player.md)。需要补图且不能占用前台时使用 `screenshot --background-only`。Qt 管理与模板界面用于人工操作。
严禁业务代码依赖 `mcpy.*`：这些方法仅存在于临时注入的调试会话，正常游戏运行环境不提供它们；业务实现须使用正式 ModSDK 或项目框架。
连续执行统一先生成时间计划，`at_ms` 可省略并按动作时长与 `delay_ms` 自动计算。允许占用游戏前台的 Windows 键鼠快切测试使用 `input-sequence --file <计划.json>`，一次请求返回输入提交时间与实际偏差；后台游戏语义动作继续使用 `runtime player sequence`。详见 [连续动作编排与输入计时](docs/input-sequence.md)。
常用入口：`mcpy --project <目录> --non-interactive <命令> --json`。
## 视频录制与提帧
Windows 游戏会话可录制无音频的固定帧率 H.264 MP4，录制期间继续发送键鼠输入。先用 `doctor --capabilities --json` 检查 `record/record-frames`；源码安装需重新编译原生组件。
```powershell
mcpy --local --project D:\mods\test record start --session <sid> --duration 10 --fps 30 --json
mcpy --local --project D:\mods\test key --session <sid> W --hold-ms 1000 --json
mcpy --local --project D:\mods\test record status --session <sid> --recording <rid> --json
mcpy --local --project D:\mods\test record download --session <sid> --recording <rid> --output clip.mp4 --json
mcpy --local --project D:\mods\test record frames --session <sid> --recording <rid> --at 1.0 --at 2.0 --output frames --json
```
`rid` 来自 start 的 `recording`；等待 `completed` 后下载。默认 10 秒／30 FPS，支持整数 1–300 秒、1–60 FPS。每个会话一次录制；`record stop` 只结束录像。远程把 `--local` 替换为 `--remote <地址>`，project/output 为调用端路径，视频仍在 Windows 采集、编码及临时落盘。
视频分块写入和下载，执行端产物完成后保留 24 小时，`record delete` 可提前清理；游戏退出后仍可下载。提帧也支持重复的 `--frame <从0开始的帧号>`，单次最多 100 个，与 `--at` 互斥。客户区最小化、锁屏、尺寸变化或采集停滞会结束录像。固定帧率可能重复或跳过源画面，不能保证捕获游戏每一帧；清单记录时间映射，录像成功不代表游戏逻辑通过。完整 Agent 流程见 [Skill](skills/mcpywrap/SKILL.md#视频录制与逐帧分析)。
## macOS 与 Windows 局域网联调
Windows 用户在测试桌面运行 `mcpy --local serve`，默认监听 `0.0.0.0:18765`；macOS 使用同一服务地址调用：
```bash
mcpy --remote http://192.168.1.20:18765 --non-interactive connect 192.168.1.10 --port 19132 --detach --json
mcpy --remote http://192.168.1.20:18765 screenshot --session <id> --output ./game.png --json
mcpy --remote http://192.168.1.20:18765 key --session <id> SHIFT+W --hold-ms 1000 --json
mcpy --remote http://192.168.1.20:18765 stop --session <id> --json
```
项目依赖与构建仍在 macOS，游戏诊断、网络启动、日志和输入转发到 Windows，截图下载到调用端。
Windows `serve` 默认必须配置 `MCPY_REMOTE_TOKEN`，两端使用相同令牌；可信网络可显式使用 `mcpy --local serve --no-token` 关闭认证，此时忽略已有令牌，所有可访问该端口的设备均可执行游戏客户端 Python。服务 Ctrl+C 清理所属游戏。需要 Windows 保持登录未锁屏，一次只接受一个活动会话。远程联机会话可用 `mcpy --remote <地址> runtime py --session <id> --code "1+1" --json` 执行客户端 Python，不支持远程热更。
bootstrap 检测不会保存远端地址，独立终端调用请每次显式传 `--remote <地址>`。部署、鼠标与恢复见[远程测试指引](skills/mcpywrap/references/remote-testing.md)。
## 更多信息
- 运行 `mcpy <命令> --help` 查看该命令的选项。
- [更新记录](https://github.com/EaseCation/mcpywrap/blob/main/CHANGELOG.md)
- [开发与验证](https://github.com/EaseCation/mcpywrap/blob/main/docs/development.md) · [发布流程](https://github.com/EaseCation/mcpywrap/blob/main/docs/releasing.md)
- 欢迎通过 [Issues](https://github.com/EaseCation/mcpywrap/issues) 反馈问题或提交 PR。
[MIT License](LICENSE) © EaseCation
