Skip to content

About

MCP server for efficient StarCraft II Editor automation and verified Galaxy/GUI metadata

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

37 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SC2EditorToolkit

Verified scope: supported MCP authoring workflows and original Editor checks on recorded fixtures. The optional Toolkit integration is pinned to 1.1.0-rc.1/protocol16. Native compilation, Data, save/reopen and original Editor rendering evidence remains versioned by the actual tested runtime. Compilation, save/reopen and exact saved-artifact gameplay have their own dated acceptance records; the complete quality roadmap remains open. See the acceptance matrix and reproducible checks for evidence and the features still awaiting engine/gameplay validation.

The public project name is SC2EditorToolkit. The existing repository URL, sc2editor-mcp protocol identifier, environment variables and tool names remain compatible; the historical source and license attribution are retained.

Current agent workflow: Authoring protocol, compact commands, and trigger organization. Galaxy is the default logic language. Terrain profiles and reference palettes are available through terrain.catalog, terrain.style, and terrain.compose. Maintained documentation is English.

For grouped balance edits, bounded asset inspection and verified preparation reuse, see authoring performance.

The source includes the authoring reference catalog, measured decor workflow, portable agent rules and three scoped project skills. These are runtime and authoring inputs, not optional local reports. Verify them with npm run catalog:verify and npm run docs:check-language.

Native Editor checks use the optional pinned Toolkit 1.1.0-rc.1 backend; map.preview remains the fast ModKit preview. Native compilation, save/reopen, rendered appearance and gameplay have distinct verification scopes.

Private game tests can use a separately installed SC2GameToolkit through game.status/tools/attach/call/detach. The integration does not bundle its private sources or instrument delivered maps. Game launch requires explicit local configuration; the existing Editor adapter is independent.

Original code: Copyright (c) 2026 VoVanRusLvSC2 ([email protected]), under the custom attribution license. Projects using our code or modules must credit VoVanRusLvSC2 and identify SC2Editor-MCP-Codex as their source in README, Credits or About, in addition to retaining copyright and license notices. Surface Toolkit author: vise (attribution provided by the project owner). Third-party components keep their own licenses; see credits, license scope and the source publication checklist.

A single MCP server and local workbench for StarCraft II map/mod files. TypeScript/Node.js implements semantic tools and shared transactions; the C++ backend in native/ handles MPQ archives.

Legacy guide · TERRAIN module · Repository structure

Installed SC2 resources can now be read directly through casc.*, with a verified build-specific cache and explicit Data/Browse mounts. CASC guide · Current capabilities and gaps.

Renderer v61: original DDS 2D/cube mip chains, native material UV/detail-normal and reflection LOD handling, and scoped static sampler bias. Blue Director UI and the authored-property inspector are retained. Changes; historical v42 status. SC2 engine parity remains unvalidated; native shadow passes and complete postprocessing remain unfinished.

MCP frame capture: cutscene.render WebGL2 frame capture for MCP, using installed Edge/Chrome and the same player as interactive preview. Protocol/controller tests pass; actual browser capture of this version is not yet verified. Rebuild and reconnect MCP to load the new tool.

Settings: map attributes, variants, players and game options. Portable packages include SC2-MCP.cmd; MCP setup.

Modules

The optional Live Editor module defaults to the current open document: bounded existing Unit numeric edits and native same-file Save, without exporting or reopening a map copy. Saved-checkpoint collaboration is an explicitly selected alternative. Direct in-memory Terrain, placement and trigger edits remain unimplemented. Select SC2_MCP_PROFILE=live for focused tools.

Module Scope Documentation
Live Current-document Unit scalar edits, native same-file Save and explicit checkpoint workflows Live Editor
UI Layout frames, properties, anchors, states, animations UI guide
Text Localization, Font Styles and rich text Text
Cutscene Scenes, cameras, shots and animation tracks Cutscene
Data Native Catalog XML, references and batch edits Data
AI CustomAI metadata and bounded authoring AI
Browse / Placement Available assets, dependencies, Unit/Doodad/ObjectPoint plans Browse / Placement
Terrain Height, textures, recipes, flat water, lighting and component inspection TERRAIN, API
CASC Installed-game MNDX/BLTE reads, search, byte/semantic cache and metadata mounts CASC
Settings Map attributes, native game variants, v39 players and game options Settings
Document Fresh empty dependent/extension mods and Arcade map foundations Document
Map MPQ import/export, MapInfo and template-based creation Map
Script Galaxy and bounded GUI trigger authoring Script, Trigger

The supplied Surface Toolkit is integrated into Terrain through ten terrain.surface.* tools. They expose component inventories, bounded raw samples, structural validation, preview-only byte edits and authored terrain catalog inspection. They share the existing workspace and observe staged drafts. Native cliff/ramp rebuild, full pathing semantics, complex water-body editing and engine validation remain unavailable.

Terrain authoring also exposes terrain.paint, terrain.blend, terrain.hide, terrain.show and visibility inspection. Ground hiding/restoration was visually confirmed by the user on the supplied p.SC2Map; pathing regeneration remains unavailable.

Run

Requires Node.js 20+. In PowerShell:

npm ci
npm run build
$env:SC2_UI_ROOT = "K:\Maps\MyMap.SC2Map"
$env:SC2_MCP_PROFILE = "terrain"
node dist/index.js

Use an unpacked map/mod; use map.import for MPQ input. stdout is reserved for MCP traffic. Profiles include all (default), ui, cutscene, data, terrain, casc, settings, landscape, script, authoring and focused variants. SC2_MCP_MODULES overrides the profile. modkit.capabilities reports the actual selection.

Existing authoring tools prepare plans/drafts, validate them and save complete groups with stale guards and backups. The new terrain.surface.plan.cell is an in-memory diagnostic and cannot be passed to terrain.apply.

GUI: npm run gui, then http://127.0.0.1:4312. Workbench. Windows portable build: npm run windows:portable; EXE guide.

Development

npm test
npm run lint
npm run build:release
npm run terrain:schemas

Tests include source codec regressions and real SDK stdio checks for Terrain profile selection. Architecture, status, changelog.

About

MCP server for efficient StarCraft II Editor automation and verified Galaxy/GUI metadata

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages