Share

Share

Server

From Terraria Wiki
Jump to: navigation, search
For server set-up tips, see Guide:Setting up a Terraria server. For lists of existing multiplayer servers, see Multiplayer.

A Terraria server provides a platform for players to connect over the internet or other network for multiplayer games. Windows installations of Terraria include its server software.

By default, on a 32-bit Windows installation of Terraria, TerrariaServer.exe can be found at:

%programfiles%\Steam\steamapps\common\terraria

On a 64-bit Windows installation, it can be found at:

%programfiles(x86)%\Steam\steamapps\common\terraria

A player then may join the server from the game menu by choosing the Multiplayer option.

The server runs on port 7777 by default, and it must be port-forwarded in order for other players be able to join. If one can't portforward, one may choose to use a VPN service like Hamachi or Tunngle instead (although in those cases, every player needs to install the VPN software). The default max players is 8, but this can be changed during server start-up, as well as within the server configuration file (serverconfig.txt).

Downloads[edit]

The vanilla Terraria server software is included with the regular Terraria package (see above), but can also be downloaded:

Dedicated Server GUI is a third-party add-on for the vanilla server that offers graphical controls (the server is normally a command-line program):

Tshock and TDSM are third-party server packages that offer additional functionality, such as in-game commands, whitelists, player passwords, and a plugin interface for added features (such as factions):

Server files[edit]

The server consists of three files:

  • TerrariaServer.exe - The main server file. Can be run stand-alone.
  • serverconfig.txt - The server config files. Defines all parameters for the server (see below).
  • start-server.bat - A Windows Batch file which starts the server using the serverconfig.txt file. Also contains a loopback to restart the server if it should crash.

List of console commands[edit]

Once a dedicated server is running, the following commands can be run:

  • help - Displays a list of commands.
  • playing - Shows the list of players. This can be used in-game by typing /playing into the chat.
  • clear - Clear the console window.
  • exit - Shutdown the server and save.
  • exit-nosave - Shutdown the server without saving.
  • save - Save the game world.
  • kick <player> - Kicks a player from the server.
  • ban <player> - Bans a player from the server.
  • password - Show password.
  • password <pass> - Change password.
  • version - Print version number.
  • time - Display game time.
  • port - Print the listening port.
  • maxplayers - Print the max number of players.
  • say <words> - Send a message to all players. They will see the message in yellow prefixed with <Server> in the chat.
  • motd - Print MOTD.
  • motd <words> - Change MOTD.
  • dawn - Change time to dawn (4:30 AM).
  • noon - Change time to noon (12:00 PM).
  • dusk - Change time to dusk (7:30 PM).
  • midnight - Change time to midnight (12:00 AM).
  • settle - Settle all water.

Note that a forward-slash / is not required to precede the command, as some command interfaces require. For a list of Tshock commands, refer to this forum thread.

Command line parameters[edit]

The following is a list of parameters that can be entered when running TerrariaServer initially:

  • -config <config file> - Specifies a configuration file to use (see Server config file below).
  • -port <port number> - Specifies the port to listen on.
  • -players <number> / -maxplayers <number> - Sets the max number of players.
  • -pass <password> / -password <password> - Sets the server password.
  • -motd <text> - Set the server motto of the day text.
  • -world <world file> - Load a world and automatically start the server.
  • -autocreate <#> - Creates a world if none is found in the path specified by -world. World size is specified by: 1(small), 2(medium), and 3(large).
  • -banlist <path> - Specifies the location of the banlist. Defaults to "banlist.txt" in the working directory.
  • -worldname <world name> - Sets the name of the world when using -autocreate.
  • -noupnp - Disables automatic universal plug and play.
  • -secure - Adds additional cheat protection to the server.

Server config file[edit]

It is possible to start the dedicated server using a configuration file that enters the above parameters automatically. The config file must be called using the -config parameter. The file can have any name, but must be in the same folder as TerrariaServer.exe. If a server config file is defined and the file is not located during the server boot, then the server will ask the user to input the parameters as it would if run without a defined config file.

The following is a list of available config commands:

  • maxplayers=8 - Sets the max number of players allowed on a server. Value must be between 1 and 255
  • world=C:\Users\Defaults\My Documents\My Games\Terraria\Worlds\world1.wld - Load a world and automatically start the server.
  • port=7777 - Set the port number
  • password=p@55w0rd* - Set the server password
  • motd=Please don’t cut the purple trees! - Set the message of the day
  • worldpath=C:\Users\Defaults\My Documents\My Games\Terraria\Worlds\ - Sets the folder where world files will be stored
  • autocreate=3 - Creates a new world if none is found. World size is specified by: 1(small), 2(medium), and 3(large).
  • worldname=World - Sets the name of the world when using autocreate
  • banlist=banlist.txt - The location of the banlist. Defaults to "banlist.txt" in the working directory.
  • secure=1 - Adds additional cheat protection.

Comment lines can be included using the hash symbol (#). Lines that begin with # will be skipped entirely.

Banning and un-banning[edit]

The command "ban <player>" will ban the indicated player from the server. A banned player may then be un-banned by editing the file "banlist.txt," which is located in the Terraria folder. This document contains a list of all currently banned players. To un-ban a player, delete the player's name and IP address from the list.

System requirements[edit]

  • Windows Operating System
  • 500 MB free RAM for a small world (RAM depends on world size and number of players)
  • .NET Framework 4.0
  • XNA Framework

An easy method of installing .NET and XNA is to simply install the Terraria client, which should install both as part of its regular installation.

Notes[edit]

  • The server will auto-save the world now and then, but will not auto-save on shutdown. You should save manually prior to shutdown.
  • When you launch a server, it will ask if you want to auto port forward, however this doesn't always work.
  • Servers are often set up using Hamachi. This removes the need of having to port-forward, but relies on a third party program.

History[edit]

  • 1.2.3.1: Fixed crashes when starting the dedicated server in a language other than English.
  • 1.0.2:
    • Servers now listen to all IP addresses on the hosting PC, regardless of how many network connections are active.
    • Typing "localhost" instead of your own local IP address will connect to your own same-PC server.
    • The games default port is no longer ELEET (31337) it is now 7777.
    • Client will now resolve a hostname into its IP address, for example, if randomsite.org ran a server, you could type randomsite.org as the IP address and be able to connect.
  • Pre-Release: Introduced.
Terraria-related software
 
Servers  •   Map viewers  •   Inventory editors  •   Mods