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.
Additional Documentation
Verify Project Setup
The BugQuest Godot plugin automatically reports errors by monitoring Godot log file output. For this to work properly, you must ensure debug file logging is enabled in your project settings.
File logging must be enabled
Check your Project Settings → Debug → File Logging to ensure file logging is enabled. If this setting is disabled, BugQuest will not be able to capture errors.
When properly configured, any errors generated by push_error() will automatically be reported to BugQuest.
# Example - These errors will be automatically captured:
push_error("Failed to load player data")
push_error("Invalid item ID: " + str(item_id))Note: Errors printed with printerr() will not be automatically reported. Use push_error() for errors you want to track with BugQuest.