WebSlog
A simple WebSocket Server which forwards BepInEx log output to connected websocket clients
About this mod Author’s original text
WebSlog
A ProtoBuf powered WebSocket Log forwarder for BepInEx
This is a patcher time mod for BepInEx which provides a simple WebSocket Server that forward's
bepinex log messages to connected WebSockets on the local machine.
This is primarily intended to provide the ability to create alternative log display systems for bepinex.
WebSlog forwards messages over Websockets using protobuf-net, an implementation of Google's Protobuf.
The protobuf definition for log messages is as follows;
[ProtoContract]
public class LogEntry
{
[ProtoMember(1)]
public string Source { get; internal set; }
[ProtoMember(2)]
public string Level { get; internal set; }
[ProtoMember(3)]
public int LevelCode { get; internal set; }
[ProtoMember(4)]
public string Data { get; internal set; }
}
Change Log
3.0.2 / 3.0.3 / 3.0.4
- Update this description to fix formatting errors
3.0.1
- Update README.md with change log and protobuf definition
3.0.0
- Migrate to using Protobuf for websocket protocol
2.2.2
- Attempt to use Newtonsoft because Manual json is error prone and I'm stupid for trying it.
2.2.1
- Fix manual JSON setup
2.2.0
- Migrate off JsonUtility due to compatibility issues, implement simple manual JSON.
2.1.0
- Migrate to using JsonUtiliy
1.1.0
- Cache logs and forward cached logs to clients upon connect
1.0.0
- Initial Release
Install & use Install: BepInEx plugin
- The archive from playbuff is the mod itself — usually a BepInEx plugin (a .dll or a plugin folder once unzipped).
- Recommended: use a community mod manager (such as r2modman) — pick this game, import the mod, and the manager sets up BepInEx and its dependencies for you.
- Manual route: install the BepInEx loader in the game folder, then drop the unzipped .dll or plugin folder into BepInEx/plugins/.
- Launch the game — the BepInEx console logs every plugin it loads; seeing this mod in the log means it is installed.
Mods with listed dependencies need those installed too, or they will not load. Options are usually changed in-game or in the plugin's config file.
Install these first, or the mod will not work: