Super Game Boy

Technical overview. The Super Game Boy is a Game Boy cartridge for the SNES. Games that support it send commands through the joypad port to request a screen border, custom palettes, and multiplayer joypads. The commands transfer border tiles, tile map, and palette data as pixels drawn on the LCD, which the emulator captures a few frames later.

Using the API. The SGB object reports whether the loaded cartridge supports Super Game Boy features and whether they are enabled. Pass sgb_border=True to the PyBoy constructor to enable SGB processing and border rendering in the SDL2 and GLFW windows.

SGB API module for PyBoy.

This module provides access to Super Game Boy features and border functionality.

class pyboy.api.sgb.SGB(mb)

Bases: object

API for accessing Super Game Boy features.

This class provides access to SGB functionality including: - SGB detection status - Border control - Multiplayer joypad support - SGB command processing

property enabled

Returns True if SGB features are enabled for the loaded cartridge.

property detected

Returns True if SGB hardware has been detected.

property border_enabled

Returns True if an SGB border is currently active.

property border_data

Returns the current border data as a tuple of (tiles, map, palettes).

get_border_buffer()

Get the current SGB border frame buffer.

Returns:

The border buffer in RGBA format (256x224)

Return type:

array

get_composited_frame()

Get the composited frame with SGB border and Game Boy screen.

Returns:

The composited frame buffer in RGBA format (256x224)

Return type:

array