如何在VSCode中通过FiveM.exe调试FiveM Lua代码并配置launch.json

前置准备 #

• 安装VSCode的Lua Debug插件（直接在扩展市场搜索安装即可）
• 确保FiveM服务器文件夹已作为VSCode工作区打开

步骤1：创建/修改launch.json配置 #

1. 打开VSCode的「运行和调试」面板（快捷键Ctrl+Shift+D）
2. 点击「创建launch.json文件」，选择「Lua」环境
3. 将默认配置替换为以下内容，根据你的系统和服务器路径调整参数：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "FiveM Server + Lua Debug",
            "type": "lua",
            "request": "launch",
            // 服务器启动程序路径：Windows用FXServer.exe，Linux用run.sh
            "program": "${workspaceFolder}/FXServer.exe",
            "args": [], // 启动服务器需要的额外参数可添加在此数组
            "cwd": "${workspaceFolder}",
            "stopOnEntry": false,
            // 指定Lua资源文件路径，确保调试器能定位代码
            "path": ["${workspaceFolder}/resources/**/*.lua"],
            "luaVersion": "5.4", // FiveM使用的Lua版本，保持一致即可
            "port": 4278, // FiveM默认调试端口，需与服务器配置同步
            "wait": true // 等待调试器连接后再启动服务器，避免错过断点
        }
    ]
}

步骤2：开启FiveM服务器调试模式 #

在你的服务器server.cfg文件中添加以下配置：

set sv_debugMode true

若需自定义调试端口，可追加set sv_debugPort 4278（端口号必须与launch.json中的port字段完全匹配）

步骤3：开始调试 #

1. 在目标Lua代码行左侧点击，添加断点（会显示红色圆点）
2. 点击VSCode调试面板的「启动调试」按钮（绿色三角图标）
3. 调试器会自动启动FiveM服务器并建立连接，当代码执行到断点时会自动暂停
4. 此时可进行以下操作：
   • 在变量面板查看实时数据
   • 使用单步执行、跳过、继续等调试控制按钮
   • 彻底替代print()语句的调试方式

注意事项 #

• 确保断点所在Lua文件属于已加载的服务器资源（需在server.cfg中通过ensure命令加载）
• 若调试客户端Lua代码，需将配置中的type改为lua-client，并将program指向FiveM客户端的启动程序路径
• 若启动服务器时需要指定配置文件，可在args数组中添加+exec server.cfg

内容的提问来源于stack exchange，提问作者aghyksa