Visual Studio Code

Visual Studio Code <https://code.visualstudio.com> _是 Microsoft <https://microsoft.com> _推出的免费跨平台代码编辑器(不要与 Visual Studio 混淆).

导入项目

  • 确保C/C++扩展已经安装. 你可以在 官方文件 中找到说明.

  • 现在在VS Code中打开克隆的godot文件夹 文件 > 打开文件夹... .

  • 按Ctrl + Shift + P打开命令提示符窗口, 然后输入 Configure Task.

../../../_images/vscode_configure_task.png
  • 选择从模板中创建tasks.json文件选项.

../../../_images/vscode_create_tasksjson.png
  • 然后选择 "其他".

../../../_images/vscode_create_tasksjson_others.png
  • tasks.json 文件中找到 "tasks" 数组, 并在其中添加一个新部分:

{
  "label": "build",
  "group": "build",
  "type": "shell",
  "command": "scons",
  "args": [
    "-j $(nproc)"
  ],
  "problemMatcher": "$msCompile"
}
{
  "label": "build",
  "group": "build",
  "type": "shell",
  "command": "scons",
  "args": [
    // Use this when your default shell is Command Prompt (cmd.exe).
    "-j %NUMBER_OF_PROCESSORS%",
    // Use this when your default shell is PowerShell.
    "-j $env:NUMBER_OF_PROCESSORS"
  ],
  "problemMatcher": "$msCompile"
}
../../../_images/vscode_3_tasks.json.png

填好了 tasks.json 的一个例子.

参数可以根据你自己的设置和需要而不同. 参见 构建系统介绍 以获取完整的参数列表.

调试项目

为了构建项目, 我们需要配置文件 launch.json.

  • 按Ctrl + Shift + D打开 运行 面板.

  • 如果缺少 launch.json 文件, 系统会提示你创建一个新的文件.

../../../_images/vscode_1_create_launch.json.png
  • 选择 C++ (GDB/LLDB) . 这里可能还有其他特定平台的选项. 如果选择了, 请相应调整所提供的配置示例.

  • launch.json 文件中找到 "configurations" 数组, 并添加一个新部分:

{
  "name": "Launch Project",
  "type": "lldb",
  "request": "launch",
  // Change to godot.x11.tools.64.llvm for llvm-based builds.
  "program": "${workspaceFolder}/bin/godot.x11.tools.64",
  // Change the arguments below for the project you want to test with.
  // To run the project instead of editing it, remove the "--editor" argument.
  "args": [ "--editor", "--path", "path-to-your-godot-project-folder" ],
  "stopAtEntry": false,
  "cwd": "${workspaceFolder}",
  "environment": [],
  "externalConsole": false,
  "preLaunchTask": "build"
}
{
  "name": "Launch Project",
  "type": "cppdbg",
  "request": "launch",
  // Change to godot.x11.tools.64.llvm for llvm-based builds.
  "program": "${workspaceFolder}/bin/godot.x11.tools.64",
  // Change the arguments below for the project you want to test with.
  // To run the project instead of editing it, remove the "--editor" argument.
  "args": [ "--editor", "--path", "path-to-your-godot-project-folder" ],
  "stopAtEntry": false,
  "cwd": "${workspaceFolder}",
  "environment": [],
  "externalConsole": false,
  "setupCommands":
  [
    {
      "description": "Enable pretty-printing for gdb",
      "text": "-enable-pretty-printing",
      "ignoreFailures": true
    }
  ],
  "preLaunchTask": "build"
}
{
  "name": "Launch Project",
  "type": "cppvsdbg",
  "request": "launch",
  "program": "${workspaceFolder}/bin/godot.windows.tools.64.exe",
  // Change the arguments below for the project you want to test with.
  // To run the project instead of editing it, remove the "--editor" argument.
  "args": [ "--editor", "--path", "path-to-your-godot-project-folder" ],
  "stopAtEntry": false,
  "cwd": "${workspaceFolder}",
  "environment": [],
  "console": "internalConsole",
  "visualizerFile": "${workspaceFolder}/platform/windows/godot.natvis",
  "preLaunchTask": "build"
}
../../../_images/vscode_2_launch.json.png

填写好的 launch.json 的例子.

注解

Due to sporadic performance issues, it is recommended to use LLDB over GDB on Unix-based systems. Make sure that the CodeLLDB extension is installed.

If you encounter issues with lldb, you may consider using gdb (see the X11_gdb configuration).

Do note that lldb may work better with llvm-based builds. See 为X11平台(Linux, *BSD操作系统)编译 for further information.

program [程序]下的名称取决于你的构建配置, 例如启用 tools 的64位X11平台 godot.x11.tools.64 .

如果遇到问题, 也可在 Godot 社区论坛 中寻求帮助.