Type to search the current language.

View all results
DeerFolia · Configuration overview
Docs/deerfolia/DeerFolia · Configuration overview

DeerFolia · Configuration overview

Find DeerFolia configuration files, edit them safely, and apply changes.

Configuration files

DeerFolia stores its configuration files in the server root config/ directory:

FilePurposeLoaded by DeerFolia
deer-folia.ymlCore optimization groups: Dynamic Activation, async pathfinding, network, Lithium, POI, and AFK networkOn every server start
kaiiju-entity-throttling.ymlPer-entity and per-region ticking limits and removal thresholdsWhen entity throttling is enabled in deer-folia.yml

Folia and Paper own files such as global, world-defaults, spigot, and bukkit. Follow the upstream configuration rules for those files. DeerFolia reads the files listed above.

How the files are generated

DeerFolia creates deer-folia.yml during the first configuration load. When kaiiju-entity-throttling is true, the Kaiiju limiter also creates kaiiju-entity-throttling.yml. The file starts with entries for ZombifiedPiglin and Axolotl.

The configuration manager converts Java field names to kebab-case keys. For example, asyncPathfindingMaxThreads becomes async-pathfinding-max-threads. The manager restores missing known keys during startup. An unknown key does not enable a feature.

  1. Stop the server. Wait for the world save to finish.
  2. Copy the file you will edit. Add a date to the backup name.
  3. Change one feature group or one entity type.
  4. Check YAML indentation, colons, quotes, and list syntax.
  5. Start a test server. Read the complete log.
  6. Test with players, an entity-heavy area, or an AFK account.
  7. Copy the tested change to production.

How changes take effect

DeerFolia loads these files during server startup. Restart the server after every edit. Do not use Bukkit or Paper reload as a configuration reload. Restarting is required for Lithium optimizations and async pathfinding.

YAML editing notes

  • Use spaces. Never use Tab.
  • Write booleans as true or false. Do not quote them.
  • Use a dash for a list entry. Use [] for an empty list.
  • Quote messages that contain colons, hashes, braces, or color symbols.
  • Do not delete an unfamiliar section to hide an error. Restore the last known-good backup.
  • Check the field unit before you change a value. Units can be ticks, distance, entity count, or bytes.

Continue