Debug mode provides enhanced logging capabilities for development and troubleshooting purposes.
Enabling Debug Mode
Debug mode can be enabled in your OverlayedOptions configuration:
Features
When debug mode is enabled, the following additional features are available:
logger.debug() logs will be printed to the console and saved to the log file
- Overlayed’s internal logs will be logged to the console
When to Use Debug Mode
Debug mode is useful for:
- Development environments
- Troubleshooting issues
- Understanding application flow
- Inspecting internal Overlayed behavior
Debug mode should be disabled in production environments as it can impact performance and generate large log files.
Example Usage