Purpur/docs/source/configuration.rst

=============
Configuration
=============

This page details the various configuration settings exposed by Purpur in the purpur.yml file.

.. |br| raw:: html

.. contents::
   :depth: 1
   :local:

If you want information on settings in paper.yml, spigot.yml, and bukkit.yml you should see
their respective documentation pages.

* `Bukkit Configuration (bukkit.yml) <https://bukkit.gamepedia.com/Bukkit.yml>`_

* `Spigot Configuration (spigot.yml) <https://www.spigotmc.org/wiki/spigot-configuration/>`_

* `Paper Configuration (paper.yml) <https://paper.readthedocs.io/en/stable/server/configuration.html>`_

.. warning::
    Configuration values change frequently at times. It is possible for the
    information here to be incomplete. If you cannot find what you're looking for
    or think something may be wrong, :doc:`contact`

Global Settings
===============

Global settings affect all worlds on the server as well as the core server
functionality itself.

verbose
~~~~~~~
* **default**: false
* **description**: Sets whether the server should dump all configuration values to the server log on startup.

enable-tick-overload
~~~~~~~~~~~~~~~~~~~~
* **default**: false
* **description**: Enable/disable the vanilla tick overload detection ("Can't keep up! Is the server overloaded?")

enable-tps-catchup
~~~~~~~~~~~~~~~~~~
* **default**: false
* **description**: Enable/disable Spigot's TPS catchup (makes everything tick faster than 20 tps after lag spikes, which can cause more lag - also skews /tps reports by ruining the average with above 20 tps entries)

disable-drops-on-cramming-death
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* **default**: true
* **description**: Stops entities from dropping loot on death, if killed by cramming gamerule

dont-send-useless-entity-packets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* **default**: false
* **description**: Skips sending relative move packets for entities that didn't really move

.. warning::
    The `dont-send-useless-entity-packets` option is highly experimental! Only enable this if you are feeling brave.

fix-item-position-desync
~~~~~~~~~~~~~~~~~~~~~~~~
* **default**: false
* **description**: Update item positions according to the rounding the client does

.. warning::
    The `fix-item-position-desync` option is highly experimental! Only enable this if you are feeling brave.

large-ender-chests
~~~~~~~~~~~~~~
* **default**: true
* **description:** Use large size ender chests (6 rows, aka 54 slots)

packed-barrels
~~~~~~~~~~~~~~
* **default**: true
* **description:** Use large size barrels (6 rows, aka 54 slots)

use-better-mending
~~~~~~~~~~~~~~~~~~
* **default**: true
* **description:** Set to true for mending enchantment to always repair the most damaged equipment first

logger
~~~~~~
* show-duplicate-entity-uuid-errors
    - **default**: true
    - **description**:: Controls if errors about duplicate entity uuids are shown in console/logs

* show-unknown-attribute-warnings
    - **default**: true
    - **description**:: Controls if warnings about unknown attributes are shown in console/logs

mobs
~~~~
* require-shift-to-mount
    - **default**: true
    - **description**: Require shift click to mount otherwise non-ridable mobs

* cow
    * feed-mushrooms-for-mooshroom
        - **default**: 5
        - **description**: Number of mushrooms to feed a cow to make it transform into a mooshroom. Set to 0 to disable.

* ender-dragon
    * death-always-places-egg-block
        - **default**: true
        - **description:** When true all valid ender dragon deaths will place an ender egg block on top of the portal

* fox
    * tulips-change-type
        - **default**: true
        - **description**: Feeding a white/orange tulip changes type snow/regular.

* giant
    * naturally-spawn
        - **default**: true
        - **description**: Control if giant zombies naturally spawn in the game

    * have-ai
        - **default**: true
        - **description**: Control if giant zombies have AI instead of just standing there

* illusioner
    * naturally-spawn
        - **default**: true
        - **description**: Control if illusioners naturally spawn in the game

* iron_golem
    * swims
        - **default**: true
        - **description**: Set whether iron golem can swim or not

* phantom
    * spawn-in-the-end
        - **default**: true
        - **description**: Set whether phantoms spawn naturally in the end

* snow_golem
    * drops-pumpkin-when-sheared
        - **default**: true
        - **description**: Control if shearing a snowman makes the pumpkin drop to the ground

    * pumpkin-can-be-added-back
        - **default**: true
        - **description**: Control if pumpkins can be placed back onto snowmen

