ryshe/terraria repository overview

⁠Terraria

[UPDATE] vanilla 1.4.5.2 Server is working on Linux

⁠Quick start guide

First you need a linux machine with Docker⁠ installed. Everything from here on out assumes the docker service is running (you may need to start the service after install).

⁠Create directory to save your world to

Next create a directory for your world file, configuration, and logs

mkdir -p $HOME/terraria/world

⁠Creating a fresh world

For the first run you will need to generate a new world with a size where: 1=Small, 2=Medium, 3=Large

sudo docker run -it -p 7777:7777 --rm -v $HOME/terraria/world:/root/.local/share/Terraria/Worlds ryshe/terraria:latest -world /root/.local/share/Terraria/Worlds/<world_name_here>.wld -autocreate <world_size_number_here>

Note: If you close the the terminal, the server will stop running. You will need to restart with a preexisting world. It may be worth while to close after creation anyway to update the initial config.json settings.

To create a world with a few more initial options, you can do so in an interactive mode.

sudo docker run -it -p 7777:7777 --rm -v $HOME/terraria/world:/root/.local/share/Terraria/Worlds ryshe/terraria:latest

⁠To start with a preexisting world

sudo docker run -d --rm -p 7777:7777 -v $HOME/terraria/world:/root/.local/share/Terraria/Worlds --name="terraria" -e WORLD_FILENAME=<.wld world_filename_here> ryshe/terraria:latest

Note: This command is designed to run in the background, and it is safe to close the terminal window.

Any config.json in the directory will automatically be loaded. The <world_file_name>.wld should be the name of your wld file in your $HOME/terraria/world directory.

⁠Updating your container

Updating is easy!

1. Grab the latest terraria container

   docker pull ryshe/terraria:latest
   

   Copy

2. First we need to find our running container to stop, so we can later restart with the latest

   docker container ls | grep ryshe/terraria
   

   Copy

   The first few numbers and letters, on a line, are the container hash. Remember the first 3 or so letters or numbers

   Example:

   f25261ac55a4        ryshe/terraria:latest   "/bin/sh bootstrap.s…"   3 minutes ago       Up 3 minutes        0.0.0.0:7777->7777/tcp, 7878/tcp   reverent_solomon
   

   Copy

   f25 would be the first few letters/numbers of the container hash

   NOTE: If you see multiple lines, find the one that still has an up status.

3. Stop and remove the container

   docker container rm -f xxx # xxx is the letters/numbers from the last step
   

   Copy

4. Start your container again with your world (see the Quick start⁠)

⁠[Virtual] Machine Setup

Provision a linux machine that can support docker and containerization. For more information visit docker⁠. For a small or medium world with no more than 8 users a linux machine with 1-1.5GB of ram should suffice. If you are running a vm in the cloud, make sure to expose tcp port 7777 and udp port 7777.

Before starting the build process make sure the latest tshock version⁠ is specified in the Dockerfile⁠ under

ADD https://github.com/Pryaxis/TShock/releases/download/v4.4.0-pre1/TShock_4.4.0_226_Pre1_Terraria1.4.0.2.zip /

⁠Building from source

Assuming git⁠ and docker⁠ are installed..

1. Clone this repository

   git clone https://github.com/ryansheehan/terraria.git
   

   Copy

2. Open a terminal window into the directory downloaded by the git

3. Build the container

   docker build -t <name_here> .
   

   Copy

⁠Running a container image

Whether you build your own container, or use my container⁠ published to docker hub, we are ready to run our terraria server!

Note: For a full set of docker run options go here⁠

⁠First run

The first run of the server will give you the opportunity to create a world, and it will generate the server's config file. You may wish to add the config file for many reasons, but one of which is to add a password to your server.

docker run -it --rm -p 7777:7777 -v $HOME/terraria/world:/root/.local/share/Terraria/Worlds ryshe/terraria:latest

Let's break down this command:

• The config file can be found in the directory specified by the -v volume.
• If the terminal window is shut down, that will exit the process. Make sure to do so after the world is created!

⁠Running with an existing generated world

After a world has been generated, you may want to load directly into it.

docker run -d --rm -p 7777:7777 -v $HOME/terraria/world:/root/.local/share/Terraria/Worlds ryshe/terraria:latest -world /root/.local/share/Terraria/Worlds/<world_filename_here>.wld

Let's break down the command:

• for the other parts check out the First run⁠ section
• check out additional server startup flags here⁠. They go on after the ryshe/terraria:latest portion of the line

⁠Plugin support

A volume exists to support plugins. Create a folder, not inside your /world folder, for your plugins

mkdir ServerPlugins

Mount the plugins directory with an additional -v switch on your docker run ... command

-v <path_to_your_ServerPlugins_folder>:/plugins

⁠Logs

A separate directory can be volumed in for storing logs outside of the image

-v <path_to_store_logs>:/tshock/logs

⁠Notes

• sudo may be required to run docker commands.

• Please post to the TShock⁠ team with questions on how to run a server.

• Any additional command-line instructions⁠ can be added to the end of either method for launching a server. Docker maps the $HOME/terraria/world linux-host folder to the /tshock/world container-folder.

• Expecting your server to run for a while? Add --log-opt max-size=200k to limit your log file size. Otherwise one day you will wake up to see all your hdd space chewed up for a terraria docker setup!

⁠Contributing

Email me rsheehan at gmail dot com if any of these instructions do not seem to work.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

⁠TODO

• Fork TShock and create a Dockerfile to build the project