[Feature]: Single machine-readable data file for server metadata and default ports
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
Research direction
Start by reading lgsm/modules/info_messages.sh, the per-server lgsm/config-default/config-lgsm/<server>/_default.cfg files, and lgsm/data/serverlist.csv to see how port metadata is currently represented. The issue proposes a new lgsm/data/servers.json and CI validation, but leaves the schema, coverage of every server, and handling of ports without known defaults to be worked out. Done means the metadata is complete and dependable enough for scripts, CI, and the website to use.
Written by the indexing model from the issue text.
Description
Summary
Add one machine-readable data file that holds the definitive per-server metadata, starting with port definitions, so the scripts, the docs and the website all read the same source instead of each working it out separately.
Problem
Default ports are currently spread across several places:
- the port tables printed by
detailslive inlgsm/modules/info_messages.sh(labels, protocols and variable names) - the default values live in
lgsm/config-default/config-lgsm/<server>/_default.cfg, but only for some servers and only some ports - other defaults are only implied by
lgsm/modules/info_game.shfallbacks or by the game's own default config in Game-Server-Configs - some games have no default anywhere in LinuxGSM and the value only exists in the game's own documentation
Anything outside the main script that needs ports has to scrape shell code. The new linuxgsm.com site needs a port table for every server, and building it from the current files gave only about half of the default values directly from this repo. The rest had to be guessed or taken from another source, which is not reliable enough to publish.
Proposal
Add a data file (for example lgsm/data/servers.json, next to serverlist.csv) with one entry per server. For ports:
{
"csgoserver": {
"ports": [
{ "setting": "port", "label": "Game", "default": 27015, "protocol": "udp" },
{ "setting": "port", "label": "Game", "default": 27015, "protocol": "tcp" },
{ "setting": "sourcetvport", "label": "SourceTV", "default": 27020, "protocol": "udp" }
]
}
}
Then:
- Generate or validate the
fn_portlines ininfo_messages.shand the port values in_default.cfgfrom that file, or have CI fail if they disagree, so there is only one place to edit. - Add a check in CI that every server in
serverlist.csvhas an entry, and every port thedetailscommand prints has a default value. - Publish the file so linuxgsm.com, the docs and other tools can read it directly.
Other uses
The same file could hold other facts that are currently scattered or only in the docs, for example engine, whether SteamCMD is used, whether a Steam login or a game server token is needed, default install size, supported distros, and the config file paths. The linuxgsm.com server pages already show several of these.
Notes
- Servers where LinuxGSM currently has no default for a port would need the value confirmed from the game's own documentation before it goes in.
- A follow-up could let
detailsread from the same file, but that is not required for the first version.
- Dominant language
- Shell
- Stars
- 4.9k
- Forks
- 866
- Avg merge
- 17h 58m
- Merged PRs (30d)
- 100
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from GameServerManagers/LinuxGSM
-
command: update-lgsm distro: Debian engine: source2 game: Counter-Strike 2 regression: yes reproducible: always severity: low type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
GameServerManagers/LinuxGSM#5242 ·
Maintainers usually reply within 1 day
-
distro: Debian distro: Ubuntu engine: spark game: Natural Selection 2 priority: high scope: single game type: feature
Difficulty 4/5 3-5 days Newbie friendliness 45/100
GameServerManagers/LinuxGSM#5241 ·
Maintainers usually reply within 1 day
-
command: send distro: Ubuntu engine: spark game: Natural Selection 2 priority: high scope: single game type: feature
Difficulty 4/5 3-5 days Newbie friendliness 48/100
GameServerManagers/LinuxGSM#5240 ·
Maintainers usually reply within 1 day
-
command: monitor distro: Ubuntu engine: spark game: Natural Selection 2 info: query reproducible: unable severity: critical type: bug
Difficulty 3/5 1-2 days Newbie friendliness 35/100
GameServerManagers/LinuxGSM#5238 ·
Maintainers usually reply within 1 day
-
engine: null game: Teamspeak 3
Difficulty 3/5 Half a day Newbie friendliness 66/100
GameServerManagers/LinuxGSM#5237 ·
Maintainers usually reply within 1 day
All issues in GameServerManagers/LinuxGSM
Similar issues
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
varnish/helm-varnish#173 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
📦 Update Request
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
cdnjs/packages#2225 · 1 comment ·
Maintainers usually reply within 3 days
-
good first issue help wanted testing
Difficulty 1/5 Under an hour Newbie friendliness 78/100