Skip to content
 
 

Repository files navigation

MCDevTool

C++23 CMake Build Test Artifacts MCP Platform Kid Studio License

适用于网易我的世界的开发者工具包,提供创建测试世界、加载用户Mod等功能,方便开发者在脱离mcs编辑器的环境下离线测试Mod。

该工具由 Kid Studio 成员 Zero123 创建并维护,源于网易我的世界 Mod / Addon 开发中的本地调试需求。

image

功能概览

  • 一键生成并启动开发测试世界,自动挂载用户行为包 / 资源包。
  • 支持直接运行玩法地图工程,自动识别包含 level.dat 的地图目录,并保留地图自带的世界数据和包清单。
  • 支持 Python Mod 热更新,修改代码后回到游戏前台自动触发增量刷新。
  • 支持 JSON UI 热重载,可在资源包 ui/*.json 变化后触发原生 UI definition reload。
  • 支持 Shader / Material 单文件热更新,可在资源包文件变化后回到游戏前台触发增量重载。
  • 内置调试 MOD,可重定向 Python 输出、绑定热更新快捷键,并提供调试期 IPC 能力。
  • 可选启用 MCP 服务,让 AI / 自动化客户端读取日志、执行代码、分析 JSON UI、截图和点击游戏窗口。

配置mcdk

您可以将mcdk添加到环境变量Path中,也可以直接放置在本地项目工作区以便命令搜索。

vscode插件现已经上线,可直接使用插件一站式开发,无需额外配置。该插件由 dofes 封装与维护。

在vscode中使用

您可以在vscode中配置任务以便直接运行mcdk,例如:

// .vscode/tasks.json
{
    "version": "2.0.0",
    "tasks": [
        {
            // 普通启动模式(根据配置文件,默认自动进入存档)
            "label": "RUN MC DEV",
            "type": "shell",
            "command": "cmd /c mcdk",
            "presentation": {
                "reveal": "always",
                "panel": "shared"
            },
            "problemMatcher": [
                "$python"
            ]
        },
        {
            // 子进程启动模式(必定不会自动进入存档),用于自测联机调试
            "label": "RUN MC SUB DEV",
            "type": "shell",
            "command": "cmd /c mcdk",
            "options": {
                "env": {
                    // 传递环境变量控制mcdk行为
                    "MCDEV_AUTO_JOIN_GAME": "0",
                    "MCDEV_IS_SUBPROCESS_MODE": "1"
                }
            },
            "presentation": {
                "reveal": "always",
                "panel": "shared"
            },
            "problemMatcher": [
                "$python"
            ]
        }
    ]
}

vscode断点调试

使用插件扩展可直接提供可视化的断点能力支持。

mcdev.json 配置参数

MCDEV配置文件,若不存在字段将以此处默认值为基准。

{
    // 首次运行将会自动生成 .mcdev.json 文件
    // 用于包含需要加载的MOD目录(默认值) 允许相对路径和绝对路径(相对路径以工作区为基准)
    "included_mod_dirs": [
        "./"   // 可以使用 {"path": "./", "hot_reload": true, "enabled": true} 控制包含的目录是否参与热更新检测
    ],
    // 指定游戏exe路径(string)
    "game_executable_path": "",
    // 生成的世界种子 若为null则随机生成(null / int)
    "world_seed": null,
    // 是否在启动时重置并新生成世界(玩法地图开发建议开启,详见下文)
    "reset_world": false,
    // 用于渲染的世界名称 (string)
    "world_name": "MC_DEV_WORLD",
    // 目录存档名(ASCII STRING)
    "world_folder_name": "MC_DEV_WORLD",
    // 玩法地图源目录:"auto" 会识别当前目录;空字符串表示不启用
    "world_source_path": "auto",
    // 是否自动进入游戏存档
    "auto_join_game": true,
    // 是否附加调试MOD(boolean),若启用将在生成的世界中包含热更新脚本(R键触发检测)并重定向输出流使其附加[Python]前缀可供筛选搜索。
    "include_debug_mod": true,
    // 日志处理策略  0.PIPE方案(默认)  1.Safaia协议(实验性)
    "log_protocol": 0,
    // 是否自动热更新MOD
    "auto_hot_reload_mods": true,
    // 是否自动热更新 JSON UI,默认关闭。开启后,资源包 ui 目录下的 json 修改会在回到游戏前台时触发 UI 热重载
    "auto_hot_reload_ui": false,
    // 是否自动热更新 Shader,默认关闭。开启后,资源包 shaders 目录下任意文件修改会在回到游戏前台时触发单文件 Shader 重载
    "auto_hot_reload_shaders": false,
    // 是否自动热更新 Material,默认关闭。开启后,资源包 materials 目录下任意 material 文件修改会在回到游戏前台时触发单文件 Material 重载
    "auto_hot_reload_materials": false,
    // 是否自动热更新 Particle,默认关闭。开启后,资源包 particles 目录下任意 json 修改会在回到游戏前台时触发单文件 Particle 重载
    "auto_hot_reload_particles": false,
    // 生成的世界类型(0.旧版有限世界 1.无限世界 2.超平坦) (int)
    "world_type": 1,
    // 游戏模式(0.生存 1.创造 2.冒险) (int)
    "game_mode": 1,
    // 是否启用作弊(boolean)
    "enable_cheats": true,
    // 是否死亡不掉落(boolean)
    "keep_inventory": true,
    // 天气是否自然更替
    "do_weather_cycle": true,
    // 昼夜是否自然更替
    "do_daylight_cycle": true,
    // 实验性玩法配置
    "experiment_options": {
        // 数据驱动生物群系
        "data_driven_biomes": false,
        // 即将到来的创作者功能
        "upcoming_creator_features": false,
        // 创建者照相机的实验性功能
        "experimental_creator_cameras": false,
        // beta版api
        "gametest": false,
        // 为创作者提供的RenderDragon功能
        "deferred_technical_preview": false
    },
    // 用户自定义名称(默认"developer")
    "user_name": "developer",
    // 用户自定义皮肤信息(默认缺失字段自动生成)
    "skin_info": {
        "slim": false,
        "skin": "完整贴图路径.png"
    },
    // MODPC调试器配置(依赖mcdbg后端,请确保配置在环境变量/当前工作区)
    "modpc_debugger": {
        // 注:若使用插件一站式解决方案则通常不需要启用此选项,由插件自动管理
        "enabled": false,   // 默认不启用
        "port": 5632        // 端口号(需要在vscode配置中同步)
    },
    // 自定义debug参数(选填可缺失)
    "debug_options": {
        // 键码查阅:https://mc.163.com/dev/mcmanual/mc-dev/mcdocs/1-ModAPI-beta/%E6%9E%9A%E4%B8%BE%E5%80%BC/KeyBoardType.html
        // 绑定热更新快捷键
        "reload_key": "82",
        // 绑定重载世界快捷键
        "reload_world_key": "",
        // 绑定重载Addon快捷键
        "reload_addon_key": "",
        // 绑定重载着色器快捷键
        "reload_shaders_key": "",
        // 是否在全体UI界面都触发热更新快捷键(默认false仅HUD界面)
        "reload_key_global": false
    },
    // 窗口样式(美化类?)
    "window_style": {
        // 悬浮置顶
        "always_on_top": false,
        // 隐藏标题栏
        "hide_title_bar": false,
        // 隐藏 Windows 任务栏图标
        "hide_taskbar_icon": false,
        // 自定义标题栏颜色 null | [R,G,B]
        "title_bar_color": null,
        // 窗口整体不透明度(包括标题栏和窗口内容)null | int (0-255)
        "opacity": null,
        // 锁定大小 null | [w, h]
        "fixed_size": null,
        // 锁定屏幕位置 null | [x, y]
        "fixed_position": null,
        // 锁定在屏幕四个脚落(覆盖fixed_position)1. 左上 2. 右上 3. 左下 4. 右下 null | int
        "lock_corner": null
    },
    // 网易独占配置项
    "netease_config": {
        // 是否启用聊天扩展功能(nethard魔改的游戏聊天界面)
        "chat_extension": false
    },
    // MCP服务器配置项
    "mcp_server_config": {
        // 是否启用MCP服务器功能
        // 该 MCP 提供:日志查询、客户端/服务端代码执行、JSON UI 运行时分析、画面捕获、点击操作、重载命令等能力。
        "enabled": false,
        // 服务器IP地址
        "server_ip": "localhost",
        // 服务器端口
        "server_port": 19133
    }
}

玩法地图工程

world_source_path 默认为 "auto",会识别当前目录中包含 level.dat 的地图,未找到时继续按普通 Addon 工程运行。地图位于子目录时需要显式指定路径;设置为空字符串或 null 可关闭地图识别。

地图数据会复制到 world_folder_name 指定的运行时世界,带有标准 manifest.json 的行为包和资源包会通过目录联接加载并参与热更新。

地图开发建议启用 reset_world,使每次启动都重新部署地图;否则项目地图的最新内容不会同步到运行时世界。需要保留游戏内测试进度时可临时关闭。

MCP客户端配置

启用 mcp_server_config.enabled 后,mcdk 会随游戏进程启动一个标准 MCP Server。它适合接入 Roo Code、Copilot、Claude Desktop 等 MCP 客户端,让 AI 在开发期直接使用结构化工具观察和操作游戏。

MCP 功能

常用工具包括:

  • get_latest_logs / get_latest_error_logs:读取游戏运行日志和 Python 错误输出。
  • execute_code:在客户端或服务端执行 Python 代码,适合触发开发期测试函数、查询运行时状态。
  • jsonui_debugger:读取 Minecraft JSON UI 运行时结构,支持 screen 列表、节点查询、子节点枚举、树结构、HTML-like 布局、SVG 布局图、节点搜索、Mod UI 状态分析和 UI 重载。
  • mc_profiler:通过单工具命令分析 Python CPU、Python 内存和可选的 Native CPU 性能,支持分页查询与 Markdown / SVG 报告。
  • capture_game_window / click_game_window:用于必要时的视觉确认和简单交互。
  • reload_game:触发完整游戏重载;资源级重载使用 reload_game(reload_addons=true)

jsonui_debugger 是推荐用于 UI 开发反馈的主入口。常用命令:

JSON UI Debugger runtime layout

/help
/screens
/overview [--screen=top|all|<screen>] [--nud]
/tree <screen> <path> [--depth=2] [--max-nodes=80]
/html <screen> <path> [--depth=2] [--html-only]
/render <screen> <path> [--depth=2] [--out=<absolute.svg>]
/find <screen> <path> <query> [--depth=5]
/mod-ui [--include-registered] [--children-depth=1]
/reload-ui [--preserve-mod-ui]

更多 UI 调试设计说明见 docs/ui-debugger/README.md

客户端示例

支持标准 MCP 客户端接入,以下配置以 Roo Code 为例。

{
    // Roo Code MCP Settings
    "mcpServers": {
        "minecraft_be_mcdk": {
            "url": "http://localhost:19133/sse",
            "name": "Minecraft(BE) MCP Server(MCDK)"
        }
    }
}

VSCode(Copilot)

VSCode 暂不支持直接连接 SSE,需通过 mcp-remote 桥接,配置在 .vscode/mcp.json

{
    "servers": {
        "minecraft_be_mcdk": {
            // 依赖nodejs环境
            "command": "npx",
            "args": [
                "mcp-remote",
                "http://localhost:19133/sse",
                "--transport",
                "sse-only"
            ]
        }
    }
}

MCP 服务器随 MCDK/MC 一起启停,游戏关闭后需重新连接。各客户端对自动重连的支持情况不同,请自行测试。

性能分析

mc_profiler 提供 Python CPU 热点与调用关系、Python 内存增长与保留量,以及 Native CPU 分析。内存调用栈以结构化帧返回;Native 模式读取 Tracy zone 调用树,并保留每个索引 zone 最多三次最慢调用的起始时间和持续时间,可在游戏提供相应埋点时关联 Python 调用和 C++ 引擎阶段,用于继续定位数据驱动 JSON 解析、转换、对象构建或事件分发等底层耗时。

分析任务具有服务端截止时间。结果默认只保存在进程内,连续 20 分钟未访问后由下一次性能分析请求惰性回收,不进入历史记录;需要跨进程恢复或前后对比时,可在启动任务时显式选择磁盘存储。相同分析类型的任务可按稳定来源身份在服务端计算基线、候选值和差值。Markdown 和 SVG 报告仅在显式导出时写入受控目录;CPU 报告会明确区分总耗时和自耗时。

Native 分析是可选能力,仅支持 Windows x64。mcdev-tracy-bridge.dll 必须与 mcdk.exe 位于同一目录;缺少或导出 API/Tracy 协议不兼容时 Native 分析将不可使用,可自行选择该功能扩展。

MCP 游戏测试工作流策略

MCDK MCP 的定位不是让通用 Agent 仅凭 LLM、截图和点击完成复杂游戏测试。现阶段更可靠的方式是:在开发代码时预留测试函数、诊断入口和结构化日志,再通过 MCP 客户端 / 服务端代码执行 Tool 触发这些入口,并用日志查询 Tool 收集结果做统计分析。

推荐工作流:

  1. 在 Mod / Addon 代码中预留开发期测试函数;
  2. 使用 MCP execute_code 调用客户端或服务端测试入口;
  3. 使用 get_latest_logs / get_latest_error_logs 收集结构化日志;
  4. 多轮执行后统计成功率、耗时和异常分布;
  5. 仅在视觉效果本身是测试目标时使用截图和点击能力。

详细规范见 MCP 游戏测试功能介绍与工作流策略规范

第三方依赖

库名 用途 备注
nlohmann/json 处理 JSON 配置文件解析与生成 Header-only
NBT 用于构建 level.dat 等 NBT 格式文件 依赖 BinaryStream 和 Zlib
BinaryStream NBT 的底层二进制读写支持 NBT 内部依赖
Zlib NBT 数据压缩与解压缩 NBT 内部依赖
CLI11 命令行参数解析 Header-only
cpp-mcp 实现 MCP 协议的服务器功能 魔改扩展协议
Tracy Native CPU 采集、时间线与 zone 调用树解析 可选 Windows x64 组件,固定使用 0.11.1
Capstone Tracy Native 采集所需的指令解析支持 仅随可选 Native 组件构建

About

适用于网易我的世界的开发者工具

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages