Skip to content

Configuration

Sofiane H. Djerbi edited this page Aug 1, 2023 · 27 revisions

kaiiju.yml

GLOBAL CONFIGURATION

network

send-null-entity-packets

Default: true
If false server won't send null move entity packets.
Recommended: false unless you have a plugin that requires true.

alternate-keepalive

Default: false
Purpur alternate keepalive.
Enabling this sends a keepalive packet once per second to a player, and only kicks for timeout if none of them were responded to in 30 seconds.
Responding to any of them in any order will keep the player connected.
AKA, it won't kick your players because one packet gets dropped somewhere along the lines

kick-player-on-bad-packet

Default: true
If false, we won't kick players that send corrupted packets. Experimental.

gameplay

server-mod-name

Default: Kaiiju
Server name send to the client.

optimization

disable-vanish-api

Default: false
Disable vanish API.

disable-player-stats

Default: false
Disable player stats.

disable-arm-swing-event

Default: false
Don't call arm swing events.

disable-ensure-tick-thread-checks

Default: false
Disable thread safety checks. Don't enable this.

async-path-processing.enable

Default: false
Enable async path processing.
Requires a restart!

async-path-processing.max-threads

Default: 0
Determines the maximum number of threads that can be utilized for asynchronous processing of paths.
Having a maximum pool size larger than the core pool size allows the thread pool to create additional threads to handle bursts of tasks or temporarily increased workload.

Zero: Thread amount = 0 = max(CoreAmount/4, 1)
Negative: Thread amount = -n = max(CoreAmount - n, 1)

async-path-processing.keepalive

Default: 60
Determines how long idle threads are kept alive when the number of threads exceeds the core pool size. Unit: Seconds.
A short keep-alive time ensures that unnecessary threads are terminated quickly when not needed.

async-path-processing.queue-capacity

Default: 4096
Defines how many tasks can be waiting in the queue before new threads are created.
A larger queue capacity can help absorb short bursts of tasks without creating additional threads.

PER WORLD CONFIGURATION

gameplay

fix-void-trading

Default: true
Enable/disable void trading.
If you turn this to false, we recommend using Kaiivoid plugin.

tick-when-empty

Default: true If true, the world will be ticked when empty (no players).

break-redstone-on-top-of-trap-doors-early

Default: true Always break redstone on top of trap doors if true.
Disabling this will allow portal slicing, and trapdoors lag machines.

fix-tripwire-state-inconsistency

Default: true If false, string duplication will be enabled.
Disabling this will also allow end obsidian platform suppression.

safe-teleportation

Default: true If false, end portal will teleport removed entities.
Disable this if you want to allow sand duping.

sand-duplication

Default: false Allow sand duplication. Need safe-teleportation: false to work.

region-format

format

Default: ANVIL
Region file format used when saving on disk.
Available formats:

  • ANVIL: Minecraft default region format.
  • LINEAR: Xymb linear format. Up to 50% less disk space in the OW/Nether and 95% in The End.

LINEAR is not compatible with ANVIL! You MUST convert your map.
Linear region format documentation

region-format.linear

compression-level

Default: 1
ZSTD compression level.
This value should stay between 1 and 22.
Recommended levels: 1 / 3 / 6
Comparison:

Anvil Linear 1 Linear 3 Linear 6
Overworld 12,64GB 7,06GB 6,88GB 5,93GB
Nether 1,55GB 624,56MB 605,07MB 516,37MB
End 4,01GB 211,45MB 194,27MB 153,08MB
TOTAL 18,19GB 7,88GB 7,66GB 6,59GB

crash-on-broken-symlink

Default: true If true, the server will crash on a broken region file symlink.
Useful when accessing region files over NFS.

optimization

shulker-box-drop-contents-when-destroyed

Default: true
Should shulker items drop their contents when destroyed (by lava/cactus..) ?

optimize-hoppers

Default: true
Should we turn on Paper hopper optimization ?
Turn this off if you want your server to be as vanilla as possible.
Paper hopper optimization break a lot of technical redstone farms.

enable-entity-throttling

Default: false
Enable entity throttling.
Please use kaiiju-entity-limits.yml to configure.

disable-achievements

Default: false
Disable achievements.

disable-creatures-spawn-events

Default: false
Disable creature spawn events.

disable-dolphin-swim-to-treasure

Default: false
Disable dolphin swimming to treasures.