Quick setup

First run

Suki can be used as a drop-in replacement for Mirai, Pufferfish or Paper: Suki supports all their features and configuration options.

Without configuring anything, the following will be different:

• Chunk packets are interweaved with non-chunk packets.
• Plugins can no longer set a per-player view distance. (This is replaced with Suki's automatic per-player view distance.)

All other features are disabled by default. Upon running, the configuration files config/suki-global.yml and config/suki-world-defaults.yml will be generated. Please see Features for an explanation of each configuration option.

First things to configure

Suki provides various performance or quality-of-life enhancements that are good to set up right away. The following configuration options are not default, but recommended:
(Please see Features for further details and explanations of these options.)

Options

File	Option		Recommended value	Notes
Global
	console-logs	change-invalid-pool-element-level-to-info	true
		chat-messages.empty	false
		chat-messages.not-secure	false
		invalid-statistics	false
	keepalive	kick-player-for.late-response	false
		kick-player-for.unexpected-response	false
		kick-player-for.wrong-response-id	false
		send-interval	3000
	view-distance	see.max-total-chunks	12500	Works well for 15 online players and 8GB of RAM, see details
		track.max-total-chunks	2500	Works well for 15 online players and 4 cores @ 2.0 GHz, see details
World
	entity-ticking	immune-from-inactive.non-sitting-pets	true
		skipped-active-entity-ratio	0.25 - 0.75	Choose a higher value if you currently often experience entity lag, see details
		wake-up-duration-standard-deviation-ratio	0.2
	item-pickup	hopper.tick-rate	20
		villager.delay-after-drop	100
	view-distance	if-can-see-but-not-tracking.send-chunk-refresh	false
		load.limit-by-client-view-distance	true
		load.limit-by-see-view-distance	true
		load.per-player	true
		see.limit-by-client-view-distance	true
		see.per-player	true
		track.limit-by-client-view-distance	true
		track.max	11
		track.per-player	true

Environment variables

It is highly recommended to add the Suki multithreading environment variables to your startup script. You should also add Aikar's flags.

Permissions

In addition, Suki allows players to directly place items into the head slot to wear them. You may want to give the permission suki.moreitemsonhead.banner or suki.moreitemsonhead.all to players.