Getting started

Getting Started with Runfiles

1. Naming Rules

• Filename: run<GameName>.ssui
• <GameName> rules:
  • Starts with an uppercase letter
  • Alphanumeric characters only (A-Z, a-z, 0-9)
  • No spaces or special characters

Examples:

• ✅ Good: runValheim.ssui, runStationeers.ssui, runArkSE.ssui
• ❌ Bad: runvalheim.ssui (lowercase), runArk Survival Evolved.ssui (spaces)

Important

meta.name inside the JSON must exactly match <GameName>.

2. Minimal Required Fields

Every runfile needs at least:

{
  "meta": {
    "name": "YourGameName"
  },
  "steam_app_id": "123456",
  "windows_executable": "./server.exe",
  "linux_executable": "./server.x86_64",
  "args": {
    "basic": []
  }
}

• At least one executable matching the host OS
• Valid numeric steam_app_id

3. Recommended Starting Template

{
  "meta": {
    "name": "GameName",
    "version": "1.0",
    "author": "Your Name",
    "image": "https://url-to-banner.jpg",
    "logo": "https://url-to-icon.jpg"
  },
  "backup_content_dir": "./saves",
  "steam_app_id": "123456",
  "windows_executable": "./GameServer.exe",
  "linux_executable": "./GameServer.x86_64",
  "args": {
    "basic": [],
    "network": [],
    "advanced": []
  }
}

Tip

Use "basic", "network", and "advanced" as category keys — the current UI works best with these.

4. Testing Your Runfile

1. Place it in your SSUI runfiles folder
2. Restart SSUI or refresh the gallery
3. Select your game and try launching
4. Check logs if something fails (validation errors will prevent loading)

Note

SSUI validates on load. Common errors: missing required fields, non-numeric AppID, wrong executable extension.