Skip to content

Special arg fields

JLangisch edited this page Dec 23, 2025 · 1 revision

Special Behaviors and Advanced Patterns

special Field Options

"hide_in_ui"

  • Argument is never shown in the UI
  • Still added to command line based on required/requires_value rules
  • Perfect for mandatory technical flags

Example:

{
  "flag": "-nographics",
  "value": "",
  "required": true,
  "requires_value": false,
  "special": "hide_in_ui",
  "description": "Required for headless servers",
  "type": "bool",
  "ui_label": "No Graphics (hidden)",
  "ui_group": "basic",
  "weight": 5
}

"dont_append_flag_just_value"

  • Only the value is appended (no flag)
  • Useful for games with positional or flagless parameters
  • Common in games like Stationeers (e.g., SaveName MySave)

Example:

{
  "flag": "SaveName",
  "value": "MySave",
  "required": true,
  "requires_value": true,
  "special": "dont_append_flag_just_value",
  "ui_label": "Save Name",
  "ui_group": "basic",
  "weight": 30
}

"space_delimited" (Legacy)

  • Splits value on spaces and appends each part separately
  • Avoid if possible — better to use multiple args with dont_append_flag_just_value

OS-Specific Arguments

Use the os field to restrict:

{
  "flag": "-logFile",
  "value": "./server.log",
  "os": "linux",
  ...
}

Only included when running on matching OS.

Command-Line Order

BuildCommandArgs sorts by:

  1. weight ascending (primary!)
  2. Fallback group order (Basic → Network → Advanced)

Note

UI tab order is currently random. Command-line order is reliable.

Tip

Use low weights (10, 20, 30...) for important early flags, higher for advanced options.

Clone this wiki locally