Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nnarain/gameboycore
Gameboy Emulator Library
https://github.com/nnarain/gameboycore
emulation emulator gameboy gameboy-emulator gameboy-emulator-library
Last synced: about 10 hours ago
JSON representation
Gameboy Emulator Library
- Host: GitHub
- URL: https://github.com/nnarain/gameboycore
- Owner: nnarain
- License: mit
- Created: 2014-08-09T00:09:53.000Z (about 10 years ago)
- Default Branch: develop
- Last Pushed: 2020-12-10T04:17:19.000Z (almost 4 years ago)
- Last Synced: 2024-08-02T15:23:32.338Z (3 months ago)
- Topics: emulation, emulator, gameboy, gameboy-emulator, gameboy-emulator-library
- Language: C++
- Homepage:
- Size: 11.4 MB
- Stars: 69
- Watchers: 3
- Forks: 7
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# GameboyCore
[](https://codecov.io/gh/nnarain/gameboycore)
[](https://github.com/nnarain/gameboycore/releases)
[](https://nnarain.github.io/gameboycore)
GameboyCore is a Gameboy/Gameboy Color emulator library written in C++.
GameboyCore is a dependency free C++11 library. It does not open a window to render frames, it does not collect user input or play audio. GameboyCore emulates the Gameboy system and provides the audio/video output through the GameboyCore API.
This means the emulation logic and GUI logic of an emulator are separate. As long as the target platform has a C++11 compiler that platform can run GameboyCore.
GameboyCore running as:
* [A desktop application](https://github.com/nnarain/dotrix)
* [A libretro core in RetroArch](https://github.com/nnarain/gameboycore-retro)
* [Python bindings, usable with pygame](https://github.com/nnarain/gameboycore-python)
* [An Android App](https://github.com/nnarain/dotrix-android)
* [In the Web](https://github.com/nnarain/gameboycore-web/tree/master)
The above application are somewhat incomplete however they all demonstrate GameboyCore working for the given environment.
Building
--------
The `GameboyCore` library does not have any dependencies and can be compiled using any C++11 compiler. The tools contained in this repo, however, do have additional dependencies that need to be installed. All dependencies should be findable by CMake.
Fetch source:
```bash
git clone https://github.com/nnarain/gameboycore
cd gameboycore
git submodule update --init --recursive
```
To build the library, simply run `cmake`.
```bash
mkdir build && cd build
cmake ..
cmake --build . --target gameboycore
```
**Building Tests**
Install `gtest` and build with `BUILD_TESTS=ON`. Optionally you can setup benchmarks by installing `google-benchmark`.
```bash
cmake .. -DBUILD_TESTS=ON
cmake --build . --target check
cmake --build . --target bench
```
A few test ROMs can be run as well.
```bash
cmake --build . --target run_test_roms
```
**Building Tools**
Enable building tools by specifying `BUILD_TOOLS=ON`. If building tools is enabled, all will be built by default. Disable building tools with `WITH_=OFF`.
All tools are compiled with the latest C++ standard.
Debugger:
* Used for running Gameboy ROMs and inspecting the core
* Depends on SFML
RomInfo
* Used for printing the information in the ROM header