Unable to launch debugger with Godot 4 (workaround included)

[ooo-mmm]

Godot version

4.0 alpha 10

VS Code version

1.68.1

Godot Tools VS Code extension version

1.3.1

System information

Windows 11

Issue description

Unable to launch a debugger with Godot 4, connection with GDScript language server works fine.
Godot instance was already running.

My analysis says that an "&" is missing from suffix of exe

Steps to reproduce

Try opening debug session with default generated launch.json from VS code

[atirut-w]

I don't think they added Godot 4 support for this addon yet and a lot of things has changed between 3 and 4. Your best bet might be to wait for 4.0 to be released.

[alfredbaudisch]

I don't think they added Godot 4 support for this addon yet and a lot of things has changed between 3 and 4. Your best bet might be to wait for 4.0 to be released.

Just to make sure I'm not doing something wrong, after all the setup, I also get Failed to launch Godot instance: Error: Command failed with Godot 4-beta1 (non-Mono) + VS Code,

So Godot 4.0 is still not support right?

[atirut-w]

In Godot 4.0 beta1, default LSP port is 6005, not 6008 (like 3.x).

LSP is for autocompletions, not debugging.

[yoieh]

The input flags has changed and now requires a port to launch with remote debugging.

By trying to launch it form a terminal you get this error:

PS> Godot_v4.0-beta2_win64.exe --path "....\Godot\PROJECT" --remote-debug 127.0.0.1:6008 
Invalid debug host address, it should be of the form <protocol>://<host/IP>:<port>.

I tested a none real protocole and it seems launches

PS> Godot_v4.0-beta2_win64.exe --path "....\Godot\PROJECT" --remote-debug any://127.0.0.1:6008
Godot Engine v4.0.beta2.official.f8745f2f7 - https://godotengine.org
Vulkan API 1.2.0 - Using Vulkan Device #0: NVIDIA - NVIDIA GeForce GTX 970
--------------------------------
...

Adding the same fake protocole to the address field in launch.json launches a debug window but workout working breakpoints.

---

Edit:

Chaning the protocol to tcp and prot to 6006 breakpoints stops the runtime but gives not feedback in vscode.

looks like 6006 is the defualt debug adapter port not 6008

[Zyjinn]

I was able to adjust the launch.json and use the tcp port like you mentioned, and get the editor to launch, but I get some strange errors, and the debugger doesn't work still.

I don't expect things to work prior to Godot 4 launch, just interesting and thought I'd share the error.

Failed to launch Godot instance: Error: Command failed: "D:\Game Dev\Godot\Godot 4\Godot_v4.0-beta2_win64.exe" --path "D:\Game Dev\Games\Constellation-Cadence" --remote-debug tcp://127.0.0.1:6007 --breakpoints res://Levels/Conductor.gd:30,res://Levels/level.gd:27,res://Levels/level.gd:30,res://Levels/level.gd:33,res://Levels/level.gd:36,res://Levels/level.gd:37 ERROR: Remote Debugger: Unable to connect. Status: 1. at: connect_to_host (core/debugger/remote_debugger_peer.cpp:182) SCRIPT ERROR: Parse Error: Expected ":" after function declaration. at: GDScript::reload (res://Preload/Transitions/sceneTransition.gd:8) WARNING: ObjectDB instances leaked at exit (run with --verbose for details). at: cleanup (core/object/object.cpp:1956) ERROR: Resources still in use at exit (run with --verbose for details). at: clear (core/io/resource.cpp:473)

[yoieh]

@Zyjinn

failed: "D:\Game Dev\Godot\Godot 4\Godot_v4.0-beta2_win64.exe" --path "D:\Game Dev\Games\Constellation-Cadence" --remote-debug tcp://127.0.0.1:6007 --breakpoints

Check your remot debugging port really is 6007

Project -> Network -> Debug Adapter

I have not gotten brakeponts working ether but I got it to lunch.

[Zyjinn]

