[Feature]: Single machine-readable data file for server metadata and default ports

Aperta
#5,196 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
bash, github-actions, json, shell
Ambito
cli, tooling

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

engine: source game: Counter-Strike: Global Offensive info: steamcmd info: website type: docs type: feature
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 details live in lgsm/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.sh fallbacks 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:

  1. Generate or validate the fn_port lines in info_messages.sh and the port values in _default.cfg from that file, or have CI fail if they disagree, so there is only one place to edit.
  2. Add a check in CI that every server in serverlist.csv has an entry, and every port the details command prints has a default value.
  3. 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 details read from the same file, but that is not required for the first version.
Lingua principale
Shell
Stelle
4.9k
Fork
866
Merge medio
17h 58m
PR unite (30g)
100

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di GameServerManagers/LinuxGSM

Tutte le issue di GameServerManagers/LinuxGSM

Issue simili

Altre issue su Shell/Bash

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.