Skip to content

docs: eliminate README redundancies via consolidation and cross-references #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TimInTech merged 3 commits into from
Jan 2, 2026
Merged

docs: eliminate README redundancies via consolidation and cross-references #68

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3111a46
Initial plan
Copilot Jan 2, 2026
3c051f4
docs: reduce README redundancies by consolidating duplicate information
Copilot Jan 2, 2026
1259636
docs: consolidate duplicate simulation workflow references
Copilot Jan 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
- Network: Bridged NIC (vmbr0), ports 25565/TCP and 19132/UDP

Java 21 is required. If OpenJDK 21 is missing in your repositories, the installers automatically fall back to Amazon Corretto 21 (APT with signed-by keyring).
**Note:** UFW must be installed before running any `ufw` commands. JVM memory is auto-sized by the installer (see below). Bedrock installer enforces SHA256 checksum by default.
**Note:** UFW must be installed before running any `ufw` commands. JVM memory is auto-sized by the installer (see [Configuration](#configuration)).

---

Expand Down Expand Up @@ -69,7 +69,7 @@ chmod +x setup_minecraft.sh
sudo -u minecraft screen -r minecraft
```

> Debian 12/13: Ensure `/run/screen` exists with `root:utmp` and mode `0775` (see below).
> **Debian 12/13:** If you encounter screen socket errors, see [Integrity & Firewall](#integrity--firewall) for `/run/screen` setup.

### VM (Static IP)

Expand Down Expand Up @@ -159,8 +159,7 @@ cd /opt/minecraft && ./update.sh
crontab -e
0 4 * * 0 /opt/minecraft/update.sh >> /var/log/minecraft-update.log 2>&1
```
> Bedrock requires a manual download. `setup_bedrock.sh` enforces SHA256 by default (see below).
> **Checksum enforcement:** Bedrock installer requires `REQUIRED_BEDROCK_SHA256` and validates the ZIP before extraction.
> Bedrock requires a manual download. See [Integrity & Firewall](#integrity--firewall) for checksum enforcement details.
## Configuration

### JVM memory (Java)
Expand Down Expand Up @@ -208,14 +207,10 @@ If this project saves you time, consider supporting continued maintenance via [B
## Troubleshooting

- Not enough RAM in LXC → reduce values in `start.sh`.
- Missing `/run/screen` → follow the "screen socket" section above.
- Missing `/run/screen` → see [Integrity & Firewall](#integrity--firewall) section for setup commands.
- Bedrock ZIP MIME-Type issue → revisit the Mojang download page.

Use the PR template. Do not execute anything in this workspace. See **[.github/copilot-instructions.md](.github/copilot-instructions.md)**.

For safe simulation workflow details, see **[SIMULATION.md](SIMULATION.md)**.

> **Simulation CLI:** For step-by-step Copilot CLI workflow, see [.github/copilot-instructions.md](.github/copilot-instructions.md).
Use the PR template. Do not execute anything in this workspace. See **[SIMULATION.md](SIMULATION.md)** for safe workflow details and **[.github/copilot-instructions.md](.github/copilot-instructions.md)** for step-by-step Copilot CLI workflow.


## References
Expand Down