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

Docker Hub image:

hexlo/terraria-tmodloader-server:latest

Github image:

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

Server-side:

• Docker
• docker-compose

Client-side:

• Terraria
• tModLoader

• Clone this repository
• Create a docker-compose.yml file (see example below).
  You can otherwise rename docker-compose-example.yml to docker-compose.yml and modify it.
• Edit the environment variables as you see fit. They are explained in a table further down.
• Edit the enabled.json to include the mods you want. Check below for available mods.

services:
  terraria-tmodloader-server1:
    # Github mirror: ghcr.io/hexlo/terraria-tmodloader-server:latest
    image: hexlo/terraria-tmodloader-server:latest
    container_name: terraria-tmodloader-server1
    restart: unless-stopped
    stdin_open: true
    tty: true
    ports:
      - 7782:7777
    volumes:
      - type: bind
        source: ./Worlds
        target: /root/.local/share/Terraria/ModLoader/Worlds/
      - type: bind
        source: ./enabled.json
        target: /root/.local/share/Terraria/ModLoader/Mods/enabled.json
    environment:
      - world=/root/.local/share/Terraria/ModLoader/Worlds/Calamity0.wld
      - autocreate=2
      - worldname=Calamity0
      - difficulty=1
      - password=calamity
      - motd="Welcome to hexlo's server! :)"

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

Terraria tModloader worlds are comprised of two files: a .wld and a .twld
If you have a Terraria tModloader compatible world already, you can simply put the two files in the Worlds directory.
Note: worlds created with terraria 1.4 or newer are not compatible with tModLoader's current version

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/ModLoader/Worlds/Calamity0.wld
      - autocreate=2
      - worldname=Calamity0
      - 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

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.

Mods included in this image:

• AlchemistNPC
• AlchemistNPClite
• BossChecklist
• CalamityMod
• CalamityMusicMod
• ExtensibleInventory
• Fargowiltas
• FargowiltasSouls
• FargowiltasSoulsDLC
• MagicStorageExtra
• RecipeBrowser
• SpiritMod
• TerrariaOverhaul
• ThoriumMod
• Tremor
• WingSlot
• WMITF

Note: If you would like mods that are not here, please let me know and I'll try my best to add them.

To enable or disable mods on the server, modify the enabled.json file with the names of the mods (the exact names as above). This needs to be done before starting the container.
Some mods may clash with each others, especially big content mods. Refer to the mod's wiki for more info.

enabled.json example:

[
  "BossChecklist",
  "MagicStorageExtra",
  "RecipeBrowser",
  "ThoriumMod"
]

Notes; The array of mod's names need the following properties:

• The mod's names are exactly as they appear in the list above
• The mod's names are in double quote
• They are separated with a comma
• There needs to be no trailing comma after the last item in the array
  

On the Client (your computer):

You need tModLoader to play on this version of the server. Download it through steam and keep it up to date.

On the server:

If the server gets out of date, make sure you recreate the container to update it.
Worlds and players created with 1.4 or newer will not work with this version of tModLoader.

Note: These are case-sensitive!

• 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.

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.