🚇/Docs

Getting Started

Learn how to create your first mod for Subway Builder

This section will guide you through creating your first mod for Subway Builder. We'll start with quick browser testing, then move to creating a proper mod that can be shared and installed.

Prerequisites#

  • Subway Builder (desktop version for full modding support)
  • Basic JavaScript knowledge
  • A text editor

Mods Folder Location#

The `mods/` folder is located in the same directory as your `saves/` folder in your app data directory:

Full paths by platform:

  • macOS: ~/Library/Application Support/metro-maker4/mods/
  • Windows: %APPDATA%\metro-maker4\mods\
  • Linux: ~/.config/metro-maker4/mods/

Directory structure:

metro-maker4/
├── saves/              ← Your save files are here
├── mods/               ← Put your mods here (create if missing)
│   ├── my-mod/
│   │   ├── manifest.json
│   │   └── index.js
│   └── another-mod/
│       ├── manifest.json
│       └── index.js
└── settings.json

How to find it:

  1. Open Subway Builder
  2. Go to Settings > System
  3. Click "Open Saves Folder"
  4. Navigate up one level - you'll see the metro-maker4/ folder
  5. Create a mods/ folder if it doesn't exist

Next Steps#

  1. Quick Start - Test mods in the browser console
  2. First Mod - Create a proper mod with manifest
  3. Electron Setup - Installing and managing mods