Skip to content

Features

Jump to bottom
Martijn edited this page Oct 17, 2022 · 33 revisions

Below is a list of all features, organized by their respective configuration options. The configuration for Suki is the same as Paper, and can be found in:

  • Global settings: config/suki-global.yml
  • World settings: defaults in config/suki-world-defaults.yml, and overriding settings for a specific world can be defined in <world name>/suki-world.yml

Optimization

view-distance

Global track.max-total-chunks

The maximum number of chunks that can be tracked by all players together. Tracking means: the player will receive entity and block updates from these chunks. A higher value costs more CPU and network bandwidth. -1 means no limit.

Default: -1
Recommended: for a server with 4 cores @ 2.0 GHz, with usually 15 players online max, 2500 works well. For 2500: if there are 15 players online, each player can track chunks at a distance of 6. If you would like 30 players to track chunks at a distance of 6, you should use 5000, etcetera.

World track.per-player

Whether track view distance is automatically optimally set for each player individually.

Default: false
Recommended: true

World track.limit-by-client-view-distance

(Only if track.per-player is true)

Whether chunks further than the client view distance will not be tracked by players. Setting this to true saves CPU and network bandwidth, without being noticeable by players.

Default: false
Recommended: true

World track.max

(Only if track.per-player is true)

The maximum chunk distance for each individual player to track. -1 means no limit.

Default: -1
Recommended: 11

Global see.max-total-chunks

The maximum number of chunks that can be seen by all players together. See distance should be much higher than tracking (which includes entities and block changes) distance. A higher value costs more RAM, and a little bit more CPU. -1 means no limit.

Default: -1
Recommended: for a server with 8GB RAM, with usually 15 players online max, 12500 works well. For 12500: if there are 15 players online, each player can see chunks at a distance of 14. If you would like 30 players to see chunks at a distance of 14, you should use 25000, etcetera.

World see.per-player

Whether see view distance is automatically optimally set for each player individually.

Default: false
Recommended: true

World see.limit-by-client-view-distance

(Only if see.per-player is true)

Whether chunks further than the client view distance will not be sent to players. Setting this to true saves network bandwidth, without being noticeable by players.

Default: false
Recommended: true

World see.max

(Only if see.per-player is true)

The maximum chunk distance for each individual player to see. -1 means no limit.

Normally, it is not necessary to change this setting, because with see.per-player, Suki will already set the view distance fairly without a limit being required.

Default: -1
Recommended: -1

World load.per-player

Whether the distance at which chunks are loaded into server memory is automatically optimally set for each player individually.

Default: false
Recommended: true

World load.limit-by-client-view-distance

(Only if load.per-player is true)

Whether chunks further than the client view distance will not be loaded into server memory. Setting this to true saves CPU and RAM. If the client sets a low view distance, this makes mob spawning higher up or lower down in their own chunks more likely, and mob spawning further away less likely.

Default: false
Recommended: true - but note that this may change mob spawning for players with very low client view distance (such as 4 or lower)

World load.limit-by-see-view-distance

(Only if load.per-player is true)

Whether chunks further than the player can receive will not be loaded into server memory. Setting this to true saves CPU and RAM.

Default: false
Recommended: true

World load.max

(Only if load.per-player is true)

The maximum chunk distance to load into server memory for each individual player. -1 means no limit.

Normally, it is not necessary to change this setting, because with load.per-player, Suki will already set the load distance fairly without a limit being required.

Default: -1
Recommended: -1

World if-can-see-but-not-tracking

Whether some chunk events will be sent to players that are too far away to see the entities in that chunk:

  • send-chunk-refresh
    When plugins request to refresh the chunk for a player
    Default: true
    Recommended: false
  • send-end-portal-fill-sound
    The sound when an End portal is completed
    Default: true
    Recommended: true
  • send-ender-dragon-spawn-sound
    The sound when an Ender Dragon spawns
    Default: true
    Recommended: true
  • send-wither-spawn-sound
    The sound when a Wither spawns
    Default: true
    Recommended: true

Global allow-invalid-client-view-distance

Whether to allow clients to send an invalid view distance. If true, clients can send a view distance above 127 (but it will have no effect). If false, clients will be kicked when they send a view distance above 127.

Default: false

Entity activation

Networking

Short TPS dips

Gameplay

Survival debug stick

Banners in head slot

Unstrip with bone meal

Difficulty

Strongholds

Enchantments

mob-spawning

World all-nether-bricks-count-as-fortress

If true, mobs that normally only spawn in Nether fortresses can spawn on Nether bricks anywhere in the Nether.

Default: false

never-despawn-entities-due-to-distance

World wither

If true, a Wither will never despawn just because all players are far away.

Default: false

Other

relocate-corrupted-chunks

World enabled

Whether chunks are relocated when data corruption is detected. This is true in Paper.

Default: true
Recommended: false

Clone this wiki locally