Minecraft Wiki

Server.properties: Difference between revisions

Page Talk

Server.properties (view source)

Revision as of 01:43, 16 October 2024

402 bytes removed ,  16 October 2024
Improve option descriptions, remove outdated information
VisualWikitext
mNo edit summary
(Improve option descriptions, remove outdated information)
Line 103:
!Default Value
!Description
 
|-
|- id="accepts-transfers"
|'''accepts-transfers'''
|boolean
|false
|Allows serversWhether to accept incoming transfers via a transfer packet.
:'''false''' - Incoming transfers are rejected, and the player is disconnected.
:'''true''' - Incoming transfers are allowed, and the server must approve it.
 
|- id="allow-flight"
|'''allow-flight'''
|boolean
|false
|AllowsWhether usersplayers tocan use flight on the server while in Survival mode, ifby they have ausing [[mod]] that provides flight installeds.
With allow-flight enabled, [[griefers]] may become more common, because it makes their work easier. In Creative mode, this has no effect.
:'''false''' - Flight is not allowed (players in air for at least 5 seconds get kicked).
Line 123 ⟶ 125:
|boolean
|true
|AllowsWhether players tocan travel to the [[Nether]].
:'''false''' - [[Nether portal]]s do not work.
:'''true''' - The server allows [[Nether Portal (block)|portal]]s to send players to the Nether.
 
