Subsystem

Read

Write

Notes

Workspace staging

✅

✅

Unpacked documents, plus packed documents when the MPQ helper is available

Component inventory

✅

✅

Resolve component files; add, update, or remove lossless ComponentList declarations; edit DocumentInfo and dependencies

GameData catalogs

✅

✅

Search, inspect, resolve inheritance, find references, patch/clone/create/delete. Local dependencies load read-only

MPQ archives (.SC2Map, .SC2Mod)

✅

✅

Byte-identical round trips on real ladder maps, and maps packed here open in the editor — see docs/native-helper.md

Galaxy scripts

✅

✅

Parse, symbols, syntax diagnostics, safe text patching. No type checking — needs the game's natives. Requires the vendored toolkit to be built

Triggers

✅

✅

Full local reference graph, names, search, rename, graph-safe clone, and shared-node-aware delete

Localization

✅

✅

Text tables, preserving BOM and CRLF exactly

SC2Layout

✅

✅

List, read, diagnose, search, create, and losslessly patch layout elements

Placed objects / regions

✅

✅

Both are XML, not binary. Place, move, delete — round-tripped through the editor. Terrain height is not consulted

Terrain

✅

✅

Typed height, texture, pathing, and cliff reads/writes, synchronized-file updates, validation, and bounded raw component access. See docs/terrain.md

Map player slots

✅

✅

Reads and rewrites version 39 MapInfo player entries; synchronizes Attributes lobby defaults

Editor/test launch

✅

✅

Opens documents in the Galaxy Editor; writes bounded Maps\Test staging; launches packed or workspace maps; reports editor/game logs

Tool

Read-only

Purpose

sc2_get_server_info

yes

Versions, configuration, capability matrix, limitations

sc2_detect_installations

yes

Find StarCraft II without scanning the disk

sc2_open_document

no

Stage a document, get a workspace_id

sc2_get_document_summary

yes

Kind, counts, components, dependencies, diagnostics, known gaps

sc2_list_workspaces

yes

Recover a workspace_id after a reconnect

sc2_list_components

yes

Parse ComponentList.SC2Components; resolve each entry to real files

sc2_add_component

no

Add a lossless component declaration, normally for files already in the workspace

sc2_update_component

no

Change a component type, logical path, or locale

sc2_remove_component

no

Remove a declaration while preserving its staged files

sc2_get_document_info

yes

Name, author, mod type, icon, screenshots, dependencies

sc2_get_dependencies

yes

Dependency chain in resolution order

sc2_list_component_types

yes

Reference table of component type codes

sc2_list_catalog_domains

yes

Catalog domains present, with entry counts

sc2_search_catalog

yes

Find catalog objects by id, filtered by domain

sc2_get_catalog_object

yes

One object's own declaration, plus verbatim XML

sc2_resolve_catalog_object

yes

Effective values with inheritance, and where each came from

sc2_find_catalog_references

yes

What refers to an object, and whether it is shared

sc2_patch_catalog_object

no

Field-level edits by path, with shared-object warnings

sc2_clone_catalog_object

no

Copy an object under a new id, byte-for-byte

sc2_create_catalog_object

no

Add a new object with a parent, root attributes, and child fields

sc2_delete_catalog_object

no

Remove an object; refuses while referenced

sc2_list_locales

yes

Locales and text tables present

sc2_search_text_keys

yes

Search a text table by key or value

sc2_get_text_value

yes

Read one localized string

sc2_set_text_value

no

Create or update localized strings

sc2_delete_text_key

no

Remove localized strings

sc2_copy_text_key

no

Copy strings between keys or locales

sc2_find_missing_localization

yes

Catalog objects with no display name

sc2_launch_editor

no

Open a document in the Galaxy Editor to confirm it loads

sc2_get_editor_logs

yes

List or read the editor's own logs

sc2_test_document

no

Stage and launch a map through the editor-compatible SC2Switcher workflow

sc2_get_last_test_log

yes

Running/exited status, game logs, and parsed Alerts and ScriptError diagnostics for the last test

sc2_get_user_maps

yes

The user's Maps folder, resolved through the registry

sc2_get_map_players

yes

