description |
---|
Learn about startup arguments and system properties. |
The start arguments and system properties are values appended to the commands1 used in Plazma execution, which have a overall impact on the operation of Plazma.
According to the start argument and system properties divided by the position added to the command (#user-content-fn-2)2.
System properties inputted before -jar
are processed in the JVM before Plazma initialization.
{% hint style="warning" %}
Modifying system properties can change the operation of Plazma and JVM, and can have a significant impact on the game!
If you are not sure what each system property does, do not use it under any circumstances!
{% endhint %}
System properties are inputted as Java command arguments between java
and -jar
.
For example, if you want to apply the Plazma.dummyProperty
system property, entering the following will initialize Plazma with 37
in the next property.
java -Xms4G (...) -DPlazma.dummyProperty=37 -jar plazma.jar (...)
-D
indicates that the argument is an exclusive argument added to Plazma, not embedded in the JVM,
If no value is entered for the property, the value is fixed to true
3.
{% hint style="info" %}
The Paperweight server platform includes a .
in the property name to distinguish system properties for each platform.
In some terminals such as Windows Powershell, these arguments may not be allowed, so "
should be added to both ends of the argument (#user-content-fn-4)4.
{% endhint %}
- Type:
Boolean
- Default:
False
Updates deprecated sign formats.
- Type:
Boolean
- Default:
False
Enables debug logs related to entity information.
- Type:
Boolean
- Default:
False
Disables NMS revision in IDE to correctly load debug information, and automatically remaps internal version information.
- Type:
Boolean
- Default:
False
Disables Spigot's Watchdog warning system.
- Type:
Boolean
- Default:
False
Disables confirmation message for the /reload
command.
{% hint style="danger" %}
The /reload
command is very unstable, so any issues that occur after using /reload
are the responsibility of the user themselves.
If you are a plugin developer and need to update a plugin, use hotswapping instead of /reload
.
{% endhint %}
- Type:
Boolean
- Default:
False
Disables plugins using standard input/output system.
- Type:
Boolean
- Default:
False
Warns when deprecated formatting is detected in chat components.
- Type:
Boolean
- Default:
False
Disables server pattern matching verification when players connect to the server.
- Type:
Boolean
- Default:
False
Enables debug logs for missing keys in NBT objects.
- Type:
Boolean
- Default:
False
Enables debug logs for skull blocks with invalid profile information.
Logs all invalid skull blocks in the world with their locations.
- Type:
Boolean
- Default:
False
Disable the limit of 128 plugin channels5 applied per player.
- Type:
Boolean
- Default:
False
Disables plugin class prioritization system.
Useful when issues arise in plugin shading.
- Type:
Boolean
- Default:
False
Disables Netty flush consolidation system.
- Type:
Integer
- Default:
750
Splits entities into multiple packets if they exceed the set value.
- Type:
Integer
- Default:
8192
Sets the maximum packet size the server can receive at once.
- Type:
Boolean
- Default:
False
Disables Java version verification.
{% hint style="danger" %}
This may allow JVM to attempt to access non-existent code!
Files and overall game mechanics can be permanently damaged, causing the game to break.
Any issues caused by this are the user's responsibility, and Plamza does not provide any support for it.
{% endhint %}
- Type:
Integer
- Default:
64
Sets restrictions on the plugin channel name.
- Type:
Integer
- Default:
80
Sets the maximum length of characters that can be entered on one line of a sign.
- Type:
Integer
- Default:
(world version) + 1
Sets the version of initial world update information to be initialized.
Useful when updating a large number of chunks, but otherwise not used.
- Type:
Boolean
- Default:
True
Enables processing of comments in YAML files.
- Type:
Integer
- Default:
30
Kicks players if no data is received from them for the entered value (in seconds).
In general, the game6 continues to send heartbeat signals7 to the server, so players are not kicked,8 but if the game does not respond, it is considered a crash and the server will no longer process the player and kick them.
- Type:
Boolean
- Default:
False
Ignores comments in server properties.
- Type:
Boolean
- Default:
False
Enables debug logs for synchronous chunk loading.
- Type:
Boolean
- Default:
False
Enables Minecraft's default chunk writing system9.
This proceeds to save each chunk in order, causing significant performance degradation.
- Type:
Boolean
- Default:
False
Enables Explicit Flushing for network channels.
- Type:
Boolean
- Default:
False
Always logs errors not occurring on the main thread.
- Type:
Boolean
- Default:
False
Outputs a warning if scheduled tasks have excessive wait time.
- Type:
Boolean
- Default:
False
When using the default provided executable, only applies patches without starting the server.
- Type:
Boolean
- Default:
false
- Conflict:
Plazma.disableConfigOptimization
Optimizes the initial configuration more strongly.
Enabling this makes the server faster and safer, but it can have a significant impact on gameplay.
- Type:
Boolean
- Default:
false
- Conflict:
Plazma.aggressiveOptimize
Does not optimize the initial configuration.
This uses the default configuration of Paper.
- Type:
Boolean
- Default:
false
Suppress the warning message displayed when Plazma is initialized (#user-content-fn-11)10.
- Type:
Boolean
- Default:
false
Disables Plazma branding and uses the vanilla default server favicon.
- Type:
Boolean
- Default:
false
- Conflict:
Plazma.disableConfigOptimization
{% hint style="info" %}
This attribute is still under development.
{% endhint %}
{% hint style="danger" %}
This attribute reverts all patched vulnerabilities!
This can significantly impact server safety and performance.
Any issues resulting from using this attribute are the responsibility of the server administrator.
{% endhint %}
Provides the default values provided by Mojang for the initial configuration.
This disables all vulnerability patches applied by Paper.
Vulnerability patches can be re-enabled in Paper configuration or Plazma configuration.
- Type:
Boolean
- Default:
true
- Conflict:
Plazma.aggressiveOptimize
{% hint style="info" %}
This attribute is still under development.
{% endhint %}
Sets the initial configuration closer to vanilla.
This is applied only to the extent that it does not significantly impact server performance and safety,
and configures to use vanilla default values when the Plazma.disableConfigOptimization
attribute is used.
The following system attribute is obsolete.
- Type:
Boolean
- Default:
false
- Deprecated: Since Timings was completely removed from Plazma
Determines whether exceeding the maximum value that can be sent to Aikar's Timings API is allowed.
Even if done so, rate limiting will be applied if not handled in the API.
The start argument is entered after -jar *.jar
to initialize Plazma and is processed together.
System attributes are entered as program command arguments after -jar *.jar
.
For example, if you want to apply the nogui
start argument,
enter as follows to have Plazma process the nogui
argument during initialization.
java -Xms4G (...) -DPlazma.dummyProperty=37 -jar plazma.jar nogui (...)
- Alias:
b
- Default:
bukkit.yml
Sets the name and location of the Bukkit configuration file.
- Alias:
c
- Default:
commands.yml
Sets the name and location of the Bukkit command configuration file.
- Alias:
c
- Default:
server.properties
Sets the name and location of the server properties file.
Starts the server in demo world.
Removes remaining cache files after world upgrade.
Forces upgrading the world regardless of version.
- Alias:
?
Outputs all start arguments and descriptions of Plazma.
Creates configuration files only and shuts down the server.
Enables JFR profiling.
- Alias:
s
,size
- Default:
(server properties)
Sets the maximum number of allowed players.
Disables the graphical interface panel.
Disables JLine and uses vanilla console.
- Alias:
o
- Default:
(server properties)
Selects whether to verify players with Mojang authentication server.
May be sanctioned for violating the EULA if not using Velocity or other proxies.
- Alias:
paper
- Default:
paper.yml
{% hint style="warning" %}
This argument has been deprecated after 1.19.4
{% endhint %}
Sets the location of the deprecated PaperSpigot configuration file.
Used to transfer existing configurations to a new configuration file, and is no longer used afterwards.
- Alias:
paper-dir
- Default:
config
Sets the name and location of the folder where Paper configuration files are located.
- Alias:
plazma-dir
Sets the name and location of the folder where Plazma configuration files are located.
- Alias:
p
- Default:
plugins
Sets the location of the plugins folder.
- Alias:
pufferfish
- Default:
pufferfish.yml
Sets the name and location of the Pufferfish configuration file.
- Alias:
purpur
- Default:
purpur.yml
Sets the name and location of the Purpur configuration file.
Starts the server in a completely vanilla state (safe mode).
- Alias:
h
,host
- Default:
(server properties)
Sets the host name or Internet Protocol address of the server.
- Alias:
p
,port
- Default:
(server properties)
Sets the port of the server.
- Default:
A Plazma Server
Sets the name of the server.
- Alias:
S
- Default:
spigot.yml
Sets the name and location of the Spigot configuration file.
- Alias:
v
Outputs the Plazma version.
- Alias:
W
,universe
,world-container
- Default:
(server folder)
Sets the location where world files are stored.
- Alias:
w
,world
- Default:
(server properties)
Sets the name of the world file.
Footnotes
-
java (...) -jar server.jar (...)
↩ -
The processing location of the acquisition changes depending on the attached location. ↩
-
For example, if you want to set
Plazma.iKnowWhatIAmDoing
totrue
(activate), instead of entering-DPlazma.iKnowWhatIAmDoing=true
, entering-DPlazma.iKnowWhatIAmDoing
will work the same way. ↩ -
For example,
"-DPlazma.iKnowWhatIAmDoing"
↩ -
Event detector. ↩
-
Client. ↩
-
A signal indicating that the server is properly connected like a heartbeat. ↩
-
Using Purpur's AFK kick feature, you can kick players who are away from their keyboards. ↩
-
Sync Chunk Write System. ↩
-
WARNING! Plazma may cause unexpected problems, so be sure to test it thoroughly before using it on a public server.
↩