Skip to content

Console Module

A full-featured runtime log viewer for the FludeX panel. It captures Unity log messages from all threads in real time, supports filtering and search, and lets you copy any entry to clipboard — all without connecting to the editor.

Install the package and the console appears in the FludeX panel automatically on the next run. No registration or code changes needed.

Quick Start

csharp
private void Awake()
{
    FludeX.Instance.Initialize();
}

That's all. The console module is drop-in — it self-registers via its FludexModuleDescriptor asset.

To pass a configuration, supply a ConsoleModuleConfiguration to Initialize(). Every property is optional — omit any of them to keep its built-in default:

csharp
private void Awake()
{
    FludeX.Instance.Initialize(new ConsoleModuleConfiguration
    {
        TagColors = new Dictionary<string, Color32>
        {
            ["UI"]   = new Color32(0, 200, 255, 255),
            ["PERF"] = new Color32(255, 210, 0, 255)
        },
        TagFormat = new ConsoleTagFormat("[", "]", ":"),
        Timestamp = new ConsoleTimestampConfiguration
        {
            Mode             = TimeDisplayMode.DeviceTime,
            ShowMilliseconds = true,
            ShowInList       = false
        },
        DefaultRules = new[]
        {
            new FludexConsoleAlertRule(
                Id: "uncaught-exceptions",
                Name: "Uncaught Exceptions",
                Severity: AlertSeverity.Exception,
                TextPattern: "Exception",
                IsEnabled: true)
        }
    });
}

Features

FeatureDetails
Real-time log captureReceives logs from any thread the moment they are emitted
Log levelsInfo, Warning, and Error — each with a toggle and a live count badge. See Filtering
CollapseGroups consecutive identical logs into a single entry with a repeat counter. See Filtering
SearchCase-insensitive filter across all log messages, plus tag and AND qualifiers. See Filtering
ClearWipes the full log history and resets all state. See Filtering
AlertingDefine rules that match logs by severity and pattern, with a toast notification on each hit. See Alerting
Configurable historyRing buffer capacity from 100 to 10,000 entries, persisted across sessions; a window label shows the visible range when the buffer wraps
Long press to copyHold any log entry on mobile to copy it; a progress indicator fills while holding. See Sharing
Detail viewTap a log to open the detail pane with the full message and stack trace; tap the pane to reveal the actions menu. See Detailed View
Keyboard shortcutSelect a log and press Ctrl+C (Windows / Linux) or Cmd+C (Mac) to copy. See Sharing
Auto-scrollFollows new logs automatically; disabled on selection or manual scroll, with a floating button to jump back to the bottom
TagsLog messages prefixed with [TAG]: are parsed and shown as color-coded chips in the log list and detail view. See Tags
Multiple tags per messageStack tags before the message — e.g. [UI][PERF]: rendering took 12ms — each rendered as its own chip. See Tags
Per-tag color overridesAssign custom colors to individual tag names via ConsoleModuleConfiguration.TagColors. See Tags
Custom tag formatConfigurable tag prefix, suffix, and separator via ConsoleModuleConfiguration.TagFormat. See Tags
Configurable timestampDetail pane and optional history list show game time or device time, with optional milliseconds. See Detailed View

Configuration

The Console module implements IConfigurableModule, so a settings button appears in the app bar when the console is active. Tap it to open the configuration tray.

Runtime settings (adjustable from the tray):

  • History buffer size (100 – 10,000 entries)
  • Timestamp source — game time or device time
  • Milliseconds display in timestamps

Code-only settings (set via ConsoleModuleConfiguration passed to Initialize(), all optional):

  • TagColorsIReadOnlyDictionary<string, Color32> mapping tag names to custom colors. See Tags
  • TagFormatConsoleTagFormat struct (TagPrefix, TagSuffix, EndSeparator) controlling how tags are parsed from log messages. See Tags
  • TimestampConsoleTimestampConfiguration with Mode, ShowMilliseconds, and ShowInList; each is applied only if the player has no saved preference yet (first launch). See Detailed View
  • DefaultRules — starter list of FludexConsoleAlertRules, seeded only on first launch — never overwrites rules the player has since created, edited, or removed. See Alerting

Requirements

  • Unity 2022.3 or later
  • com.nakuru.fludex 1.3.0

Installation

Available on the Unity Asset Store.

Samples

Import via Package Manager → FludeX Console Module → Samples tab.

#SampleWhat it covers
01ConsoleShowcaseFires random Debug.Log, LogWarning, and LogError messages on start and at a configurable interval