For a much better guide, visit our wiki
A world change logging tool for the Fabric modloader.
Ledger can be found on Discord at https://discord.gg/GtwDTTr3pe
Put Ledger in your mods folder along with Fabric API and fabric-language-kotlin. When you launch your server, the config file will be created automatically.
Ledger's configuration file is found at config/ledger.toml.
Found under [color]
Ledger allows for the customisation of the colors used in the messages sent in game. By default, Ledger uses the blue theme. More themes can be found in the themes file
Found under [search]
pageSize [Default: 8] controls the number of actions displayed per page
Found under [database]
maxQueueSize [Default: 50] is the number of items logged before writing to the database
queueTimeoutSec [Default: 5] is the maximum amount of time to wait for the queue to fill before writing
These allow you to control what is and is not logged
Found under [actions]
All listed here are arrays and are formatted like so:
array = []
blocks = ["minecraft:air", "minecraft:dirt"]
typeBlacklist [Default: empty] controls what action types are logged. Hover over the action in a chat message to see the type
worldBlacklist [Default: empty] controls in which dimensions events are logged. Provide
objectBlacklist [Default: empty] controls which objects are logged. These can be item types, block types or entities
sourceBlacklist [Default: empty] controls which sources are logged. Examples are "lava" and "gravity"
/lg inspect - toggles inspect mode
/lg inspect [on|off] - enables or disables inspect mode
/lg inspect <pos> - inspects the block at a given position
/lg search <args> - searches with the given arguments
/lg rollback <args> - rollbacks with filters specified
/lg page <index>
When viewing results, you can use this command to quickly skip to a certain page.
All Ledger commands support the LuckPerms API
The permission nodes are formatted as: ledger.<command>
All Ledger commands have fallback on permission level 3 should you not wish to have a permissions mod installed.
Ledger is written in Kotlin, and therefore all contributions should be in Kotlin where possible. The exceptions to this are mixins, which must be written in Java.