Files
minecraft-optimization/README.md
T
YouHaveTrouble 74063459a3 add tps catchup
2021-02-04 02:25:20 +01:00

17 KiB

Minecraft server optimization guide

Guide for version 1.16.5

Based on this guide and other sources (all of them are linked throughout the guide when relevant).

Intro

There will never be a guide that you can follow and it will give you perfect results. Each server has their own needs and limits on how much you can or you are willing to sacrifice. Tinkering around with the options to fine tune them to your servers needs it's what it's all about. This guide only aims to help you understand what options have impact on performance and what exactly they change. If you think you found inaccurate information within the guide you're free to open github issue telling me about it or open a pull request.

Server jar

Your choice of server software can make a huge difference in performance and api possibilities. There are currently multiple viable popular server jars, but there are also a few that you should stay away from for various reasons.

Recommended top picks:

  • Paper - This is the more popular server software that aims to improve performance while also fix gameplay and mechanics inconsistencies
  • Tuinity - A fork of paper that aims at improving server performance farther than paper
  • Purpur - A fork of tuinity that aims at giving the server owner more freedom in feature configurability

You should stay away from:

  • Yatopia - "The combined power of Paper forks for maximum instability and unmaintainablity!" - KennyTV's list of shame. Nothing more to be said.
  • Any paid server jar that claims async anything - 99.99% chance of being a scam.
  • Bukkit/Craftbukkit/Spigot - Extremely outdated in terms of performance compared to other server software you have access to.

Map pregen

Map pregeneration is one of the most important steps in improving a low-budget server. This helps out servers that are hosted on a shared cpu/single core node the most, since they can't fully utilize async chunk loading. You can use a plugin such as chunky to pregenerate the world. Make sure to set up a world border so your players don't generate new chunks! Note that pregenning can sometimes take hours depending on the radius you set in the pregen plugin.

It's key to remember that the overworld, nether and the end have separate world borders that need to be set up for each world. The nether dimension is 8x smaller than the overworld (if not modified with a datapack), so if you set the size wrong your players might end up outside of the world border!

Make sure to set up a vanilla world border (/worldborder set [radius]), as it limits certain functionalities such as lookup range for treasure maps that can cause lag spikes.

Configurations

server.properties

network-compression-threshold

default: 256
optimized: Standalone(512) BungeeCord(-1)
explanation:
This option caps the size of a packet before the server attempts to compress it. Setting it higher can save some resources at the cost of bandwidth, and setting it to -1 disables it. If your server is in a network with the proxy on the same machine or datacenter (with less than 2 ms ping), disabling this (-1) will be beneficial.


bukkit.yml

spawn-limits

default:
monsters: 70, animals: 10, water-animals: 15, water-ambient: 20, ambient: 15
optimized:
monsters: 12, animals: 5, water-animals: 2, water-ambient: 2, ambient: 0
explanation:
Lower values mean less mobs. Less mobs is less lag in general, but you want to balance it with player quality of life, finding mobs in the world is big part of gameplay. With per-player-mob-spawns those numbers represent basically 1:1 limit of mobs in the given category per player, so mob cap math is playercount*limit where "playercount" is current amount of players on the server.

chunk-gc.period-in-ticks

default: 600
optimized: 400
explanation:
This decides how often vacant chunks are unloaded. Smaller the value means less chunks being ticked, but going too low will stress your CPU more.

ticks-per

default:
monster-spawn: 1, animal-spawns: 400, water-spawns: 1, ambient-spawns: 1, water-ambient-spawns: 1
optimized:
monster-spawn: 10, animal-spawns: 400, water-spawns: 40, ambient-spawns: 40, water-ambient-spawns: 40
explanation:
This sets how often (in ticks) the server attempts to spawn certain living entities. Water/ambient mobs do not need to spawn each tick as they don't usually get killed that quickly. As for monsters: Slightly increasing the time between spawns should not impact spawn rates even in mob farms.


spigot.yml

max-tick-time

default:
tile: 50, entity: 50
optimized:
tile: 1000, entity: 1000
explanation:
Setting these to the recommended values disables this feature. You can read why it should be disabled here. SOG

view-distance

default: default
optimized: 3
explanation:
Setting the actual view distance lower than default will make less chunks tick, and with paper's no-tick-view-distance enabled you will be able to send more chunks to player that actually tick. If you encounter issues with optimized value you can bump it to 4 and still get decent performance.

mob-spawn-range

