docs: design specs, architecture diagram, setup guide, server-ctl script - #28
Open
shiftySenpai wants to merge 3 commits into
Open
docs: design specs, architecture diagram, setup guide, server-ctl script#28shiftySenpai wants to merge 3 commits into
shiftySenpai wants to merge 3 commits into
Conversation
README.md: add an Architecture section (Mermaid diagram of the HEC vs
KV-store write paths) and a platform support matrix (which MC version(s)
and which logging categories each of Spigot/Paper/Forge/NeoForge/Fabric
actually implements) so it's clear up front that NeoForge/Fabric are
block/death/player only. Also fixes a wrong path in the player-stats
section (world/players/stats/<uuid>.json -> world/stats/<uuid>.json --
that's actually where vanilla Minecraft writes per-player stats).
MINECRAFT_SETUP.md: reorganized so all prerequisites (Splunk HEC/index/
KV-token, then Minecraft JDK/Maven/platform-version matrix) come before
any instructions, replacing the old structure where you'd discover a
missing requirement mid-setup.
Adds minecraft-server-ctl.sh: a single start/stop/restart/status/console
script driving the server inside a detached tmux session, replacing the
old run_minecraft.sh foreground-only launcher. The stop path specifically
avoids a footgun hit while testing this branch: once the server process
exits, its pane sits at a shell prompt ("Press any key to close..."), and
sending one more keystroke into that pane can consume the prompt and kill
the entire tmux session (not just the Minecraft process) if it's the
session's only window. This script polls for the java process to actually
exit and then kills the tmux session directly, never sending a second
keystroke into the pane.
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Split out of #23 (docs slice). No code changes — safe to review/merge independently of the other 4.
world/players/stats/<uuid>.json->world/stats/<uuid>.json).minecraft-server-ctl.sh: a tmux-based start/stop/restart/status/console script replacing the old foreground-only launcher.Test plan
Part of the #23 split.