pyboy-advance 1.0.0

Game Boy Advance emulator written in Python

---

PyBoy Advance is a Game Boy Advance emulator written in Python, with Cython declarations for compiling to C.

[!WARNING] This is experimental software and under development. Some GBA hardware features are not yet implemented and many games do not function properly.

Getting started

Install PyBoy Advance with pip:

$ pip install pyboy-advance

You will need to provide a Game Boy Advance BIOS. Normatt's open source BIOS is supported and available here.

Launch PyBoy Advance from the terminal:

$ pyboy_advance --bios /path/to/bios.bin game_rom.gba

Or import and use it in your Python scripts:

from pyboy_advance import PyBoyAdvance

emulator = PyBoyAdvance(rom="game_rom.gba", bios="/path/to/bios.bin")
emulator.run()

Performance

PyBoy Advance is written in "pure" Python and can technically be run with PyPy or even CPython (though games will be virtually unplayable with the latter). To achieve practical performance, we use Cython to statically type our Python code and generate efficient C code from it. This allows us to build PyBoy Advance as a Python C extension module, significantly improving execution speed.

Screenshots

Acknowledgements

• Cython compiler for Python. Thanks to the development team and contributors!
• GBATEK by Martin Korth, the king of GBA hardware documentation
• ARM7TDMI Technical Reference Manual
• CowBite Virtual Hardware Specifications by Tom Happ
• Tonc by Jasper Vijn
• Excellent reference GBA emulators:
  • mGBA by Vicki Pfau (endrift)
  • NanoBoyAdvance by Fleroviux
  • Hades by Arignir
  • RustBoyAdvance-NG by Michel Heily
• GBA Tests by Julian Smolka
• PyBoy by Mads Ynddal (Baekalfen), the original inspiration for this project!