default: 8
optimized: 2
explanation:
Some people may argue that setting this to 1 less than view-distance is good enough, but lower values like 2 or 3 will allow you to decrease amount of mobs in spawn-limits.

entity-activation-range

default:
animals:32, monsters:32, raiders: 48, misc:16
optimized:
animals:16, monsters:24, raiders: 48, misc:8
explanation:
Entities past this range will be ticked less often. Avoid setting this too low or you might break mob behavior (mob aggro, raids, etc). SOG

tick-inactive-villagers

default: true
optimized: false
explanation:
Enabling this prevents the server from ticking villagers outside the activation range. Villager tasks in 1.14+ are very heavy. SOG

merge-radius

default:
item:2.5, exp:3.0
optimized:
item:3.0, exp:6.0
explanation:
This will decide the distance between the items to be merged, reducing the amount of items ticking on the ground. Merging will lead to the illusion of items disappearing as they merge together.

nerf-spawner-mobs

default: false
optimized: true
explanation:
When enabled, mobs from spawners will not have AI (will not swim/attack/move). This is a big TPS saver on servers with mob farms, but also messes with their behavior. SOG


paper.yml

Most of the settings in this file can be configured per-world. See this pdf for details.

max-auto-save-chunks-per-tick

default: 24
optimized: 8
explanation:
Slows down incremental world saving by spreading the task over time even more for better average performance. You might want to set this higher with more than 20-30 players; if incremental save can't finish in time then bukkit will automatically save leftover chunks at once and begin the process again.

per-player-mob-spawns

default: false
optimized: true
explanation:
By default mob limits are counted for the entire server which means mobs might end up being distributed unevenly between online players. This option enables per-player mob limits, meaning all players can get approximately the same number of mobs around them regardless of number of online players. Enabling this option also allows you to lower default spawn-limits in bukkit.yml since those are optimized for per-server mob limits.

optimize-explosions

default: false
optimized: true
explanation:
Faster explosion algorithm with no noticeable impact on gameplay. SOG

max-entity-collisions

default: 8
optimized: 2
explanation:
Limits the amount of collisions one entity will calculate at the same time. Setting this to optimized value will let you keep the player ability to nudge mobs. Setting this to 0 will completely disable collisions making nudging mobs/players impossible.

grass-spread-tick-rate

default: 1
optimized: 4
explanation:
Time in ticks before server tries to spread grass/mycelium. No gameplay impact in most cases. SOG

despawn-ranges

default:
soft: 32, hard: 128
optimized:
soft: 28, hard: 52
explanation:
Lower ranges clear background mobs and allow more to be spawned in areas with player traffic. This further reduces the gameplay impact of reduced spawning (bukkit.yml). Values adjusted for view-distance: 3.

hopper.disable-move-event

default: false
optimized: true
explanation:
InventoryMoveItemEvent doesn't fire unless there is a plugin actively listening to that event. This means that you only should set this to true if you have such plugin(s) and don't care about them not being able to act on this event. Do not set to true if you use plugins that listen to this event, e.g. protection plugins!

non-player-arrow-despawn-rate

default: -1
optimized: 20
explanation:
Makes arrows shot by mobs disappear after 1 second after hitting something.

creative-arrow-despawn-rate

default: -1
optimized: 20
explanation:
Makes arrows shot by players in creative disappear after 1 second after hitting something.

prevent-moving-into-unloaded-chunks

default: false
optimized: true
explanation:
Prevents players from entering an unloaded chunk (due to lag), which causes more lag. Setting this to true will set them back to a safe location instead. SOG

use-faster-eigencraft-redstone

default: false
optimized: true
explanation:
Alternative, faster redstone system. Reduces redundant redstone updates by nearly 95%. SOG

alt-item-despawn-rate.enabled

default: false
optimized: true
explanation:
This option lets you despawn selected items faster than default despawn rate. You can add things like cobblestone, netherrack etc. to the list and make them despawn after ~20 seconds (400 ticks). SOG

enable-treasure-maps

default: true
optimized: false
explanation:
Generating treasure maps is extremely expensive and can hang a server if the structure it's trying to locate is outside of your pregenerated world. It's only safe to enable this if you pregenerated your world and set a vanilla world border.

treasure-maps-return-already-discovered

default: false
optimized: true
explanation:
Default value forces the newly generated maps to look for unexplored structure, which are usually outside of your pregenerated terrain. Setting this to true makes it so maps can lead to the structures that were discovered earlier.

