From ca5c9f73e3d9ab2885158d36bff673e9f95b2249 Mon Sep 17 00:00:00 2001 From: BruceChen Date: Sun, 12 Apr 2026 23:33:59 +0800 Subject: [PATCH] docs: describe shared server MCC sessions --- .skills/mcc-dev-workflow/SKILL.md | 128 ++- docs/guide/ai-assisted-development.md | 93 ++- ...-12-mcc-shared-server-isolated-sessions.md | 789 ++++++++++++++++++ tools/README.md | 32 + 4 files changed, 983 insertions(+), 59 deletions(-) create mode 100644 docs/superpowers/plans/2026-04-12-mcc-shared-server-isolated-sessions.md diff --git a/.skills/mcc-dev-workflow/SKILL.md b/.skills/mcc-dev-workflow/SKILL.md index b1a9ef01..79980b63 100644 --- a/.skills/mcc-dev-workflow/SKILL.md +++ b/.skills/mcc-dev-workflow/SKILL.md @@ -12,7 +12,7 @@ Use this skill when the task needs a real local server loop, not just code readi - Solution: `MinecraftClient.sln` - Runtime target: `.NET 10` / `net10.0` - Environment: Linux, macOS, or WSL with Java, tmux, python3, and dotnet available -- Default server root: `${MCC_SERVERS:-$MCC_REPO/MinecraftOfficial/downloads}` +- Default server root after `source tools/mcc-env.sh`: `${MCC_SERVERS:-/MinecraftOfficial/downloads}` - Default validation target when the user does not specify a version: `1.21.11` ## Console modes @@ -34,6 +34,50 @@ Both modes support the same commands and input/output through `ConsoleIO.Backend - A server log line containing `Done (` means startup finished. It does not guarantee that RCON is ready on the first attempt. Retry early `mc-rcon` commands. - When instructions, docs, and code disagree, trust current code and current tool behavior first. +## Shared server, isolated MCC sessions + +- `mc-*` commands operate on the shared local Minecraft server. +- `mcc-*` commands operate on one MCC client session. +- The default `session` is the current worktree name. +- The default username is derived from `session`, unless you pass `--username`. +- Session files live under `${TMPDIR:-/tmp}/mcc-debug//`. +- `MCC_SERVERS` stays the shared server-root override. + +Keep shared servers running by default. Do not stop or reset them unless the user explicitly asks for that, or you need to switch server versions. + +Two worktrees can debug against one shared server like this: + +```bash +# worktree A +cd ~/Minecraft/Minecraft-Console-Client +source tools/mcc-env.sh +mc-start 1.21.11 +mcc-debug -v 1.21.11 --file-input + +# worktree B +cd ~/Minecraft/Minecraft-Console-Client-foo +source tools/mcc-env.sh +mcc-debug -v 1.21.11 --file-input + +# from each worktree, mcc-* targets that worktree's default session +mcc-state +``` + +If you want two MCC sessions from the same worktree, pass `--session NAME` explicitly. + +## tmpfs build mode + +Use this on machines with enough RAM when you want worktree-isolated builds outside the repo tree: + +```bash +source tools/mcc-env.sh +export MCC_BUILD_MODE=tmpfs +mcc-build +mcc-build-clean +``` + +`MCC_BUILD_MODE=tmpfs` redirects build output to `/dev/shm/mcc-build//` on Linux, or `${TMPDIR:-/tmp}/mcc-build//` if `/dev/shm` is unavailable. + ## Preflight and reset Before scripted runs, especially on macOS or in a reused tmux environment: @@ -58,9 +102,11 @@ Interactive shell: ```bash source tools/mcc-env.sh +SESSION="$(_mcc_resolve_session)" +USERNAME="$(_mcc_resolve_username "$SESSION")" mc-start 1.21.11 mc-log 1.21.11 100 -mc-rcon "op CursorBot" +mc-rcon "op $USERNAME" mc-stop 1.21.11 ``` @@ -68,7 +114,7 @@ Non-interactive shell: ```bash tools/start-server.sh 1.21.11 -tools/mc-rcon.sh "op CursorBot" +tools/mc-rcon.sh "op mcc_smoke_a" ``` If the servers live outside the repo, set `MCC_SERVERS` before sourcing or invoking the tools: @@ -104,16 +150,16 @@ mcc-debug -v 1.21.11 --file-input --no-build ### What mcc-debug.sh does 1. Builds MCC (unless `--no-build`) -2. Creates a clean temp config at `/tmp/mcc-debug/MinecraftClient.debug.ini` with CursorBot account, Terrain/Inventory/Entity enabled and noisy bots disabled +2. Creates a clean temp config at `${TMPDIR:-/tmp}/mcc-debug//MinecraftClient.debug.ini` 3. Ensures server is running (starts if not, waits for `Done (`) -4. Launches MCC in the specified mode +4. Launches MCC in a session-scoped tmux session and session-scoped log/input/pid files ### After launch -- **FileInput mode**: drive MCC via `mcc-cmd "debug state"` or `echo "debug state" >> mcc_input.txt` -- **Interactive/TUI mode**: attach with `tmux attach -t mcc-debug`, type commands directly -- **Logs**: `tail -f /tmp/mcc-debug/mcc-debug.log` (FileInput mode only; TUI/interactive mode outputs to tmux) -- **Server RCON**: `mc-rcon "op CursorBot"`, `mc-rcon "gamemode creative CursorBot"` +- **FileInput mode**: drive MCC via `mcc-cmd --session smoke-a "debug state"`, or just `mcc-cmd "debug state"` from the same worktree +- **Interactive/TUI mode**: attach with `tmux attach -t mcc-` +- **Logs**: `mcc-log-mcc --session smoke-a` or `tail -f "${TMPDIR:-/tmp}/mcc-debug//mcc-debug.log"` +- **Server RCON**: grant op or gamemode to the username derived from that session ## Debug commands (in-game) @@ -128,7 +174,7 @@ Prints a one-shot summary of MCC's internal state: ``` === MCC Debug State === Server: localhost:25565 -Username: CursorBot +Username: mcc_smoke_a Protocol: 774 GameMode: 1 Health: 20.0 @@ -152,18 +198,20 @@ For agents calling MCC commands programmatically: ```bash source tools/mcc-env.sh -mcc-debug -v 1.21.11 --file-input --no-build +SESSION="smoke-a" +mcc-debug -v 1.21.11 --file-input --session "$SESSION" --no-build # Send commands: -mcc-cmd "debug state" -mcc-cmd "inventory player list" -mcc-cmd "entity" +mcc-cmd --session "$SESSION" "debug state" +mcc-cmd --session "$SESSION" "inventory player list" +mcc-cmd --session "$SESSION" "entity" # Check results: -tail -20 /tmp/mcc-debug/mcc-debug.log +mcc-log-mcc --session "$SESSION" # Stop: -mcc-cmd "quit" +mcc-cmd --session "$SESSION" "quit" +mcc-kill --session "$SESSION" mc-stop 1.21.11 ``` @@ -171,10 +219,11 @@ mc-stop 1.21.11 ```bash source tools/mcc-env.sh -mcc-debug -v 1.21.11 +SESSION="live-a" +mcc-debug -v 1.21.11 --session "$SESSION" # In another terminal: -tmux attach -t mcc-debug +tmux attach -t "mcc-$SESSION" # Type commands directly in MCC console ``` @@ -192,22 +241,23 @@ TUI mode runs Consolonia full-screen in a tmux session. Key differences: ```bash source tools/mcc-env.sh -mcc-debug -v 1.21.11 -m tui --no-build +SESSION="tui-a" +mcc-debug -v 1.21.11 -m tui --session "$SESSION" --no-build # Cannot use mcc-cmd (no FileInput); must use tmux send-keys: -tmux send-keys -t mcc-debug "/debug state" Enter +tmux send-keys -t "mcc-$SESSION" "/debug state" Enter # Read TUI screen: -tmux capture-pane -t mcc-debug -p -S -30 +tmux capture-pane -t "mcc-$SESSION" -p -S -30 # Stop: -tmux send-keys -t mcc-debug Escape +tmux send-keys -t "mcc-$SESSION" Escape ``` **Caveat with tmux send-keys and Consolonia**: When sending text containing `/`, the Enter key may need to be sent separately: ```bash -tmux send-keys -t mcc-debug "/inventory player list" -tmux send-keys -t mcc-debug Enter +tmux send-keys -t "mcc-$SESSION" "/inventory player list" +tmux send-keys -t "mcc-$SESSION" Enter ``` ## mcc-env.sh quick reference @@ -226,26 +276,28 @@ After `source tools/mcc-env.sh`: | `mc-wait-stop VER [SEC]` | Wait for server shutdown, with force-kill fallback | | `mc-reset-test-env [--all|VER...]` | Reset shared tmux server state and stale pipes | | `mcc-build` | Build MCC | -| `mcc-run [PORT]` | Run MCC classic+FileInput on port | -| `mcc-tui [PORT]` | Run MCC TUI mode in tmux | -| `mcc-cmd "CMD"` | Append command to mcc_input.txt | -| `mcc-kill` | Kill MCC process and debug session | +| `mcc-build-clean` | Clear the current worktree's build output | +| `mcc-run [--session NAME] [--username NAME] [--port PORT]` | Convenience wrapper for `mcc-debug --file-input --no-build` | +| `mcc-tui [--session NAME] [--username NAME] [--port PORT]` | Convenience wrapper for `mcc-debug -m tui --no-build` | +| `mcc-cmd [--session NAME] "CMD"` | Append a command to one session's input file | +| `mcc-kill [--session NAME]` | Kill one MCC process and session | | `mcc-debug [OPTS]` | One-step debug session (see above) | -| `mcc-log-mcc` | Tail MCC debug log | -| `mcc-state` | Send `debug state` and print last 30 log lines | +| `mcc-log-mcc [--session NAME]` | Tail one MCC debug log | +| `mcc-state [--session NAME]` | Send `debug state` and print the last 30 log lines | | `mcc-preflight [VER...]` | Verify Java, tmux, dotnet, python3, and server dirs | ## Temporary config recipe ```bash source tools/mcc-env.sh -TEST_ROOT="${TMPDIR:-/tmp}/mcc-dev" -CFG="$TEST_ROOT/MinecraftClient.1.21.11.ini" -mkdir -p "$TEST_ROOT" +SESSION="smoke-a" +USERNAME="$(_mcc_resolve_username "$SESSION")" +CFG="$(_mcc_session_root "$SESSION")/MinecraftClient.debug.ini" +mkdir -p "$(_mcc_session_root "$SESSION")" bash "$MCC_REPO/.skills/mcc-integration-testing/scripts/prepare_offline_mcc_config.sh" \ "$CFG" \ "1.21.11" \ - "CursorBot" + "$USERNAME" ``` For TUI mode, also add: @@ -259,14 +311,14 @@ MCC output should include: - `[MCC] Server was successfully joined.` -Server output should include: +Server output should include the session-derived username, for example: -- `CursorBot joined the game` +- `mcc_smoke_a joined the game` Basic command check: ```bash -mcc-cmd "inventory player list" +mcc-cmd --session smoke-a "inventory player list" ``` If a scripted run fails before MCC joins, check for a harness problem before assuming a product regression. Missing `mcc.log`, a pre-join `Connection refused`, or a server that never reached `Done (` usually means shared-state cleanup or startup failed. @@ -292,7 +344,7 @@ If a scripted run fails before MCC joins, check for a harness problem before ass - Legacy `1.8` and `1.8.9` servers may need `use-native-transport=false` in `server.properties` on some Linux environments. - For timing-sensitive work, do not trust wall-clock intuition. Use a real server run and capture evidence from logs or test scripts. - **TUI mode tip**: if the terminal becomes unresponsive after a crash, run `stty sane && reset` to restore it. -- **tmux capture trick**: `tmux capture-pane -t mcc-debug -p -S -50` captures the last 50 lines of a tmux session without attaching. +- **tmux capture trick**: `tmux capture-pane -t mcc- -p -S -50` captures the last 50 lines of a tmux session without attaching. ## Tool files diff --git a/docs/guide/ai-assisted-development.md b/docs/guide/ai-assisted-development.md index 9f8fdc03..852df5db 100644 --- a/docs/guide/ai-assisted-development.md +++ b/docs/guide/ai-assisted-development.md @@ -367,10 +367,16 @@ This gives you the helper functions used by the workflow: - `mc-cmd` - `mc-log` - `mc-rcon` +- `mc-reset-test-env` - `mcc-build` +- `mcc-build-clean` - `mcc-run` +- `mcc-tui` - `mcc-cmd` +- `mcc-log-mcc` +- `mcc-state` - `mcc-kill` +- `mcc-debug` - `mcc-reload` @@ -412,7 +418,7 @@ Then make sure the helper functions are loaded: ```bash type mc-start type mcc-build -type mcc-run +type mcc-debug ``` @@ -426,11 +432,55 @@ The moving parts are: - a local Minecraft server running in `tmux` - `mc-rcon` for server-side commands such as `/op`, `/give`, `/summon`, or gamerule setup - MCC started with `MCC_FILE_INPUT=1` -- `FileInputBot`, which watches `mcc_input.txt` and turns file lines into MCC commands or server chat +- `FileInputBot`, which watches the session input file under `${TMPDIR:-/tmp}/mcc-debug//mcc_input.txt` - logs from MCC and the local server, which the agent can inspect between runs The result is simple: the agent can change code, rebuild, start the app, inject commands, and read the result without waiting for a human to sit in the terminal. +## Shared Server, Isolated MCC Sessions + +The harness separates shared server state from MCC client state. + +- `mc-*` commands operate on the shared local Minecraft server. +- `mcc-*` commands operate on one MCC client session. +- The default `session` is the current worktree name. +- The default username is derived from `session`, so two worktrees can join the same shared server without kicking each other. +- Session files live under `${TMPDIR:-/tmp}/mcc-debug//`. +- `MCC_SERVERS` stays the shared server-root override. + +Keep shared servers running by default. Do not stop or reset them unless the user explicitly asks for that, or you need to switch server versions. + +Two worktrees can share one local server like this: + +```bash +# worktree A +cd ~/Minecraft/Minecraft-Console-Client +source tools/mcc-env.sh +mc-start 1.21.11 +mcc-debug -v 1.21.11 --file-input + +# worktree B +cd ~/Minecraft/Minecraft-Console-Client-foo +source tools/mcc-env.sh +mcc-debug -v 1.21.11 --file-input + +# from each worktree, mcc-* targets that worktree's default session +mcc-state +``` + +If you need two MCC sessions from one worktree, pass `--session NAME` explicitly. + +### tmpfs build mode + +```bash +source tools/mcc-env.sh +export MCC_BUILD_MODE=tmpfs +mcc-build +mcc-build-clean +``` + +When `MCC_BUILD_MODE=tmpfs`, build output goes to `/dev/shm/mcc-build//` on Linux, or `${TMPDIR:-/tmp}/mcc-build//` when `/dev/shm` is unavailable. + ## Repository Tools These are the repo-level tools that make the workflow practical. @@ -438,6 +488,7 @@ These are the repo-level tools that make the workflow practical. | Path | Purpose | | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `tools/mcc-env.sh` | Loads the shell helper functions used for the normal loop. | +| `tools/mcc-debug.sh` | Starts a session-scoped MCC debug run with generated config, log, pid, and tmux state. | | `tools/start-server.sh` | Starts a local Minecraft server in a named `tmux` session with a FIFO for stdin. | | `tools/mc-rcon.sh` | Sends RCON commands to the local server using `python3`. | | `tools/decompile.sh` | Downloads `MinecraftDecompiler.jar` if needed, decompiles the requested Minecraft version, and fetches `server.jar` for server-side work. | @@ -453,7 +504,7 @@ There is one more piece worth calling out: - `MinecraftClient/ChatBots/FileInputBot.cs` is what makes file-driven command injection possible. - It is loaded when `MCC_FILE_INPUT=1` is set. -- `mcc-run` in `tools/mcc-env.sh` already sets that flag for you. +- `mcc-debug --file-input` and `mcc-run` already set that flag for you. ## Skills @@ -485,9 +536,12 @@ Some skills also carry their own bundled resources: This is the core loop you should expect an agent to follow. -### 1. Start the local server +### 1. Start the local server and resolve the MCC identity ```bash +source tools/mcc-env.sh +SESSION="smoke-a" +USERNAME="$(_mcc_resolve_username "$SESSION")" mc-start 1.20.6 ``` @@ -506,13 +560,7 @@ mcc-build ### 3. Run MCC with file input enabled ```bash -mcc-run -``` - -The raw form looks like this: - -```bash -MCC_FILE_INPUT=1 dotnet run --project MinecraftClient -c Release -- CursorBot - localhost:25565 +mcc-debug -v 1.20.6 --file-input --session "$SESSION" --no-build ``` ### 4. Set up server state through RCON @@ -520,20 +568,20 @@ MCC_FILE_INPUT=1 dotnet run --project MinecraftClient -c Release -- CursorBot - Examples: ```bash -mc-rcon "op CursorBot" +mc-rcon "op $USERNAME" mc-rcon "gamerule sendCommandFeedback true" -mc-rcon "give CursorBot diamond_sword 1" +mc-rcon "give $USERNAME diamond_sword 1" mc-rcon "summon minecraft:armor_stand ~ ~ ~" ``` -### 5. Drive MCC through `mcc_input.txt` +### 5. Drive MCC through the session input file Examples: ```bash -mcc-cmd "inventory player list" -mcc-cmd "entity" -mcc-cmd "/gamemode creative" +mcc-cmd --session "$SESSION" "inventory player list" +mcc-cmd --session "$SESSION" "entity" +mcc-cmd --session "$SESSION" "/gamemode creative" ``` Behavior: @@ -638,12 +686,15 @@ Use skills: Typical loop: ```bash +source tools/mcc-env.sh +SESSION="smoke-a" +USERNAME="$(_mcc_resolve_username "$SESSION")" mc-start 1.20.6 mcc-build -mcc-run -mc-rcon "op CursorBot" -mcc-cmd "inventory player list" -mcc-cmd "entity" +mcc-debug -v 1.20.6 --file-input --session "$SESSION" --no-build +mc-rcon "op $USERNAME" +mcc-cmd --session "$SESSION" "inventory player list" +mcc-cmd --session "$SESSION" "entity" ``` Then inspect the MCC output, patch the code, and use: diff --git a/docs/superpowers/plans/2026-04-12-mcc-shared-server-isolated-sessions.md b/docs/superpowers/plans/2026-04-12-mcc-shared-server-isolated-sessions.md new file mode 100644 index 00000000..975787b9 --- /dev/null +++ b/docs/superpowers/plans/2026-04-12-mcc-shared-server-isolated-sessions.md @@ -0,0 +1,789 @@ +# MCC 共享服务器与隔离会话 Implementation Plan + +> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking. + +**Goal:** 让多个 Git worktree 共享同一套本地 Minecraft 测试服务器，同时让每个 MCC 调试会话按 `session` 隔离，并支持按 worktree 选择性把构建输出放到 tmpfs。 + +**Architecture:** 保持 `mc-*` 命令面向共享服务器，保留 `MCC_SERVERS` 作为共享 server root override；把 `mcc-*` 命令改成面向显式 `session` 的客户端会话工具，默认 `session` 取当前 worktree 名，默认用户名从 `session` 派生。构建层通过统一的 helper 和 `Directory.Build.props` 接入可选的 tmpfs 构建根，不再依赖 shell 中泄漏的 `MCC_REPO`。 + +**Tech Stack:** Bash, tmux, dotnet CLI, MSBuild `Directory.Build.props`, repo 自带的 MCC integration harness + +--- + +### Task 1: 建立会话与构建根解析的基础 helper，并补一个可重复运行的 shell smoke test + +**Files:** +- Create: `tools/test-mcc-env.sh` +- Modify: `tools/mcc-env.sh` + +- [ ] **Step 1: 先写一个会失败的 shell smoke test，锁定会话名、用户名和路径解析规则** + +```bash +#!/usr/bin/env bash +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" +REPO_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)" +source "$REPO_ROOT/tools/mcc-env.sh" + +assert_eq() { + local expected="$1" + local actual="$2" + local label="$3" + if [[ "$expected" != "$actual" ]]; then + echo "FAIL: $label" >&2 + echo " expected: $expected" >&2 + echo " actual: $actual" >&2 + exit 1 + fi +} + +assert_regex() { + local regex="$1" + local actual="$2" + local label="$3" + if [[ ! "$actual" =~ $regex ]]; then + echo "FAIL: $label" >&2 + echo " regex: $regex" >&2 + echo " actual: $actual" >&2 + exit 1 + fi +} + +session="$(_mcc_resolve_session "demo-branch")" +assert_eq "demo-branch" "$session" "explicit session" + +short_name="$(_mcc_resolve_username "feature-ai")" +assert_eq "mcc_feature_ai" "$short_name" "short derived username" + +long_name="$(_mcc_resolve_username "very-long-worktree-name")" +assert_regex '^mcc_[a-z0-9_]{7}_[0-9a-f]{4}$' "$long_name" "long derived username shape" +assert_eq "16" "${#long_name}" "long derived username length" + +assert_eq "${TMPDIR:-/tmp}/mcc-debug/demo-branch" "$(_mcc_session_root "demo-branch")" "session root" +assert_eq "mcc-demo-branch" "$(_mcc_tmux_session_name "demo-branch")" "tmux session name" + +MCC_BUILD_MODE=tmpfs +build_root="$(_mcc_build_root)" +assert_regex '^(/dev/shm|/tmp)/mcc-build/.+$' "$build_root" "tmpfs build root" + +echo "PASS" +``` + +- [ ] **Step 2: 运行测试，确认它先失败** + +Run: `bash tools/test-mcc-env.sh` + +Expected: FAIL，错误类似 `_mcc_resolve_session: command not found` + +- [ ] **Step 3: 在 `tools/mcc-env.sh` 中加入 repo root、server root、session、username、会话目录、tmux 名和 build root helper** + +```bash +if [[ -n "${BASH_SOURCE[0]:-}" ]]; then + _mcc_env_source="${BASH_SOURCE[0]}" +elif [[ -n "${ZSH_VERSION:-}" ]]; then + _mcc_env_source="${(%):-%N}" +else + _mcc_env_source="$0" +fi + +TOOLS_DIR="$(cd "$(dirname "$_mcc_env_source")" && pwd)" +MCC_REPO_ROOT="$(cd "$TOOLS_DIR/.." && pwd)" +unset _mcc_env_source + +_mcc_repo_root() { + printf '%s\n' "$MCC_REPO_ROOT" +} + +_mcc_servers_root() { + printf '%s\n' "${MCC_SERVERS:-$MCC_REPO_ROOT/MinecraftOfficial/downloads}" +} + +_mcc_current_worktree_name() { + git -C "$MCC_REPO_ROOT" rev-parse --show-toplevel 2>/dev/null | xargs basename +} + +_mcc_resolve_session() { + local explicit="${1:-}" + if [[ -n "$explicit" ]]; then + printf '%s\n' "$explicit" + return 0 + fi + + local worktree + worktree="$(_mcc_current_worktree_name)" + if [[ -n "$worktree" ]]; then + printf '%s\n' "$worktree" + else + basename "$MCC_REPO_ROOT" + fi +} + +_mcc_sha1_short() { + if command -v sha1sum >/dev/null 2>&1; then + printf '%s' "$1" | sha1sum | awk '{print substr($1, 1, 4)}' + else + printf '%s' "$1" | shasum -a 1 | awk '{print substr($1, 1, 4)}' + fi +} + +_mcc_resolve_username() { + local session="$1" + local normalized + normalized="$(printf '%s' "$session" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g')" + local candidate="mcc_${normalized}" + if (( ${#candidate} <= 16 )); then + printf '%s\n' "$candidate" + return 0 + fi + + local hash + hash="$(_mcc_sha1_short "$normalized")" + printf '%s_%s\n' "${candidate:0:11}" "$hash" +} + +_mcc_session_root() { + printf '%s/mcc-debug/%s\n' "${TMPDIR:-/tmp}" "$1" +} + +_mcc_session_log_file() { + printf '%s/mcc-debug.log\n' "$(_mcc_session_root "$1")" +} + +_mcc_session_input_file() { + printf '%s/mcc_input.txt\n' "$(_mcc_session_root "$1")" +} + +_mcc_session_pid_file() { + printf '%s/mcc.pid\n' "$(_mcc_session_root "$1")" +} + +_mcc_session_meta_file() { + printf '%s/session.meta\n' "$(_mcc_session_root "$1")" +} + +_mcc_tmux_session_name() { + printf 'mcc-%s\n' "$1" +} + +_mcc_build_root() { + local worktree + worktree="$(_mcc_current_worktree_name)" + if [[ "${MCC_BUILD_MODE:-local}" == "tmpfs" ]]; then + if [[ -d /dev/shm && -w /dev/shm ]]; then + printf '/dev/shm/mcc-build/%s\n' "$worktree" + else + printf '%s/mcc-build/%s\n' "${TMPDIR:-/tmp}" "$worktree" + fi + return 0 + fi + + printf '%s\n' "$MCC_REPO_ROOT" +} +``` + +- [ ] **Step 4: 再跑 smoke test，确认规则都落地** + +Run: `bash tools/test-mcc-env.sh` + +Expected: PASS + +- [ ] **Step 5: 提交这一小步** + +```bash +git add tools/mcc-env.sh tools/test-mcc-env.sh +git commit -m "tools: add MCC session and build root helpers" +``` + +### Task 2: 让 `mcc-*` shell helper 全部按 `session` 工作，并新增安全的 session reset + +**Files:** +- Modify: `tools/mcc-env.sh` +- Test: `tools/test-mcc-env.sh` + +- [ ] **Step 1: 在 smoke test 里加入 `mcc-cmd` 和 `mcc-reset-session` 的行为检查** + +```bash +session="wrapper-smoke" +input_file="$(_mcc_session_input_file "$session")" +rm -rf "$(_mcc_session_root "$session")" + +mcc-cmd --session "$session" "debug state" +grep -Fq "debug state" "$input_file" + +mcc-reset-session --session "$session" +[[ ! -e "$(_mcc_session_root "$session")" ]] +``` + +- [ ] **Step 2: 运行测试，确认它先因为参数解析或命令不存在而失败** + +Run: `bash tools/test-mcc-env.sh` + +Expected: FAIL，错误类似 `mcc-reset-session: command not found` 或 `Unknown option: --session` + +- [ ] **Step 3: 在 `tools/mcc-env.sh` 里把 `mcc-*` helper 改成 session-aware** + +```bash +mcc-build() { + local repo_root + repo_root="$(_mcc_repo_root)" + if [[ "${MCC_BUILD_MODE:-local}" == "tmpfs" ]]; then + local build_root + build_root="$(_mcc_build_root)" + mkdir -p "$build_root" + MCC_BUILD_ROOT="$build_root" dotnet build "$repo_root/MinecraftClient.sln" -c Release + else + dotnet build "$repo_root/MinecraftClient.sln" -c Release + fi +} + +mcc-cmd() { + local session="" + local command="" + while [[ $# -gt 0 ]]; do + case "$1" in + --session) session="$2"; shift 2 ;; + *) command="$1"; shift ;; + esac + done + + [[ -n "$command" ]] || { echo "Usage: mcc-cmd [--session NAME] " >&2; return 1; } + session="$(_mcc_resolve_session "$session")" + local input_file + input_file="$(_mcc_session_input_file "$session")" + mkdir -p "$(dirname "$input_file")" + printf '%s\n' "$command" >> "$input_file" +} + +mcc-log-mcc() { + local session="${1:-}" + if [[ "$session" == "--session" ]]; then + session="${2:-}" + fi + session="$(_mcc_resolve_session "$session")" + tail -f "$(_mcc_session_log_file "$session")" +} + +mcc-state() { + local session="" + while [[ $# -gt 0 ]]; do + case "$1" in + --session) session="$2"; shift 2 ;; + *) echo "Unknown option: $1" >&2; return 1 ;; + esac + done + + session="$(_mcc_resolve_session "$session")" + mcc-cmd --session "$session" "debug state" + sleep 1 + tail -30 "$(_mcc_session_log_file "$session")" +} + +mcc-reset-session() { + local session="" + while [[ $# -gt 0 ]]; do + case "$1" in + --session) session="$2"; shift 2 ;; + *) echo "Unknown option: $1" >&2; return 1 ;; + esac + done + + session="$(_mcc_resolve_session "$session")" + tmux kill-session -t "$(_mcc_tmux_session_name "$session")" 2>/dev/null || true + rm -rf "$(_mcc_session_root "$session")" +} +``` + +- [ ] **Step 4: 运行 smoke test，确认 session input 与 reset 生效** + +Run: `bash tools/test-mcc-env.sh` + +Expected: PASS + +- [ ] **Step 5: 提交这一小步** + +```bash +git add tools/mcc-env.sh tools/test-mcc-env.sh +git commit -m "tools: scope MCC shell helpers by session" +``` + +### Task 3: 改造 `mcc-debug.sh`、`mcc-log-tail.sh` 和 kill 流程，隔离 tmux、log、config、PID、metadata + +**Files:** +- Modify: `tools/mcc-debug.sh` +- Modify: `tools/mcc-log-tail.sh` +- Modify: `tools/mcc-env.sh` + +- [ ] **Step 1: 用真实命令先验证当前行为会互相覆盖** + +Run: + +```bash +source tools/mcc-env.sh +mcc-debug -v 1.21.11 --file-input --no-build +ls -la /tmp/mcc-debug +tmux list-sessions | grep '^mcc-debug:' +``` + +Expected: 看到固定目录 `/tmp/mcc-debug` 和固定 tmux 名 `mcc-debug` + +- [ ] **Step 2: 在 `tools/mcc-debug.sh` 中加入 `--session` 和 `--username`，并把所有运行时工件改成 session-scoped** + +```bash +SESSION="" +USERNAME="" + +while [[ $# -gt 0 ]]; do + case "$1" in + --session) SESSION="$2"; shift 2 ;; + --username) USERNAME="$2"; shift 2 ;; + -v|--version) VERSION="$2"; shift 2 ;; + -m|--mode) MODE="$2"; shift 2 ;; + -p|--port) PORT="$2"; PORT_SET_BY_USER=true; shift 2 ;; + --no-build) DO_BUILD=false; shift ;; + --debug-on) DEBUG_ON=true; shift ;; + --file-input) FILE_INPUT=true; shift ;; + -h|--help) usage; exit 0 ;; + *) echo "Unknown option: $1" >&2; usage >&2; exit 1 ;; + esac +done + +SESSION="$(_mcc_resolve_session "$SESSION")" +USERNAME="${USERNAME:-$(_mcc_resolve_username "$SESSION")}" +SESSION_ROOT="$(_mcc_session_root "$SESSION")" +CFG="$SESSION_ROOT/MinecraftClient.debug.ini" +MCC_LOG="$(_mcc_session_log_file "$SESSION")" +INPUT_FILE="$(_mcc_session_input_file "$SESSION")" +PID_FILE="$(_mcc_session_pid_file "$SESSION")" +META_FILE="$(_mcc_session_meta_file "$SESSION")" +MCC_TMUX_SESSION="$(_mcc_tmux_session_name "$SESSION")" + +mkdir -p "$SESSION_ROOT" + +cat > "$META_FILE" <&2; return 1 ;; + esac + done + + session="$(_mcc_resolve_session "$session")" + local pid_file meta_file tmux_name + pid_file="$(_mcc_session_pid_file "$session")" + meta_file="$(_mcc_session_meta_file "$session")" + tmux_name="$(_mcc_tmux_session_name "$session")" + + if [[ -f "$pid_file" ]]; then + pid="$(cat "$pid_file")" + if kill -0 "$pid" 2>/dev/null; then + kill "$pid" + wait "$pid" 2>/dev/null || true + fi + rm -f "$pid_file" + fi + + tmux kill-session -t "$tmux_name" 2>/dev/null || true + [[ -f "$meta_file" ]] && rm -f "$meta_file" +} +``` + +- [ ] **Step 4: 让 `tools/mcc-log-tail.sh` 支持 `--session`，读取 session-specific log** + +```bash +SESSION="" + +while [[ $# -gt 0 ]]; do + case "$1" in + --session) SESSION="$2"; shift 2 ;; + --server) SERVER_VER="$2"; shift 2 ;; + --server-only) SERVER_ONLY=true; SERVER_VER="$2"; shift 2 ;; + -h|--help) echo "Usage: tools/mcc-log-tail.sh [--session NAME] [--server VER] [--server-only VER]"; exit 0 ;; + *) echo "Unknown option: $1"; exit 1 ;; + esac +done + +SESSION="$(_mcc_resolve_session "$SESSION")" +MCC_LOG="$(_mcc_session_log_file "$SESSION")" +``` + +- [ ] **Step 5: 用两个显式 session 跑一次真实 smoke** + +Run: + +```bash +source tools/mcc-env.sh +mcc-debug -v 1.21.11 --session smoke-a --username SmokeA --file-input --no-build +mcc-debug -v 1.21.11 --session smoke-b --username SmokeB --file-input --no-build +test -f "$(_mcc_session_log_file smoke-a)" +test -f "$(_mcc_session_log_file smoke-b)" +test -f "$(_mcc_session_meta_file smoke-a)" +test -f "$(_mcc_session_meta_file smoke-b)" +tmux list-sessions | grep '^mcc-smoke-a:' +tmux list-sessions | grep '^mcc-smoke-b:' +``` + +Expected: 两套独立文件与两套 tmux 会话都存在 + +- [ ] **Step 6: 提交这一小步** + +```bash +git add tools/mcc-debug.sh tools/mcc-log-tail.sh tools/mcc-env.sh +git commit -m "tools: isolate MCC debug state by session" +``` + +### Task 4: 加入按 worktree 选择性启用的 tmpfs 构建根，并修正外置 `obj` 的 MSBuild 过滤问题 + +**Files:** +- Create: `Directory.Build.props` +- Modify: `tools/mcc-env.sh` +- Test: `tools/test-mcc-env.sh` + +- [ ] **Step 1: 先用当前仓库验证“直接外置 obj 会失败”，把这个回归固定住** + +Run: + +```bash +rm -rf /tmp/mcc-plan-build-smoke +dotnet build MinecraftClient.sln -c Release -v minimal --nologo \ + -p:BaseOutputPath=/tmp/mcc-plan-build-smoke/bin/ \ + -p:BaseIntermediateOutputPath=/tmp/mcc-plan-build-smoke/obj/ \ + -p:MSBuildProjectExtensionsPath=/tmp/mcc-plan-build-smoke/obj/ +``` + +Expected: FAIL，包含重复 `AssemblyInfo` 或 `TargetFrameworkAttribute` 一类错误 + +- [ ] **Step 2: 新建 `Directory.Build.props`，统一把 `MCC_BUILD_ROOT` 接到每个项目自己的外置 `bin/obj`，并显式排除仓库内 `bin/obj`** + +```xml + + + $(DefaultItemExcludes);**/bin/**;**/obj/** + + + + $(MCC_BUILD_ROOT)/$(MSBuildProjectName)/bin/ + $(MCC_BUILD_ROOT)/$(MSBuildProjectName)/obj/ + $(BaseIntermediateOutputPath) + + +``` + +- [ ] **Step 3: 在 `tools/mcc-env.sh` 中把 `mcc-build`、`mcc-run`、`mcc-tui`、`mcc-debug` 的 `dotnet` 调用统一接入 `MCC_BUILD_MODE=tmpfs`** + +```bash +_mcc_dotnet_env() { + if [[ "${MCC_BUILD_MODE:-local}" == "tmpfs" ]]; then + local build_root + build_root="$(_mcc_build_root)" + mkdir -p "$build_root" + env MCC_BUILD_ROOT="$build_root" "$@" + return 0 + fi + + "$@" +} + +mcc-run() { + local session="" username="" port="25565" + while [[ $# -gt 0 ]]; do + case "$1" in + --session) session="$2"; shift 2 ;; + --username) username="$2"; shift 2 ;; + --port) port="$2"; shift 2 ;; + *) break ;; + esac + done + + session="$(_mcc_resolve_session "$session")" + username="${username:-$(_mcc_resolve_username "$session")}" + mkdir -p "$(_mcc_session_root "$session")" + _mcc_dotnet_env env \ + MCC_FILE_INPUT=1 \ + MCC_INPUT_FILE="$(_mcc_session_input_file "$session")" \ + dotnet run --project "$(_mcc_repo_root)/MinecraftClient" -c Release -- \ + "$(_mcc_session_root "$session")/MinecraftClient.debug.ini" \ + "$username" \ + - \ + "localhost:$port" +} + +mcc-tui() { + local session="" username="" port="25565" + while [[ $# -gt 0 ]]; do + case "$1" in + --session) session="$2"; shift 2 ;; + --username) username="$2"; shift 2 ;; + --port) port="$2"; shift 2 ;; + *) break ;; + esac + done + + session="$(_mcc_resolve_session "$session")" + username="${username:-$(_mcc_resolve_username "$session")}" + tmux new-session -d -s "$(_mcc_tmux_session_name "$session")" -x 160 -y 50 \ + "cd '$(_mcc_repo_root)' && MCC_BUILD_MODE='${MCC_BUILD_MODE:-local}' bash tools/mcc-debug.sh --session '$session' --username '$username' -p '$port' -m tui --no-build" +} + +mcc-build-clean() { + if [[ "${MCC_BUILD_MODE:-local}" == "tmpfs" ]]; then + rm -rf "$(_mcc_build_root)" + else + dotnet clean "$(_mcc_repo_root)/MinecraftClient.sln" -c Release + fi +} +``` + +- [ ] **Step 4: 扩展 smoke test，检查 `tmpfs` build root helper 和清理命令** + +```bash +MCC_BUILD_MODE=tmpfs +build_root="$(_mcc_build_root)" +mkdir -p "$build_root/probe" +mcc-build-clean +[[ ! -e "$build_root/probe" ]] +``` + +- [ ] **Step 5: 用 tmpfs 模式重新 build，确认能成功且产物出现在 worktree 专属构建根** + +Run: + +```bash +source tools/mcc-env.sh +export MCC_BUILD_MODE=tmpfs +mcc-build +find "$(_mcc_build_root)" -maxdepth 3 -type d | sed -n '1,20p' +``` + +Expected: `Build succeeded.`，并且构建目录位于 `/dev/shm/mcc-build//` 或 `/tmp/mcc-build//` + +- [ ] **Step 6: 提交这一小步** + +```bash +git add Directory.Build.props tools/mcc-env.sh tools/test-mcc-env.sh +git commit -m "build: add worktree-aware tmpfs build mode" +``` + +### Task 5: 更新 integration harness，并新增“单服务器双会话”自动化 smoke test + +**Files:** +- Create: `.skills/mcc-integration-testing/scripts/run_parallel_session_smoke_test.sh` +- Modify: `.skills/mcc-integration-testing/scripts/reset_shared_test_state.sh` +- Modify: `.skills/mcc-integration-testing/scripts/run_full_spectrum_test.sh` +- Modify: `tools/run-creative-e2e.sh` + +- [ ] **Step 1: 新增并行会话 smoke test 脚本，先把预期行为写下来** + +```bash +#!/usr/bin/env bash +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" +REPO_ROOT="$(cd "$SCRIPT_DIR/../../.." && pwd)" +source "$REPO_ROOT/tools/mcc-env.sh" +source "$SCRIPT_DIR/common.sh" + +VERSION="${1:-1.21.11}" +SESSION_A="parallel-a" +SESSION_B="parallel-b" +USER_A="ParallelA" +USER_B="ParallelB" + +bash "$SCRIPT_DIR/preflight_test_env.sh" "$VERSION" >/dev/null +bash "$SCRIPT_DIR/reset_shared_test_state.sh" "$VERSION" >/dev/null +mcc-reset-session --session "$SESSION_A" +mcc-reset-session --session "$SESSION_B" +mcc-build +mc-start "$VERSION" >/dev/null +wait_for_server_ready "$VERSION" + +mcc-debug -v "$VERSION" --session "$SESSION_A" --username "$USER_A" --file-input --no-build +mcc-debug -v "$VERSION" --session "$SESSION_B" --username "$USER_B" --file-input --no-build + +grep -Fq "Server was successfully joined" "$(_mcc_session_log_file "$SESSION_A")" +grep -Fq "Server was successfully joined" "$(_mcc_session_log_file "$SESSION_B")" +mcc-cmd --session "$SESSION_A" "debug state" +mcc-cmd --session "$SESSION_B" "debug state" + +mcc-kill --session "$SESSION_A" +tmux has-session -t "$(_mcc_tmux_session_name "$SESSION_B")" +mc-log "$VERSION" 50 | grep -Fq "$USER_B joined the game" +``` + +- [ ] **Step 2: 运行脚本，确认它先因为新参数或旧的共享路径逻辑而失败** + +Run: `bash .skills/mcc-integration-testing/scripts/run_parallel_session_smoke_test.sh 1.21.11` + +Expected: FAIL，错误类似 `Unknown option: --session`、固定 `mcc_input.txt` 被共用，或者只有一个客户端会话存活 + +- [ ] **Step 3: 把 `reset_shared_test_state.sh` 缩回“只管共享服务器”，不要再删除 repo 根下 `mcc_input.txt`** + +```bash +if [[ $# -eq 0 || "${1:-}" == "--all" ]]; then + while IFS= read -r session_name; do + [[ -z "$session_name" ]] && continue + kill_named_session "$session_name" + done < <(tmux list-sessions 2>/dev/null | awk -F: '/^mc-/{print $1}' || true) + + while IFS= read -r pipe_path; do + [[ -z "$pipe_path" ]] && continue + if [[ ! -p "$pipe_path" ]]; then + rm -f "$pipe_path" + fi + done < <(find "$MCC_SERVERS" -maxdepth 2 -name 'stdin.pipe' 2>/dev/null || true) +fi +``` + +- [ ] **Step 4: 更新现有 integration 脚本，让它们使用 session-specific input/log，而不是 repo 根下固定文件** + +```bash +SESSION="creative-e2e-${SERVER_DIR//\//_}" +USERNAME="$(_mcc_resolve_username "$SESSION")" +INPUT_FILE="$(_mcc_session_input_file "$SESSION")" +MCC_LOG="$(_mcc_session_log_file "$SESSION")" + +rm -rf "$(_mcc_session_root "$SESSION")" +mkdir -p "$(_mcc_session_root "$SESSION")" + +( + cd "$REPO_ROOT" + MCC_FILE_INPUT=1 dotnet run --project MinecraftClient -c Release --no-build -- \ + "$CFG" \ + "$USERNAME" \ + - \ + "localhost:$SERVER_PORT" \ + > "$MCC_LOG" 2>&1 +) & +``` + +- [ ] **Step 5: 重新运行并行 smoke test 与现有 creative/full-spectrum 回归** + +Run: + +```bash +bash .skills/mcc-integration-testing/scripts/run_parallel_session_smoke_test.sh 1.21.11 +bash tools/run-creative-e2e.sh 1.21.11 1.21.11 modern +bash .skills/mcc-integration-testing/scripts/run_full_spectrum_test.sh 1.21.11 +``` + +Expected: 三个脚本都 PASS；并行 smoke test 中一个 session 被 kill 后，另一个 session 和共享服务器继续存活 + +- [ ] **Step 6: 提交这一小步** + +```bash +git add .skills/mcc-integration-testing/scripts/reset_shared_test_state.sh \ + .skills/mcc-integration-testing/scripts/run_full_spectrum_test.sh \ + .skills/mcc-integration-testing/scripts/run_parallel_session_smoke_test.sh \ + tools/run-creative-e2e.sh +git commit -m "test: cover shared server with isolated MCC sessions" +``` + +### Task 6: 更新文档，并给出两个 worktree 并行调试的标准操作流程 + +**Files:** +- Modify: `tools/README.md` +- Modify: `docs/guide/ai-assisted-development.md` +- Modify: `.skills/mcc-dev-workflow/SKILL.md` + +- [ ] **Step 1: 在文档里先补“共享服务器，隔离 MCC 会话”的核心规则** + +```md +## Shared Server, Isolated MCC Sessions + +- `mc-*` commands operate on the shared local Minecraft server. +- `mcc-*` commands operate on one MCC client session. +- Default `session` = current worktree name. +- Default username is derived from `session`, so two worktrees can join the same server without kicking each other. +``` + +- [ ] **Step 2: 在 `mcc-dev-workflow` 文档和 skill 里补两个 worktree 的真实示例** + +````md +```bash +# worktree A +cd ~/Minecraft/Minecraft-Console-Client +source tools/mcc-env.sh +mc-start 1.21.11 +mcc-debug -v 1.21.11 --file-input + +# worktree B +cd ~/Minecraft/Minecraft-Console-Client-foo +source tools/mcc-env.sh +mcc-debug -v 1.21.11 --file-input + +# Each worktree gets: +# - its own session +# - its own username +# - its own log/input/config/tmux session +# - the same shared server +``` +```` + +- [ ] **Step 3: 在文档里加入 tmpfs 构建模式与清理命令** + +````md +### tmpfs build mode + +```bash +source tools/mcc-env.sh +export MCC_BUILD_MODE=tmpfs +mcc-build +mcc-build-clean +``` + +When `MCC_BUILD_MODE=tmpfs`, build outputs are redirected to `/dev/shm/mcc-build//` on Linux, or `${TMPDIR:-/tmp}/mcc-build//` if `/dev/shm` is unavailable. +```` + +- [ ] **Step 4: 跑最终验证矩阵并保存关键输出** + +Run: + +```bash +bash tools/test-mcc-env.sh +source tools/mcc-env.sh && unset MCC_BUILD_MODE && mcc-build +source tools/mcc-env.sh && export MCC_BUILD_MODE=tmpfs && mcc-build +bash .skills/mcc-integration-testing/scripts/run_parallel_session_smoke_test.sh 1.21.11 +``` + +Expected: + +```text +PASS +Build succeeded. +Build succeeded. +parallel session smoke: PASS +``` + +- [ ] **Step 5: 提交文档与最终验证结果** + +```bash +git add tools/README.md docs/guide/ai-assisted-development.md .skills/mcc-dev-workflow/SKILL.md +git commit -m "docs: document shared server and isolated MCC sessions" +``` + +### Self-Review Checklist + +- [ ] 计划里的 `session`、`username`、`MCC_BUILD_MODE`、`MCC_BUILD_ROOT` 命名在所有任务中一致 +- [ ] 没有任何步骤重新引入 repo 根下固定 `mcc_input.txt` +- [ ] 没有任何步骤重新使用 `pkill -f "MinecraftClient"` +- [ ] 并行 smoke test 明确验证“共享服务器 + 双会话 + 单边 kill 不影响另一边” +- [ ] tmpfs build 任务明确覆盖了当前已知的 `obj` 外置重复编译问题 diff --git a/tools/README.md b/tools/README.md index 7d33d2cf..5c9d29cd 100644 --- a/tools/README.md +++ b/tools/README.md @@ -4,6 +4,38 @@ Scripts for analyzing Minecraft version differences and generating MCC palette f Requires: Python 3.10+ +## Local debug helpers + +The `tools/` directory also contains the shell helpers used for day-to-day MCC debugging: + +```bash +source tools/mcc-env.sh +mc-start 1.21.11 +mcc-debug -v 1.21.11 --file-input +mcc-cmd "debug state" +``` + +### Shared server, isolated MCC sessions + +- `mc-*` commands operate on the shared local Minecraft server. +- `mcc-*` commands operate on one MCC client session. +- The default `session` is the current worktree name. +- The default username is derived from `session`, so two worktrees can join the same shared server without kicking each other. +- `MCC_SERVERS` remains the shared server-root override. + +Keep shared servers running by default. Do not stop or reset them unless the user explicitly asks for that, or you need to switch server versions. + +### tmpfs build mode + +```bash +source tools/mcc-env.sh +export MCC_BUILD_MODE=tmpfs +mcc-build +mcc-build-clean +``` + +When `MCC_BUILD_MODE=tmpfs`, build output goes to `/dev/shm/mcc-build//` on Linux, or `${TMPDIR:-/tmp}/mcc-build//` when `/dev/shm` is unavailable. + ## Data Sources Two types of data can be used as input: