If you have any questions, or just want to chat, join us on Discord.

It is highly recommended to read the report to get a light introduction to Game Boy emulation. The report is relevant, eventhough you want to contribute to another emulator, or create your own.

If you've read the report and want more explicit details, have a look at the Pan Docs.

If you are looking to make a bot or AI, you can find all the external components in the PyBoy Documentation. There is also a short example or our Wiki page Scripts, AI and Bots. If more features are needed, or if you find a bug, don't hesitate to make an issue here on GitHub, or write on our Discord channel.

Installation

We have now moved away from PyPy, and PyBoy fully supports CPython ("regular Python"), by the use of Cython (Python-to-C compiler). Performance has also increased dramatically.

The code base is still pure Python, which means it will still run in CPython and PyPy (although slowly). Cython is an addition, where we can compile the code to run 100-200 times faster.

To get started, look at the installation instructions. We support: macOS, Raspberry Pi (Raspbian) and Linux (Ubuntu).

At the Wiki page, you will also find out how to interface with PyBoy from your own project: Wiki.

Contributors

Thanks to all the people, who have contributed to the project!

Original Developers

• Asger Anders Lund Hansen - AsgerLundHansen
• Mads Ynddal - baekalfen
• Troels Ynddal - troelsy

GitHub Collaborators

• Kristian Sims - krs013

Student Projects

• Rewind Time: Jonas Flach-Jensen - thejomas
• Link Cable: Jacob Olsen - JacobO1

Contribute

Any contribution is appreciated. The currently known errors are registered in the Issues tab. Feel free to take a swing at any one of them.

For the more major features, there are the following that you can give a try. They are also described in more detail in the project list:

• Sound
• Color
• Link Cable
• (Experimental) AI - use the botsupport to train a neural network
• (Experimental) Bot Support - make wrappers for popular games

If you want to implement something which is not on the list, feel free to do so anyway. If you want to merge it into our repo, then just send a pull request and we will have a look at it.

License

Creative Commons BY-NC-SA 4.0 http://creativecommons.org/licenses/by-nc-sa/4.0/