viewdistances.no-tick-view-distance

default: -1
optimized: 8
explanation:
This allows players to see further without ticking as many chunks as regular view-distance would. Although it's not really heavy on the server, keep in mind that sending more chunks will affect bandwidth.

entity-per-chunk-save-limit

default: -1
optimized:

entity-per-chunk-save-limit:
    arrow: 8
    dragonfireball: 8
    egg: 8
    ender_pearl: 8
    fireball: 8
    firework: 8
    largefireball: 8
    lingeringpotion: 8
    llamaspit: 8
    shulkerbullet: 8
    sizedfireball: 8
    snowball: 8
    spectralarrow: 8
    splashpotion: 8
    thrownexpbottle: 8
    trident: 8
    witherskull: 8

explanation:
Limits the amount of projectiles that can be saved in a chunk. This prevents issues that arise with lower view-distance like players throwing massive amounts of snowballs into unloaded chunk that has a potential to crash your server on loading of that chunk.

anti-xray.enabled

default: false
optimized: true
explanation:
Hides ores from x-rayers. For detailed configuration of this feature check out Stonar96's recommended settings.


purpur.yml

Only applicable for purpur.

tps-catchup

default: true
optimized: false
explanation:
TPS catchup sends your server into overdrive after tps drops. If your server is constantly running more than 50mspt you'll most likely see an improvement in performance due to the fact that the server will not try to average the tps to 20 by going over 20. It's worth noting that some plugins may not expect this feature being disabled.

use-alternate-keepalive

default: false
optimized: true
explanation:
Alternate system for keepalive packets so players with bad connection don't get timed out as often.

dont-send-useless-entity-packets

default: false
optimized: true
explanation:
Prevent the server from sending empty position change packets (by default server sends move packet for each entity even if the entity hasn't moved)

gameplay-mechanics.player.teleport-if-outside-border

default: false
optimized: true
explanation:
Teleport the player to the world spawn if they happen to be outside of the world border. Helpful since the vanilla world border is bypassable and the damage it does to the player can be mitigated.

gameplay-mechanics.player.entities-can-use-portals

default: true
optimized: false
explanation:
Disables portal usage of all entities besides the player. This potentially fixes a dupe* and prevents entities changing worlds loading chunks on main thread.

* more sources needed.

mobs.dolphin.disable-treasure-searching

default: false
optimized: true
explanation:
Prevents dolphins from performing structure search similiar to treasure maps (enable-treasure-maps).

mobs.zombie.aggressive-towards-villager-when-lagging

default: true
optimized: false
explanation:
Zombies stop targetting villagers when tps is under lag treshold. This saves the server precious time of calculating paths for zombies that are not targetting players.

Java startup flags

Paper and its forks in upcoming version 1.17 will require Java 11 (LTS) or higher. Good 2021 resolution to finally update your version of Java! (or at least inform your host so they can handle the migration).

JVM can be configured to reduce lag spikes caused by big garbage collector tasks. You can find startup flags optimized for minecraft servers here SOG.

"Performance" plugins

Plugins removing ground items

Absolutely unnecessary since they can be replaced with merge radius and alt-item-despawn-rate and frankly, they're less configurable than basic server configs. They tend to use more resources scanning and removing items than not removing the items at all.

Mob stacker plugins

It's really hard to justify using one. Stacking naturally spawned entities causes more lag than not stacking them at all due to the server constantly trying to spawn more mobs. The only "acceptable" use case is for spawners on servers with a large amount of spawners.

What's lagging? - measuring performance

mspt

Paper offers a /mspt command that will tell you how much time server took to calculate recent ticks. If the first and second value you see are lower than 50, then congratulations! Your server is not lagging! If the third value is over 50 then it means there was at least 1 tick that took longer. That's completely normal and happens from time to time, so don't panic.

timings

Great way to see what might be going on when your server is lagging are timings. Timings is a tool that lets you see exactly what tasks are taking the longest. It's the most basic troubleshooting tool and if you ask for help regarding lag you will most likely be asked for your timings.

To get timings of your server you just need to execute /timings paste command and click the link you're provided with. You can share this link with other people to let them help you. It's also easy to misread if you don't know what you're doing. There is a detailed video tutorial by Aikar on how to read them.

spark

Spark is a plugin that allows you to profile your servers CPU and memory usage. You can read on how to use it on its wiki. There's also a guide on how to find the cause of lag spikes here.