Repository navigation
Troubleshooting
Contents
| Where | What |
|---|---|
BepInEx/LogOutput.log |
Everything: BepInEx, the core (ProLeak/core) and every plugin (ProLeak/<id>). |
ProLeak/logs/core.log |
The core alone. |
ProLeak/logs/<id>.log |
One plugin. Files rotate at 5 MB, and three old files are kept. |
| Mods menu, Logs tab | The last 200 lines, in the game. |
ProLeak failed to start; the game runs unmodified.
ProLeak hit an error while starting and switched itself off: the game runs without ProLeak and
its plugins. The rest of the line is the error. If it names ProLeak/python or a missing
Python file, run the installer again.
The Mods menu shows each plugin's state, with a reason for every state except loaded.
| State | Meaning | What to do |
|---|---|---|
loaded |
Running. | |
disabled |
Switched off in the Mods menu (saved in config/proleak.yml). |
Enable it in the Mods menu. |
refused |
plugin.yml is missing or invalid, the entry file is missing, a dependency did not load, or the module name collides with another plugin. |
Fix what the reason names. |
unavailable |
The plugin's proleak: range excludes this version of ProLeak. |
Update the plugin or ProLeak. |
faulted |
on_load failed, handlers ran past their budget three times within 10 s, or the plugin raised five errors within 10 s. |
Read the traceback in the plugin's log, then reload it. |
| Message | Meaning |
|---|---|
the plugin registry could not be reached |
GitHub did not answer. Installed plugins keep running; the Browse tab lists nothing until the next start. |
needs ProLeak >=x.y |
The release's proleak: range excludes this ProLeak version. Update ProLeak first. |
tag vX does not match plugin.yml Y |
The plugin's author tagged the release wrongly. Nothing was installed. |
a plugin with the id X is already installed by hand |
Remove ProLeak/plugins/<id> to install the registry version. |
Install failed: ... in the Browse tab |
The download failed or the release was refused. Nothing was installed. |
Update failed: ... on a plugin |
The download failed or the release was refused, and nothing changed; or the new version did not load, and the previous version was put back and loaded again. The text after the colon says which. |
SHA256SUMS does not carry a valid signature from a ProLeak release key |
The release was not signed with a ProLeak release key. Nothing was installed or changed. |
this ProLeak build has no release key to check updates with |
This copy of ProLeak cannot check signatures. Run the installer to update. |
checksum mismatch on a ProLeak update |
The download was damaged or altered. Nothing changed; try again later. |
a ProLeak update was interrupted; the previous version was restored; restart the game to run it |
The game closed while files were being replaced. This start put the previous version back and left ProLeak off for the session; the next start runs it. |
built for game 26.10a, running 26.10b; 3 changed, 0 missing (checked in 410 ms)
changed: method Assets.Api.HudApi::TryHireUnit(System.Int16,System.String):System.Boolean (actions.hire): its code or signature changed
The game updated after this ProLeak was built. At start ProLeak checks every part of the game it
uses, and switches off only the features that depend on a part that changed (an event, a
player action, the recorder, and so on). The rest works as usual.
Mods > Advanced > Game version lists each feature that is off and why.
| State | Meaning |
|---|---|
| changed | Off. Run anyway turns it back on, at each start too, until the game no longer changes it; it may misbehave. |
| missing | Off. The game no longer has something it needs, so it cannot run. |
| failed | Off until the game restarts: it hit an error, and the log has it. |
| running anyway | Turned back on. Each start says so in a toast. |
If the game crashes while features run anyway, the next start leaves them off and says so; Run anyway turns them back on.
When the game's UI itself changed, the Game version panel cannot open. Write the parts to run
anyway in ProLeak/config/run-anyway.json:
{"features": ["ui"]}The recorder is the exception: if the game changed how it logs in, recording stays off and cannot be run anyway, so a recording never holds your login.
the server sent X (2, 371), which ProLeak does not know means the server sends a message this
ProLeak was not built for. the game left 4 bytes of X unread means a message's format changed;
recordings that hold it do not play back. A ProLeak release built for the new game version
fixes all of these.
Using ProLeak
Features
Tutorial
- Your first plugin
- Plugin basics
- Handling events
- Plugin settings
- User interface
- Players, units and game data
- Purchases, signals and pings
- Chat, camera, input and more
- Game assets
- Game modes
- Game updates
- Publishing plugins
Reference