bc-luke / gbdk-2020

An updated version of GBDK, A C compiler, assembler, linker and set of libraries for the Z80 like Nintendo Gameboy.

GBDK-2020

GBDK is a cross-platform development kit for sm83 and z80 based gaming consoles. It includes libraries, toolchain utilities and the SDCC C compiler suite.

Supported Consoles: (see docs)

• Nintendo Gameboy / Game Boy Color
• Analogue Pocket
• Sega Master System & Game Gear
• Mega Duck / Cougar Boy

Current Release

Upgrading to a new version? Check the Migration notes. You can find older versions here.

For a full list of changes see the ChangeLog file or online Docs.

Build status

Docs

GBDK includes extensive documentation. A good place to begin is the Getting Started Section.

Check the Links and Third-Party Tools Section for a list of recommended emulators, graphics tools, music drivers and more.

For SDCC you can check its website and the manual

Usage

Most users will only need to download and unzip the latest release

Then go to the examples folder and build them (with compile.bat on Windows or running make). They are a good starting point.

The sources in this repo are only needed if you want to re-compile GBDK-2020 yourself instead of using the release binaries linked above.

Discord servers

• gbdk/zgb Discord - For help with using GBDK (and ZGB), discussion and development of gbdk-2020

• gbdev Discord - There is a #gbdk channel and also people with a lot of Game Boy development knowledge

• SMS Power! Discord - Additional SMS & Game Gear discussion and resources.

Forums

• The Game Boy Development Forum - A good place to search for Game Boy related answers.
• SMS Power! Forum - Additional SMS & Game Gear discussion and resources.

Current status

• Updated CRT and library that suits better for game development
• SDCC Versions
  • Current GBDK-2020 versions require SDCC patches for z80 SMS/Game Gear support. So SDCC nightlies/snapshot builds cannot be used if you want to target SMS/Game Gear. Instead use the Patched SDCC Builds.
  • In addition, recent SDCC nightlies/snapshot builds have switched to a new calling convention which is not well tested with GBDK-2020 and there may be bugs. It's recommended to not use versions after build #12539 at this time.
• The compiler driver lcc supports the latest sdcc toolchain.

Origin

Over the years people have been complaining about all the GBDK issues caused by a very old version of SDCC (the compiler). This is a proper attempt of updating it while also keeping all the old functionallity working, like support for banked code and data and so on.

The last version in the OLD repo is 2.96 although releases are available until 2.95-3. Version 2.96 is the starting point of this repo.

Build instructions

Unless you are interested on recompiling the sources for some reason (like fixing some bugs) you don't need to build GBDK

• Windows only: Download and install mingw
• Clone, download this repo or just get the source form the releases
• Download and install the PATCHED sdcc builds from the separate repo for that (https://github.com/gbdk-2020/gbdk-2020-sdcc/releases/tag/sdcc-12539-patched).
• On Linux don't use package managers The latest release available won't work, you need to compile or download one of the nightlies
• Create SDCCDIR environment variable, that points into the folder, where you installed sdcc
• Open command prompt or a terminal, go to the root directory of the repo and run make