🎛️Arguments and Properties

Learn about startup arguments and system properties.

The start arguments and system properties are values appended to the commands used for Plasma execution, influencing the overall operation of Plasma.

According to the start argument and system properties in the position added to the command (#user-content-fn-2), it will be divided.

System Properties

System properties are values processed in the JVM before Plazma is initialized and entered in front of -jar.

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!

Usage

System properties are entered as Java command arguments between java and -jar.

For example, when applying the Plazma.dummyProperty system property, entering as follows initializes Plazma with 37 entered 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 inherent to JVM,

If no value is entered for the property, the value is fixed as .

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 you should add " to the ends of the arguments (#user-content-fn-4).

Full System Properties

`convertLegacySigns`

Type: Boolean
Default: False

Updates deprecated sign formats.

`debug.entities`

Type: Boolean
Default: False

Enables debug logs related to entity information.

`debug.rewriteForIDE`

Type: Boolean
Default: False

Disables NMS revision to correctly load debug information in IDE, and automatically remaps internal version information.

`disable.watchdog`

Type: Boolean
Default: False

Disables Spigot's Watchdog warning system.

`letMeReload`

Type: Boolean
Default: False

Disables confirmation message for the /reload command.

The /reload command is very unstable, so any issues that occur after using /reload are the responsibility of the user.

If you are a plugin developer and need to update a plugin, use hotswap instead of /reload.

`io.papermc.paper.suppress.sout.nags`

Type: Boolean
Default: False

Disables plugins using standard input and output system.

`net.kyori.adventure.text.warnWhenLegacyFormattingDetected`

Type: Boolean
Default: False

Warns when deprecated formatting is detected in chat components.

`Paper.bypassHostCheck`

Type: Boolean
Default: False

Disables server's pattern matching verification when players connect to the server.

`Paper.debugDynamicMissingKeys`

Type: Boolean
Default: False

Enables debug logs for missing keys in NBT objects.

`Paper.debugInvalidSkullProfiles`

Type: Boolean
Default: False

Enables debug logs for head blocks with invalid profile information.

Logs all incorrect head blocks in the world with their locations.

`Paper.disableChannelLimit`

Type: Boolean
Default: False

Disables the limit of 128 plugin applied per player.

`Paper.disableClassPrioritization`

Type: Boolean
Default: False

Disables plugin class prioritization system.

Useful when issues arise in plugin shading.

`Paper.disableFlushConsolidate`

Type: Boolean
Default: False

Disables Netty flush consolidation system.

`Paper.excessiveTELimit`

Type: Integer
Default: 750

Splits entities into multiple packets if they exceed the set value.

`Paper.filterThreshold`

Type: Integer
Default: 8192

Sets the maximum packet size the server can receive at once.

`Paper.ignoreJavaVersion`

Type: Boolean
Default: False

Disables Java version check.

This may allow JVM to attempt to access non-existent code!

World and overall files can be permanently corrupted, breaking the game's entire mechanics.

Any issues that arise from using this are the user's responsibility, and Plamza does not provide any support for it.

`Paper.maxCustomChannelName`

Type: Integer
Default: 64

Sets restrictions on the plugin name.

`Paper.maxSignLength`

Type: Integer
Default: 80

Sets the maximum length of characters that can be entered on a sign line.

`Paper.minPrecachedDatafixVersion`

Type: Integer
Default: (world version) + 1

Sets the version of initial world update information to be initialized first.

Useful when a large number of chunks need to be updated, but otherwise not used.

`Paper.parseYamlCommentsByDefault`

Type: Boolean
Default: True

Enables processing of comments in YAML files.

`Paper.playerConnection.keepAlive`

Type: Integer
Default: 30

Kicks players if no data is received from them for the specified time (in seconds).

In general, the continues to send to the server, so it is not kicked, but if the game does not respond, it is considered a crash and the server will no longer process the player and kick them.

`Paper.skipServerPropertiesComments`

Type: Boolean
Default: False

Ignores server properties comments.

`Paper.debug-sync-loads`

Type: Boolean
Default: False

Enables debug logs for synchronous chunk loading.

`Paper.enable-sync-chunk-writes`

Type: Boolean
Default: False

Enables Minecraft's .

This proceeds to save each chunk sequentially, causing significant performance degradation.

`Paper.explicit-flush`

Type: Boolean
Default: False

Enables explicit flushing of network channels.

`Paper.strict-thread-checks`

Type: Boolean
Default: False

Always logs errors that do not occur on the main thread.

`Paper.tickList-warn-on-excessive-delay`

Type: Boolean
Default: False

Outputs a warning if scheduled tasks have excessive wait times.

`Paperclip.patchOnly`

Type: Boolean
Default: False

When using the default executable file, only applies patches without starting the server.

`Plazma.aggressiveOptimize`

Type: Boolean
Default: false
Conflict: Plazma.disableConfigOptimization

Optimize the initial configuration more strongly.

Enabling this will make the server faster and safer, but it can have a significant impact on gameplay.

`Plazma.disableConfigOptimization`

Type: Boolean
Default: false
Conflict: Plazma.aggressiveOptimize

Do not optimize the initial configuration.

This makes it use Paper's default configuration.

`Plazma.iKnowWhatIAmDoing`

Type: Boolean
Default: false

Suppresses the warning message displayed when Plazma is initialized (#user-content-fn-11).

`Plazma.useVanillaFavicon`

Type: Boolean
Default: false

Disable the Plazma branding and use the vanilla default server favicon.

`Plazma.useVanillaConfiguration`

Type: Boolean
Default: false
Conflict: Plazma.disableConfigOptimization

This property is still under development.

This property reverts all patched vulnerabilities!

This can have a significant impact on server safety and performance.

Any issues arising from this property are the responsibility of the server administrator.

Provides the initial configuration with the default values supplied by Mojang.

This disables all vulnerability patches applied by Paper.

Vulnerability patches can be re-enabled in either the Paper configuration or Plazma configuration.

`Plazma.vanillaize`

Type: Boolean
Default: true
Conflict: Plazma.aggressiveOptimize

This property is still under development.

Set the initial configuration closer to vanilla.

This is applied only to a degree that does not generally affect server performance and safety, and configures to use vanilla defaults when Plazma.disableConfigOptimization property is used.

The deprecated propertyis in use.

The following system property is a deprecated property.

`timings.bypassMax`

Type: Boolean
Default: false
Deprecated: Timings has been removed from Plazma since

Determines if values exceeding the maximum that can be sent to Aikar's Timings API are allowed.

Even if done this way, rate limiting will be applied if not handled in the API.

Start Arguments

Start arguments are entered after -jar *.jar to initialize Plazma and are processed together.

Usage

System properties are entered as program command arguments after -jar *.jar.

For example, if you want to apply the nogui start argument, enter as follows for Plazma to process the nogui argument during initialization.

java -Xms4G (...) -DPlazma.dummyProperty=37 -jar plazma.jar nogui (...)

All Start Arguments

`bukkit-settings`

Alias: b
Default: bukkit.yml

Sets the name and location of the Bukkit configuration file.

`command-settings`

Alias: c
Default: commands.yml

Sets the name and location of the Bukkit command configuration file.

`config`

Alias: c
Default: server.properties

Sets the name and location of the server properties file.

`demo`

Starts the server with a demo world.

`eraseCache`

Removes leftover cache files after world upgrades.

`forceUpgrade`

Forces an upgrade of the world, ignoring the version.

`help`

Alias: ?

Outputs the full start arguments and descriptions for Plazma.

`initSettings`

Only generates configuration files and shuts down the server.

`jfrProfile`

Enables JFR profiling.

`max-players`

Alias: s, size
Default: (server properties)

Sets the maximum number of allowed players.

`nogui`

Disables the graphical interface panel.

`nojline`

Disables JLine and uses vanilla console.

`online-mode`

Alias: o
Default: (server properties)

Selects whether to authenticate players with Mojang authentication servers.

Sanctions may apply for violating the EULA if not using Velocity or other proxies.

`paper-settings`

Alias: paper
Default: paper.yml

This argument has been deprecated after 1.19.4.

Sets the location of the deprecated PaperSpigot configuration file.

Used to transfer existing configurations to new configuration files, and not used afterwards.

`paper-settings-directory`

Alias: paper-dir
Default: config

Sets the name and location of the folder containing the Paper configuration files.

`plazma-settings-directory`

Alias: plazma-dir

Sets the name and location of the folder containing the Plazma configuration files.

`plugins`

Alias: p
Default: plugins

Sets the location of the plugins folder.

`pufferfish-settings`

Alias: pufferfish
Default: pufferfish.yml

Sets the name and location of the Pufferfish configuration file.

`purpur-settings`

Alias: purpur
Default: purpur.yml

Sets the name and location of the Purpur configuration file.

`safeMode`

Starts the server in a completely vanilla state (Safe Mode).

`server-ip`

Alias: h, host
Default: (server properties)

Sets the host name or Internet Protocol address of the server.

`server-port`

Alias: p, port
Default: (server properties)

Sets the port of the server.

`server-name`

Default: A Plazma Server

Sets the name of the server.

`spigot-settings`

Alias: S
Default: spigot.yml

Sets the name and location of the Spigot configuration file.

`version`

Alias: v

Outputs the Plazma version.

`world-dir`

Alias: W, universe, world-container
Default: (server folder)

Sets the location where world files are saved.

`world-name`

Alias: w, world
Default: (server properties)

Sets the name of the world file.

Last updated 4 months ago