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

未关闭
#5,196 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
bash, github-actions, json, shell
领域
cli, tooling

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.
主要语言
Shell
星标
4.9k
派生
866
平均合并
17 小时 58 分钟
30 天内合并 PR
100

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

GameServerManagers/LinuxGSM 的其他 Issue

查看 GameServerManagers/LinuxGSM 的全部 Issue

相似的 Issue

更多 Shell/Bash Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。