Start-up Parameters

Jan 31, 2015 at 9:31 PM
Start-up Parameters
  • Spigot Start-up Parameters

    Optional command line parameters used when starting Spigot


    These parameters below should be put after ".jar" in your start script if the description of a parameter does not specify something else.

    --bukkit-settings <file>.yml
    Alias: -b <file>.yml
    Default: bukkit.yml
    This parameter allows you to manually define the bukkit configuration file to use for the server.

    --commands-settings <file>.yml
    Alias: -C <file>.yml
    Default: commands.yml
    This allows you to modify the file name of commands.yml

    --config <config file>.yml
    Alias: -c <file>.yml
    Default: server.properties
    This parameter allows you to manually define the configuration file to use for the server startup.

    --date-format <definition>
    Alias: -d <definition>
    This allows you to define the date format used in console output and log files.

    -Dcom.mojang.eula.agree=true (for build #1544 and up)
    Position: before "-jar"
    This parameter allows you to run your server without editing the eula.txt. Put this parameter before "-jar".
    Please note, this is still legally binding that you have read and agree to the Minecraft EULA.

    -DconvertLegacySigns=true (for Spigot 1.8)
    This parameter will convert text on signs from the pre 1.8 format to the new 1.8 JSON format. This is needed to convert signs with bracket enclosed [text] on it properly as they would loose the brackets otherwise due to Minecraft beeing stupid.
    You have to load all chunks to convert the whole world! For example with a plugin like WorldBorder.
    Do NOT run this on a world already loaded with 1.8! That would mess up your signs!

    -Dfile.encoding=UTF-8
    Position: before "-jar"
    This parameter will ensure that all UTF-8 characters are being saved properly in server's log files, all characters should be correctly displayed in the console aswell. Put this parameter before "-jar"
    This parameter is only useful for older Linux based distributions, this may cause weird characters on Windows operating system.

    -Djline.terminal=jline.UnsupportedTerminal
    Position: before "-jar"
    This parameter will disable the JLine console and ">" character in console's input field.
    You should only use this parameter if you do not have Microsoft Visual C++ 2008 redistributable installed on Windows. Put this parameter before "-jar"
    Linux and UNIX users can safely ignore this option.

    --help
    Alias: -?
    Shows the help menu for startup parameters.
    Please note, this parameter will prevent you from starting the server. The JVM session will be terminated at startup.
    This help menu also shows when you try to use a misspelled/unknown parameter.

    --host <IP address>
    Alias: -h <IP address>
    Default: value from server.properties (none)
    This parameter allows you to manually define the hostname or IP address for the server to listen on.
    The argument may only include the IP address; please see below for overriding the port setting.

    --level-name <name>
    Aliases: -w <name> or --world <name>
    Default: value from server.properties (world)
    This parameter allows you to modify the level name, this will bypass the leve-name= value in server.properties file.
    Please pay attention to the uppercase for the first alias.

    --log-strip-color (for #1138 and below)
    This parameter strips all colors when saving to the log.

    --max-players <amount>
    Aliases: -s <amount> or --size <amount>
    Default: value from server.properties (20)
    Maximum amount of players that the server will allow, this will bypass the max-players= value in server.properties file.

    --noconsole
    To entirely disable the console usage, Log files are still being written.

    --nojline
    This parameter disables Bukkit's JLine console, and instead emulates the vanilla one, which is useful for users who do not have the Microsoft Visual C++ 2008 redistributable on Windows. Linux and UNIX users can safely ignore this option.

    --online-mode <true/false>
    Alias: -o <true/false>
    Default: boolean from server.properties (true)
    This parameter allows you to define in which mode the server should operate in, this will bypass the online-mode= boolean in server.properties file.

    -org.spigotmc.netty.disabled=true (for #1138 and below)
    This parameter disabled the Netty networking engine, defaulting to the regular one.
    Please see this page for more information.

    --plugins <directory>
    Alias: -P <directory>
    Default: plugins
    This parameter allows you to manually define the plugins directory to use for the server.
    Please note, pay attention to the uppercase for the alias.

    --port <port number>
    Aliases: --server-port <port number> or -p <port number>
    Default: value from server.properties (25565)
    This parameter allows you to manually define the port for the server to listen on. Be sure that you have to port you are using open (port forwarded).
    Please pay attention to the lowercase for the alias.

    --version
    Alias: -v
    This will display the server build number (version) on the startup, it's useful if you want to avoid of being a few builds after the latest.

    --world-dir <directory>
    Aliases: -W <directory> or --universe <directory> or --world-container <directory>
    Default: ./
    This parameter will put all worlds your server uses into a specific directory, it's useful if you have many folders inside in the main server directory.
    Please pay attention to the uppercase for the first alias.
  • Loading...
  • Loading...