Replace PORT with GAMEPORT for better clarity

[EvilOlaf]

and add deprecation warning.

Summary by CodeRabbit

• Documentation

  • Updated port configuration docs to reference the new GAMEPORT environment variable and examples.

• Chores

  • Migrated port env var from PORT to GAMEPORT across deployment/configuration.
  • Backward compatibility preserved with deprecation warnings for PORT; behavior and default port remain unchanged.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

The PR renames the repository port variable from PORT to GAMEPORT across docs and configuration, and adds backward-compatibility in the startup script to accept PORT while preferring GAMEPORT. No public API or exported signatures changed.

Changes

Cohort / File(s)	Summary
Documentation README.md	Updated port customization section to reference GAMEPORT (env example, footnote, warning, and port-mapping examples adjusted).
Configuration docker-compose.yml	Replaced PORT with GAMEPORT in the scum-server service environment block; port mappings unchanged.
Startup script start-server.sh	Added compatibility handling: emit deprecation warning if PORT set, initialize GAMEPORT from PORT if absent, and invoke SCUMServer.exe with -port=${GAMEPORT:-7777}; QUERYPORT/MAXPLAYERS unchanged.

Sequence Diagram(s)

(Skipped — changes are limited to docs, compose, and a simple env-var compatibility in a script; no multi-component sequential flow requiring visualization.)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• overhaul readme #15 — Documentation change renaming PORT → GAMEPORT in the README's port-customization section.

Poem

🐰 I nibble old PORT and plant GAMEPORT seeds,
A gentle hop forwards for servers' new deeds.
Compose sings the tune, the script gives a wink,
Backward-safe paths make migration quick. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately captures the main change: replacing PORT with GAMEPORT for clarity, which is reflected across all modified files (README.md, docker-compose.yml, and start-server.sh).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch gameport

---

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 553eb36 and b20cb87.

📒 Files selected for processing (1)

• README.md

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-11-26T08:22:42.142Z

Learnt from: EvilOlaf
Repo: EvilOlaf/scum PR: 8
File: README.md:53-56
Timestamp: 2025-11-26T08:22:42.142Z
Learning: In the EvilOlaf/scum repository, providing detailed help with customizing the gaming experience (such as extensive SCUM server configuration guidance) is out of scope. The repository focuses on the Docker container setup rather than comprehensive game server customization documentation.

Applied to files:

• README.md

🔇 Additional comments (3)

README.md (3)

31-31: LGTM!

The terminology update to GAMEPORT is clear and improves documentation consistency.

---

33-55: LGTM!

The warning block correctly references GAMEPORT, and the expanded port mapping example is comprehensive and demonstrates the behavior described in the footnote (GAMEPORT + two additional ports). This provides clear, actionable guidance for users customizing ports.

---

83-83: LGTM!

The footnote correctly references GAMEPORT and provides essential context about SCUM's port allocation behavior, which directly supports the expanded port mapping example above.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

37-37: Minor formatting: Remove extra space after blockquote symbol.

The markdown has multiple spaces after the blockquote symbol.

🔎 Proposed fix

->  
+> 

📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0eb1b36 and 553eb36.

📒 Files selected for processing (3)

• README.md
• docker-compose.yml
• start-server.sh

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-11-26T08:22:42.142Z

Learnt from: EvilOlaf
Repo: EvilOlaf/scum PR: 8
File: README.md:53-56
Timestamp: 2025-11-26T08:22:42.142Z
Learning: In the EvilOlaf/scum repository, providing detailed help with customizing the gaming experience (such as extensive SCUM server configuration guidance) is out of scope. The repository focuses on the Docker container setup rather than comprehensive game server customization documentation.

Applied to files:

• README.md
• docker-compose.yml

🪛 markdownlint-cli2 (0.18.1)

README.md

37-37: Multiple spaces after blockquote symbol

(MD027, no-multiple-space-blockquote)

🔇 Additional comments (4)

docker-compose.yml (1)

6-6: LGTM! Environment variable renamed for clarity.

The change from PORT to GAMEPORT improves clarity. The backward compatibility layer in start-server.sh ensures existing deployments won't break.

README.md (1)

31-31: LGTM! Documentation consistently updated.

All references to the port environment variable have been correctly updated from PORT to GAMEPORT throughout the documentation, including the usage example and footnote.

Also applies to: 34-34, 40-40, 83-83

start-server.sh (2)

4-13: LGTM! Backward compatibility implemented correctly.

The deprecation logic properly handles the migration path:

• Clear warning message guides users to update their configuration
• GAMEPORT="${GAMEPORT:-$PORT}" correctly prioritizes GAMEPORT if both variables are set
• Prevents breaking existing deployments

---

39-39: LGTM! Server invocation updated correctly.

The port parameter now uses GAMEPORT with the same default value (7777), maintaining existing behavior while supporting the new variable name.