godotengine / godotengine/godot-docs

Add a guide on remote debugging

Open
#11,245 3 comments 0 reactions 0 assignees View on GitHub
area:manual content:new page
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:** 4.4.1

**Issue description:**
A guide to using the debugger remotely (i.e. exporting a game and running it on one computer, while using another computer to monitor performance) would probably be a useful addition to the docs. Here's the steps I followed:

1. Navigate to the Editor settings in Godot and find the Debug/Remote Host settings.
2. Change the remote host to use your IP address instead of 127.0.0.1.
3. Open port 6007 in the firewall on your development PC.
4. Make sure that `Keep Debug Server Open` is enabled from the Editor's Debug menu.
5. Export your game as a debug build and copy to the remote machine you’re testing on.
6. On your test machine, run the exported shell script or EXE file with the following commands:
a) `myGame.sh --remote-debug tcp://:6007`
b) `myGame.exe --remote-debug tcp://:6007`

**URL to the documentation page (if already existing):**
None yet, but it should probably go under https://docs.godotengine.org/en/stable/tutorials/scripting/debug/overview_of_debugging_tools.html

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.