Repository navigation
Developer options
These keys of ProLeak/config/proleak.yml apply in developer mode only (dev: true, see
Settings). They help with work on ProLeak itself and on the local
server.
| Key | Meaning |
|---|---|
capture |
Write every game to a capture file (below). |
drift_dump |
Write the game members that differ from the build at each start (below). |
authority, releases, release_key
|
Point installs and updates at local files. See Testing an install locally. |
In developer mode a recording also holds each message's decoded line.
capture: true records each game to ProLeak/captures/<date>-<time>-<game id>.jsonl, one JSON
object per line:
| Line | Holds |
|---|---|
header |
The game version, map, queue type, the local player's slot, the slot ids, the ProLeak version, whether the game ran on the local server, and the builder of each legion. |
| one per message | From the server or the client: t (milliseconds since the server's welcome), frame, tick (the client's estimate of the server clock), from (server or client), tag, subject, name and the decoded msg. |
footer |
Written when the player leaves the game, the connection ends or the game quits: the result, the highest wave and the number of lines dropped. A file without one was cut short. |
The session ticket the client sends is a credential: its line keeps an empty msg. A
thirty-wave game makes a file of about 50 MB.
Warning
Captures hold account ids and names
tools/scrub-capture.py replaces them with placeholders (P1,
name1) and can cut a tick range. Run it before sharing a capture or a slice of one.
The local server's replay tool replays captures against it outside the game and reports where
the two differ; it reads the map data that tools/extract-map.sh
extracts for the capture's game version.
drift_dump: true fingerprints every game member and message ProLeak depends on again at
startup, whatever the game files' hashes say, and writes those whose print differs from the
build's to ProLeak/logs/drift-dump.txt, each with the lines behind every hash. The check adds
about a second to startup.
tools/Fingerprints ... --dump FILE writes the same dump on .NET, and
tools/drift-diff.py prints the lines the two disagree on.
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
- Cosmetics
- Game modes
- Game updates
- Publishing plugins
Reference