Configuration

Each backend has its own plugins/EdenEffects/config.yml. Most keys decide what this server shows, so the hub, survival, and minigame servers can each allow different things while players keep the same selections everywhere.

There is no reload command. Restart the server after changing the config.

Disabling never deletes anything

Turning a cosmetic type off, or off in a world, only stops it showing on that server. The player's selection in MySQL is untouched and they are not told. A pet hidden on survival simply reappears when they return to the hub.

---

server-id

Key	Default	Description
server-id	""	This backend's name as Velocity knows it. Must be unique across the network. Required: the plugin disables itself if it is blank.

database

Every backend should point at the same database.

Key	Default	Description
database.host	127.0.0.1	MySQL host.
database.port	3306	MySQL port.
database.name	edeneffects	Database name.
database.user	edeneffects	Database user.
database.password	""	Database password.
database.pool-size	10	Maximum connections in the pool.
database.connection-timeout-ms	5000	How long to wait for a connection before giving up. If the database is unreachable on start, the server waits this long before EdenEffects disables itself.
database.properties	useSSL=false&allowPublicKeyRetrieval=true	Extra JDBC URL properties.

cosmetics

A toggle per cosmetic type, plus a list of worlds where that type is off.

Key	Default	Description
cosmetics.<type>.enabled	true	Whether this type shows on this server at all.
cosmetics.<type>.disabled-worlds	[]	Worlds where this type is off, even when enabled is true. Names are case-insensitive.

<type> is one of trails, hats, wings, pets, gadgets, joins, leaves, or deaths.

When a type is off:

• Trails, hats, wings, and pets stop showing, and come back when the player moves to a world or server that allows them.
• Join, leave, and death effects do not play. The world checked is the one the player is in at that moment.
• The gadget item is taken out of the player's hotbar, and /cosmetics use answers "Gadgets are disabled here."
• The category button in the menu says Unavailable on this server. Players can still browse it and change their selection.

gadgets

Key	Default	Description
gadgets.allow-movement	true	Whether gadgets that launch the player (Grappling Hook, Balloon) can be used. Turn this off where they could be used to leave the map or skip a parkour.
gadgets.item-slot	2	Hotbar slot (0 to 8) for the selected gadget's item. If that slot is taken, the first empty hotbar slot is used. A player's own item is never replaced.

render

Key	Default	Description
render.period-ticks	2	Ticks between frames for trails, hats, and wings. 1 is smoothest; 2 looks almost the same for half the work. Minimum 1.
render.distance	48.0	How far away, in blocks, a trail, hat, or wings can be seen. Anything further is skipped before it is drawn. Pets are real entities, so the server's own entity tracking range applies to them instead, and one-shot effects are played through the world so everyone nearby sees them.

pets

Pet size uses the vanilla SCALE attribute, clamped to a range. See Pets for how the range is applied.

Key	Default	Description
pets.scale.min	0.4	Smallest pet size for normal players (40%).
pets.scale.max	1.6	Largest pet size for normal players (160%). The upper limit is what stops a giant cow blocking a doorway.
pets.scale.bypass.min	0.0625	Smallest size for players with edeneffects.bypass.pet-scale. Cannot go below the vanilla limit of 0.0625.
pets.scale.bypass.max	16.0	Largest size for players with edeneffects.bypass.pet-scale. Cannot go above the vanilla limit of 16.

The pet editor's size slider moves in steps of 5%, so the ends of each range are rounded inward to the nearest 5%.

menu

Key	Default	Description
menu.show-locked	true	Show cosmetics the player does not own, greyed out, so the menu doubles as a list of what a rank unlocks. When false, players only see what they can wear.
menu.item.enabled	false	Give players a hotbar item that opens the menu. Leave off on servers with their own hotbar layout. Turning it off removes existing menu items when players join.
menu.item.slot	4	Hotbar slot (0 to 8) for the menu item. It is only placed if the slot is empty.
menu.item.material	CHEST	Item type for the menu item. An unknown material falls back to CHEST.

effects

Key	Default	Description
effects.sounds	true	Whether cosmetics may play sounds at all, on top of their particles.

The Thunder death effect is the exception: its lightning flash carries vanilla's own thunder sound, which this setting does not silence.

config-version

Leave this alone. It tells EdenEffects which renamed or removed keys to carry forward when the plugin updates. New keys are merged into your file automatically on start.

Upgrading from config version 1

Version 2 turned join and death effects into cosmetics players choose. effects.join and effects.death are gone: if they are still in your file they do nothing, and the per-server toggles are now cosmetics.joins, cosmetics.leaves, and cosmetics.deaths.

Nobody sees a join, leave, or death effect until you grant the new permission nodes and they pick one. See Permissions.

---

Example: a network

Hub - allow everything and give players a menu item:

server-id: hub
menu:
  item:
    enabled: true

Survival - keep entity counts down and stop players launching over walls:

server-id: survival
cosmetics:
  pets:
    enabled: false
  wings:
    enabled: true
    disabled-worlds: [survival_nether, survival_the_end]
  joins:
    enabled: false
gadgets:
  allow-movement: false
render:
  distance: 32.0

Minigames - no cosmetics during play, but still show them in the lobby world:

server-id: minigames
cosmetics:
  trails:
    disabled-worlds: [arena]
  hats:
    disabled-worlds: [arena]
  wings:
    disabled-worlds: [arena]
  pets:
    disabled-worlds: [arena]
  gadgets:
    disabled-worlds: [arena]
  deaths:
    # a death effect every few seconds would be noise
    disabled-worlds: [arena]

Each example only shows the keys that change. Every other key keeps its default.