https://github.com/raulpy271/gameboy-emulator

🎮 A gameboy emulator written in C++
https://github.com/raulpy271/gameboy-emulator

cmake cpp emulator gameboy gameboy-development gameboy-emulator test-driven-development

Last synced: 4 months ago
JSON representation

🎮 A gameboy emulator written in C++

• Host: GitHub
• URL: https://github.com/raulpy271/gameboy-emulator
• Owner: raulpy271
• License: mit
• Created: 2022-01-22T17:09:34.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-15T20:27:24.000Z (over 2 years ago)
• Last Synced: 2023-03-10T10:26:33.266Z (over 2 years ago)
• Topics: cmake, cpp, emulator, gameboy, gameboy-development, gameboy-emulator, test-driven-development
• Language: C++
• Homepage:
• Size: 426 KB
• Stars: 9
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Project Name](https://img.shields.io/badge/gameboy-emulator-success?logo=nintendo)

[![License: MIT](https://img.shields.io/badge/License-MIT-success.svg)](https://opensource.org/licenses/MIT)

[![Tests](https://github.com/raulpy271/gameboy-emulator/actions/workflows/cmake.yml/badge.svg)](https://github.com/raulpy271/gameboy-emulator/actions/workflows/cmake.yml)

[![Build Artifacts](https://github.com/raulpy271/gameboy-emulator/actions/workflows/build_artifacts.yml/badge.svg)](https://github.com/raulpy271/gameboy-emulator/actions/workflows/build_artifacts.yml)

[![My followers](https://img.shields.io/github/followers/raulpy271?style=social)](https://github.com/raulpy271)

# gameboy-emulator

A gameboy emulator written in C++ using [GTK+](https://www.gtk.org/) gui interface, and using Test Driven Development methodology. 

# Screenshoots

![Playing Tetris](/assets/playing_tetris.gif)

![Tetris screenshot](/assets/tetris.png)

![Hello World screenshot](/assets/hello-world.png)

# How to setup

## Compiling the code

First of all, install the dependencies executing the script:

```sh

apt-get update

apt-get -y install g++ 

apt-get -y install cmake libgtk-3-dev libgtkmm-3.0-dev

```

After that, run the following commands to compile the source code:

```sh

export COMPILE_GUI=true 

make generate-buildsystem

make build-cmake

```

Now, the executable is ready, the following command starts the emulation:

```sh

./build/main 

```

## Using a pre-compiled binary

> In progress(feel free to add this method of setup)

# References

See the list of useful resources:

- [Game Boy CPU Manual (pdf)](http://marc.rawer.de/Gameboy/Docs/GBCPUman.pdf)

- [Game Boy Development community](https://gbdev.io/)

- [RGBDS - toolchain for developing Game Boy programs](https://rgbds.gbdev.io/)

- [PyBoy - Emulator](https://github.com/Baekalfen/PyBoy)

- [GTKmm Tutorial](https://developer-old.gnome.org/gtkmm-tutorial/3.24/sec-gtkmm.html.en)