ridable
~~~~~~~
* <mob string id here>
    - **default**: true
    - **description**: When true this mob is ridable by right clicking it while holding shift

controllable-minecarts
~~~~~~~~~~~~~~~~~~~~~~
* enabled
    - **default**: true
    - **description**: Whether minecarts can be controlled with WASD when not on rails

* base-speed
    - **default**: 0.2
    - **description**: Base speed of minecart when controlled with WASD

* block-speed
    - **default**: {}
    - **description**: List of speed overrides per block type

.. note::
    Example of block-speed overrides:
      * block-speed:
         - minecraft:sand: 0.1
         - minecraft:stone: 0.6
         - minecraft:black_concrete: 1.0

World Settings
==============

World settings are on a per-world basis. The child-node `default` is used for all worlds that do not have their own specific settings.

editable-signs
~~~~~~~~~~~~~~
* **default**: true
* **description**: Ability to edit signs by right clicking them with another sign in hand

campfire-obeys-gravity
~~~~~~~~~~~~~~~~~~~~~~
* **default**: true
* **description**: When true, campfires will fall to the ground (like anvils do) instead of floating in the air

campfire-regen
~~~~~~~~~~~~~~
* interval
    - **default**: 40
    - **description**: Time (in ticks) that campfires scan for player and apply regen on. Regen buff only gets applied if campfire is lit. Set to 0 to disable

* duration
    - **default**: 80
    - **description**: How long (in ticks) the regen buff lasts

* range
    - **default**: 5
    - **description**: Distance (in blocks) a player must be within to receive the regen buff

* amplifier
    - **default**: 0
    - **description**: The amplifier on the regen buff. `0` for level 1, `1` for level 2

* require-line-of-sight
    - **default**: true
    - **description**: Only players within line of sight of the campfire will receive the regen buff

* boost-duration
    - **default**: 80
    - **description**: How long (in ticks) the regen buff lasts when the campfire is in smoke signal mode

* boost-range
    - **default**: 10
    - **description**: Distance (in blocks) a player must be within to receive the regen buff when the campfire is in smoke signal mode

* boost-amplifier
    - **default**: 1
    - **description**: The amplifier on the regen buff when the campfire is in smoke signal mode

* boost-require-line-of-sight
    - **default**: false
    - **description**: Only players within line of sight of the campfire will receive the regen buff when the campfire is in smoke signal mode

campfires-go-out-in-rain
~~~~~~~~~~~~~~~~~~~~~~~~
* **default**: true
* **description**: Campfires burn out in the rain

allow-moist-soil-from-water-below
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* **default**: true
* **description**: Allow soil to moisten from water directly below it

allow-sign-colors
~~~~~~~~~~~~~~~~~
* **default**: true
* **description**: Allow players to use color codes on signs

allow-leashing-villagers
~~~~~~~~~~~~~~~~~~~~~~~~
* **default**: true
* **description**: Allow players to use leads on villagers (trader not included)

items-can-break-turtle-eggs
~~~~~~~~~~~~~~~~~~~~~~~~~~~
* **default**: false
* **description**: Allow dropped items to damage/break turtle eggs

milk-cures-bad-omen
~~~~~~~~~~~~~~~~~~~
* **default**: false
* **description**: Allow players to drink milk to cure bad omen status effect

block-tick-events
~~~~~~~~~~~~~~~~~
* **default**: true
* **description**: Fire plugin events when blocks tick

fluid-tick-events
~~~~~~~~~~~~~~~~~
* **default**: true
* **description**: Fire plugin events when fluids tick

limit-pillager-outpost-spawns
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* **default**: 10
* **description**: Limit the number of pillagers allowed to spawn at an outpost at any given time

radius-villager-iron-golem-spawns
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* **default**: 10
* **description**: Radius villagers search for existing iron golems before spawning more

elytra
~~~~~~
* damage-per-second
    - **default**: 1
    - **description**: How much damage an elytra takes during flight each second

* damage-multiplied-by-speed
    - **default**: 0
    - **description**: Damage is multiplied by speed if flight is faster than set speed. Value of 0 disables this multiplier.

* ignore-unbreaking
    - **default**: false
    - **description**: Should elytras ignore the unbreaking enchantment

* damage-per-boost
    * firework
        - **default**: 0
        - **description**: How much damage to deal to the elytra when firework boost activates

    * trident
        - **default**: 0
        - **description**: How much damage to deal to the elytra when trident riptide boost activates