|- id="broadcast-console-to-ops"
|'''broadcast-console-to-ops'''
|boolean
|true
|SendWhether to send console command outputs to all [[Server#Managing_and_maintaining_a_server|online operators]].
 
|- id="broadcast-rcon-to-ops"
Line 136 ⟶ 139:
|boolean
|true
|SendWhether to send rcon console command outputs to all online operators.
 
|- id="bug-report-link"
Line 142 ⟶ 145:
|string
|''blank''
|The URL for the <code>report_bug</code> server link. If empty, the link is not sent.
 
If empty, the link is not sent.
 
|- id="difficulty"
Line 148 ⟶ 153:
|string
|easy
|Defines theThe [[difficulty]] (such as damage dealt by mobs and the way hunger and poison affects players) of the server.
 
If a legacy difficulty number is specified, it is silently converted to a difficulty name.
 
Line 160 ⟶ 166:
|boolean
|false
|EnablesWhether command blocks are enabled.
 
|- id="enable-jmx-monitoring"
Line 166 ⟶ 172:
|boolean
|false
|ExposesWhether to expose an MBean with the Object name <code>net.minecraft.server:type=Server</code> and two attributes <code>averageTickTime</code> and <code>tickTimes</code> exposing the tick times in milliseconds.
 
In order forto enablingenable JMX on the Java runtime you also need to adduse a couple ofcertain JVM flags: to the startup as documented [https://docs.oracle.com/javase/8/docs/technotes/guides/management/agent.html here].
 
|- id="enable-rcon"
Line 189 ⟶ 196:
|boolean
|false
|EnablesWhether GameSpy4to protocolenable server listener[https://wiki.vg/Query Usedquery], towhich getprovides information about the server.
 
|- id="enforce-secure-profile"
Line 214 ⟶ 221:
|integer (10-1000)
|100
|How close entities need to be to the player to be sent. Higher values means they'll be rendered from farther away, potentially causing more lag.
 
Higher values means they'll be rendered from farther away, potentially causing more lag.
 
This is expressed as a percentage. For example, setting to 50 makes entites only render at half the usual distance. This mimics the function on the client video settings (not unlike Render Distance, which the client can customize so long as it's under the server's setting).
Line 231 ⟶ 240:
|integer (1-4)
|2
|Sets theThe default permission level for [[Function (Java Edition)|functions]].
 
See [[permission level]] for the details on the 4 levels.
 
Line 283 ⟶ 293:
|string
|''blank''
|Comma-separated list of datapacksDatapacks to not be auto-enabled on world creation.
 
Specified as a comma-separated list.
 
|- id="initial-enabled-packs"
Line 289 ⟶ 301:
|string
|vanilla
|Comma-separated list of datapacksDatapacks to be enabled during world creation. Feature packs need to be explicitly enabled.
 
Specified as a comma-separated list. Feature packs need to be explicitly enabled.
 
|- id="level-name"
Line 296 ⟶ 310:
|world
|The world name and the world directory name.
 
When generating a new world, this will be used as it's name.
 
The player may place an existing world directory in the server directory, and change this value to the name of the world directory to load it.
 
Characters such as ' (apostrophe) may need to be escaped by adding a backslash before them.
 
|- id="level-seed"
Line 305 ⟶ 319:
|string
|''blank''
|The [[Seed (world generation)|seed]] for the generated world. A random seed is used if left blank.
 
A random seed is used if left blank.
 
|- id="level-type"
Line 331 ⟶ 347:
|integer{{more info|the valid range}}
|1000000
|LimitThe limit of consecutive neighbor updates before skipping additional ones.
 
Negative values removedisable the limit.
 
|- id="max-players"
Line 347 ⟶ 363:
|integer (-1 or 0–(2^63 - 1))
|60000
|The maximum number of milliseconds a single tick may take.
|The maximum number of milliseconds a single tick may take before the server watchdog stops the server with the message, ''A single server tick took 60.00 seconds (should be max 0.05); Considering it to be crashed, server will forcibly shutdown.'' Once this criterion is met, it calls System.exit(1).▼
 
▲|TheAfter maximumthis numberlimit ofis milliseconds a single tick may take beforeexceeded, the server watchdog stops the server with the message, ''A single server tick took 60.00 seconds (should be max 0.05); Considering it to be crashed, server will forcibly shutdown.'' Onceand thisexits criterionwith isan met,exit itcode callsof System.exit(1).
 
:'''-1''' - disable watchdog entirely (this disable option was added in 14w32a)
 
|- id="max-world-size"
Line 355 ⟶ 373:
|integer (1-29999984)
|29999984
|The amount of blocks from the center of the world where the [[world border]] appears.
|This sets the maximum possible size in blocks, expressed as a radius, that the [[world border]] can obtain. Setting the world border bigger causes the commands to complete successfully but the actual border does not move past this block limit. Setting the max-world-size higher than the default doesn't appear to do anything. ▼
Examples:
 
▲|This sets the maximum possible size in blocks, expressed as a radius, that the [[world border]] can obtain. Setting the world border bigger causes the commands to complete successfully but the actual border does not move past this block limit. Setting the max-world-size higher than the default doesn't appear to do anything. {{verify}}
*Setting max-world-size to 1000 allows the player to have a 2000×2000 world border.
*Setting max-world-size to 4000 gives the player an 8000×8000 world border.
 
|- id="motd"
Line 365 ⟶ 381:
|string
|''A Minecraft Server''
|This is theThe message that is displayed in the server list of the client, below the server name.
 
*The MOTD supports [[Formatting codes#Use in server.properties and pack.mcmeta|color and formatting codes]].
*The MOTD supports special characters, such as "♥". However, such characters must be converted to escaped Unicode form. An online converter can be found [http://www.freeformatter.com/string-utilities.html#charinfo here].
*If the MOTD is over 59 characters, the server list may report a communication error.
 
Line 375 ⟶ 391:
|integer
|256
|How big should a packet be to be compressed.
|By default it allows packets that are ''n-1'' bytes big to go normally, but a packet of ''n'' bytes or more gets compressed down. So, a lower number means more compression but compressing small amounts of bytes might actually end up with a larger result than what went in.▼
 
▲|ByPackets defaultthe itsize allowsof packets that are ''n-1'' bytes big to go normally, but a packet ofthis ''n''many bytes or more getswill be compressed down. So, aA lower numberthreshold meanswill compress more compressionpackets, but compressing small amounts of bytesdata might actually end up with a larger result than what wentthe insource.
 
:'''-1''' - disable compression entirely
:'''0''' - compress everything
 
'''Note:''' ''The Ethernet spec requires that packets less than 64 bytes become padded to 64 bytes. Thus, setting a value lower than 64 may not be beneficial. It is also not recommended to exceed the MTU, typically 1500 bytes.''
 
|- id="online-mode"
Line 386 ⟶ 404:
|boolean
|true
|Whether to only allow players verified with the ''Minecraft'' account database to join.
|Server checks connecting players against ''Minecraft'' account database. Set this to false only if the player's server is '''not''' connected to the Internet. Hackers with fake accounts can connect if this is set to false! If minecraft.net is down or inaccessible, no players can connect if this is set to true. Setting this variable to off purposely is called "cracking" a server, and servers that are present with online mode off are called "cracked" servers, allowing players with unlicensed copies of ''[[Minecraft]]'' to join.▼
 
▲|Server checks connecting players against ''Minecraft'' account database. Set this to false only if the player's server is '''not''' connected to the Internet. Hackers with fake accounts can connect if this is set to false! If minecraft.net is down or inaccessible, no players can connect if this is set to true. Setting this variable to off purposely is called "cracking" a server, and servers that are present with online mode off are called "cracked" servers, allowing players with unlicensed copies of ''[[Minecraft]]'' to join.
 
:'''true''' - Enabled. The server assumes it has an Internet connection and checks every connecting player.
Line 395 ⟶ 415:
|integer (0-4)
|4
|Sets theThe default [[permission level]] for ops when using {{cmd|op}}.
 
|-
|- id="pause-when-empty-seconds"
|'''pause-when-empty-seconds'''{{upcoming|java 1.21.2}}
|integer
|60
|CausesHow themany serverseconds have to pausepass whenafter no player has been online forbefore thisthe manyserver secondsis paused.
 
|- id="player-idle-timeout"
|'''player-idle-timeout'''
|integer
|0
|IfHow non-zero,many playersminutes are kicked fromdoes the serverplayer ifhave they areto idle forto morebe thankicked thatfrom manythe minutesserver.
 
If set to 0, idle players are never kicked.
 
:'''Note:''' ''Idle time is reset when the server receives one of the following packets:''
Line 424 ⟶ 448:
|boolean
|false
|IfWhether to kick players if the ISP/AS sent from the server is different from the one from Mojang Studios' authentication server, the player is kicked.
 
|- id="pvp"
Line 430 ⟶ 454:
|boolean
|true
|Whether to enable PvP on the server.
|Enable PvP on the server. Players shooting themselves with arrows receive damage only if PvP is enabled.▼
 
▲|Enable PvP on the server. Players shooting themselves with arrows receive damage only if PvP is enabled.
 
:'''true''' - Players can kill each other.
Line 441 ⟶ 467:
|integer (1-(2^16 - 2))
|25565
|The TCPUDP port number the query server (see '''enable-query''') listens on.
 
|- id="rate-limit"
Line 447 ⟶ 473:
|integer
|0
|The maximum amount of packets a userplayer can send before getting kicked.
 
Setting to 0 disables this feature.
Line 457 ⟶ 483:
|The password for rcon.
 
If the password is blank and rcon is enabled, it iswill not startedstart as a safeguard.
 
|- id="rcon.port"
Line 464 ⟶ 490:
|25575
|The TCP port number rcon listens on.
 
|-
|- id="region-file-compression"
|'''region-file-compression'''
|string
Line 476 ⟶ 503:
|string
|''blank''
|The [[Resourceresource pack]] download URL.
 
The player may choose to download the resource pack when joining.
Line 490 ⟶ 517:
|[[UUID]] in hyphenated hexadecimal format
|''blank''
|OptionalAn optional UUID for the resource pack set by {{cd|resource-pack}} to identify the pack with clients.
 
|- id="resource-pack-prompt"
Line 497 ⟶ 524:
|''blank''
|{{Anchor|resource-pack-prompt}}
Optional, adds aA custom message to be shown on resource pack prompt when <code>require-resource-pack</code> is used.
 
Can be left empty for a default message. Expects chat component syntax, can contain multiple lines.
 
|- id="resource-pack-sha1"
Line 505 ⟶ 532:
|string
|''blank''
|{{Anchor|resource-pack-hash}} OptionalAn optional SHA-1 digest of the resource pack, in lowercase hexadecimal. It is recommended to specify this, because it is used to verify the integrity of the resource pack.
 
It is recommended to specify this, because it is used to verify the integrity of the resource pack.
 
'''Note:''' If the resource pack is any different, a yellow message "Invalid sha1 for resource-pack-sha1" appears in the console when the server starts.
 
Line 512 ⟶ 542:
|boolean
|false
|{{Anchor|resource-pack-hash}}When this option is enabled (set to true),Whether players are prompted for a response and get disconnected if they decline to use the requiredresource pack.
 
|- id="server-ip"
Line 534 ⟶ 564:
|integer (3-32)
|10
|Sets theThe maximum distance from players that living entities may be located in order to be updated by the server, measured in chunks in each direction of the player (radius, not diameter). If entities are outside of this radius, then they are not ticked by the server and they are not visible to players.
''10 is the default/recommended. If the player has major lag, this value is recommended to be reduced.''▼
 
If entities are outside of this radius, then they are not ticked by the server and they are not visible to players.
|- id="snooper-enabled"
|'''snooper-enabled'''
|boolean
|true
|Sets whether the server sends snoop data regularly to http://snoop.minecraft.net.
 
▲''10 is the default/recommended. If the player has major lag, this value is recommended to be reduced.''
:'''false''' - disable snooping.
:'''true''' - enable snooping.
 
|- id="spawn-animals"
Line 550 ⟶ 574:
|boolean
|true
|Determines ifWhether [[animal]]s can spawn. Removed.{{upcoming|java in [[24w33a]]1.21.2}}
 
:'''true''' - Animals spawn as normal.
Line 561 ⟶ 585:
|boolean
|true
|Determines ifWhether [[monster]]s can spawn.
 
:'''true''' - Enabled. Monsters appear at night and in the dark.
Line 574 ⟶ 598:
|boolean
|true
|Determines whetherWhether villagers can spawn. Removed.{{upcoming|java in [[24w33a]]1.21.2}}
 
:'''true''' - Enabled. Villagers spawn.
Line 583 ⟶ 607:
|integer
|16
|The side length of the square [[spawn protection]] area as 2''x''+1.
|Determines the side length of the square [[spawn protection]] area as 2''x''+1. Setting this to 0 disables the spawn protection. A value of 1 protects a 3×3 square centered on the spawn point. 2 protects 5×5, 3 protects 7×7, etc. This option is not generated on the first server start and appears when the first player joins. If there are no [[Server#Managing_and_maintaining_a_server|ops]] set on the server, the spawn protection is disabled automatically as well.▼
 
▲|Determines the side length of the square [[spawn protection]] area as 2''x''+1. Setting this to 0 disables the spawn protection. A value of 1 protects a 3×3 square centered on the spawn point. 2 protects 5×5, 3 protects 7×7, etc. This option is not generated on the first server start and appears when the first player joins. If there are no [[Server#Managing_and_maintaining_a_server|ops]] set on the server, the spawn protection is disabled automatically as well.
 
|- id="sync-chunk-writes"
Line 589 ⟶ 615:
|boolean
|true
|EnablesWhether to enable synchronous chunk writes.
 
|- id="text-filtering-config"
Line 601 ⟶ 627:
|boolean
|true
|Linux serverWhether performanceto improvements:use optimized packet sending/receiving on Linux.
 
:'''true''' - Enabled. Enable Linux packet sending/receiving optimization.
:'''false''' - Disabled. Disable Linux packet sending/receiving optimization.
 
|- id="view-distance"
Line 610 ⟶ 636:
|integer (3-32)
|10
|Sets theThe amount of world data the server sends the client, measured in chunks in each direction of the player (radius, not diameter). It determines the server-side viewing distance.
 
This determines the server-side viewing distance.
 
''10 is the default/recommended. If the player has major lag, this value is recommended to be reduced.''
 
Line 617 ⟶ 646:
|boolean
|false
|EnablesWhether athe whitelist on theis serverenabled.
 
With a whitelist enabled, users not on the whitelist cannot connect. Intended for private servers, such as those for real-life friends or strangers carefully selected via an application process, for example.
 
Line 1,180 ⟶ 1,210:
|{{HistoryLine|||dev=release|Added {{cd|generate-structures}}.}}
|{{HistoryLine||1.2.1|dev=12w07a|Added {{cd|max-build-height}}.}}
|{{HistoryLine||1.3.1|dev=12w30a|Added {{cd|snooper-enabled}}. It specified whether to send snoop data regularly to http://snoop.minecraft.net.}}
|{{HistoryLine||1.4.2|dev=12w40a|Added {{cd|spawn-protection}}.}}
|{{HistoryLine||1.5|dev=13w05a|Setting {{cd|spawn-protection}} to 0 now disables spawn protection, instead of protecting a 1&times;1 area ({{bug|MC-666}}).}}
Line 1,186 ⟶ 1,216:
|{{HistoryLine||1.8|dev=14w17a|Added {{cd|generator-settings}}.}}
|{{HistoryLine||1.8|dev=14w28a|Added option to customize network compression.}}
|{{HistoryLine||1.8|dev=14w32a|Setting {{cd|max-tick-time}} to {{cd|1}} now disables the watchdog entirely.}}
|{{HistoryLine||1.11|dev=16w38a|Added {{cd|prevent-proxy-connections}}.}}
|{{HistoryLine||1.12|dev=17w18a|Removed option {{cd|announce-player-achievements}} as it was replaced by the gamerule {{cd|announceAdvancements}}.}}
Retrieved from "https://minecraft.wiki/w/Special:MobileDiff/2718881"