LogDuck - Your Logging Buddy for Godot 4.x
An asset by zeeweasel
Install Asset
Install via Godot
To maintain one source of truth, Godot Asset Library is just a mirror of the old asset library so you can download directly on Godot via the integrated asset library browser
Quick Information
A straight-forward logging addon for Godot 4.x to centralize and customize your Debug output for your project. - Customizable rich-text console outputs with BBCode.- Class name detection (GDScript)- Toggleable logging levels: Debug, Warning, Error.- Show full stack or last stack_frame for each LogLevel individually- Instance numbering to differentiate the ouput from different instances- Output of systems specs to console- Many settings, to make sure you get the most out of your logs!
LogDuck for GodotEngine
A straight-forward logging addon for Godot 4.x to centralize and manage your Debug output for your project.
·
Report Bug
·
Request Features
·
Discord Server
Installation
Download the .zip file and extract the LogDuck folder into your addons folder in your Godot Project.
At the top of LogDuck.gd are the settings to change how you'd like LogDuck to behave and how to format it. Every entry has a short explanation what it does. By default LogDuck will push warnings and errors automatically into the Debugger and rich output is enabled.Alternatively, you can take the LogDuck.gd script and drag it into your project, and add it as an autoloaded script. Make sure to set it as high as possible in the Load Order, so it can be ready for other autoloaded scripts.
**Note: **You can adjust the desired class name either inside of plugin.gd or inside the autoloaded script list, if you prefer a different way to call the logger. (Log.d() instead of LogDuck.d() for example)
Compatibility
Currently LogDuck supports Godot 4.0.1+ with GDScript. I have yet to look into making sure it plays along nicely with C# scripts. If you'd like to tackle that, feel free to contribute!
Using LogDuck
By default, LogDuck will output anything sent to LogDuck with d() w() and e() into the output / console, errors and warnings also into the Debugger if you are in the Editor. LogDuck, however, will not automatically catch any output sent to print(), printerr() or print_rich() calls. A careful Search and Replace of these functions with LogDuck.d, usually fixes this quickly.
If you need help with the setup, I will try my best to help out on the Discord server. If LogDuck is useful for you, please give me a shout on Twitter!
Planned Features
- Logging to files (Per Session / Continuing)
- Output of images into the output when in print_rich mode
- Being fully compatible with C# scripts
- Useful functions like printing system specs to console
See the open issues for a full list of proposed features and known issues.
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. I especially am looking to make this more robust and able to simplify debugging overall with the least amount of setup.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star if you enjoy it!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE.txt for more information.
Contact
A straight-forward logging addon for Godot 4.x to centralize and customize your Debug output for your project.
- Customizable rich-text console outputs with BBCode.
- Class name detection (GDScript)
- Toggleable logging levels: Debug, Warning, Error.
- Show full stack or last stack_frame for each LogLevel individually
- Instance numbering to differentiate the ouput from different instances
- Output of systems specs to console
- Many settings, to make sure you get the most out of your logs!
Reviews
Quick Information
A straight-forward logging addon for Godot 4.x to centralize and customize your Debug output for your project. - Customizable rich-text console outputs with BBCode.- Class name detection (GDScript)- Toggleable logging levels: Debug, Warning, Error.- Show full stack or last stack_frame for each LogLevel individually- Instance numbering to differentiate the ouput from different instances- Output of systems specs to console- Many settings, to make sure you get the most out of your logs!