Skip to content

Arguments

JLangisch edited this page Dec 23, 2025 · 1 revision

Arguments Reference

The args object is a map of category names to arrays of arguments:

"args": {
  "basic": [ ... ],
  "network": [ ... ],
  "advanced": [ ... ]
}

Important

Use "basic", "network", and "advanced" as category keys for best UI compatibility. Other names may cause grouping issues in the current UI.

GameArg Fields

Field Type Required Description
flag string Yes The command-line flag (e.g., "-port" or "SaveName")
value string Yes Default (and saved user) value. Updated by UI on changes.
required boolean Yes If true → always include in command line (even if value empty)
requires_value boolean Yes If true → expects a value. If false + required → boolean flag (no value appended)
description string Yes Shown in UI tooltips
type string Yes "string", "bool", or "int" — used for validation
ui_label string Yes Label shown in UI
ui_group string Yes Must match the category key (e.g., "basic")
weight int Yes Primary sort order for command-line args (lower = earlier). Also affects UI order within group.
special string No Special behavior: "hide_in_ui" or "dont_append_flag_just_value" (see next doc)
os string No "linux" or "windows" → only include on that OS
disabled boolean No If true → completely skipped
min / max int No Currently unused (planned for UI validation)

required + requires_value Logic

required requires_value value empty Result
true true yes/no Always include flag + value
true false N/A Always include flag only
false true yes Include flag + value
false true no Skip entirely
false false N/A Include flag only

Tip

Use required: true + requires_value: false + "special": "hide_in_ui" for always-on hidden flags like -nographics.

Clone this wiki locally