beasty-debug-logger / guides / beasty-integration.md

Working with the other Beasty packages

How Beasty Visual Novel and Beasty Save System use this logger. Read this if you own more than one of them; if you own only the logger, you can skip it.

Each package is sold and imported on its own, and each works on its own. Nothing here is a dependency you have to satisfy.

Beasty Visual Novel

Beasty Visual Novel references this logger directly and logs through its own facade, VNLog. The facade adds three things on top of the API:

  • a [BeastyVN] tag on every message, so you can find them with the console’s search field;
  • per-system channels — data, director, stage, streaming, save and verbose — each with its own switch, so you can silence a noisy area without touching call sites;
  • its own master switch, which is on in the editor and in a development build, and off in a release build by default. A shipped novel does not write a line for every dialogue line the player advances.

VNLog sits on top of BeastyDebugLogger, so IsEnabled still applies: switching the logger off silences the VN too.

Beasty Save System

Beasty Save System does not reference this logger. It looks for it by reflection when it first logs something:

  • if the logger is in your project, the save system routes its messages through it, and they arrive in the Beasty Console classified and coloured;
  • if it is not, the save system logs through UnityEngine.Debug.

That is why both assets ship independently. You never have to install one to use the other.

Warning One consequence to know about. With the logger present, the save system’s warnings are routed to LogCaution — which is a soft alert and, to Unity, a normal log. So save-system warnings stop appearing as warnings in Unity’s own Console, and they do not trip Error Pause. They are still there, under the Caution filter in the Beasty Console. Errors are unaffected: they remain Unity errors.

If you would rather keep the save system’s warnings as Unity warnings, assign your own log sink on the save system’s logging facade and route them where you want.

See also