Documentation

Package Scope

Azkar Console adds a separate editor window and logging API. It does not remove or modify Unity's Console window. Unity-log capture and mirroring Azkar logs back to Unity are configurable, so both consoles can be used in the same project.

How Unity log capture works

Unity exposes different kinds of logs through different interfaces, so Capture Unity Logs automatically combines supported public paths. Azkar Console uses the appropriate source for the current event and suppresses overlapping copies.

• Unity's threaded log event captures editor, play-mode, and player logs promptly.
• Unity's compilation pipeline provides structured compiler warnings and errors, including file, line, and column data.
• Optional bounded Editor.log startup recovery captures eligible diagnostics written before Azkar Console initializes when LogConfig.CaptureEditorBootLogs is enabled before bootstrap.

No single path provides the same lifecycle coverage and metadata as the combined system.

Captured Unity-originated entries can include their message, severity, stack trace, and source location, but Unity's public log callback does not include the original context object. Open Unity's Console and locate the original row when you need Unity's native context behavior. Logs emitted through AzCon can carry an explicit Unity object context and expose Ping Context Object while that object remains live.

Product and API Names

Azkar Console is the product. AzCon is the API you call from code after importing using Azkar.Console;.

using Azkar.Console;
using UnityEngine;

public sealed class ConsoleExample : MonoBehaviour
{
    private void Start()
    {
        AzCon.Log("Player spawned", this);
        AzCon.Debug("Spawn debug details");
        AzCon.LogWarning("Health below threshold", AzCon.Category.Gameplay);
        AzCon.LogError("Spawn failed");
    }
}

Common Workflows

Security, Privacy, and Data Lifecycle

Treat messages, exceptions, stack traces, paths and line numbers, categories, tags, aliases, context identifiers, bookmark notes, device labels and models, platform/application/Unity versions, archives, exports, and clipboard text as potentially sensitive. Do not log passwords, API keys, tokens, credentials, private keys, personal, health, financial, or other secret data. Redact content before copying, exporting, committing, or sending it to support.

Your project is responsible for consent, access control, retention, deletion, and its legal basis. Live rows and mounted database pages use process memory; editor configuration uses namespaced EditorPrefs; runtime filter presets use PlayerPrefs; imported profile fonts, bookmarks, automatic logs, and manual exports use their documented file locations; copy actions use the operating-system clipboard. Clearing visible rows does not delete all of that persistent data.

Development-Build remote logging uses Unity PlayerConnection. Frame and peer validation does not add an independent application-layer authentication, confidentiality, or integrity guarantee. Use trusted devices and networks, and treat remote labels and log data as untrusted. A pre-freeze engineering scan of the current Azkar-owned source and locally built Azkar assemblies found no product telemetry or automatic Azkar Industries upload implementation. The final candidate must repeat that scan; this working-source result is not final-candidate evidence. Unity services, customer-controlled ILogSink integrations, and other project packages are outside that statement.

Uninstall and Complete Removal

1. Stop Play Mode and remote listening, disable built-in persistence if it was enabled at runtime, and allow active writers to close.
2. Back up profiles, themes, key binds, bookmarks, logs, databases, and exports you need.
3. Select Settings > Reset All Preferences and confirm. This stops the current remote listener, deletes the explicit allowlist of Azkar-owned settings, custom-theme, shortcut, UI shelf/layout, tool-window, editor filter-preset/recovery-backup, and runtime filter-preset preference keys, and applies defaults to the running UI. It does not scan by prefix or delete unrelated EditorPrefs or PlayerPrefs keys.
4. Remove the complete Assets/Azkar Industries/Azkar Console root and its root .meta; do not remove only selected scripts.
5. Optionally remove imported-profile fonts, bookmark files/backups, automatic logs, user-selected exports, and copied clipboard content from their separately documented locations. Those file-backed items survive Reset All Preferences.
6. Remove Burst or Collections only if no other project dependency uses them.
7. Restart Unity, verify there is no Azkar assembly, menu, writer, or diagnostic, and then verify a clean complete-package reimport if needed.

Compatibility

Azkar Console works on Unity 6 (6000.0 or newer). The distributed build's Technical Details identify the exact Unity patch and Burst/Collections combinations qualified for that release.

Explicit Unity object contexts supplied to AzCon use the version-neutral typed LogContextId and Unity's supported public object APIs. Editors exposing the public entity-identity API prefer it; other supported editors use the public instance-ID fallback. For worker-thread traces, captureAzCon.GetContextId(object) on Unity's main thread and pass it to the typed TraceContext overload. Unity-originated callback messages do not include the original context object.

Next Steps