Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quiltservertools/ledger
A server-side logging mod for fabric 1.17+
https://github.com/quiltservertools/ledger
fabric minecraft
Last synced: 5 days ago
JSON representation
A server-side logging mod for fabric 1.17+
- Host: GitHub
- URL: https://github.com/quiltservertools/ledger
- Owner: QuiltServerTools
- License: lgpl-3.0
- Created: 2021-03-28T19:56:12.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-05T00:26:25.000Z (about 1 month ago)
- Last Synced: 2025-01-06T09:06:42.674Z (5 days ago)
- Topics: fabric, minecraft
- Language: Kotlin
- Homepage: https://www.quiltservertools.net/Ledger/latest/
- Size: 5.28 MB
- Stars: 193
- Watchers: 12
- Forks: 51
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://discord.gg/UxHnDWr)
For a much better guide, visit our [wiki](https://quiltservertools.github.io/Ledger/latest/)
## Ledger
A world change logging tool for the Fabric modloader.
Ledger can be found on Discord at https://discord.gg/GtwDTTr3pe
### Install
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.
### Configuration
Ledger's configuration file is found at `config/ledger.toml`.
#### Message theme
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](./themes.md) file
#### Search settings
Found under `[search]`
`pageSize` [Default: 8] controls the number of actions displayed per page
#### Database settings
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
#### Filters
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"`
### Commands
#### Inspect
`/lg inspect` - toggles inspect mode
`/lg inspect [on|off]` - enables or disables inspect mode
`/lg inspect ` - inspects the block at a given position
### Search
`/lg search ` - searches with the given arguments
### Rollback
`/lg rollback ` - rollbacks with filters specified
### Page
`/lg page `
When viewing results, you can use this command to quickly skip to a certain page.
### Permissions
All Ledger commands support the LuckPerms API
The permission nodes are formatted as: `ledger.`
All Ledger commands have fallback on permission level 3 should you not wish to have a permissions mod installed.
### Contribute
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.