Merge pull request #2 from g-otn/feat/terraria

feat: finish terraform support, misc fixes

Author: g-otn

README.md

@@ -32,6 +32,7 @@ https://github.com/user-attachments/assets/e2e63d59-3a4e-4aaa-8513-30243aafa6c4
     - [Registering interaction endpoint](#registering-interaction-endpoint)
     - [Creating the guild commands](#creating-the-guild-commands)
   - [Automatic backups](#automatic-backups)
+  - [Game specific post-setup](#game-specific-post-setup)
 - [Recommendations and notes](#recommendations-and-notes)
   - [**Game-specific notes**](#game-specific-notes)
   - [Regions](#regions)
@@ -54,10 +55,11 @@ https://github.com/user-attachments/assets/e2e63d59-3a4e-4aaa-8513-30243aafa6c4
 **Supported**
 
 - Minecraft (via [itzg/docker-minecraft-server](https://github.com/itzg/docker-minecraft-server))
+- Terraria (via [ryshe/terraria](https://hub.docker.com/r/ryshe/terraria))
 
 **Others:**
 
-You can run other game servers Docker containers using the `custom` server module option. See [Custom game](#custom-game).
+You can run other game servers Docker containers using the `custom` server module option. See [Custom game](#custom-game) and custom game [example](#examples).
 
 ## Strategy
 
@@ -264,7 +266,7 @@ Other "Common values" are also required but are the same between servers or/and
 
 #### Examples
 
-For a full example, check the [`servers.tf`](servers.tf) and [`regions.tf`](regions.tf) files themselves.
+For a full example, check the [`servers.tf`](servers.tf) and [`regions.tf`](regions.tf) files themselves. See [ryshe/terraria](https://hub.docker.com/r/ryshe/terraria/).
 
 <details>
 
@@ -382,6 +384,37 @@ EOT
 
   <summary>Custom game</summary>
 
+Creating a TShock Terraria server using the `custom` game option.
+See [ryshe/terraria](https://hub.docker.com/r/ryshe/terraria/).
+
+```tf
+module "terraria" {
+  source = "./server"
+
+  # Change these to desired values
+  id               = "CustomExample"
+  game             = "custom"
+  custom_game_name = "Terraria"
+  hostname         = "gsed-example.duckdns.org"
+
+  instance_type    = "m7g.medium"
+  arch             = "arm64"
+  data_volume_size = 1
+
+  main_port = 7777
+  compose_services = {
+    main : {
+      image : "ryshe/terraria"
+      ports : ["7777:7777"]
+      command : "-world ${local.terraria_workdir_path}/Worlds/CustomExample.wld -autocreate 3"
+      volumes : ["/srv/terraria:${local.terraria_workdir_path}"]
+    }
+  }
+
+  // ...
+}
+```
+
 </details>
 
 ### Applying
@@ -473,14 +506,16 @@ Daily snapshots of the data volume are taken via Data Lifecycle Manager. However
 
 See also [Restoring a backup](#restoring-a-backup)
 
-### Protecting your server from the internet
+### Game specific post-setup
 
-Since you're running a public server, techinically **anyone on the internet** can join your server and do anything (grief, cheat, troll, etc).
+Since you're running a public server, techinically **anyone on the internet** can join your server and do anything (grief, cheat, crash the server, etc).
 This is most likely not desirable and you might want to do game-specific configuration
-to limit the server for you and your friends. (one of the purposes of this project)
+to limit the server for you and your friends.
 
 These are done by SSH-ing into your instance and then running commands or modifying some game server configuration files. (See also [SSH](#ssh))
 
+You'll also want to do this to load an existing save / world, depending on the game.
+
 15. Please **check the "post-setup" section on each games' [Game-specific notes](#game-specific-notes)** for things you may want to do.
 
 Check also [Useful info and commands](#useful-info-and-commands).
@@ -502,7 +537,7 @@ You can do that by op-ing yourself by creating an whitelist on the Minecraft ser
 
 1. Connect to your running server instance using SSH (See [SSH](#ssh))
 2. Attach your terminal to the Minecraft server terminal by running `docker attach minecraft-mc-1`
-3. Run `whitelist <player name>` to whitelist someone. You could also give yourself admin using `op <your player name>` to run more commands from within your game chat.
+3. Run `whitelist add <player name>` to whitelist someone. You could also give yourself admin using `op <your player name>` to run more commands from within your game chat.
 
 If you're running an offline server, you could also consider setup an auth plugin such as [AuthMeReloaded](https://www.spigotmc.org/resources/authmereloaded.6269/) (Spigot).
 
@@ -535,6 +570,22 @@ Finally, save around 600MiB-1GiB for the JVM / Off-heap memory. Examples:
 
 </details>
 
+<details>
+  <summary>Terraria</summary>
+
+### Terraria post-setup
+
+You should set up a server password so only you and your friends can join the server.
+
+1. Connect to your running server instance using SSH (See [SSH](#ssh))
+2. Edit the file at `/srv/terraria/config.json`
+3. Set a password in the `Settings.ServerPassword` field
+4. Restart the server by running `docker compose restart terraria-terraria-1` or by restarting the whole instance.
+
+See also TShock [Config Settings](https://tshock.readme.io/docs/config-settings) and [Setting Up Your Server](https://tshock.readme.io/docs/setting-up-your-server).
+
+</details>
+
 ### Regions
 
 Sometimes you want to change the AWS region you server is located at, due to latency and/or price. By default this project
@@ -612,6 +663,7 @@ To help choose a instance type different from the defaults, check out:
   - Grouping "Cost" by "Daily" can facilitate visualize how much (the instance alone) would cost for 24h of gameplay.
 - [Spot Instance advisor](https://aws.amazon.com/ec2/spot/instance-advisor/)
 - [aws-pricing.com Instance Picker](https://aws-pricing.com/picker.html)
+- [Geekbench Browser](https://browser.geekbench.com/search?utf8=✓&q=amazon+ec2) (CPU single-core and multi-core performance benchmarks)
 
 If you choose a burstable instance types (`t4g`, `t3a`, `t3` and `t2`), check ["Things to keep in mind"](#things-to-keep-in-mind) in Cost breakdown
 
@@ -639,21 +691,28 @@ by using the `custom` value in the `game` variable.
 
 The game server must meet the following criteria:
 
-- It can run on Linux
-- It is containerized using Docker (for example, using [steamcmd](https://hub.docker.com/r/steamcmd/steamcmd) image as base)
-- It can handle rare sudden shutdowns (due to the nature of Spot instances)
-  - This means it is able to shut down gracefully or/and auto-save if needed, also if requested via Discord slash command.
-- The "main port" of the game server, the one players stay connected to, uses TCP (for auto-shutdown to work properly)
+- It can run on Linux 64-bits
+- It is containerized using Docker (for example, based on [CM2.Network steamcmd](https://cm2.network) or [steamcmd/steamcmd](https://hub.docker.com/r/steamcmd/steamcmd))
+  - The container can be run on `x86_64` or `arm64` architectures
+- It can handle rare sudden shutdowns
+  - This is due to the nature of Spot instances or if someone requests it via Discord slash commands
+  - This means it should be able to shut down gracefully and preferrably auto-save periodically
+- It makes sense for this project:
+  - This project allows part of the friend group to play on the server, without
+    requiring the host player who has the save file to be online at all play sessions.
+    Examples are Multiplayer "Open World Survival Craft" / Sandbox games.
+  - Some games though, can only be played or only make sense to play when the all players are together.
 
-To define a custom game server:
+To define a custom game server (see also custom game [example](#examples)):
 
 1. Copy and paste a new server module usage in the [`servers.tf`](servers.tf) file.
 2. Set common server-specific values such as `id`, `az`, `hostname` and other DDNS config.
 3. Set `game` to `custom` and define an alphanumeric `custom_game_name` (e.g `CustomGame`).
 4. Set the game's networking using `main_port` and add `sg_ingress_rules` as needed.
 5. Set the game's available storage using `data_volume_size` and backup frequency and retation using the `data_volume_snapshot_*` variables.
    - If your volume is too big and/or the game data changes too much between snapshots (e.g big save files are compressed each time), consider lowering snapshot retention. Check AWS pricing calculator.
-6. Configure the Docker Compose file which will be used within the instance by setting up the `compose_*` variables.
+6. Configure the Docker Compose file which will be used within the instance by setting up at least the `compose_services` variable.
+   - Create a service with the name `main`
    - Networking: Define the container `ports` to match `main_port` and `sg_ingress_rules`.
    - Storage: Define a volume matching `server_data_path`, which is based from lowercase value of `custom_game_name`
      (e.g `/srv/customgame`, See [server/main.tf](server/main.tf)).
@@ -667,6 +726,8 @@ To define a custom game server:
 
 ### SSH
 
+You most likely will want to SSH into your instance at least once to maybe upload an existing save / world or to modify server configuration.
+
 I recommend using some UI application to help navigate and manage files via SSH like [VS Code Remote Explorer](https://marketplace.visualstudio.com/items?itemName=ms-vscode.remote-explorer).
 
 SSH into your instance using the `ec2-user` user. Example:

base_region/vpc.tf

@@ -1,7 +1,7 @@
 locals {
   base_cidr_block     = "10.0.0.0/16"
   public_subnets      = [for i in range(length(var.azs)) : cidrsubnet(local.base_cidr_block, 8, 101 + i)]
-  public_subnet_names = [for i in range(length(var.azs)) : "${local.prefix_sm} Public Subnet ${i + 1}"]
+  public_subnet_names = [for i in range(length(var.azs)) : "${local.prefix_sm} Public Subnet ${i + 1} (${var.azs[i]})"]
 }
 
 module "vpc" {

example.tfvars

@@ -7,47 +7,3 @@ discord_bot_token      = "MTIabcdefg.12345.hijklm"
 
 duckdns_domain = "mydomain"
 duckdns_token  = "abcdefg-2057-4bd2-a6f5-4716e6d20516"
-
-extra_ingress_rules = {
-  // See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule#argument-reference
-  "Simple Voice Chat" : {
-    description = "Simple Voice Chat mod server"
-    from_port   = 24454
-    to_port     = 24454
-    ip_protocol = "udp"
-    cidr_ipv4   = "0.0.0.0/0"
-  }
-}
-
-instance_key_pair_public_key = "ssh-ed25519 AA...a minecraft-spot-discord"
-instance_timezone            = "America/Bahia"
-
-minecraft_port          = 23456
-minecraft_compose_ports = ["23456:25565", "24454:24454/udp"]
-
-minecraft_compose_environment = {
-  "INIT_MEMORY" = "6000M"
-  "MAX_MEMORY"  = "6000M"
-
-  "ICON" = "https://picsum.photos/300/300"
-  "MOTD" = "     \u00A7b\u00A7l\u00A7kaaaaaaaa\u00A7r \u00A75\u00A7lGame EC2 Spot Discord\u00A7r \u00A7b\u00A7l\u00A7kaaaaaaaa\u00A7r"
-
-  "VERSION"     = "1.20.4"
-  "ONLINE_MODE" = false
-  "PLUGINS"     = <<EOT
-https://cdn.modrinth.com/data/9eGKb6K1/versions/AyVUPPCX/voicechat-bukkit-2.5.15.jar
-
-https://cdn.modrinth.com/data/UmLGoGij/versions/mr2CijyC/DiscordSRV-Build-1.27.0.jar
-
-https://cdn.modrinth.com/data/cUhi3iB2/versions/Ua2p3xKG/tabtps-spigot-1.3.23.jar
-
-https://cdn.modrinth.com/data/MubyTbnA/versions/vbGiEu4k/FreedomChat-Paper-1.6.0.jar
-https://github.com/SkinsRestorer/SkinsRestorer/releases/download/15.0.13/SkinsRestorer.jar
-
-https://download.luckperms.net/1544/bukkit/loader/LuckPerms-Bukkit-5.4.131.jar
-
-https://github.com/dmulloy2/ProtocolLib/releases/download/5.2.0/ProtocolLib.jar
-https://ci.codemc.io/job/AuthMe/job/AuthMeReloaded/lastSuccessfulBuild/artifact/target/AuthMe-5.6.0-SNAPSHOT.jar
-https://ci.codemc.io/job/Games647/job/FastLogin/lastSuccessfulBuild/artifact/bukkit/target/FastLoginBukkit.jar
-EOT
-}

main.tf

@@ -12,3 +12,9 @@ module "global" {
   discord_app_public_key = var.discord_app_public_key
   discord_bot_token      = var.discord_bot_token
 }
+
+
+locals {
+  // Helpful common strings
+  terraria_workdir_path = "/root/.local/share/Terraria/Worlds"
+}

server/cloud-init.yml

@@ -63,6 +63,20 @@ write_files:
     content: ${auto_shutdown_timer_file_content_b64}
 # %{ endif }
 
+# %{ if watch_connections }
+  # Connection watcher
+  - path: /home/ec2-user/watch_conn.sh
+    defer: true
+    owner: ec2-user
+    permissions: "0744"
+    encoding: base64
+    content: ${watch_conn_script_file_content_b64}
+  - path: /etc/systemd/system/watch_conn.service
+    defer: true
+    encoding: base64
+    content: ${watch_conn_service_file_content_b64}
+# %{ endif }
+
 # %{ if ddns_service == "duckdns" }
   # Duck DNS files
   - path: /home/ec2-user/duck.sh
@@ -90,12 +104,15 @@ runcmd:
   - [
       curl,
       -SL,
-      "https://github.com/docker/compose/releases/download/v2.27.3/docker-compose-linux-aarch64",
+      'https://github.com/docker/compose/releases/download/v2.29.1/docker-compose-linux-%{ if arch == "x86_64" }x86_64%{ else }aarch64%{ endif }',
       -o,
       /usr/local/lib/docker/cli-plugins/docker-compose,
     ]
   - chmod +x /usr/local/lib/docker/cli-plugins/docker-compose
 
+  # Manually install fastfetch
+  - rpm -i 'https://github.com/fastfetch-cli/fastfetch/releases/download/2.20.0/fastfetch-linux-%{ if arch == "x86_64" }amd64%{ else }aarch64%{ endif }.rpm'
+
   # Finish Docker setup
   - usermod -a -G docker ec2-user # Allow docker commands without sudo
   - systemctl enable docker
@@ -110,6 +127,12 @@ runcmd:
   # Start for the first time
   - systemctl enable compose_start
   - systemctl start compose_start
+
+# %{ if watch_connections }
+  - systemctl enable watch_conn.service
+  - systemctl start watch_conn.service
+# %{ endif }
+
 # %{ if auto_shutdown }
   - systemctl enable auto_shutdown.timer
   - systemctl start auto_shutdown.timer

server/dlm.tf

@@ -32,6 +32,6 @@ resource "aws_dlm_lifecycle_policy" "backup_data" {
   }
 
   tags = {
-    Name = "${local.prefix_id_game} Data volume backup Lifecycle Policy"
+    Name = "${local.prefix_sm_id_game} Data volume backup Lifecycle Policy"
   }
 }

server/ec2.tf

@@ -12,6 +12,13 @@ locals {
     compose_main_service_name = local.game.compose_main_service_name
   }))
 
+  watch_conn_service_file_content_b64 = base64encode(file("./server/systemd/watch_conn/watch_conn.service"))
+  watch_conn_script_file_content_b64 = base64encode(templatefile("./server/systemd/watch_conn/watch_conn.sh", {
+    main_port                 = local.game.main_port
+    server_data_path          = local.server_data_path
+    compose_main_service_name = local.game.compose_main_service_name
+  }))
+
   duckdns_script_file_content_b64 = var.ddns_service == "duckdns" ? base64encode(templatefile("./server/ddns/duckdns/duck.sh", {
     duckdns_domain = local.duckdns_domain
     duckdns_token  = var.duckdns_token
@@ -21,6 +28,8 @@ locals {
   ec2_user_data = templatefile("./server/cloud-init.yml", {
     instance_timezone = var.instance_timezone
 
+    arch = local.game.arch
+
     server_data_path = local.server_data_path
     device_name      = local.device_name
 
@@ -34,6 +43,10 @@ locals {
     auto_shutdown_service_file_content_b64 = local.auto_shutdown_service_file_content_b64
     auto_shutdown_timer_file_content_b64   = local.auto_shutdown_timer_file_content_b64
 
+    watch_connections                   = local.game.watch_connections
+    watch_conn_script_file_content_b64  = local.watch_conn_script_file_content_b64
+    watch_conn_service_file_content_b64 = local.watch_conn_service_file_content_b64
+
     duckdns_script_file_content_b64  = local.duckdns_script_file_content_b64
     duckdns_service_file_content_b64 = local.duckdns_service_file_content_b64
   })

server/main.tf

@@ -6,8 +6,8 @@ locals {
 
   prefix            = "GameServerEC2Discord"
   prefix_sm         = "GSED"
-  prefix_id_game    = "${local.prefix} ${var.id} ${var.game}"
-  prefix_sm_id_game = "${local.prefix_sm} ${var.id} ${var.game}"
+  prefix_id_game    = "${local.prefix} ${var.id} ${local.game.game_name}"
+  prefix_sm_id_game = "${local.prefix_sm} ${var.id} ${local.game.game_name}"
 
   subnet_id = var.base_region.public_subnets[index(var.base_region.available_azs, var.az)]
 
@@ -23,13 +23,25 @@ locals {
       data_volume_size          = coalesce(var.data_volume_size, 10)
       compose_main_service_name = "mc"
       main_port                 = coalesce(var.main_port, 25565)
+      watch_connections         = coalesce(var.watch_connections, false)
+    }
+    terraria = {
+      game_name                 = "Terraria"
+      instance_type             = coalesce(var.instance_type, "m7a.medium")
+      arch                      = coalesce(var.arch, "x86_64")
+      data_volume_size          = coalesce(var.data_volume_size, 1)
+      compose_main_service_name = "terraria"
+      main_port                 = coalesce(var.main_port, 7777)
+      watch_connections         = coalesce(var.watch_connections, true)
     }
     custom = {
       game_name                 = var.custom_game_name
       instance_type             = var.instance_type
+      arch                      = var.arch
       data_volume_size          = var.data_volume_size
       compose_main_service_name = "main"
       main_port                 = var.main_port
+      watch_connections         = coalesce(var.watch_connections, true)
     }
   }
   game                     = local.game_defaults_map[var.game]
@@ -76,6 +88,21 @@ locals {
         }
       }
     }, var.compose_top_level_elements)
+
+    terraria = merge({
+      services : {
+        "${local.game_defaults_map.terraria.compose_main_service_name}" : {
+          image : "ryshe/terraria",
+          ports : coalesce(var.compose_game_ports, ["7777:7777"]),
+          environment : merge({}, var.compose_game_environment)
+          command : "-world /root/.local/share/Terraria/Worlds/${var.id}.wld -autocreate ${var.terraria_world_size}"
+          volumes : [
+            "${local.server_data_path}:/root/.local/share/Terraria/Worlds"
+          ]
+        }
+      }
+    }, var.compose_top_level_elements)
+
     custom = merge({
       services : var.compose_services
     }, var.compose_top_level_elements)