scmJS documentation

A StarCraft: Brood War map editor that runs in a browser tab — it opens real .scm and .scx files, draws terrain from the game's own tileset graphics, and writes playable archives back.

These pages are the repository's own guides, and a reference generated from the plugin API's declarations. The editor itself is at editor.scmjs.dev.

• User guideWhat each layer does, how the editor is used, and the table of what is and is not implemented.
• PluginsWriting one, the shape of the API, and a tour of the plugins the editor ships with.
• Map filesThe MPQ container, the CHK sections, and how much of a file the editor preserves.
• Game dataWhere the graphics come from, how they are extracted, and what the editor does without them.
• DevelopmentBuilding the editor and the desktop app, the release channels, and the repository layout.
• API referenceEvery call a plugin can make, group by group — plugin API version 1.

Where to start

• New to the editor: Getting started, then Working in the editor.
• Wondering whether it does the thing you need: What works, and what does not.
• Writing a plugin: Writing a plugin, then the API reference.
• Working on the editor itself: Development and Map files.