cartridge-sdk

Pre-release

This release is a pre-release and may not be stable for production use.

GameBoy Advance - SDK

A Software Development Kit for developers who want to build GameBoy Advance games.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Roadmap
Contributing
License
Contact
Acknowledgments

About The Project

This SDK aims to simplify GameBoy Advance homebrew development by allowing developers to write game logic in Python. It handles the underlying compilation, asset conversion, and bindings to interface efficiently with the GBA hardware.

Built With

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

You need Python 3.x installed on your system

Installation

Development mode (clone the repo, with local changes)

Clone the repo

git clone https://github.com/lukas-sgx/GBA-sdk.git
cd GBA-sdk

Install the SDK in development mode

pip install -e .

Release mode (stable version from PyPI)

pip install cartridge-sdk

Usage

Here is a quick example of how to dump header of ROM:

$ cartridge-sdk hdr dump bin/ExampleGBA.gba
bin/ExampleGBA.gba:
|-- entry
|   |-- valid: True
|   |-- raw: 0xea00002e
|   `-- opcode: b 0xc0
|-- nintendo logo:
|   |-- status: True
|   `-- debugging: True
|-- game title: EXAMPLEGBA
|-- game code:
|   |-- code: BXXE
|   |-- date: 2003.. (new)
|   `-- language: USA/English
|-- marker code:
|   |-- id: 01
|   `-- developer: Nintendo
|-- fixed value: valid (96h)
|-- unit code: 00h
|-- device type: 00h
|-- reserved: valid
|-- software_ver: 00h
`-- checksum:
    |-- valid: True
    |-- rom: e3
    `-- our: e3

For more advanced examples, please refer to the Documentation.

Roadmap

Automated header checker .gba ROM
Automated compilation to .gba ROM
Font asset pipeline (PNG to C file converter)
Core GBA bindings (Video, Audio, Inputs)
Asset pipeline (PNG to GBA sprite palette converter)

See the open issues for a full list of proposed features (and known issues), and CHANGELOG.md for release history.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

See CONTRIBUTING.md for setup instructions, commit conventions, and the PR process.

Top contributors:

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Lukas Soigneux - lukas.soigneux@epitech.eu

Acknowledgments

GBATEK - GameBoy Advance Technical Info
Ayyboy-Advance - Great emulator for testing

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cartridge_sdk-2.0.0a0.tar.gz (12.9 kB view details)

Uploaded Jul 25, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

cartridge_sdk-2.0.0a0-py3-none-any.whl (13.5 kB view details)

Uploaded Jul 25, 2026 Python 3

File details

Details for the file cartridge_sdk-2.0.0a0.tar.gz.

File metadata

Download URL: cartridge_sdk-2.0.0a0.tar.gz
Upload date: Jul 25, 2026
Size: 12.9 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for cartridge_sdk-2.0.0a0.tar.gz
Algorithm	Hash digest
SHA256	`96a6e6812cc0382ed04b094ac0faddd8794c632430c51dfb143786f6ac693d85`
MD5	`38690dbdc7e48b18d424628ff4d9b1b7`
BLAKE2b-256	`39197e3809b255b0d85701148b9365f26d9c28483b209a6fc483da072611401c`

See more details on using hashes here.

Provenance

The following attestation bundles were made for cartridge_sdk-2.0.0a0.tar.gz:

Publisher: release.yml on lukas-sgx/GBA-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: cartridge_sdk-2.0.0a0.tar.gz
- Subject digest: 96a6e6812cc0382ed04b094ac0faddd8794c632430c51dfb143786f6ac693d85
- Sigstore transparency entry: 2249147866
- Sigstore integration time: Jul 25, 2026
Source repository:
- Permalink: lukas-sgx/GBA-sdk@01551d2ddd9f06fb46b1e5b63b61d106829e027f
- Branch / Tag: refs/heads/main
- Owner: https://github.com/lukas-sgx
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@01551d2ddd9f06fb46b1e5b63b61d106829e027f
- Trigger Event: workflow_run