chrismaltby /gb-studio

A quick and easy to use drag and drop retro game creator for your favourite handheld video game system

★ 9,461⑂ 583👁 124⑃ 904● 1,362▤ 33
TypeScriptMITCreated 2019-04-17www.gbstudio.dev
下载:v4.3.2v4.3.2 ↓4.3.22026-06-22
+3
日增长
9,461
stars
583
forks
124
watchers
904
prs
1,362
issues
33
releases

README

GB Studio

  

Copyright (c) 2019-2026 Chris Maltby, released under the MIT license.

Patreon: gbstudiodev  
Twitter: @maltby  
Reddit: /r/gbstudio  
Discord: Join Chat

GB Studio is a quick and easy to use retro game creator for Game Boy available for Mac, Linux and Windows.
For more information see the GB Studio site

!GB Studio

GB Studio consists of an Electron game builder application and GBVM, a C-based game engine using GBDK.

 Installation

Download a release for your operating system from the GB Studio Downloads page.

Or to run from source, clone this repo then:

- Install NodeJS (required version is given in .nvmrc)

bash
 cd gb-studio
 corepack enable
 yarn
 npm run fetch-deps
 npm start


After checking out a new version you may also need to fetch dependencies again to ensure you have the latest version of GBVM + GBDK etc.

bash
 cd gb-studio
 npm run fetch-deps


GB Studio currently uses Node 24 LTS. If you have NVM installed you can use the included .nvmrc to switch to the supported Node version.

bash
 cd gb-studio
 nvm use


 GB Studio CLI

Install GB Studio from source as above then

bash
 npm run make:cli
 yarn link
 From any folder you can now run gb-studio-cli
 $(yarn bin gb-studio-cli) -V
 $(yarn bin gb-studio-cli) --help


 Update the CLI

Pull the latest code and run make:cli again, yarn link is only needed for the first run.

bash
 npm run make:cli


 CLI Examples

- Export Project

  bash
   $(yarn bin gb-studio-cli) export path/to/project.gbsproj out/
  

  Export GBDK project from gbsproj to out directory

- Export Data

  bash
   $(yarn bin gb-studio-cli) export -d path/to/project.gbsproj out/
  
  Export only src/data and include/data from gbsproj to out directory

- Make ROM

  bash
   $(yarn bin gb-studio-cli) make:rom path/to/project.gbsproj out/game.gb
  

  Make a ROM file from gbsproj

- Make Pocket

  bash
   $(yarn bin gb-studio-cli) make:pocket path/to/project.gbsproj out/game.pocket
  

  Make a Pocket file from gbsproj

- Make Web
  bash
   $(yarn bin gb-studio-cli) make:web path/to/project.gbsproj out/
  
  Make a Web build from gbsproj

- Make ROM with Usage Report

  bash
   $(yarn bin gb-studio-cli) make:rom path/to/project.gbsproj out/game.gb --usage
  

  Make a ROM file from gbsproj and print a ROM usage report to stdout

 GBS Music

A standalone web application of the music editor is available at https://music.gbstudio.dev/

To run this application locally

bash
 npm run start:music-web


or to generate the assets for self hosting

bash
 npm run build:music-web


which will output build files to out/music-web.

 Documentation

GB Studio Documentation

 Note For Translators

If you'd like to help contribute new language localisations to GB Studio you can do so by submitting pull requests adding or updating the JSON files found here https://github.com/chrismaltby/gb-studio/tree/develop/src/lang

If you're looking to update an existing translation with content that is missing, there is a handy script 

Top issues

Latest release

v4.3.2 v4.3.2 2026-06-22
GB Studio is a quick and easy to use drag and drop retro game creator for your favourite handheld video game system.

 [4.3.2] - 2026-06-22

 Added

- Add ability to view the current background and overlay tilemap in the debugger @pau-tomas
- Add ability to "Eject Web Template" from the Settings section, allowing packages created with "Export Web" to be customised
- Add support for web template plugins

 Changed

- Updated Polish localisation. @ReptiIe
- Updated Japanese localisation. @tomo666

 Fixed

- Fix issue preventing build log from opening automatically on warnings
- 

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON