安装 VS Code 和 EmmyLua
中文 | English
在仓库根目录运行以下命令,用本机 Unity MCP 回放本页示例。
python Docs/Manual/manual/tools/tutorials.py run install-vs-code-emmylua
点击展开 MCP 操作点击收起 MCP 操作
准备教学样例。${变量} 由配方提供。
{
"variables": {},
"calls": [
{
"tool": "inspect",
"arguments": {
"path": "static:System.Environment/GetFolderPath(LocalApplicationData)"
},
"expect": {
"contains": "(String)"
},
"capture": {
"localApp": {
"regex": "\\(String\\) ([^\\r\\n]+)"
}
}
},
{
"tool": "inspect",
"arguments": {
"path": "static:System.Environment/GetFolderPath(UserProfile)"
},
"expect": {
"contains": "(String)"
},
"capture": {
"profile": {
"regex": "\\(String\\) ([^\\r\\n]+)"
}
}
}
]
}
1. 安装编辑器和扩展
- 从 VS Code 下载页 选择你的系统和架构。Windows 运行安装程序。macOS 解压后把 Visual Studio Code.app 拖入 Applications。
- 打开 VS Code,点左侧 扩展。Windows 可按 Ctrl+Shift+X,macOS 可按 Cmd+Shift+X。搜索扩展 ID
@id:tangzx.emmylua,打开 EmmyLua 并点 Install。EmmyLua 扩展 - 命令行可用时,在新终端运行
code --list-extensions。看到tangzx.emmylua即确认已安装。
点击展开 MCP 操作点击收起 MCP 操作
检查本机 Windows 用户安装位置。安装程序和扩展商店操作由读者完成。
[
{
"tool": "invoke",
"arguments": {
"path": "static:System.IO.File/Exists",
"args": [
"${localApp}/Programs/Microsoft VS Code/Code.exe"
]
},
"expect": {
"contains": "(Boolean) True"
}
},
{
"tool": "invoke",
"arguments": {
"path": "static:System.IO.Directory/GetDirectories",
"args": [
"${profile}/.vscode/extensions",
"tangzx.emmylua-*"
]
},
"expect": {
"contains": "tangzx.emmylua"
}
}
]
2. 配置仍使用 Java 的 EmmyLua
先看已安装扩展的版本和设置。上游新版本使用 Rust 语言服务。旧 Java 后端仍包含在部分安装中,本机核对的 0.6.18 也有该模式。当前启用的后端若要求 Java,请按以下步骤配置。EmmyLua 项目说明
- 按你安装版本的说明下载 JDK,选择与操作系统和 CPU 一致的安装包。旧文档的版本下限为 1.8.0_181。
- 在 扩展 → EmmyLua → 齿轮 → Extension Settings 搜索 Java Home。填写 JDK 目录,比如 Windows 的
C:/Program Files/Java/jdk-17,或 macOS 的/Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home。以本机安装位置为准。 - 若使用 Preferences: Open User Settings (JSON) 编辑设置,键名为
emmylua.java.home。Windows 路径可写成正斜杠形式,避免处理 JSON 的转义。
{
"emmylua.java.home": "C:/Program Files/Java/jdk-17"
}
保存设置后重新加载窗口,打开一个 .lua 文件。若语言服务未启动,先在 输出面板选择 EmmyLua,查看具体依赖或路径错误。
3. 加入项目的 API 定义
用 VS Code 打开 Lua 源码所在文件夹。在 Unity 执行 XLua → Generate EmmyLua for LuaCallCSharp,确认工程的 Build/EmmyLua/ 出现 csharp.lua 和 api.lua。把该目录加入 VS Code 工作区作为编辑器提示。打开自己的脚本,输入 WeaponAPI. 检查能否提示方法。
点击展开 MCP 操作点击收起 MCP 操作
[
{
"tool": "inspect",
"arguments": {
"path": "static:GeneralEditor.Utility_XluaDefineEditor"
},
"expect": {
"contains": "GenerateEmmyLuaForLuaCallCSharp"
}
}
]
点击展开 MCP 操作点击收起 MCP 操作
在自己的工程中生成或更新 Build/EmmyLua;日常回放只查入口。
[
{
"tool": "invoke",
"arguments": {
"path": "static:GeneralEditor.Utility_XluaDefineEditor/GenerateEmmyLuaForLuaCallCSharp",
"args": []
}
}
]
接下来可做 Lua 断点调试。