Spigot Configuration

May 8, 2015
Spigot Configuration

  • The following guide is for builds older than #938 in which still use the bukkit.yml file
    For builds #938 and onwards, please see the new configuration guide by clicking here.​

    Spigot Configuration
    Main, ungrouped settings
    filter-unsafe-ips
    Default: false
    Type: Boolean
    Description: If enabled, this checks all player IPs against the SpamHaus database (xbl.spamhaus.org) on login. This setting may potentially block many legitimate players, so toggle this with caution.

    whitelist-message
    Default: You are not white-listed on this server!
    Type: String
    Description: When whitelist mode is enabled, this is the message that will be displayed to all un-whitelisted users upon connection.

    command-complete
    Default: true
    Type: Boolean
    Description: Controls whether or not a player should be allowed to press the TAB key to auto-complete commands. If enabled, this may pose somewhat of a security risk, as a player will be able to view all registered commands when typing in / and then pressing TAB.

    spam-exclusions
    Default: /skill
    Type: List
    Description: Excludes commands listed from the vanilla spam check. This is probably not necessary for most plugins.

    tab-ping
    Default: false
    Type: Boolean
    Description: Controls the automatic updating of ping bars in the tab list. When disabled, the "ping bars" will only update when a player logs in. When enabled, "ping bars" will update automatically, but may cause packet spam on larger servers which can adversely affect your server machine (however, this may not be an issue for you as Spigot uses a much more efficient ping update method, based on BungeeCord's implementation).

    restart-on-crash
    Default: false
    Type: Boolean
    Description: Controls whether or not the server will automatically attempt to restart your server when a crash occurs. May not work in some cases. This only measures hangs in server ticks, and will not detect connection issues or such.
    For true crash detection that determines whether your server is reachable, a wrapper (e.g. mark2, MCMyAdmin, RemoteToolkit) that supports server list ping is recommended.
    If your server wrapper has crash detection support, it is recommend to disable this feature - it can result in neither form of crash detection working properly.

    restart-script-location
    Default: /path/to/server/start.sh
    Type: String
    Description: The location for your server's startup script. This path will be used for the /restart command and for the restart-on-crash option. You will need to adjust this to your servers startup script path (unless you really do have a /path/to/server/start.sh path).
    This feature will not work for most server wrappers (e.g. mark2, MCMyAdmin, RemoteToolkit), therefore it is use your wrapper's restart function instead.

    snapshot-protocol (removed)
    Default: false
    Type: String
    Description: Allows your server to support the (usually) latest snapshot protocol so users running that snapshot version can connect to the server. When enabled, it will deny the normal client for your server version from connecting.

    bungee-proxies
    Default: 127.0.0.1
    Type: List
    Description: All BungeeCord IPs in the list will never be seen by a plugin. Instead, it will allow the player's actual IP to pass-through. This option is void unless using BungeeCord.

    texture-resolution
    Default: 16
    Type: Integer
    Description: The size of the texture pack the server is sending to the client. This option is void if you are not using a server-side texture pack via server.properties.

    info
    Default: true
    Type: Boolean
    Description: Whether or not to show the various per-world configuration options of Spigot in the server console on startup.


    World settings

    growth-chunks-per-tick
    Default: 650
    Type: Integer
    Description: Controls the amount of chunks that will be updated for growth per tick. Lowering this will potentially make growth slower while saving resources and vice versa.

    mob-spawn-range
    Default: 4
    Type: Integer
    Description: Controls the range in which mobs will spawn around a player. The default vanilla value is 8.

    item-merge-radius
    Default: 3.5
    Type: Integer
    Description: Controls the range (in blocks), in which items will group together when on the ground.

    exp-merge-radius
    Default: 3.5
    Type: Integer
    Description: Controls the range (in blocks), in which XP points will group together when on the ground.

    random-light-updates
    Default: false
    Type: Boolean
    Description: Controls whether or not the server will randomly sample chunks in order to verify and fix lighting.

    aggregate-chunkticks
    Default: 4
    Type: Integer
    Description: Controls the amount of chunk ticks the server will skip then apply x times. Set this to 1 to disable the feature (and bring back vanilla behavior).

    x-growth-modifier
    where x = wheat, cactus, melon, pumpkin, sugar, tree, mushroom
    Default: 100
    Type: Integer
    Description: Controls the rate in percentage of the growth speed of each crop.

    entity-activation-range-x
    where x = animals, monsters, misc
    Default: (animals: 32, monsters: 32, misc: 16)
    Type: Integer
    Description: Controls the range in blocks that entities will become "activated" - entities outside of this range will tick at a reduced rate to prevent server lag. These numbers can adversely effect gameplay when changed so do so with a clear mind.

    entity-tracking-range-x
    where x = players, animals, monsters, misc, max
    Default: (players: 48, animals: 48, monsters: 48, misc: 32, max: 64)
    Type: Integer
    Description: Controls the range in blocks that entities will become "visible" or otherwise known as "tracked" - entities outside of this range will be invisible as they are not being rendered to preserve cpu and bandwidth. This is particularly useful for PVP and PVE servers as turning down the player range will nerf various forms of wallhax / boundinghax.

    view-distance
    Default: The setting from server.properties.
    Type: Integer
    Description: Controls the radius of chunks around every player that will be loaded - This is normally adjusted via server.properties but can be added per-world in bukkit.yml.


    Chunk GC settings
    Disabling chunk GC or editing settings in this section is not recommended if you're not absolutely sure of what you're doing.

    period-in-ticks
    Default: 600
    Type: Integer
    Description: Controls the time (in ticks) that the chunk garbage collector will run chunk cleanup. Do not set this 0!

    load-threshold
    Default: 0
    Type: Integer
    Description: The number of chunks loaded by plugins that will force the chunk GC to run.


    Anti x-ray settings

    enable
    Default: false
    Type: Boolean
    Description: Self explanatory. Controls whether or not anti x-ray should be enabled.

    engine-mode
    Default: 1
    Type: Integer
    Description: Controls the engine mode that the inbuilt anti x-ray uses. Example
    Engine mode 1 will hide all ores in the world with stone. Ores exposed to air pockets will still be visible!
    Engine mode 2 will hide everything by creating random ores all over the world, so that x-rayers will not be able to identify actual ores. Client and/or server latency due to overloading or network issues can cause undesired effects on the client side such as appearance of "fake ores".

    disabled-worlds
    Default: world_the_end
    Type: List
    Description: Any worlds listed here will be ignored by the anti x-ray.

    blocks
    Default: 1, 5, 14, 15, 16, 21, 48, 49, 54, 56, 73, 74, 82, 129, 130
    Type: List
    Description: Blocks that should be obfuscated by the anti x-ray.
  • Loading...
  • Loading...