Configuration

Configuration

Rivet separates feature switches, behavior settings, and generated state. This makes it clear which files are safe to edit and which changes need a restart.

Directory layout

plugins/Rivet/
|-- config.yml
|-- modules.yml
|-- settings/
|   |-- one file for each substantial module
|   |-- gameplay.yml
|   `-- teleports.yml
`-- data/
    `-- generated runtime state

Global settings

config.yml contains presentation switches shared by several features:

effects:
  titles: true
  sounds: true
  particles: true

The other values in this file are internal migration markers. Do not change them.

Modules

modules.yml enables or disables substantial features. Every value must be the Boolean true or false. Restart the server after changing a module.

Module	Default	Controls
afk	On	Manual and automatic AFK state
announcements	Off	Scheduled broadcasts
backpacks	Off	Persistent personal storage
breeders	On	Auto Breeder recipes, storage, breeding, and holograms
chat	On	Chat, /me, private messages, ignore, social spy, and chat colours
creeper-restoration	On	Creeper crater snapshots and Restoration Cores
daily	Off	Daily and streak rewards
egg-capture	On	Capturing supported mobs with thrown eggs
environment	On	Time and weather commands
filter	On	Persistent pickup filters
graves	On	Death graves, death locations, and /back
help	On	Permission-aware /help pages
holograms	On	Persistent text, item, and block displays
homes	On	Named player homes
inventory	Off	Inventory administration and item editing
join-leave	On	Join, leave, first-join, title, and MOTD content
kits	Off	Configured kits and persistent kit cooldowns
lagg	On	Scheduled ground-item cleanup
mob-heads	On	Mob-head drops and player heads
near	Off	Nearby-player search
nicknames	On	Persistent nicknames
permissions	Off	Rivet's optional local permission provider
poses	Off	Sitting, laying, and crawling
rtp	Off	Safe random teleport
spawn	On	Rivet's server spawn and join spawning
staff	Off	Staff movement, moderation, and monitoring tools
statistics	On	Statistics, playtime, and last-seen information
tpa	Off	Player teleport requests
trash	On	Disposable inventory
tree-feller	On	Tree felling and vein mining
utilities	On	Portable interfaces, list, ping, jump, and ride
villager-reroll	On	Villager reroll trade
warps	On	Public warps
worlds	Off	Test worlds and world tools

Disabled modules do not start listeners, recipes, or scheduled work. Their declared commands remain visible to Paper but return a disabled-feature message.

Settings files

File	Main purpose
afk.yml	Automatic AFK time, sleep exclusion, indicator, and messages
announcements.yml	Interval, empty-server behavior, sound, and named broadcasts
backpacks.yml	Rows, title, blocked worlds, and messages
breeders.yml	Collection, display, inventory, activation effects, and messages
chat.yml	Chat, /me, private messages, colours, social spy, and ignore messages
creeper-restoration.yml	Core item, crater restoration, debris, sounds, particles, and messages
daily.yml	Claim window, streaks, rewards, milestones, and messages
egg-capture.yml	Capture rules, egg display, effects, and messages
environment.yml	Time/weather command actions and transition effects
filter.yml	List size, blocked worlds, GUI, feedback, and messages
gameplay.yml	Small mechanics: crops, poppies, water replanting, and hoppers
graves.yml	/back, ownership, expiry, tracking compass, and messages
help.yml	Help page title, navigation, and page size
holograms.yml	Reference defaults for hologram behavior
homes.yml	Home messages and visual feedback
inventory.yml	Scan limits, item-editing limits, blocked materials, and messages
join-leave.yml	Join, first-join, leave, welcome, and MOTD sections
kits.yml	Kit definitions, equipment, cooldowns, and messages
lagg.yml	Cleanup interval, warnings, protected items, and messages
mob-heads.yml	Drop chance, exclusions, player heads, sounds, and particles
near.yml	Search radius, result limit, spectator handling, and messages
nicknames.yml	Length, messages, and formatting behavior
permissions.yml	Local permission groups and inheritance
poses.yml	Allowed worlds and pose messages
rtp.yml	Allowed worlds, search radius, attempts, biome rules, and RTP cooldown
spawn.yml	Join teleport rules and spawn messages
staff.yml	God persistence, boss bars, toasts, notes, and staff messages
statistics.yml	Statistics, playtime, and seen formats
teleports.yml	Shared warmup, cooldown, movement cancellation, and messages
tpa.yml	Request expiry, request cooldown, and request messages
trash.yml	Inventory size, layout, actions, and title
tree-feller.yml	Safety limits, timing, drops, sounds, and particles
utilities.yml	Portable interfaces, jump, ride, list, and ping
villager-reroll.yml	Eligibility, trade items, messages, and effects
warps.yml	Warp messages and visual feedback
worlds.yml	Test-world spawning, biome search, and tree generation range

Shared teleport policy

settings/teleports.yml applies to /home, /warp, /spawn, /back, accepted TPA requests, and /rtp:

warmup-seconds: 3
cooldown-seconds: 10
cancel-on-move: true

/back, TPA requests, and /rtp also have feature-specific cooldowns. rivet.tp.nocooldown bypasses all cooldowns, but not the warmup. Staff movement, test-world movement, and automatic join spawning are immediate.

Small gameplay settings

settings/gameplay.yml keeps simple mechanics together:

crop-trample-protection: true
water-harvest-replanting: true
iron-golem-poppy-drops: true

hoppers:
  enabled: true
  transfer-cooldown-ticks: 2

Messages, sounds, and particles

Messages use MiniMessage and %placeholder% variables. The available placeholders are documented beside each setting.

Sound fields accept canonical Minecraft keys such as entity.enderman.teleport, optional minecraft: prefixes, and older Bukkit-style names such as ENTITY_ENDERMAN_TELEPORT or entity_enderman_teleport.

Particle fields use registry keys. A configured particle that requires extra data is rejected where Rivet expects a simple particle.

Invalid configured effects fall back to a safe default and write a warning to the console.

Reloading

/rivet reload validates and reloads config.yml, modules.yml, and every file under settings/. Invalid YAML leaves the current configuration active.

/lagg reload reloads only settings/lagg.yml and restarts its warning schedule.

Data files are not reloaded. Stop the server before editing generated data, then restart.