§3. Configuration

3.1. Plugin configuration

All of Tracel's settings live in one file: config.toml. Most servers never need to change it. The first-run wizard already picked sensible values for how long to keep history and how safe saving is.

Tip

If you're not sure what a setting does, leave it alone. The defaults work well on most servers.

Note

Restart the server after you edit the file. Turning off a kind of logging needs a restart, and history that was already recorded stays where it is.

3.1.1. Logging

Option	Default	Records
blocks	true	Placing, breaking, growth, fluids, fire, explosions and everything blocks do
items	true	Item and container movement, crafting, drops
events	true	Chat, commands, joins and leaves, deaths, shots
entities	true	Entity spawns, removals and changes
entity-damage	true	Damage dealt to entities and players
worldedit	true	WorldEdit / FastAsyncWorldEdit edits, when installed

For example, a creative-plot server may turn events off; a survival server almost never turns anything off.

3.1.2. Rollback

Option	Default	Meaning
entity-restore-limit	256	Most entities a rollback restores without #confirm. 0 = always ask, "unlimited" = never ask
max-radius	256	Widest s: a rollback may use, in blocks. "unlimited" removes the cap. Lookups are separately capped at 1024
min-tick-time	"5ms"	How long a rollback may work in one tick when the server is busy
max-tick-time	"35ms"	...and when it's idle

3.1.3. Purge

Option	Default	Meaning
auto-purge	false	Delete old history automatically
interval	"90d"	How often it looks (minimum ten minutes)
keep-blocks	"90d"	Block and entity history is kept this long
keep-items	"90d"	Item movements
keep-containers	"90d"	What containers held
keep-events	"90d"	Chat, commands, sessions, deaths

Use "forever" to keep a kind. A sensible mix:

[purge]
auto-purge = true
interval = "1d"
keep-blocks = "180d"
keep-items = "60d"
keep-containers = "30d"
keep-events = "14d"

/tracel status shows when it last ran. See purge for the manual command.

3.1.4. Paste

Where /tracel lookup uploads results.

[paste]
paste-url = "https://privatebin.net"
paste-expire = "3day"
paste-burn = false

paste-burn = true deletes a paste after it is first read.

3.1.5. Updates

[updates]
check = true

check = true checks for newer Tracel version.

3.1.6. Advanced

Leave these alone unless you have a reason.

Option	Default	What it does	Recommendation
sync	"every-batch"	How often history is saved to disk: • "every-batch": every change. Safest, nothing is lost in a crash • A time, like "1s": saves at most once per second. A crash can lose that last second • "never": not for real servers	Keep "every-batch". Use "1s" only if the disk is clearly the bottleneck and losing about a second of history is acceptable. Never use "never" on a live server
memtable-size	"16MiB"	How much history is held in memory before it is written to disk. Bigger means fewer writes, but more memory	Keep the default. Change it only if memory is plentiful and writes cause lag. Don't go below the default
max-pending-flushes	3	How many full memory batches can wait to be written. Higher handles short slow-disk moments better, but uses more memory	Keep the default. Raise it only if the server stutters on large writes or disk spikes
capture-ring-slots	65536	How many events can wait in the queue during a burst. Must be a power of two, like 65536 or 131072	Keep the default. Double it only if status shows a backlog during bursts such as TNT parties

3.2. Messages

Every message Tracel sends is in a language file. To reword one, create plugins/Tracel/lang/en.json with only the keys you want to change; the rest comes from the built-in text.

{
  "help": { "about": "<gray>The all-seeing eye</gray>" },
  "lookup": { "no_matches": "Nothing. Suspicious" }
}

Texts use MiniMessage, so <red>, <gradient> and <hover> all work. A broken file is reported in the console and the built-in texts are used instead.

3.3. Presets

Presets stored in plugins/Tracel/presets.toml. You normally manage it with /tracel preset rather than by hand, but you can always do that by hand.

3.4. Permissions

Permission	Default.	Lets you
tracel.inspect	Everyone	Use /tracel inspect
tracel.near	Everyone	Use /tracel near
tracel.preset	Everyone	Use /tracel preset
tracel.preset.global	Operator	Use /tracel preset share
tracel.lookup	Operator	Use /tracel lookup, near, player, and teleport to results
tracel.player	Operator	Use /tracel player
tracel.rollback	Operator	Use /tracel rollback and /tracel rollback undo
tracel.status	Operator	Use /tracel status
tracel.data	Operator	Use /tracel data ...