Skip to content

LogCheck README

Understand Unreal errors faster. LogCheck is a local, editor-only Unreal Engine plugin that turns large output and packaging logs into a short, reviewable summary: a detected outcome, a single explainable Primary Diagnosis, ranked root causes, grouped evidence, and the significant messages no rule recognised. It runs entirely on your machine — no uploads, no telemetry, no automatic changes to your project.

LogCheck Summary showing the Primary Diagnosis and analysis result

Key features

  • Seven input workflows plus drag-and-drop, with encoding and session detection.
  • Thirteen parser families and deterministic, local analysis.
  • A single Primary Diagnosis, ranked alternatives, and Root Causes with causal chains.
  • A searchable, filterable Diagnostics workspace and a virtualized Raw Log.
  • Unknown Issues for significant messages no rule matched.
  • Local, project-scoped History, Baselines, and Comparison.
  • Safe, declarative Custom Rules with fixtures, validation, and import/export.
  • Reports & Export to Markdown, HTML, JSON, CSV, PDF, and support-package ZIP — each with a checksum.
  • A Privacy Review step with deterministic redaction profiles.
  • A responsive editor UI with a dedicated LogCheck icon.

Built-in coverage

170 built-in production rules across 17 built-in packs, covering packaging, cook, AutomationTool, staging, containers, platform SDKs, C++/Clang/linker/UBT/UHT, Blueprint, plugins/modules, assets, shaders, crashes, and environment/DDC. Custom rules you add are always counted separately.

Compatibility

Unreal Engine 5.5, 5.6, 5.7, and 5.8. UE 5.8.1 is the primary environment used for final validation. LogCheck is an editor-only C++ plugin validated for Windows desktop editor use.

Installation

  1. Copy the LogCheck folder into YourProject/Plugins/LogCheck.
  2. If your project is Blueprint-only, convert it to a C++ project first.
  3. Generate project files if needed, then build the project (or let the editor compile the plugin on launch).
  4. Launch the Unreal Editor and rebuild modules if prompted.
  5. Confirm LogCheck is enabled under Edit → Plugins (category ECal Studios).

If you move the plugin between engine versions, delete its Binaries and Intermediate folders and let it recompile. Do not reuse binaries across engine versions.

Open LogCheck

Tools → ECal Studios → LogCheck

First analysis

  1. Open LogCheck.
  2. On Start, choose a source — for a quick tour, Load Synthetic Sample.
  3. Leave Analysis Mode on Auto Detect and select Analyze Log.
  4. Read the Outcome and Primary Diagnosis on the Summary page.
  5. Open the evidence, review any Unknown Issues, and export a report when useful.

Documentation

  • Overview — what LogCheck is and how it works.
  • User Manual — the complete guide to every page and workflow.
  • Changelog — the v1.0.0 release notes.

Privacy and safety

LogCheck works locally. It does not upload your logs, use telemetry, or modify your project, and it never applies fixes automatically. Diagnoses are advisory, ranking scores are not probabilities, and redaction is an advisory aid — always review an export before sharing it.

Support

[email protected]
https://www.ecalstudios.com

LogCheck is developed by ECal Studios.