[Feature]: Single machine-readable data file for server metadata and default ports
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
调研方向
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 内容生成。
描述
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.
- 主要语言
- Shell
- 星标
- 4.9k
- 派生
- 866
- 平均合并
- 17 小时 58 分钟
- 30 天内合并 PR
- 100
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
GameServerManagers/LinuxGSM 的其他 Issue
-
command: update-lgsm distro: Debian engine: source2 game: Counter-Strike 2 regression: yes reproducible: always severity: low type: bug
难度 2/5 1-3 小时 新手友好度 84/100
GameServerManagers/LinuxGSM#5242 ·
维护者通常 1 天内回复
-
distro: Debian distro: Ubuntu engine: spark game: Natural Selection 2 priority: high scope: single game type: feature
难度 4/5 3-5 天 新手友好度 45/100
GameServerManagers/LinuxGSM#5241 ·
维护者通常 1 天内回复
-
command: send distro: Ubuntu engine: spark game: Natural Selection 2 priority: high scope: single game type: feature
难度 4/5 3-5 天 新手友好度 48/100
GameServerManagers/LinuxGSM#5240 ·
维护者通常 1 天内回复
-
command: monitor distro: Ubuntu engine: spark game: Natural Selection 2 info: query reproducible: unable severity: critical type: bug
难度 3/5 1-2 天 新手友好度 35/100
GameServerManagers/LinuxGSM#5238 ·
维护者通常 1 天内回复
-
engine: null game: Teamspeak 3
难度 3/5 半天 新手友好度 66/100
GameServerManagers/LinuxGSM#5237 ·
维护者通常 1 天内回复
查看 GameServerManagers/LinuxGSM 的全部 Issue
相似的 Issue
-
enhancement good first issue
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 2/5 1-3 小时 新手友好度 84/100
varnish/helm-varnish#173 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
-
📦 Update Request
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 3 天内回复
-
good first issue help wanted testing
难度 1/5 1 小时以内 新手友好度 78/100