-
Notifications
You must be signed in to change notification settings - Fork 55
Configuration
Settings on Nukkit PM1E are located in server.properties file. Additionally, a few other data files are created in the server folder automatically. This page explains what those do.
saves the names of players with operator permission, lowercase and one per line
it's recommended to use 'op' and 'deop' commands to modify
saves the names of whitelisted players, lowercase and one per line
it's recommended to use 'whitelist' command to modify
saves banned player names
it's recommended to use 'ban' and 'pardon' commands to modify
saves banned IP addresses
it's recommended to use 'banip' and 'pardonip' commands to modify
saves a global counter of known used map IDs
do not modify
saves all settings
some of them can be applied using 'reload' command while the server is running, some require a restart
restarting the server is always recommended after modifying these
server name / text which shows on the server list
note: can't be empty
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's port
note: there can't be two servers running in the same port
note: you will need to port forward in order to have your server publicly accessible
note: bedrock edition uses UDP
ip where server runs
default is 0.0.0.0 and you don't usually need to change this
note: do not edit unless you know what you are doing
maximum view distance in chunks
bigger value = more chunks loaded = more ram & cpu usage
allow only players on the whitelist to join the server
use whitelist command or modify white-list.txt to add players to whitelist
enable player achievements
broadcast achievement earned messages to all players
size of the spawn area in blocks where non op players can't build or break blocks
maxium number of players online at once
enable animal spawning
enable monster spawning
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
enable despawning of mobs and animals without a name tag
note: there are special cases such as the ender dragon, withers and villagers that do not despawn
default language that Nukkit uses
in default builds only English (eng) is included
force server side translations to be used
enable only if you have a plugin to implement those
message that shows for players when you stop the server
use § for colors and §n for new line
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 many gamemode servers it's recommended to use multiworld inventory system like WorldEssentials and disable this
server's default gamemode
0 = survival, 1 = creative, 2 = adventure, 3 = spectator
set player gamemode to default gamemode on every join
players will be banned when they die
enable or disable pvp on the server
use the pvp gamerule to disable pvp only in certain worlds
server's default difficulty (0-3)
special world generator settings for the default level
name of the default level
seed used to create the default level if it doesn't exist
generator used to create the default level if it doesn't exist
supported by default: default, normal, flat, nether, the_end or void
enable extended query
you don't need to enable this for your server to appear on bedrock edition server lists
enable remote console access
note: rcon isn't very secure way to remote control the server
note: rcon uses the same port (but TCP) as the server
password for rcon
automatically save the world and player data
note: if disabled, changes to worlds are not saved automatically even on unload, use plugin to save manually if needed
you can use worlds-level-auto-save-disabled to only disable the auto save task instead
force players to download server's resource pack if they want to join
also see force-resources-allow-client-packs
require Xbox account to join
note: does not bypass client side requirements
note: if you disable this (not recommended), make sure player names and UUIDs are verified before passing them to permission managers/op
allow players to set spawn point using beds and respawn anchors
enable explosion damage to blocks
affects all explosions such as tnt, creepers and end crystals
allow op to use /stop command in game
allow op to use /op command to op other players in game
allow players to throw experience bottles on creative
enable spawn eggs
enable built-in entity ai
include list of plugins in query (enable-query=on)
set a higher value (1-3) if you want more debug logging
number of async worker threads
if set to auto, it will try to automatically detect the number of cores and use that
select zlib provider
0 = ZlibOriginal, 1 = ZlibSingleThreadLowMem, 2 = ZlibThreadLocal
default: 2
note: other providers may have negative impact on the server's performance
enable async compression
adds half/one tick delay, less cpu load on main thread
note: since the 1.16.100 update all packets are batched on another thread and this setting has no use
Zlib compression level for sent packets (0-9)
higher = more cpu usage but less bandwidth usage
allow the server to automatically change level tick rate to maintain 20 ticks per second
how much the server can temporary drop 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
enable timings on startup
enable verbose for timings
hide some sensitive info from timings reports
interval between history frames for timings
in ticks, 20 ticks = 1 second
length of timings history
in ticks, 20 ticks = 1 second
allow timings to bypass max
enable block light updates
note: sky light is not implemented
enable clearing of the chunk ticking list after tick
save chunks to memory for faster sending
note: no proper multiversion support
how many chunks need to be loaded before player spawns
how many chunks can be sent per tick
how many chunks can be ticked per tick
radius of chunks around players to get ticked
how many chunks can be waiting for generation
how many chunks can be waiting for population
how often world autosave task runs
in ticks, 20 ticks = 1 second
how often entity auto spawn task runs
in ticks, 20 ticks = 1 second
how long entities live
in ticks, 20 ticks = 1 second
enable a task that checks if the server is frozen and kills it
useful if you have an auto restart script or the server runs on a panel with this feature
how long the server can be not responding until it's killed
in milliseconds
enable nether dimension and nether portals
enable the end dimension and end portals
requires WorldGeneratorExtension
enable / disable stuff optimized for SCPE
keep this disabled
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
automatically load all worlds from the worlds folder on startup
enable server status title for console window
disable this if you get text glitches (common issue with panels)
list of world where entity auto spawning is not allowed
example: lobby, pvp, creative
enable checks used for snow and iron golems, monster egg stone etc.
enable / disable fly anticheat
how long should the server wait before kicking player if no response from the client
in milliseconds, 1000 milliseconds = 1 second
the minimum protocol version which is allowed to connect if supported
to allow all supported protocol versions, set this to 0 or any other value lower than the minimum supported protocol version
to disable multiversion, set this to -1
show boss bar for wither and ender dragon (experimental)
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
that message is shown if player gets kicked because of white-listed server
use § for colors and §n for new line
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
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
you can disable DataPacketSendEvent for better performance if none of your plugins uses it
you can disable BatchPacketsEvent for better performance if none of your plugins uses it
you can disable EntityMotionEvent for better performance if none of your plugins uses it
do level garbage collection between ticks
cooldown for in game skin changes in seconds
enable movement checking for operators
disables a hack which is used to limit right click interaction spamming by client
disables maximum skin geometry size checks
may be required for some persona skins to be usable
enable automatic bug reports
enable anvils
note: anvils on Nukkit are pretty experimental and issues with item renaming or lost items are quite common
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 proxy
note: do not disable if new player data exists
enable vanilla like portal behavior
when disabled, nether and end portals bring players to the default spawn point
persona skins allowed
note: default steve skin will show if disabled
note: enabling do-not-limit-skin-geometry may be required for some persona skins to be usable
if you need multiple nether worlds, list worlds which should have their own nethers here, otherwise using the default nether world
notify operators about new Nukkit PM1E releases on join
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
set minimum MTU size
default: 576
set maximum MTU size (576 - 1492)
higher is more efficient but smaller values could fix issues on some connections
default: 1400
enable asynchronous chunk sending
this can improve the performance a lot when lots of chunks are being sent to players on different versions
it's recommended to keep this enabled
list of worlds where the experimental built-in anti xray is enabled
example: world, survival, factions
include player's world and coordinates in the "logged in" console message
make redstone work better but with possible exploits
disable placement of "new" blocks from game versions 1.2-1.14 that are not available on official Nukkit
stop sprinting when attacking an entity
Zlib compression level for world saving (1-9)
note: only affects Anvil format worlds
reduce network traffic by not sending some non-critical data such as full item nbt
don't disable client's own packs when force-resources is enabled
enable network encryption
it's recommended to enable this if you don't use a proxy software
allow unimplemented blocks to be placed (leveldb only)
enable high performace Snappy compression for packets sent over network to 1.19.30+ clients (experimental)
don't compress batch packets smaller than this (Zlib only)
used with 'use-native-leveldb'
set max size of chunk data cache used to reduce disk io
per world, consider increasing if you only have a few large worlds and lots of ram
how long a chunk should be unused before it's unloaded (seconds)
reduces unnecessary chunks loads/unloads when players move in the world
use native leveldb implementation
enable for possible performance improvements
may cause high disk load on some systems
allow changing sea level on newly generated chunks to match vanilla (64 vs 62)
note: this affects all worlds using the built-in generator
enable 1.2 - 1.12 protocol support
note: only works with Anvil worlds
note: support for these versions is no longer maintained
enable raw ore drops for gold and iron ore block
copper ore always drops raw copper
enable latest world generation features in all worlds
may create noticeable chunk borders in old worlds