Module pyboy.api

Tools to help interfacing with the Game Boy hardware

Expand source code
#
# License: See LICENSE.md file
# GitHub: https://github.com/Baekalfen/PyBoy
#
"""
Tools to help interfacing with the Game Boy hardware
"""

from . import constants
from .screen import Screen
from .sprite import Sprite
from .tile import Tile
from .tilemap import TileMap

# __pdoc__ = {
#     "constants": False,
#     "manager": False,
# }
# __all__ = ["API"]

Sub-modules

pyboy.api.constants

Memory constants used internally to calculate tile and tile map addresses.

pyboy.api.memory_scanner
pyboy.api.screen

This class gives access to the frame buffer and other screen parameters of PyBoy.

pyboy.api.sprite

This class presents an interface to the sprites held in the OAM data on the Game Boy.

pyboy.api.tile

The Game Boy uses tiles as the building block for all graphics on the screen. This base-class is used both for Sprite and …

pyboy.api.tilemap

The Game Boy has two tile maps, which defines what is rendered on the screen.