Skip to content

Commit 00d3ba4

Browse files
francoiosclaude
andcommitted
docs: update README for v2.21.1 — port affinity and heartbeat
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 3bf9053 commit 00d3ba4

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ This package runs a lightweight HTTP server inside the Unity Editor on `localhos
6060
**Infrastructure:**
6161

6262
- **Multi-Instance Support** — Multiple Unity Editor instances discovered automatically (including ParrelSync clones)
63+
- **Port Affinity** — Each editor remembers its last-used port via EditorPrefs and reclaims it on restart, minimizing port swaps across sessions
64+
- **Registry Heartbeat** — The plugin sends a heartbeat every 30 seconds to the shared instance registry (`lastSeen` timestamp), enabling the MCP server to distinguish between compiling editors (fresh entry) and crashed editors (stale entry >5 minutes)
6365
- **Multi-Agent Support** — Multiple AI agents can connect simultaneously with session tracking, action logging, and queued execution
6466
- **Play Mode Resilience** — MCP bridge survives domain reloads during Play Mode via SessionState persistence
6567
- **Dashboard** — Built-in Editor window (`Window > MCP Dashboard`) showing server status, category toggles, agent sessions, and update checker
@@ -167,6 +169,7 @@ AnkleBreaker Unity MCP is the most comprehensive MCP integration for Unity, purp
167169
| **MPPM Multiplayer** | ✅ Scenarios, start/stop ||||
168170
| **Visual Inspection** | ✅ Scene + Game view capture || ⚠️ Limited ||
169171
| **Play Mode Resilient** | ✅ Survives domain reload ||| N/A |
172+
| **Port Resilience** | ✅ Identity validation + crash detection ||| N/A |
170173
| **Project Context** | ✅ Custom docs for AI agents ||| ⚠️ Built-in only |
171174

172175
### Cost Comparison
@@ -208,12 +211,12 @@ If Unity MCP helps your workflow, consider supporting its development! Your supp
208211

209212
**Sponsor tiers include priority feature requests** — your ideas get bumped up the roadmap! Check out the tiers on [GitHub Sponsors](https://github.com/sponsors/AnkleBreaker-Studio) or [Patreon](https://www.patreon.com/AnkleBreakerStudio).
210213

211-
## What's New in v2.20.0
214+
## What's New in v2.21.1
212215

213-
- **MPPM Scenario Management**Full Multiplayer Play Mode support with 6 tools for managing virtual players, scenarios, and tags (requires Unity 6+)
214-
- **Response size validation**`SendJson()` now validates response sizes before transmission, preventing oversized payloads from crashing downstream MCP transports
215-
- **Terrain tools**Complete terrain toolkit with 25+ operations: heightmap manipulation, texture painting, tree/detail placement, hole punching, import/export, and multi-terrain grid support
216-
- **Graphics capture improvements**Scene and Game view captures return clean base64 data for reliable inline image display
216+
- **Port affinity**The plugin now remembers its last-used port via EditorPrefs and attempts to reclaim it on restart. This prevents port swaps when multiple Unity projects are open — each editor consistently uses the same port across restarts.
217+
- **Enriched ping response**The `/api/ping` endpoint now returns `projectPath` alongside the existing `projectName`, enabling the MCP server to validate instance identity by both name and path.
218+
- **Registry heartbeat**A new heartbeat mechanism updates the `lastSeen` timestamp in the shared instance registry every 30 seconds. This lets the MCP server distinguish between a compiling editor (fresh entry, temporarily unresponsive) and a crashed editor (stale entry, no heartbeat for >5 minutes).
219+
- **Crash resilience**Combined with the server-side staleness check, the heartbeat ensures that if Unity crashes mid-compile and `OnDisable` never fires, the stale registry entry is detected and cleared within 5 minutes, allowing proper re-discovery.
217220

218221
## License
219222

0 commit comments

Comments
 (0)