Check out our latest project ✨ OpenChapter.io: free ebooks the way its meant to be 📖

CLog

An asset by anchork
The page banner background of a mountain and forest
CLog hero image

Quick Information

0 ratings
CLog icon image
anchork
CLog

v1.0.6:Improved to display timer output.CLog is a simple logging utility for Godot 4.It provides enhanced console output with support for source code links, colors, and performance timers.────────────────────────Compatibility────────────────────────Supports Godot 4.5 or later.────────────────────────Features────────────────────────* Source Navigation Clicking on a log entry in the console will take you directly to the source code.* Rich Text Output Supports colored logs and text formatting.* Performance Timers Measure execution time with starting, ending, and canceling timers.Note:Source navigation is implemented using a workaround.If navigation stops working, try restarting the plugin or the editor.In IDEs such as VS Code, you can jump to the source code by usingCtrl + Click on the file path.VS Code Display Example:(media/vscode_demo.png)────────────────────────Usage────────────────────────Standard OutputLogs a simple message to the console.```gdscriptCLog.o("Some message")CLog.o("Value A:", 100, "Value B:", true)```────────────────────────Error LoggingLogs an error message with a highlighted style.```gdscriptCLog.e("An error occurred")```────────────────────────Warning LoggingLogs a warning message.```gdscriptCLog.w("This is a warning")```Both CLog.e and CLog.w internally call push_error() and push_warning() respectively.This ensures they appear in Godot’s Debugger panel and are recorded in the built-in engine logs.────────────────────────Custom Color OutputLogs a message using a specific color.```gdscriptCLog.c(Color.ORANGE, "Custom orange message")```────────────────────────Once (log once by key)Logs a message only once for a specific unique key.This is useful for logging inside _process() or loops without flooding the console.```gdscriptfunc _process(_delta: float): # This will be printed only once for the key &"start_processing" CLog.once(&"start_processing", "Process loop started")```────────────────────────Performance TimersMeasure how long a specific process takes.```gdscript# Start a timervar id = CLog.timer_start("Process Name")# End the timer and print elapsed timeCLog.timer_end(id)# Cancel the timer without printingCLog.timer_cancel(id)```────────────────────────Release Mode LoggingBy default, CLog suppresses output in release builds for performance and security.This behavior can be toggled using the disable_output_on_release_mode property.```gdscript# Enable logging even in release modeCLog.disable_output_on_release_mode = false```

Supported Engine Version
4.5
Version String
1.0.6
License Version
MIT
Support Level
community
Modified Date
6 hours ago
Git URL
Issue URL

CLog for Godot 4

README Godot Demo

CLog is a simple logging utility for Godot 4. It provides enhanced console output with support for source code links, colors, and performance timers.

Compatibility

Supports Godot 4.5 or later.

Features

  • Source Navigation: Clicking on a log entry in the console will take you directly to the source code.
  • Rich Text Output: Supports colored logs and formatting.
  • Performance Timers: Measure execution time with starting, ending, and canceling timers.

Note: Source navigation is implemented using a workaround. If navigation stops working, please try restarting the plugin or the editor.

In IDEs such as VS Code or JetBrains, you can jump to the source code by using Ctrl + Click on the file path.

VS Code Display Example: README VS Code Demo

Usage

Standard Output

Logs a simple message to the console.

CLog.o("Some message")
CLog.o("Value A:", 100, "Value B:", true)

Error Logging

Logs an error message with a highlighted style.

CLog.e("An error occurred")

Warning Logging

Logs a warning message.

CLog.w("This is a warning")

Both CLog.e and CLog.w internally call push_error() and push_warning() respectively. This ensures they appear in Godot's Debugger panel and are recorded in the built-in engine logs.

Custom Color Output

Logs a message using a specific color.

CLog.c(Color.ORANGE, "Custom orange message")

Once (Log once by key)

Logs a message only once for a specific unique key. This is ideal for logging events inside _process() or loops without flooding the console.

func _process(_delta: float):
    # This will be printed only once for the key &"start_processing"
    CLog.once(&"start_processing", "Process loop started")

Performance Timers

Measure how long a specific process takes.

# Start a timer
var id = CLog.timer_start("Process Name")

# End the timer and print elapsed time
CLog.timer_end(id)

# Cancel the timer without printing
CLog.timer_cancel(id)

Release Mode Logging

By default, CLog suppresses output in release builds for performance and security. You can toggle this behavior using the disable_output_on_release_mode property.

# Enable logging even in release mode
CLog.disable_output_on_release_mode = false

This README was generated with the assistance of AI.

v1.0.6:
Improved to display timer output.

CLog is a simple logging utility for Godot 4.
It provides enhanced console output with support for source code links, colors, and performance timers.

────────────────────────
Compatibility
────────────────────────
Supports Godot 4.5 or later.

