Skip to content

docs(start-parameters): document extraparams - #129

Open
borzaka wants to merge 3 commits into
GameServerManagers:masterfrom
borzaka:patch-3
Open

borzaka wants to merge 3 commits into
GameServerManagers:masterfrom
borzaka:patch-3

Conversation

@borzaka

@borzaka borzaka commented Oct 4, 2026 •

Copy link
Copy Markdown
Contributor

Documents the extraparams behaviour merged in GameServerManagers/LinuxGSM#4970. LinuxGSM appends it centrally after resolving startparameters, including when a user overrides that line. The examples no longer insert ${extraparams} manually, which would duplicate the extra parameters.

  • Put Extra Parameters before full overrides, with a copyable instance-config example and the v26.5.0 requirement.
  • Explain empty values, common.cfg/instance precedence, secret configs, and checking the command line with details.
  • Clarify when to use predefined settings, extraparams, or a full startparameters override, including Unreal map options and Minecraft JVM options. Explain that full overrides stop receiving default-line updates.
  • Update Basic Usage and LAN Discovery to use the current config sections and override instructions, covering the related pages addressed in docs(start-parameters): document extraparams #144.

The code PR is merged into develop; v26.5.0 is the planned first release containing this feature. The documentation states the version requirement explicitly.

Validation: checked the behaviour against merge commit 5107135cac37be80e11a2ff6ed87792334dd68ac; git diff --check; local Markdown links/anchors and GitBook markup; bash -n on all three configuration examples. No game server runtime test was run for this documentation update.

Document the new `extraparams` setting, which appends custom parameters to the end of `startparameters` without overriding it.

- Add `extraparams=""` to the predefined parameters example.
- Add an "Extra Parameters" section with an example and a warning to keep `${extraparams}` when overriding `startparameters`.
- Point the "Additional Parameters" section to `extraparams`.
- End the full example's `startparameters` with `${extraparams}`.
Revert the unintended `_start parameters_` -> `*start parameters*` change so the diff only contains the extraparams documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant