https://github.com/ajor/gameboy
Gameboy emulator targeting Linux, OSX, asm.js/Emscripten and Chrome Native Client (NaCl)
https://github.com/ajor/gameboy
emscripten emulation emulator gameboy gameboy-emulator nacl
Last synced: 6 months ago
JSON representation
Gameboy emulator targeting Linux, OSX, asm.js/Emscripten and Chrome Native Client (NaCl)
- Host: GitHub
- URL: https://github.com/ajor/gameboy
- Owner: ajor
- License: mit
- Created: 2015-11-08T23:04:27.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-09-16T13:05:22.000Z (about 8 years ago)
- Last Synced: 2025-03-20T21:18:44.517Z (7 months ago)
- Topics: emscripten, emulation, emulator, gameboy, gameboy-emulator, nacl
- Language: C++
- Homepage: http://ajor.co.uk/gameboy
- Size: 119 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gameboy Emulator
This repository contains a Gameboy emulator core with a choice of three frontends:
- [Native binary](#native-binary), only tested on Linux
- [asm.js](#asmjs), compiled using Emscripten
- [Google Chrome Native Client (NaCl)](#nacl) application
Online demos are available at http://ajor.co.uk/gameboy/
## Controls
The Gameboy's direction keys are mapped to the arrow keys.
Start button = enter
Select button = backspace
A button = z
B button = x
# Completeness / accuracy
Save files are compatible with other popular Gameboy emulators.
Audio support is not complete.
Memory bank controllers (MBCs) 1 and 3 are the only ones currently supported, although the vast majority of Gameboy games use one of these two (or no MBC at all). The Real Time Clock (RTC) used in MBC3 is not implemented, so games which use it to keep track of time while the Gameboy is powered off will not function correctly in some aspects.
Scanlines are rendered individually, with each scanline being rendered in one go at the end of the H-Blank period. This means games which modify the data to be drawn mid-scanline do not render correctly - e.g. Prehistorik Man title sequence.
## Blargg's tests
TODO results
# Native binary
## Building
### Requirements
- A C++14 compiler
- CMake 2.8.12+
- GLFW3
- GLEW
### Compilation
Compile using CMake (defaults to release configuration):
```
mkdir build
cd build
cmake ../
make
```
## Usage
./gb rom
# asm.js
## Building
### Requirements
- [Emscripten SDK](https://kripken.github.io/emscripten-site/)
- Node.js
- CMake 2.8.12+
### Compilation
Compile using CMake, substituting the path to the Emscripten.cmake toolchain file on your system:
```
mkdir build
cd build
cmake ../ -DCMAKE_TOOLCHAIN_FILE=/usr/lib/emscripten/cmake/Modules/Platform/Emscripten.cmake
make
```
## Usage
Place glfw/emscripten.html and the generated gb.js and gb.js.mem files in the same directory and open in a web browser.
# NaCl
## Building
### Requirements
- [Chrome Native Client SDK](https://developer.chrome.com/native-client)
- CMake 2.8.12+
### Compilation
Compile using CMake, replacing `[NaCl toolchain bin dir]` with the path to the PNaCl toolchain directory for your platform, e.g.: `~/nacl_sdk/pepper_46/toolchain/linux_pnacl/bin`
```
mkdir build
cd build
cmake ../ -DNACL_TOOLCHAIN_BIN=[NaCl toolchain bin dir] -DCMAKE_TOOLCHAIN_FILE=../nacl/NaCl.cmake
make
```
## Usage
Place the generated gb.pexe binary along with nacl/index.html and nacl/gameboy.nmf from this repository on a web server and open in Google Chrome.
It can be run from your own computer using Python's HTTP server module:
python2 -m SimpleHTTPServer
or:
python3 -m http.server