Hexy Templates

Terraria TShock

TShock provides Terraria servers with server-side characters, anti-cheat, and community management tools.

Not yet tested games Based on TrueNAS app v1.0.8 (Terraria TShock 6.2.1)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Terraria TShock and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
terraria-tshock.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS terraria-tshock 1.0.8"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"]
11  },
612  "ensure_directories_exists": [
13    {"path": "$LOCATION(ApplicationsPerformance)"},
14    {"path": "$LOCATION(ApplicationsPerformance)/terraria-tshock"},
15    {
16      "path": "$LOCATION(ApplicationsPerformance)/terraria-tshock/config",
17      "snapshot": {"id": "config"}
18    },
19    {
20      "path": "$LOCATION(ApplicationsPerformance)/terraria-tshock/world",
21      "snapshot": {"id": "world"}
22    },
23    {
24      "path": "$LOCATION(ApplicationsPerformance)/terraria-tshock/plugins",
25      "snapshot": {"id": "plugins"}
26    }
27  ],
28  "app_values": {
29    "storage": {
730      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/terraria-tshock/config)",
831      "world": "$HOST_PATH($LOCATION(ApplicationsPerformance)/terraria-tshock/world)",
932      "plugins": "$HOST_PATH($LOCATION(ApplicationsPerformance)/terraria-tshock/plugins)"
33    },
1034    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
35  }
36}

What this script does

Hover or tap a box to see the lines it explains.

  1. Script format

    Tells HexOS this is a version 5 install script, so it knows how to read the rest.

    Line 2

  2. Script revision

    This copy of the script is revision 0.1.0. Latest change: “Auto-generated draft from TrueNAS terraria-tshock 1.0.8”.

    Lines 3–6

  3. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast). If one isn't set up yet, HexOS will ask you to pick a place for it.

    Line 8

  4. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 9

  5. Permission to use your folders

    Allows the app to read and write files inside the storage locations listed above — and nowhere else.

    Line 10

  6. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › terraria-tshock, App storage (fast) › terraria-tshock › config, App storage (fast) › terraria-tshock › world and App storage (fast) › terraria-tshock › plugins. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 12–27

  7. Where the app's settings is saved

    Where the app's settings is saved on your server: App storage (fast) › terraria-tshock › config.

    Line 30

  8. Where the app's “world” files is saved

    Where the app's “world” files is saved on your server: App storage (fast) › terraria-tshock › world.

    Line 31

  9. Where add-ons and plugins is saved

    Where add-ons and plugins is saved on your server: App storage (fast) › terraria-tshock › plugins.

    Line 32

  10. Resource limits

    Caps how much of your server the app can use: 2 CPU cores and 10% of your server's memory, but never more than 4 GB. This keeps one busy app from slowing everything else down.

    Line 34