Read version 39 MapInfo lobby/player entries

sc2_set_map_player_slots

no

Set an exact contiguous human slot range and synchronize Attributes defaults

sc2_list_galaxy_files

yes

Scripts in the document; flags the generated MapScript

sc2_get_galaxy_file

yes

Read a script, optionally by line range

sc2_get_galaxy_symbols

yes

Functions, variables, structs, includes

sc2_get_galaxy_diagnostics

yes

Syntax errors with line and column

sc2_apply_galaxy_patch

no

Exact-text edit, refused if it breaks the parse

sc2_create_galaxy_file

no

Add a library, syntax-checked first

sc2_set_galaxy_entrypoint

no

Generate a bounded MapScript.galaxy that includes one authored library and calls its initializer

sc2_list_layouts

yes

Layout files with frame and diagnostic counts

sc2_get_layout

yes

Exact layout source plus an element index

sc2_get_layout_diagnostics

yes

XML and structural layout diagnostics

sc2_search_layouts

yes

Find frame, template, and include declarations

sc2_create_layout

no

Create a valid SC2Layout file

sc2_apply_layout_patch

no

Targeted, lossless element or attribute edits

sc2_list_triggers

yes

The trigger tree with names resolved

sc2_get_trigger

yes

One element: type, name, contents, referrers, raw XML

sc2_search_triggers

yes

Find trigger elements by name

sc2_rename_trigger

no

Rename an element (edits TriggerStrings only)

sc2_clone_trigger

no

Clone an editor-authored subgraph and remap every local id

sc2_delete_trigger

no

Detach a branch; remove only nodes with no remaining incoming path

sc2_list_placed_objects

yes

Units, doodads, and points on the map

sc2_place_object

no

Place a unit, doodad, or point with the next free id

sc2_update_object

no

Move, rotate, or rescale a placed object

sc2_delete_object

no

Remove a placed object

sc2_list_regions

yes

Regions with their shapes

sc2_create_region

no

Add a region with the next free id

sc2_update_region

no

Move or rename a region

sc2_delete_region

no

Remove a region

sc2_add_dependency

no

Append a dependency; later entries win in load order

sc2_remove_dependency

no

Remove a dependency, matched by its file: half

sc2_set_document_info

no

Set a single-valued DocInfo field such as ModType

sc2_get_terrain_summary

yes

Decode the descriptor and validate all terrain components

sc2_get_terrain_vertex

yes

Read render and synchronized height at one vertex

sc2_set_terrain_height

no

Write render and synchronized height together

sc2_get_terrain_cell

yes

Read pathing, cliff, texture blend, and synchronized texture data

sc2_set_terrain_cell_flags

no

Set one pathing-flags byte

sc2_set_terrain_texture

no

Paint eight texture layers and update synchronized texture data

sc2_set_terrain_cliff

no

Set descriptor and synchronized cliff data together

sc2_get_terrain_component

yes

Read a bounded raw byte range as base64

sc2_patch_terrain_component

no

Apply a bounded raw patch and validate the component before writing

sc2_create_unit_from_template

no

Clone a unit with a name, stats, and its own weapon

sc2_set_unit_weapon_damage

no

Change one unit's damage without touching units that share it

sc2_isolate_shared_object

no

Give one owner its own copy of something shared

sc2_check_shared_object

yes

Would editing this reach beyond one owner?

sc2_validate_document

yes

Every check this build has, per category, with unchecked ones named

sc2_commit_document

no

Write the staged document out, with backup and preflight

sc2_diff_workspace

yes

Unified diff against the source, or against a snapshot

sc2_get_changes

yes

Change history, with the snapshot taken before each

sc2_revert_change

no

Undo the most recent change

sc2_create_snapshot

no

Pin a known-good state

sc2_list_snapshots

yes

Snapshots held for a workspace

sc2_restore_snapshot

no

Roll the staging tree back to a snapshot

sc2_list_files

yes

Paginated listing of the staged tree

sc2_read_file

yes

Read one staged file (text, or base64 for binary)

sc2_search_files

yes

Literal substring search across staged text files

sc2_discard_workspace

no

Delete the staging copy; source untouched