Docs / Debug Environment

The GBDK.js web environment gives you access to a number of tools for viewing internal state and debugging your game.

Launch debug

Keyboard Controls

The controls are currently set up to mimic the default keyboard controls in KiGB though these will likely be configurable in a later version.

  • Arrow Keys - D-pad movement
  • Alt Key - A Button
  • Ctrl Key - B Button
  • Shift Key - Select Button
  • Enter Key - Start Button

Buffers

The screen buffer and window buffer panels allow you to see the entire state of the two 256x256 pixel buffers that can be scrolled by updating the values of SCX_REG, SCY_REG, WX_REG and WY_REG.

The screen buffer is used for your main game display and will wrap infinitely as you reposition it.

The window buffer does not wrap and appears above the screen buffer so can be used for displaying UI elements such as a health bar or score.

Tile and Sprite Memory

These panels allow you to see the loaded tiles in both the the tile (used for screen and window buffers) and sprite memory. This allows you to see if you’ve loaded too much or too little graphics data or if you’ve loaded the data into the wrong location.

Registers

A number of the GameBoy register values such as the screen and window positions are displayed in decimal and binary formats.

Logging to the Console

You can perform logging from your game directly to the Javascript console in your browser.

To send output to the console, add the following to your game’s code:

LOG("Hello World\n");

or to log a value using a C format string:

UBYTE i = 5;
LOG("i=%d\n", i);

Note that these commands both end with a \n newline character, without these the output won’t flush so nothing will appear in the console.

The logging function is a C macro that only compiles into the web build and is not present in the GameBoy ROM.

Next: API Reference