diff --git a/docs/command-line-parameters.md b/docs/command-line-parameters.md index 08ccd8d9..6a132eb7 100644 --- a/docs/command-line-parameters.md +++ b/docs/command-line-parameters.md @@ -1,7 +1,7 @@ The following parameters can be added to TShock to alter the way a server initializes. Options set on the command line override any of their counterparts in the config file. These can be used either for personal use or in a GSP environment for easier hosting without hassle: * `-ip` - Starts the server bound to a given IPv4 address. For example: `-ip 0.0.0.0` will bind all interfaces. In contrast, `-ip 127.0.0.1` will bind only `127.0.0.1`. If your interface has another IP address assigned to it, you should be able to bind that. -* `-port` - Starts the server bound to a given port. For example: `-port 7777` will use the default port for Terraria. `-port 25565` will use the Minecraft default port. Ports below 1000 usually require administrator or root privileges to bind on most operating systems. +* `-port` - Starts the server bound to a given port. For example: `-port 7777` will use the default port for Terraria. `-port 25565` will use the Minecraft default port. Ports below `1000` usually require administrator or root privileges to bind on most operating systems. You will also need to allow accessing this port from your firewall, and port forward this port. * `-maxplayers`, or `-players` - Starts the server with a given player count. For example: `-maxplayers 5` sets the maximum number of players to 5. The theoretical maximum is `255`. You can set `-maxplayers 255` for this. * `-world` - Starts the server and immediately loads a given world file. Note: this parameter expects an absolute path. For example: `-world C:\Terraria\MyWorld.wld` or `-world /root/MyWorld.wld`. * `-worldselectpath` - Starts the server and changes the location for worlds to be the specified path. The server will look in this path for worlds to load. For example: `-worldselectpath /root` or `-worldselectpath C:\Terraria`. @@ -14,14 +14,14 @@ The following parameters can be added to TShock to alter the way a server initia * `-motd` - Sets the base game MOTD. For example, `-motd "Welcome to my server!"` will set the MOTD to `Welcome to my server!`. * `-autoshutdown` - Enables the base game's "auto shutdown" feature. * `-secure` - Turns on the base game's "antispam" feature. -* `-configpath` - Specifies the path tshock uses to resolve configs, log files, and sqlite db. -* `-logpath` - Overrides the default log path and saves logs here. +* `-configpath` - Specifies the path tshock uses to resolve configs, log files, and sqlite db. For example, `-configpath C:\Terraria\` will set the config path to `C:\Terraria\`. +* `-logpath` - Overrides the default log path and saves logs here. For example, `-logpath C:\Terraria\` will set the log path to `C:\Terraria\`. * `-logformat` - Changes the format of the name of log files, subject to C# date standard abbreviations. For example, `-logformat "yyyy-MM-dd"` will create a new log file for each day. The default is `yyyy-MM-dd_HH-mm-ss`. * `-logclear` - Overwrites old config if it exists. Useful for docker. For example, `-logclear`. -* `-dump` - Dumps permissions and config file descriptions for wiki use. +* `-dump` - Dumps permissions and config file descriptions for documentation purposes. * `-worldevil` - Sets the world's evil state (`random`, `corrupt`, or `crimson`). This only affects new worlds. For example, `-worldevil random` will set the world to a random evil state. -* `-heaptile` - Runs the server with the heaptile tile provider. HeapTile is an alternative ITile provider that uses less memory than the default. This is experimental and may cause issues. -* `-constileation` or `-c` - Runs the server with the Constileation tile provider. Constileation is an alternative ITile provider that uses less memory than the default. This is experimental and may cause issues. +* `-heaptile` - Runs the server with the heaptile tile provider. HeapTile is an alternative ITile provider that uses less memory than the default. This is experimental and may cause issues. For example, `-heaptile`. +* `-constileation` or `-c` - Runs the server with the Constileation tile provider. Constileation is an alternative ITile provider that uses less memory than the default. This is experimental and may cause issues. For example, `-constileation`. * `-difficulty` - Sets the world's difficulty (`0` for `normal`, `1` for `expert`, `2` for `master`, `3` for `journey`). This only affects new worlds. * `-loadlib` - Instructs the base game to load the library at the path. For example, `-loadlib C:\Terraria\MyLibrary.dll` will load the library `MyLibrary.dll` from the path `C:\Terraria\`. * `-crashdir` - Instructs the base game to save crash dumps to the path. For example, `-crashdir C:\Terraria\CrashDumps` will save crash dumps to `C:\Terraria\CrashDumps`.