Hexy Templates

Palworld

Palworld is a multiplayer, open-world survival crafting game where you befriend and collect mysterious creatures called "Pals".

★ Curated by HexOS Not yet tested games Based on TrueNAS app v1.3.8 (Palworld palworld)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Palworld and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
palworld.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS palworld 1.3.8"
6  },
37  "installation_questions": [
8    {
9      "question": "Admin password",
10      "type": "password",
11      "key": "admin_password",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": ["ApplicationsPerformance"],
517    "specifications": ["2CORE"],
618    "permissions": ["READ_WRITE_LOCATIONS"],
719    "ports": [38211, 38212, 30443]
20  },
821  "ensure_directories_exists": [
22    {"path": "$LOCATION(ApplicationsPerformance)"},
23    {"path": "$LOCATION(ApplicationsPerformance)/palworld"},
24    {
25      "path": "$LOCATION(ApplicationsPerformance)/palworld/steamcmd",
26      "snapshot": {"id": "steamcmd"}
27    },
28    {
29      "path": "$LOCATION(ApplicationsPerformance)/palworld/server",
30      "snapshot": {"id": "server"}
31    }
32  ],
33  "app_values": {
934    "palworld": {"admin_password": "$QUESTION(admin_password)"},
35    "storage": {
1036      "steamcmd": "$HOST_PATH($LOCATION(ApplicationsPerformance)/palworld/steamcmd)",
1137      "server": "$HOST_PATH($LOCATION(ApplicationsPerformance)/palworld/server)"
38    },
39    "network": {
1240      "server_port": {"bind_mode": "published", "port_number": 38211},
1341      "rcon_port": {"bind_mode": "published", "port_number": 38212},
1442      "api_port": {"bind_mode": "published", "port_number": 30443}
43    },
1544    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
45  }
46}

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 palworld 1.3.8”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Admin password. 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 38211, 38212 and 30443 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) › palworld, App storage (fast) › palworld › steamcmd and App storage (fast) › palworld › server. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 21–32

  9. Your answer: admin password

    Filled in with what you typed for “admin password” when you installed.

    Line 34

  10. Where the app's “steamcmd” files is saved

    Where the app's “steamcmd” files is saved on your server: App storage (fast) › palworld › steamcmd.

    Line 36

  11. Where the app's “server” files is saved

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

    Line 37

  12. Server port: 38211

    Publishes the app's server port as 38211.

    Line 40

  13. Rcon port: 38212

    Publishes the app's rcon port as 38212.

    Line 41

  14. Api port: 30443

    Publishes the app's api port as 30443.

    Line 42

  15. 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 44