aboutsummaryrefslogtreecommitdiff
path: root/docs/contribution/debugging.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/contribution/debugging.md')
-rw-r--r--docs/contribution/debugging.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/contribution/debugging.md b/docs/contribution/debugging.md
new file mode 100644
index 0000000..e788c44
--- /dev/null
+++ b/docs/contribution/debugging.md
@@ -0,0 +1,12 @@
+# Debugging
+
+For debugging, foremost you must:
+
+1. Build the extension with dev_build, it is also recommended to include debug_symbols. To do so run `scons dev_build=yes debug_symbols=yes`.
+
+2. Attach a debugger to Godot:
+ * For VSCode this has been mostly setup for you, in `.vscode/launch.json` just set `configuration.program` to your Godot binary path.
+
+ * For Visual Studio: TODO
+
+3. Run the task with the debugger attached. \ No newline at end of file