Help us improve BugQuest by completing a short survey
BugQuest Installation Guide
- Install BugQuest in your Godot project.
- Link the project to your account in the dev console.
- Run your game and start seeing real runtime errors.
1Download and Install the BugQuest Plugin
Download the BugQuest addon zip file for Godot from our GitHub repository:
Copy the gdbq folder from the zip file to your project's addons/ folder:
Enable the addon in your Project Settings under Plugins.
2Setup the Plugin
After enabling the plugin, select BugQuest Setup from the Project/Tools menu.
Click the Setup button to:
- Automatically generate an API key for your project
- Create a link to our website to quickly setup an account associated with this project
BugQuest will automatically start tracking errors when your game runs. No additional code is required.
3Visit the Web Interface
Click the link that appears or copy it to your clipboard and paste it in a browser window. This will take you to the web interface where you can quickly create an account and view your errors.
BugQuest API
Disables BugQuest error collection and upload for the rest of the current app session.
Applies only to the current app session. Error collection starts again on next application launch unless disabled again.
var bq = get_node_or_null("/root/BugQuest")
if bq and not bq.is_disabled():
bq.disable()Bugquest.BugQuestAPI.Disable();
Additional Documentation
Verify Project Setup with GDScript Errors
When properly configured, any GDScript errors and exceptions will automatically be reported to BugQuest.
# Example - These errors will be automatically captured:
printerr("Failed to load player data")
push_error("Invalid item ID: " + str(item_id))
var x = null
x.do_something() # exceptionC# Support
BugQuest will automatically capture and report C# errors printed with GD.PrintErr() and GD.PushError(), as well as unhandled C# exceptions when you install the version.
// Example - These C# errors will be automatically captured
GD.PrintErr("c# PrintErr");
GD.PushError("c# PushError");
throw new Exception("c# test exception");Note: BugQuest Godot plugin releases include two zip files. You must use the one with dotnet in the name to handle C# errors. The correct zip file is named bugquest-godot-dotnet-<version>.zip.
The BugQuest Godot plugin with C# support requires a .sln file in your project in order to export a build.