# Metroidvania Studio

**Category:** 💻 Developer Tools  
**Repository:** https://github.com/LBarimi/metroidvania-studio  
**Views:** 0  
**Installs:** 0  
**Upvotes:** 0  
**Directory Page:** https://allmcps.com/mcp/metroidvania-studio

## Description
Create and edit connected 2D maps with a local, workspace-scoped MCP server and Lua scripts.

## Claude Desktop Quick Installation
Heuristic fallback — verify the package name and runner against the repository README before running it. Uses `npx` (confidence: low):

```json
"mcpServers": {
  "metroidvania-studio": {
    "command": "npx",
    "args": ["-y","metroidvania-studio"]
  }
}
```

## Documentation & README

# <img src="https://raw.githubusercontent.com/LBarimi/metroidvania-studio/HEAD/metroidvania-studio/web/studio-icon.svg" width="36" height="36" alt=""> Metroidvania Studio

Metroidvania Studio is a free, open-source 2D level editor for metroidvania games. Build connected rooms, paint autotiled maps, and design minimaps with JSON export for multiple game engines. The room-based map editor runs locally in your browser or the Windows program.

[Website](https://lbarimi.github.io/metroidvania-studio/) · [Documentation](https://lbarimi.github.io/metroidvania-studio/guides.html) · [Downloads](https://github.com/LBarimi/metroidvania-studio/releases/latest)

**Automate your workflow:** [Lua scripts](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/docs/scripting/quick-start.md), a [headless CLI](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/docs/cli/quick-start.md), and a [local MCP server for AI agents](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/docs/mcp/setup.md).

## Add Rooms & Paint Tiles

![Add a second room, paint rock tiles, then pan back and connect the first room](https://raw.githubusercontent.com/LBarimi/metroidvania-studio/HEAD/media/readme/create-and-paint.gif)

## Configure Tile Palettes

![Import a grassland PNG into a color palette and update an existing room](https://raw.githubusercontent.com/LBarimi/metroidvania-studio/HEAD/media/readme/configure-tile-palettes.gif)

## Resize, Rotate & Connect Rooms

![Resize, rotate, and connect three ice cavern rooms](https://raw.githubusercontent.com/LBarimi/metroidvania-studio/HEAD/media/readme/resize-rotate-and-connect.gif)

## Design Your Minimap

![Explore a world of five terrain themes, double-click an ice cavern to edit it, then zoom out](https://raw.githubusercontent.com/LBarimi/metroidvania-studio/HEAD/media/readme/design-the-minimap.gif)

## Explore with Game Preview

![Drag the game camera inside a room, inspect the live view, and maximize or collapse Game Preview](https://raw.githubusercontent.com/LBarimi/metroidvania-studio/HEAD/media/readme/explore-game-preview.gif)

## Get Started

Runs locally on Windows, macOS, and Linux. No game engine installation is required.

Download a ready-to-run package from [GitHub Releases](https://github.com/LBarimi/metroidvania-studio/releases/latest), extract it, and open the launch file at the top level. The prebuilt web package requires **ASP.NET Core Runtime 10**.

To build from source, install:

| Requirement | Used for |
| --- | --- |
| **Node.js 24+** | Building the web UI and running build scripts |
| **.NET SDK 10** | Building the local server and command-line tools |
| **Git** | Validating source files during the build |

Then use the scripts for your platform:

| Platform | Build | Run |
| --- | --- | --- |
| Windows | `platform/win/web/build.bat` | `platform/win/web/run.bat` |
| macOS | `platform/mac/build.command` | `platform/mac/run.command` |
| Linux | `bash platform/linux/build.sh` | `bash platform/linux/run.sh` |

**Run** checks your local build against the current version and source files. It builds automatically when needed, then opens the studio in your browser. An up-to-date build starts immediately.

`Maps` and `Textures` are stored beside the launcher or at the source project root. Find them through **File → Storage folders**. Room JSON updates automatically in `Maps/AutoExport`; palette settings are managed in `.studio/catalog.json`. Keep `Maps`, `Textures` and `.studio` when updating the studio.

## Try the Sample World

A new workspace opens a six-room world with a looping route, a vertical shaft, a side chamber, slopes, background tiles, and object markers. You can also open it through **Help → Open sample world**.

Paint a room, **Ctrl-click** two rooms to move them together, or switch to the minimap and **double-click** a room to jump back into editing. See the [five-minute walkthrough](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/docs/sample-world.md) or [sample JSON](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/samples/maps/starter-world.map.json).

## Editing Basics

- **Paint:** left-drag inside the active room. The first click on another room selects it.
- **Erase:** right-drag inside the active room.
- **Pan and zoom:** middle-drag to pan, mouse wheel to zoom, **Ctrl + wheel** to change brush size. Right-drag on empty space also pans.
- **Arrange rooms:** right-click empty space to add a room, drag a room's title strip to move it, or drag its outer handles to resize. Rotation is available in the inspector.
- **Save and exchange maps:** use **File** for saving and JSON import/export. Use **Edit** for Undo/Redo. Set PPU and resolution in the top toolbar (defaults: **16** and **320×180**).

- **Preview:** choose **Game camera** and drag its white frame. **Game Preview** follows immediately; expand, maximize, or collapse it as needed.

See **Help → Shortcuts** for the full control list. The interface follows your browser language and can be changed from the language picker.

Open **Help → Documentation** for searchable guides and the API reference, including offline access.

## Engine Packages

| Engine | Package | Installation |
| --- | --- | --- |
| Unity | [.unitypackage](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/engine-packages/unity/metroidvania-studio.unitypackage) | [Guide](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/engine-packages/unity/INSTALL_EN.txt) |
| Godot | [Addon ZIP](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/engine-packages/godot/metroidvania-studio.zip) | [Guide](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/engine-packages/godot/INSTALL_EN.txt) |
| Unreal Engine 4 | [Plugin ZIP](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/engine-packages/ue4/metroidvania-studio.zip) | [Guide](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/engine-packages/ue4/INSTALL_EN.txt) |
| Unreal Engine 5 | [Plugin ZIP](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/engine-packages/ue5/metroidvania-studio.zip) | [Guide](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/engine-packages/ue5/INSTALL_EN.txt) |
| SDL3 | [C++ source ZIP](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/engine-packages/sdl/metroidvania-studio.zip) | [Guide](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/engine-packages/sdl/INSTALL_EN.txt) |

Each engine folder includes translated installation guides. Maps use a shared [JSON format](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/metroidvania-studio/contracts/FORMAT.md); engine packages handle importing and rendering, while gameplay stays in your game project.

## Scripts & Automation

Use **File → Scripts** to generate rooms or repeat editing tasks. Run the same operations headlessly through the **CLI**, or connect an **AI agent** through the local **MCP server**. Dry runs, atomic updates, and revision checks keep scripted edits reviewable.

Install the CLI and MCP tools with **Node.js 24+** and the **.NET 10 runtime**:

```sh
npm install --global metroidvania-studio
```

Using a program download? Run `metroidvania-studio-cli.cmd help` on Windows, or `bash metroidvania-studio-cli.sh help` on macOS/Linux. See [headless from a download](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/docs/cli/release-downloads.md).

Start with the [documentation](https://lbarimi.github.io/metroidvania-studio/), [API reference](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/docs/api/index.md), [Lua examples](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/docs/examples/connected-rooms.lua), or [MCP setup](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/docs/mcp/setup.md).

## License

Project-owned code and assets use the [MIT License](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/LICENSE).
See [Third-party notices](https://github.com/LBarimi/metroidvania-studio/blob/HEAD/THIRD-PARTY-NOTICES.md) for external components and their terms.