Hexy Templates

HyOS - Hytale Server

Hytale dedicated game server with web management UI, OAuth authentication, auto-updates, mod support, and REST API for server control.

Not yet tested games Based on TrueNAS app v1.0.17 (HyOS - Hytale Server 0.0.29)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find HyOS - Hytale Server and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
hyos.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS hyos 1.0.17"
6  },
37  "installation_questions": [
8    {
9      "question": "Client secret",
10      "type": "password",
11      "key": "client_secret",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": ["ApplicationsPerformance"],
517    "specifications": ["2CORE"],
618    "permissions": ["READ_WRITE_LOCATIONS"],
719    "ports": [30380, 30381, 30382]
20  },
821  "ensure_directories_exists": [
22    {"path": "$LOCATION(ApplicationsPerformance)"},
23    {"path": "$LOCATION(ApplicationsPerformance)/hyos"},
24    {
25      "path": "$LOCATION(ApplicationsPerformance)/hyos/data",
26      "owner": {"user": "apps"},
27      "snapshot": {"id": "data"}
28    }
29  ],
30  "app_values": {
931    "hytale": {"api": {"client_secret": "$QUESTION(client_secret)"}},
32    "storage": {
1033      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/hyos/data)"
34    },
35    "network": {
1136      "game_port": {"bind_mode": "published", "port_number": 30380},
1237      "api_port": {"bind_mode": "published", "port_number": 30381},
1338      "manager_port": {"bind_mode": "published", "port_number": 30382}
39    },
1440    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
41  }
42}

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 hyos 1.0.17”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Client secret. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–14

  4. 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 16

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 17

  6. Permission to use your folders

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

    Line 18

  7. Network ports

    The app needs ports 30380, 30381 and 30382 to be free on your server. A port is like an apartment number for your server's address.

    Line 19

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › hyos and App storage (fast) › hyos › data. Some folders are handed to a specific system user so the app is allowed to write to them. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 21–29

  9. Your answer: client secret

    Filled in with what you typed for “client secret” when you installed.

    Line 31

  10. Where the app's main data is saved

    Where the app's main data is saved on your server: App storage (fast) › hyos › data.

    Line 33

  11. Game port: 30380

    Publishes the app's game port as 30380.

    Line 36

  12. Api port: 30381

    Publishes the app's api port as 30381.

    Line 37

  13. Manager port: 30382

    Publishes the app's manager port as 30382.

    Line 38

  14. 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 40