gb-studio

# GB Studio GB Studio is a quick and easy to use retro game creator for Game Boy, available for Mac, Linux, and Windows. It consists of an Electron-based game builder application and GBVM, a C-based game engine using GBDK. The project is released under the MIT license and is actively maintained with community support via Patreon, Twitter, Reddit, and Discord. ## Installation Download a release for your operating system from the GB Studio Downloads page. To run from source, clone the repo, install NodeJS (version specified in .nvmrc), then run: ```bash > cd gb-studio > corepack enable > yarn > npm run fetch-deps > npm start ``` After checking out a new version, fetch dependencies again to ensure you have the latest GBVM and GBDK. GB Studio currently uses Node 24 LTS; use NVM with the included .nvmrc to switch versions. ## GB Studio CLI Install from source, then build and link the CLI: ```bash > npm run make:cli > yarn link ``` From any folder, run `gb-studio-cli` with commands like: - **Export Project**: `gb-studio-cli export path/to/project.gbsproj out/` - **Export Data**: `gb-studio-cli export -d path/to/project.gbsproj out/` - **Make ROM**: `gb-studio-cli make:rom path/to/project.gbsproj out/game.gb` - **Make Pocket**: `gb-studio-cli make:pocket path/to/project.gbsproj out/game.pocket` - **Make Web**: `gb-studio-cli make:web path/to/project.gbsproj out/` - **Make ROM with Usage Report**: `gb-studio-cli make:rom path/to/project.gbsproj out/game.gb --usage` ## GBS Music A standalone web application of the music editor is available at https://music.gbstudio.dev/. To run locally, use `npm run start:music-web`, or build assets for self-hosting with `npm run build:music-web` (output to `out/music-web`). ## Documentation Full documentation is available at https://www.gbstudio.dev/docs. ## Note For Translators Contributions for new language localisations are welcome via pull requests to the JSON files in `src/lang`. A script lists missing keys from the English localisation and copies them to your localisation: ```bash npm run missing-translations lang # e.g. npm run missing-translations de # e.g. npm run missing-translations en-GB ```