domino8788 / terraria-server

terraria server

 __  __     ______     __  __     __         ______    
/\ \_\ \   /\  ___\   /\_\_\_\   /\ \       /\  __ \   
\ \  __ \  \ \  __\   \/_/\_\/_  \ \ \____  \ \ \/\ \  
 \ \_\ \_\  \ \_____\   /\_\/\_\  \ \_____\  \ \_____\ 
  \/_/\/_/   \/_____/   \/_/\/_/   \/_____/   \/_____/ 

===> New tModLoader Server available! : hexlo/terraria-tmodloader-server

Terraria Vanilla Server

This is a Vanilla server for Terraria PC, packaged as a docker image.

Docker Hub image:

hexlo/terraria-server-docker:latest

Github image:

ghcr.io/hexlo/terraria-server-docker:latest

---

Requirements

Server-side:

• Docker
• docker-compose (recommended)

Client-side:

• Terraria

---

General Config

• Either clone this repo or create a folder called Worlds
• Create a docker-compose.yml at the same level as the Worlds folder (see example below)
  You can rename docker-compose-example.yml to docker-compose.yml and modify it as well.
• Edit the environment variables as you see fit. They are explained in a table further down.

docker-compose.yml example:

version: '3'
services:
  terraria-server:
    # Github mirror: ghcr.io/hexlo/terraria-server-docker:latest
    image: hexlo/terraria-server-docker:latest
    container_name: terraria-server
    restart: unless-stopped
    stdin_open: true
    tty: true
    ports:
      - 7779:7777
    volumes:
      - ./Worlds:/root/.local/share/Terraria/Worlds
    environment:
      - world=/root/.local/share/Terraria/Worlds/world1.wld
      - autocreate=2
      - worldname=world1
      - difficulty=1
      - maxplayers=8
      - port=7777
      - password=mypassword
      - motd="Welcome to hexlo's server! :)"

• Launch the container. If you are using a command line interface (cli):
  docker-compose up -d

---

Creating and using Worlds

Using existing worlds

Terraria worlds have a .wld extention
If you have a compatible world already that you would like to use, you can simply put the file in the Worlds directory and make sure the world variable is set to match it's name.

Creating a new world

There is two ways to create a new world.

1. Using variables in the docker-compose.yml file (recommended)
2. By spinning a container, manually attaching to it and going through the command prompts of the terraria server.

1. Using variables in the docker-compose.yml file:

You need to set certain variables in the environment: part of the docker-compose.yml file, as follows:

...
    environment:
      - world=/root/.local/share/Terraria/Worlds/world1.wld
      - autocreate=2
      - worldname=world1
      - difficulty=1
...

Note: the description and possible values of these variables are described in a table below

2. Manually create a world:

You can create a new world or select different world served by a container by attaching to it.
docker attach <container-name>

• press enter
• Go through the options

To dettach without stopping the container: ctrl+p ctrl+q

Important!

If you want the server to start automatically on subsequent runs, you need to provide a world path to an existing world, by defining the environment variable world as shown in the exemple above.

---

Environment Variables

Note: These are case-sensitive!

Env variable	Default value	Description	Example
world	(empty)	Path to your world inside the container. You need to provide a world for the server to start automatically	world=/root/.local/share/Terraria/Worlds/Worlds/My_World.wld
autocreate	2	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).	autocreate=2
seed	(empty)	Specifies the world seed when using -autocreate	seed=someseed123
worldname	(empty)	Sets the name of the world when using -autocreate.	worldname=world1
difficulty	0	Sets world difficulty when using autocreate. Options: 0(normal), 1(expert), 2(master), 3(journey)	difficulty=1
maxplayers	16	The maximum number of players allowed	maxplayers=8
port	7777	Port used internally by the terraria server. You should not change this.	port=8123
password	(empty)	Set a password for the server	password=serverpassword
motd	(empty)	Set the server motto of the day text.	motd="Welcome to my private server! :)"
worldpath	/root/.local/share/Terraria/Worlds/Worlds/Worlds	Sets the directory where world files will be stored	worldpath=/some/other/dir
banlist	banlist.txt	The location of the banlist. Defaults to "banlist.txt" in the working directory.	banlist=/configs/banlist.txt -> this would imply that you mount your banlist.txt file in the container's path /configs/banlist.txt
secure	1	Option to prevent cheats. (1: no cheats or 0: cheats allowed)	secure=0
language	en/US	Sets the server language from its language code. Available codes: en/US = English de/DE = German it/IT = Italian fr/FR = French es/ES = Spanish ru/RU = Russian zh/Hans = Chinese pt/BR = Portuguese pl/PL = Polish	language=fr/FR
upnp	1	Enables/disables automatic universal plug and play.	upnp=0
npcstream	1	Reduces enemy skipping but increases bandwidth usage. The lower the number the less skipping will happen, but more data is sent. 0 is off.	npcstream=60
priority	(empty)	Sets the process priority	priority=1

Important!

If the world variable is left empty or not included, the server will need to be initialized manually after the container is spun up. You will need to attach to the container and select/create a world and set the players number, port and password manually. If you create a new world, it will be saved in the path defined by the environment variable worldpath.

1. docker attach <container name>
2. press enter
3. Go through the options
4. Detach from the container by pressing ctrl+p + ctrl+q

• If, after creating your world with a specific seed, the server still doesn't initializes automatically, be sure to comment or remove the seed=<yourseed> variable in the docker-compose.yml file.

---

List of server-side console commands from the unofficial wiki

Once a dedicated server is running, the following commands can be run.
First, attach to the container with docker attach <container name>.

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 name> - Kicks a player from the server.
ban <player name> - 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 <message> - Send a message to all players. They will see the message in yellow prefixed with <server> in the chat.
motd - Print MOTD.
motd <message> - 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.

Banning and un-banning
The command ban <player> will ban the indicated player from the server. A banned player, when they try to login, will be displayed the message:You are banned for [duration]: [reason]- [modname]. 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.

Note: no forward-slash / is needed before the command, as some command interfaces require.