Home

Runfiles for SteamServerUI

What is a Runfile?

A runfile is a JSON configuration file that tells SteamServerUI (SSUI) exactly how to launch and configure a dedicated game server. It defines:

• The game's metadata (name, images, etc.)
• Steam AppID
• Executable paths for Windows and Linux
• All command-line arguments with defaults, descriptions, and UI hints
• Optional backup directory and exposed config files

With a well-written runfile, users can select your game from the SSUI gallery, tweak settings in a friendly UI, and launch the server — no manual command-line editing required.

Runfiles are stored as run<GameName>.ssui (e.g., runStationeers.ssui) in the SSUI runfiles folder.

Runfiles Documentation

• Home
• Getting started
• Best Practices

Core Structure

• Core Fields Reference
• Arguments Reference
• Special Arg Fields

Advanced Topics

• Exposed Config Files

Complete Runfiles

• Full Example
• Actual runfiles

The Runfile gallery

• Contributing to the runfile gallery

Why Write a Runfile?

• Makes your server easy to set up via SSUI
• Provides a polished UI for common settings
• Enables built-in backup/restore for save folders
• Allows sharing via the future Runfile Gallery

Quick Example (Minimal Valheim)

See the full example for further information

{
  "meta": {
    "name": "Valheim",
    "version": "1.0",
    "author": "YourName",
    "image": "https://example.com/valheim-banner.jpg"
  },
  "steam_app_id": "892970",
  "windows_executable": "./valheim_server.exe",
  "linux_executable": "./valheim_server.x86_64",
  "backup_content_dir": "./saves",
  "args": {
    "basic": [
      {
        "flag": "-name",
        "value": "My Valheim Server",
        "required": true,
        "requires_value": true,
        "description": "Server name visible in server browser",
        "type": "string",
        "ui_label": "Server Name",
        "ui_group": "basic",
        "weight": 10
      },
      {
        "flag": "-port",
        "value": "2456",
        "required": true,
        "requires_value": true,
        "description": "Game port",
        "type": "int",
        "ui_label": "Port",
        "ui_group": "basic",
        "weight": 20
      },
      {
        "flag": "-world",
        "value": "MyWorld",
        "required": true,
        "requires_value": true,
        "description": "World name",
        "type": "string",
        "ui_label": "World Name",
        "ui_group": "basic",
        "weight": 30
      },
      {
        "flag": "-password",
        "value": "",
        "required": false,
        "requires_value": true,
        "description": "Leave empty for public server",
        "type": "string",
        "ui_label": "Password",
        "ui_group": "basic",
        "weight": 40
      }
    ]
  }
}