You are viewing a potentially older version of this package. View all versions.
CatLib-CrashWatcher-1.0.0 icon

CrashWatcher

The crash window of CatLib: a small Windows program that waits for the game to close and, if it crashed or froze, shows what happened and keeps a report. Comes with CatLib.

Date uploaded 18 hours ago
Version 1.0.0
Download link CatLib-CrashWatcher-1.0.0.zip
Downloads 15
Dependency string CatLib-CrashWatcher-1.0.0

README

CatLib Crash Watcher

The crash window of CatLib. You don't need to install it yourself: it comes with CatLib.

When Cat Mail Co. closes by itself or freezes while quitting, a small window tells you what happened in your language and keeps a report folder with everything a mod author needs to fix it. Send that folder with your bug report.

What it does

  • Starts together with the game and waits for it to close. On a normal quit it closes too and leaves nothing behind.
  • After a crash it shows a small window: what happened in one line, the details, and buttons to open the report folder or copy the report.
  • Keeps the report in BepInEx/CatLib/Crashes: the report, both game logs and a memory dump of the moment of the crash. Only the last 10 reports are kept, dumps only in the last 3.
  • Notices when the game hangs while quitting and says so in the report.

What it doesn't do

  • It sends nothing anywhere. The report stays on your computer until you attach it yourself.
  • It doesn't change the game. To write a memory dump it follows the game the way a debugger does, which pauses the game only for the moment of writing.

It is a separate Windows program, CatLib.CrashWatcher.exe, because a program can't report its own crash reliably from the inside. Source code: tools/CatLib.CrashWatcher, how it works: Crash reports.

Settings

Settings → Mods → CatLib:

  • Crash window: turn the whole thing off.
  • Crash dump: keep the window and the report, but without the memory dump.

Found a bug?

Report it on GitHub. If the crash window itself misbehaved, attach BepInEx/CatLib/Crashes/watcher.log too.

CHANGELOG

Changelog

1.0.0

  • A package of its own. Until now the crash watcher came inside CatLib (0.6.0 and 0.6.1); CatLib 0.6.2 and later depend on this package and find the program in any folder of BepInEx/plugins.
  • The crash window in every language of the game, with a different cozy phrase every time, the details, and buttons to open the report folder and to copy the report.
  • A report folder in BepInEx/CatLib/Crashes for every crash: the report for mod authors, both game logs, the recorded session and a memory dump.
  • Memory dumps of the moment of the crash, also for crashes that Unity closes itself on the game thread.
  • A hang while quitting is noticed after 8 seconds, with a dump of every thread at that moment.
  • The report names its own version and warns when CatLib records more than this version can read.