Generate per-game docker-compose examples from structured game data (e.g. ports)
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 30/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- docker, json, shell, yaml
- Domain
- build-system, devops
Research direction
Start with generate-dockerfiles.sh and generate-docker-compose.sh, which read serverlist.csv and pass four separate environment variables to the templates. Then check the default port values in lgsm/config-default/config-lgsm/<shortname>server/_default.cfg and the publish workflow's matrix. Done means each game gets one structured record that reaches the templates as game.*, with its default ports in the compose output, and the matrix and image names stay unchanged. Reading PR #103 first is worthwhile, since it covers part of this design.
Written by the indexing model from the issue text.
Description
Idea
Generate each game's docker-compose example (and Dockerfile, where useful) from richer per-game data, so the examples are correct for that game out of the box. For example, publish the game's default ports rather than a generic example.
Today
generate-dockerfiles.sh and generate-docker-compose.sh read LinuxGSM's serverlist.csv, which has only four fields per game: shortname, server name, game name and distro. The templates get those as separate environment variables, so there is nothing game-specific to put in the compose examples beyond the name and image tag.
Possible approach
- Build one structured record per game (for example JSON). Start with the four
serverlist.csvfields, and add data read from LinuxGSM, such as default ports fromlgsm/config-default/config-lgsm/<shortname>server/_default.cfg. - Pass each game's record to the Jinja templates as one object (
game.shortname,game.ports, and so on). - Keep the publish workflow's matrix as a list (
{"include":[{"shortname":"..."}]}), thedockerfiles/Dockerfile-<shortname>names, and theghcr.iobase image.
Background
#103 (B13rg, 2024) started the refactor towards per-game JSON records but stopped before adding any new data, and it no longer fits the current generator and workflow. Its JSON conversion with yq and its game.* template variables are a useful starting point.
- Dominant language
- Shell
- Stars
- 347
- Forks
- 26
- Avg merge
- 8h 2m
- Merged PRs (30d)
- 2
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- Ships a Dockerfile or Docker Compose file
- No pull request template
- No 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/docker-gameserver
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
GameServerManagers/docker-gameserver#144 · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
GameServerManagers/docker-gameserver#142 · 2 comments ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
GameServerManagers/docker-gameserver#113 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
GameServerManagers/docker-gameserver#100 · 2 comments ·
All issues in GameServerManagers/docker-gameserver
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
-
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
-
📦 Update Request
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
cdnjs/packages#2225 · 1 comment ·
Maintainers usually reply within 3 days