────────────────────────
Features
────────────────────────

* Source Navigation
Clicking on a log entry in the console will take you directly to the source code.

* Rich Text Output
Supports colored logs and text formatting.

* Performance Timers
Measure execution time with starting, ending, and canceling timers.

Note:
Source navigation is implemented using a workaround.
If navigation stops working, try restarting the plugin or the editor.

In IDEs such as VS Code, you can jump to the source code by using
Ctrl + Click on the file path.

VS Code Display Example:
(media/vscode_demo.png)

────────────────────────
Usage
────────────────────────

Standard Output
Logs a simple message to the console.

```gdscript
CLog.o("Some message")
CLog.o("Value A:", 100, "Value B:", true)
```

────────────────────────

Error Logging
Logs an error message with a highlighted style.

```gdscript
CLog.e("An error occurred")
```

────────────────────────

Warning Logging
Logs a warning message.

```gdscript
CLog.w("This is a warning")
```

Both CLog.e and CLog.w internally call push_error() and push_warning() respectively.
This ensures they appear in Godot’s Debugger panel and are recorded in the built-in engine logs.

────────────────────────

Custom Color Output
Logs a message using a specific color.

```gdscript
CLog.c(Color.ORANGE, "Custom orange message")
```

────────────────────────

Once (log once by key)
Logs a message only once for a specific unique key.
This is useful for logging inside _process() or loops without flooding the console.

```gdscript
func _process(_delta: float):
# This will be printed only once for the key &"start_processing"
CLog.once(&"start_processing", "Process loop started")
```

────────────────────────

Performance Timers
Measure how long a specific process takes.

```gdscript
# Start a timer
var id = CLog.timer_start("Process Name")

# End the timer and print elapsed time
CLog.timer_end(id)

# Cancel the timer without printing
CLog.timer_cancel(id)
```

────────────────────────

Release Mode Logging
By default, CLog suppresses output in release builds for performance and security.
This behavior can be toggled using the disable_output_on_release_mode property.

```gdscript
# Enable logging even in release mode
CLog.disable_output_on_release_mode = false
```

Reviews

0 ratings

Your Rating

Headline must be at least 3 characters but not more than 50
Review must be at least 5 characters but not more than 500
Please sign in to add a review

Quick Information

0 ratings
CLog icon image
anchork
CLog

v1.0.6:Improved to display timer output.CLog is a simple logging utility for Godot 4.It provides enhanced console output with support for source code links, colors, and performance timers.────────────────────────Compatibility────────────────────────Supports Godot 4.5 or later.────────────────────────Features────────────────────────* Source Navigation Clicking on a log entry in the console will take you directly to the source code.* Rich Text Output Supports colored logs and text formatting.* Performance Timers Measure execution time with starting, ending, and canceling timers.Note:Source navigation is implemented using a workaround.If navigation stops working, try restarting the plugin or the editor.In IDEs such as VS Code, you can jump to the source code by usingCtrl + Click on the file path.VS Code Display Example:(media/vscode_demo.png)────────────────────────Usage────────────────────────Standard OutputLogs a simple message to the console.```gdscriptCLog.o("Some message")CLog.o("Value A:", 100, "Value B:", true)```────────────────────────Error LoggingLogs an error message with a highlighted style.```gdscriptCLog.e("An error occurred")```────────────────────────Warning LoggingLogs a warning message.```gdscriptCLog.w("This is a warning")```Both CLog.e and CLog.w internally call push_error() and push_warning() respectively.This ensures they appear in Godot’s Debugger panel and are recorded in the built-in engine logs.────────────────────────Custom Color OutputLogs a message using a specific color.```gdscriptCLog.c(Color.ORANGE, "Custom orange message")```────────────────────────Once (log once by key)Logs a message only once for a specific unique key.This is useful for logging inside _process() or loops without flooding the console.```gdscriptfunc _process(_delta: float): # This will be printed only once for the key &"start_processing" CLog.once(&"start_processing", "Process loop started")```────────────────────────Performance TimersMeasure how long a specific process takes.```gdscript# Start a timervar id = CLog.timer_start("Process Name")# End the timer and print elapsed timeCLog.timer_end(id)# Cancel the timer without printingCLog.timer_cancel(id)```────────────────────────Release Mode LoggingBy default, CLog suppresses output in release builds for performance and security.This behavior can be toggled using the disable_output_on_release_mode property.```gdscript# Enable logging even in release modeCLog.disable_output_on_release_mode = false```

Supported Engine Version
4.5
Version String
1.0.6
License Version
MIT
Support Level
community
Modified Date
6 hours ago
Git URL
Issue URL

Open Source

Released under the AGPLv3 license

Plug and Play

Browse assets directly from Godot

Community Driven

Created by developers for developers