Archotech Diagnostics - BETA / WIP
[img]https://raw.githubusercontent.com/Archotech-Diagnostics/LogViewer/refs/heads/main/steam_images/SteamBanners01.png[/img]
[img]https://raw.githubusercontent.com/Archotech-Diagnostics/LogViewer/refs/heads/main/steam_images/SteamBanners02.png[/img]
Overview
[b]Archotech Diagnostics[/b] is a collection of tools designed to help you understand what is happening under the hood of your RimWorld game. It actually started out as a simple, small alternative to HugsLib's log sharing feature, but it has since grown into a much larger project.
The mod is built to help you figure out why your game might be loading slowly or where those frustrating red errors are coming from. It's important to keep in mind that the tool provides [b]estimates[/b]—the results can vary depending on your specific mod list and your PC specs, so it isn't always 100% right. It might not always give you a perfect answer, but it's designed to point you in the right direction when you're trying to track down a problem.
[b]Important Note:[/b] This is a [b]Diagnostic Tool[/b], not a performance-enhancing mod. While it helps you identify and understand performance bottlenecks, it does not automatically improve your game's speed or FPS on its own.
Key Features
— [b]Load Time Diagnostics:[/b] Shows the time each mod takes to load during the startup sequence.
— [b]Deep Scan (ModMapper):[/b] Scans your mod folders on-demand to estimate their overall impact and file sizes.
— [b]Enhanced Debug Log:[/b] A cleaned-up version of the game log that’s easier to read and search.
— [b]Suspect Analysis:[/b] A system that tries to identify which mod is most likely causing an error.
— [b]Performance Scanner:[/b] A simple readout of FPS, TPS, and active mod influence.
— [b]LogViewer:[/b] A powerful tool to export reports locally to your PC or as a shareable link.
Main Features Explained
— [b]Load Time Diagnostics:[/b]
This tool hooks into the internal processes RimWorld uses to load your mods. As the game starts up, it times how long it takes to process the XML files (Defs), initialize the C# code (Assemblies), and set up mod content. By measuring these steps individually, it can show you which mods are taking up the most time during the loading screen.
— [b]Deep Scan & Mod Mapping:[/b]
Not all performance issues come from code; sometimes it's about the sheer amount of data. This feature allows you to scan your mod directories to count things like textures, sounds, and XML files. It calculates an estimated "impact score" based on the total size and type of these files. Since this is just looking at files on your disk, it provides a clear estimate of the "weight" a mod adds to your game.
— [b]Suspect Analysis & Error Diagnosis:[/b]
When an error happens, it leaves behind a "stack trace"—a list of code instructions that were running at the time. This tool scans that trace for mod-specific markers, like folder names or unique code signatures. It then tries to label a "Suspect" (the mod that likely started the error) and "Accomplices" (other mods that were interacting with that code). It also attempts to translate cryptic error messages into something a bit easier to understand.
— [b]Performance Scanner:[/b]
While you are playing, this tool monitors the game's heartbeat (TPS) and frame rate (FPS). It looks at the methods being run by the game and checks if any modded patches are taking an unusual amount of time to execute. This helps you see if a specific mod is causing "stutters" or slowing down your simulation speed in real-time.
— [b]LogViewer & Sharing:[/b]
The mod features a comprehensive export system that opens a detailed report in your browser. You can choose to [b]Export Locally[/b] to your PC for private analysis or generate a [b]Shareable Link[/b] to get help from others.
[b]The LogViewer provides a comprehensive suite of diagnostic data:[/b]
- [b]Raw Game Log:[/b] The unfiltered, original game log for direct comparison.
- [b]Enhanced Game Log:[/b] A powerful interface to search, filter, and analyze every log entry with identified suspects and accomplices.
- [b]Unity Engine Log:[/b] Provides direct access to the game's internal [b]Player.log[/b] (available in Local Export mode only).
- [b]Load Time Log:[/b] Precise metrics on how long each mod takes to load and initialize.
- [b]Performance Scan Log:[/b] Historical data from active performance monitoring sessions.
- [b]AI Diagnostics:[/b] A specialized log format structured for LLM/AI diagnostics, making it much easier for AI tools to read and analyze mod problems.
- [b]DS Trace Report:[/b] A technical report focusing on log messages with low trace accuracy, used to refine diagnostic precision in the info view.
- [b]Archotech Mod List:[/b] A detailed overview of your mod list. The layout is designed to be used as a "dual site" comparison, allowing you to open two reports side-by-side to easily spot version or load order differences.
SIMPLE LOG EXPORT
If you just need a quick, easy link to share with a modder (similar to HugsLib), use the [b]Simple Export[/b] button for an instant, direct sharing link.
Quality of Life Improvements
— [b]Global Log Shortcut:[/b] Adds a small icon to the corner of your screen for quick access to the logs.
— [b]FPS & TPS Display:[/b] A simple counter at the bottom of the screen that gives you a rough idea of how smoothly the game is running.
— [b]FPS Limiter:[/b] Includes a optional FPS capper. Useful for reducing GPU load or when using external programs like Lossless Scaling.
— [b]Spam Filtering:[/b] Automatically hides repeated messages to keep your log clean. A counter is added to the trace to show exactly how many times the message was suppressed.
Mod Settings
Take full control of your diagnostic environment with a dedicated settings menu:
- [b]Interface Customization:[/b] Toggle the in-game FPS/TPS overlay and Log Shortcut icons.
- [b]Performance Tuning:[/b] Configure your preferred FPS cap for the built-in limiter.
- [b]Diagnostic Depth:[/b] Adjust Suspect Analysis sensitivity and Deep Scan parameters.
- [b]Feature Management:[/b] Manually trigger specific scan features (like ModMapper Deep Scans) or enable/disable specific diagnostic categories.
- [b]Data Management:[/b]
- [b]Open Data Folder:[/b] Quickly access the local directory where all exported reports and cached diagnostic data are stored.
- [b]Purge All Data:[/b] A complete reset option that wipes all data saved by the mod on your PC, ensuring a totally clean slate.
Technical Details
— [b]Performance Impact:[/b] The diagnostic tools are designed to have near-zero impact on your performance. Scans only run when you choose to start them, ensuring that your gameplay remains smooth and unaffected.
— [b]Heuristic Detection:[/b] We use several methods to guess which mod is causing a problem, including looking at file paths and code patterns. While it's often helpful, it's not a perfect science.
— [b]Technical Documentation:[/b] For a deeper look at the logic and math behind our detections, check out our [url=https%3A%2F%2Farchotech-diagnostics.github.io%2FLogViewer%2FArchotech_Technical_Docs.html]Technical Documentation (WIP)[/url][archotech-diagnostics.github.io].
Compatibility
The mod is designed to work with most other mods. It's safe to add or remove from your save at any time, as it doesn't modify your save files or core game data.
Translations
English.
More may come later.
Feedback & Bug Reports
I'm always looking to improve the tool! If you run into any bugs, strange behavior, or if you have suggestions for new features, I gladly take feedback in the comments or on Discord.
My other mods
[url=https://steamcommunity.com/id/kongkim82/myworkshopfiles/?appid=294100] See all my mods here [/url]