@yoieh Oh, yeah I got the software to launch, just no breakpoints, which is hard to sell because if I'm going to use it as a primary editor, and I can't debug, that's a pretty big issue for me personally.

If you change the external editor, I don't think there's even a way to set breakpoints in the godot editor either, so you can't even use VSC for coding and godot for debugging super well, other than by kinda like, using VSC most times, and then just using Godot when you want to debug and not setting the external editor.

I'll play around with it, but mostly going to wait for debugging to come back for now, but thanks for the notice!

[Winprox]

Hey guys!
I was able to get breakpoints working with this launch.json
First of all, obviously godot_tools.editor_path is set in settings.json
I'm not using tcp as advised above, but have added "debugServer": 6006 to the default config

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Godot",
      "type": "godot",
      "request": "launch",
      "project": "${workspaceFolder}",
      "port": 6006,
      "debugServer": 6006,
      "address": "127.0.0.1",
      "launch_game_instance": true,
      "launch_scene": false
    }
  ]
}

As for Godot options:
-- Debug Adapter - Sync Breakpoints is True
-- Debug - Remote Port is 6006
-- Deploy with Remote Debug is True as shown below

You might have to launch your game in Godot Editor once (with at least one breakpoint set from VSCode) and then breakpoints should work in VSCode as well. Also, note that as of Beta 3, breakpoints set in VSCode can be disabled only from Godot Editor

Running on Godot 4 Beta 3 and Godot Tools 1.3.1

[michaelgundlach]

Thanks @Winprox , I can confirm that in Godot 4.0 Beta 4 I had to follow most one of your instructions before debugging GDScript worked -- except for setting Debug - Remote Port away from its default of 6007. I did have to launch the game in Godot Editor with breakpoints set in VSCode.

And I think you meant launch.json not config.json, and I think the only change you made was to add the debugServer entry.

So to summarize,

To get VSCode GDScript debugging working in Godot 4.0 Beta 4:

In VSCode

1. In Settings, search for godot and set Godot_tools: Editor_path to the Godot executable
2. If your workspace has no .vscode/launch.json file,
   • Open the Run and Debug sidebar, click create a launch.json file
   • Choose GDScript Godot Debug to create the file
3. In launch.json:
   • Change "port" to 6006
   • Add on the next line: "debugServer": 6006

In Godot Editor

1. Enable the Debug menu's Deploy with Remote Debug entry
2. In Editor Settings, set Network/Debug Adapter/Remote Port to 6006
3. In Editor Settings, set Network/Debug Adapter/Sync Breakpoints to On

Finally

1. Add a breakpoint in VSCode.
2. Run your project in Godot Editor, then stop it.

Now from VSCode you can Start Debugging, and it should run your code, and trip your breakpoint. Happy debugging!

PS: See next comment if you're using C# -- I don't know how to get that working :/

[glimpsebeyond]

@michaelgundlach I've followed these instructions and @Winprox's multiple times to the letter but debugging from VSCode 1.73.0 still doesn't work on Godot v4.0.beta4.mono.official [e6751549c] with Godot Tools 1.3.1. Start Debugging results in Godot reporting [DAP] Connection Taken and if repeated will eventually result in Max client limits reached, but the program never starts. If Start Debugging is used while the program is running it shuts down and no debugging occurs. This is occurring in a project with mixed GDscript and C#.

On further inspection this error occurs on Start Debugging:

[error] The editor and client are working on different paths; the client is on 
"d:\gameDev\gd4proj\builder\pawn.cs", but the editor is on "D:/gameDev/gd4proj/builder": CodeExpectedError: 
The editor and client are working on different paths; 
the client is on "d:\gameDev\gd4proj\builder\pawn.cs", but the editor is on "D:/gameDev/gd4proj/builder"

This definitely seems related to C#.

[michaelgundlach]

Sorry @glimpsebeyond, I'm just using GDScript. I updated my comment to not disappoint C# users. If you figure it out ping me again and I'll update the comment again.