The Wayback Machine - https://web.archive.org/web/20191215060525/https://github.com/Baekalfen/PyBoy
Skip to content

/PyBoy

Game Boy emulator written in Python
gameboy emulator pypy python
Python TeX Makefile
  1. Python 96.2%
  2. TeX 3.4%
  3. Makefile 0.4%
Branch: master
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio

If nothing happens, download the GitHub extension for Visual Studio and try again.

@Baekalfen
Baekalfen Fixed GIF dimensions
Latest commit 2d9f701 Oct 27, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Projects Updated projects description Aug 24, 2019
README Refined testing and automatic GIF generation (#86) Oct 26, 2019
Source Refined testing and automatic GIF generation (#86) Oct 26, 2019
docs Refined testing and automatic GIF generation (#86) Oct 26, 2019
.flake8 Refined testing and automatic GIF generation (#86) Oct 26, 2019
.gitignore Cartridge cythonized Oct 13, 2019
.isort.cfg Fixed identifiers and added some error handling in save/load state Sep 4, 2019
.pre-commit-config.yaml Fixed identifiers and added some error handling in save/load state Sep 4, 2019
LICENSE Added License file Nov 8, 2016
PyBoy.pdf Added report Jan 25, 2016
README.md Fixed GIF dimensions Oct 27, 2019

README.md

PyBoy

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.

Contibutors

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

Original Developers

GitHub Contributors

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 six that you can give a try. They are also described in more detail in the project list:

  • Sound
  • Color
  • Link Cable
  • (Experimental) Time travel - rewind time in the emulator
  • (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/

You can’t perform that action at this time.