Skip to content
This repository has been archived by the owner on Aug 13, 2023. It is now read-only.

server.properties

LT_Name edited this page Jun 18, 2023 · 3 revisions

motd

server name / text that shows on the server list

note: can't be empty

sub-motd

second line for motd

note: shows only for players in local network when viewing the server on the friends list in game

note: can't be empty since 1.16.210

server-port

server's port

note: there can't be two servers running in same port

note: bedrock edition uses UDP

server-ip

ip where server runs

default is 0.0.0.0 and you don't usually need to change this

view-distance

maximum view distance in chunks

bigger value = more chunks loaded = more ram & cpu usage

white-list

allow only players on the whitelist to join the server

achievements

enable player achievements

announce-player-achievements

broadcast achievement earned messages to all players

spawn-protection

size of the spawn area where non op players can't build or break blocks

max-players

maxium number of players online

spawn-animals

enable animal spawning

spawn-mobs

enable monster spawning

entity-auto-spawn-task

enable task for auto spawning of mobs and animals

spawning works by the server's difficulty setting

note: spawn-animals, spawn-mobs or both must be enabled if you want anything to be spawned

entity-despawn-task

enable despawning of mobs and animals without a name tag

note: there are special cases such as the ender dragon, withers and villagers that does not despawn

language

default language that Nukkit uses

in default builds only English (eng) is included

force-language

force server side translations to be used

shutdown-message

message that shows for players when you stop the server

use § for colors and §n for new line

save-player-data

enable saving of player inventory, position, first join time etc.

recommended to keep this enabled if you have a single world server and no other plugins handling the player data

can be usually safely disabled for creative, lobby or minigame only servers

for multiworld servers it's recommended to use plugin like WorldEssentials and disable this

gamemode

server's default gamemode

0 = survival, 1 = creative, 2 = adventure, 3 = spectator

force-gamemode

set gamemode to default gamemode on every join

hardcore

players will be banned after they die

pvp

enable or disable pvp on the server

to disable pvp only in certain worlds use the pvp gamerule

difficulty

server's default difficulty (0-3)

generator-settings

special settings for the world generator of default level

level-name

name of the default level

level-seed

the seed of the default level

level-type

type of the default level

default, normal, flat, nether, end or void

enable-query

enable / disable query

note: keep this enabled if you put your server to a server list site

enable-rcon

enable / disable rcon

rcon can be used for remote console access

note: rcon isn't the most safe way to remote control the server

note: rcon uses the same port (but TCP) as the server

rcon.password

password for rcon

auto-save

enable / disable auto saving of worlds

note: no level data is saved if you don't save it manually

force-resources

force players to download server's resource pack if they want to play

xbox-auth

require Xbox account to join

note: does not bypass client side requirements

bed-spawnpoints

enable bed spawnpoints

explosion-break-blocks

enable explosion damage to blocks

affects all explosions like tnt, creepers and end crystals

stop-in-game

allow op to use /stop command in game

op-in-game

allow op to op other players in game

xp-bottles-on-creative

allow players to throw experience bottles on creative

you may want to disable this because it's very easy to lag the server by spamming them

spawn-eggs

enable spawn eggs

recommended to disable this for creative only servers

mob-ai

enable built-in entity ai

query-plugins

send list of plugins in query

enable this if you want to show list of your plugins on server list

debug-level

set a higher value (1-3) if you need more debug data

async-workers

number of async workers

if set to auto, it will try to automatically detect the number of cores

zlib-provider

select zlib provider

0 = ZlibOriginal, 1 = ZlibSingleThreadLowMem, 2 = ZlibThreadLocal

default: 2

note: other providers may have negative impact on server's performance

compression-level

Zlib compression level for sent packets (0-9)

higher = more cpu usage but less bandwidth usage

auto-tick-rate

allow the server to automatically change level tick rate to maintain 20 ticks per second

auto-tick-rate-limit

how much the server can drop tick rate

base-tick-rate

default tick rate

1 = 20 ticks per second, 2 = 10 ticks per second, etc.

recommended to keep it as default (1)

always-tick-players

always tick players

enable-timings

enable timings on startup

timings-verbose

enable verbose for timings

timings-privacy

hide some stuff from timings reports

timings-history-interval

interval between history frames for timings

in ticks, 20 ticks = 1 second

timings-history-length

length of timings history

in ticks, 20 ticks = 1 second

timings-bypass-max

allow timings to bypass max

light-updates

enable light updates

usually no reason to disable this

note: sky light is not implemented

clear-chunk-tick-list

enable clearing of the chunk ticking list

cache-chunks

save chunks to memory for faster sending

note: no multiversion support

spawn-threshold

how many chunks needs to be loaded before player spawns

chunk-sending-per-tick

how many chunks can be sent per tick

chunk-ticking-per-tick

how many chunks can be ticked per tick

chunk-ticking-radius

radius of chunks around players to get ticked

chunk-generation-queue-size

how many chunks can be waiting for generation

chunk-generation-population-queue-size

how many chunks can be waiting for population

ticks-per-autosave

