Settings

Settings

ProLeak keeps its settings in ProLeak/config/proleak.yml, in the game folder. The Mods menu changes the common ones: recording, the event stream and which plugins are disabled. The others are edited in the file, which ProLeak reads as the game starts, so a change applies after a restart.

Each plugin keeps its own settings in ProLeak/config/<id>.yml, changed from the plugin's Settings button in the Mods menu (see Plugin settings).

A small proleak.yml looks like this:

record: true
stream: false
disabled: [my.wave-toast]

A value of the wrong type falls back to that key's default, with a warning in the log, and the rest of the file still applies. An unknown key is ignored with a warning.

Contents

• General
• Event stream
• Plugin time limits
• Developer mode

General

Key	Default	Meaning
record	false	Record every game. See Replay your games.
stream	false	Start the event stream with the game. See Stream events.
chat_prefix	"!"	The prefix of chat commands: 1 to 3 characters, without spaces.
disabled	[]	Plugin ids that stay unloaded. Disable in the Mods menu adds to it.
run_anyway	[]	Parts of ProLeak to run on a game version they were not built for. Mods > Advanced > Game version sets it. See Troubleshooting.

Event stream

Key	Default	Meaning
stream_port	47600	The stream's port on 127.0.0.1, from 1024 to 65535.
stream_origins	[]	Browser pages allowed to connect to the stream.
stream_token	made at first start	The stream's token. Mods > Advanced > New token replaces it.

Plugin time limits

A plugin that takes too long in a handler or while loading is unloaded (see Plugin basics). budgets raises those limits for one plugin, by its id:

budgets:
  my.wave-toast: {handler_ms: 100, load_ms: 5000}

Field	Default	Limit on
handler_ms	50	Each event handler, UI callback and timer, in milliseconds.
load_ms	2000	Loading and unloading the plugin, in milliseconds.

Raise a limit only for a plugin you trust: a handler that takes 100 ms stalls the game for 100 ms each time it runs.

Developer mode

dev: true turns on developer mode:

• a plugin reloads when a file in its folder changes;
• the Solo & Co-op screen shows the cards that start local games, and the local_* keys set them up;
• the developer options apply.

---

Previous: Installing | Next: Plugin permissions