Hexy Templates

RomM

RomM allows you to scan, enrich, browse and play your game collection with a clean and responsive interface. With support for multiple platforms, various naming schemes, and custom tags, RomM is a must-have for anyone who plays on emulators.

★ Curated by HexOS Not yet tested games Based on TrueNAS app v1.2.46 (RomM 5.3.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 RomM and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
romm.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS romm 1.2.46"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30061]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/romm"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/romm/library",
18      "snapshot": {"id": "library"}
19    },
20    {
21      "path": "$LOCATION(ApplicationsPerformance)/romm/resources",
22      "snapshot": {"id": "resources"}
23    },
24    {
25      "path": "$LOCATION(ApplicationsPerformance)/romm/config",
26      "snapshot": {"id": "config"}
27    },
28    {
29      "path": "$LOCATION(ApplicationsPerformance)/romm/assets",
30      "snapshot": {"id": "assets"}
31    },
32    {
33      "path": "$LOCATION(ApplicationsPerformance)/romm/postgres_data",
34      "owner": {"user": "netdata", "group": "docker"},
35      "snapshot": {"id": "postgres_data"}
36    }
37  ],
38  "app_values": {
39    "romm": {
840      "db_password": "$RANDOM_STRING(16)",
941      "redis_password": "$RANDOM_STRING(16)",
1042      "auth_secret_key": "$RANDOM_STRING(32)"
43    },
44    "storage": {
1145      "library": "$HOST_PATH($LOCATION(ApplicationsPerformance)/romm/library)",
1246      "resources": "$HOST_PATH($LOCATION(ApplicationsPerformance)/romm/resources)",
1347      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/romm/config)",
1448      "assets": "$HOST_PATH($LOCATION(ApplicationsPerformance)/romm/assets)",
1549      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/romm/postgres_data)"
50    },
51    "network": {
1652      "web_port": {"bind_mode": "published", "port_number": 30061}
53    },
1754    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
55  }
56}

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 romm 1.2.46”.

    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. Network ports

    The app needs port 30061 to be free on your server. A port is like an apartment number for your server's address.

    Line 11

  7. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › romm, App storage (fast) › romm › library, App storage (fast) › romm › resources, App storage (fast) › romm › config, App storage (fast) › romm › assets and App storage (fast) › romm › postgres_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 13–37

  8. Auto-generated db password

    HexOS makes up a long random db password during install. It's only used inside RomM, so you never need to know it.

    Line 40

  9. Auto-generated redis password

    HexOS makes up a long random redis password during install. It's only used inside RomM, so you never need to know it.

    Line 41

  10. Auto-generated auth secret key

    HexOS makes up a long random auth secret key during install. It's only used inside RomM, so you never need to know it.

    Line 42

  11. Where your library is saved

    Where your library is saved on your server: App storage (fast) › romm › library.

    Line 45

  12. Where the app's “resources” files is saved

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

    Line 46

  13. Where the app's settings is saved

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

    Line 47

  14. Where the app's “assets” files is saved

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

    Line 48

  15. Where the app's database is saved

    Where the app's database is saved on your server: App storage (fast) › romm › postgres_data.

    Line 49

  16. Web port: 30061

    The app's web page is published on port 30061. You don't need to remember it — clicking the app's card in HexOS takes you there.

    Line 52

  17. 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 54