how often world autosave task runs

in ticks, 20 ticks = 1 second

ticks-per-entity-spawns

how often entity auto spawn task runs

in ticks, 20 ticks = 1 second

ticks-per-entity-despawns

how long entities live

in ticks, 20 ticks = 1 second

thread-watchdog

task that checks if the server is frozen and kills it

useful if you have auto restart script

thread-watchdog-tick how often thread watchdog runs its check

in milliseconds

nether

enable nether dimension and nether portals

end

enable the end dimension and end portals

low-profile-server-mode

disable some features

do-not-tick-worlds

list of worlds where random block ticking is disabled

this disables plants growing, leaves decacying, dirt turning into grass, falling blocks etc.

you may want to add your lobby and minigame worlds here

load-all-worlds

load all worlds from the worlds folder on startup

ansi-title

enable server status title for console window

disable this if you get text glitches (common issue with panels)

worlds-entity-spawning-disabled

list of world where entity auto spawning is not allowed

example: lobby, pvp, creative

block-listener

enable checks used for snow and iron golems, monster egg stone etc.

allow-flight

enable / disable fly anticheat

timeout-milliseconds

how long should the server wait before kicking player if no response from the client

in milliseconds, 1000 milliseconds = 1 second

multiversion-min-protocol

the minimum allowed protocol version

to allow all supported protocol versions set this to 0 or any other value lower than the minium supported protocol version

vanilla-bossbars

show boss bar for wither and ender dragon (experimental)

dimensions

enable dimension changes (experimental)

note: may cause game crashes

note: disabling this on 1.18+ causes issues due to different chunk serialization in different dimensions

whitelist-reason

that message is shown if player gets kicked because of white-listed server

use § for colors and §n for new line

chemistry-resources-enabled

enable textures for chemistry mode blocks and items with no resource pack downloading needed

note: experimental

note: chemistry mode items cause game crashes when the resource pack is not enabled

temp-ip-ban-failed-xbox-auth

block ip of player for 5 seconds when xbox auth fails

helps to prevent bot clients to slow down the server but may cause problems if many players uses same ip

call-data-pk-send-event

you can disable DataPacketSendEvent for better performance if none of your plugins uses it

call-batch-pk-send-event

you can disable BatchPacketsEvent for better performance if none of your plugins uses it

do-level-gc

enable / disable level garbage collection

skin-change-cooldown

cooldown for in game skin changes in seconds

check-op-movement

enable movement checking for operators

do-not-limit-interactions

option to disable a hack to limit right click spamming

do-not-limit-skin-geometry

disable maximum skin geometry size checks

automatic-bug-report

enable automatic bug reports

anvils-enabled

enable anvils

note: anvils on Nukkit are pretty experimental and issues with item renaming or item losses are quite common

save-player-data-by-uuid if enabled, saving player data by their uuid in the format NukkitX uses and automatically converting player data in the old format to the new format

disable this if you use the legacy Waterdog

vanilla-portals

enable vanilla like portal behavior

when disabled, nether and end portals bring players to the default spawn

persona-skins

persona skins allowed

note: default steve skin will show if disabled

multi-nether-worlds

if you need multiple nether worlds, list worlds that should have their own nethers here, otherwise using the default nether world

call-entity-motion-event

disabling entity motion events can be a small performance improvement when many mobs are moving at the same time

most plugins don't even use this event

update-notifications

notify operators about new Nukkit PM1E releases

note: while every new commit on the master branch is considered as a new version it's usually not necessary to update the server so often

bstats-metrics

enable bStats metrics

https://bstats.org/plugin/server-implementation/Nukkit/

data collected anonymously: server software (Nukkit PM1E), player count, players game versions, xbox auth required, Java version, operating system, cpu arch & core count, host country

min-mtu

set minimum MTU size

default: 576

max-mtu

set maximum MTU size

default: 1400

async-chunks

enable asynchronous chunk sending

this can improve the performance a lot when lots of chunks are being sent for players on different versions with no known side effects

anti-xray-worlds

list of worlds where the experimental built-in anti xray is enabled

example: nether, survival, factions

log-join-location

include player's world and coordinates in the "logged in" console message

unsafe-redstone

make redstone work better but with possible crash exploits

disable-new-blocks

disable placement of "new" blocks from game versions 1.2-1.14 that are not available on official Nukkit

note: does not remove new blocks from world generation when the built-in generator is used

attack-stop-sprint

stop sprinting when attacking an entity

chunk-compression-level

Zlib compression level for world saving (1-9)

reduce-traffic

reduce network traffic by not sending some non-critical data such as full item nbt

force-resources-allow-client-packs

don't disable client's own packs when force-resources is enabled

encryption

enable network encryption

it's recommended to enable this if you don't use a proxy software

use-waterdog

Enabling compatibility with the WaterdogPE proxy (to obtain the client's real IP and other functionalities).

use-client-spectator

Enabling client-side spectator mode for players on version 1.19.30 and above.

compression-threshold

don't compress batch packets smaller than this (Zlib only)

Clone this wiki locally