A Nintendo Game Boy Emulator written in Go https://phenomic.net
Go to file
PHENOM 4de6b8ed90 Changes 2019-04-21 19:11:34 +02:00
.vscode Changes 2019-04-21 19:11:34 +02:00
.gitignore Initial commit 2019-03-31 16:53:53 +02:00
LICENSE Changes 2019-04-21 19:11:34 +02:00
README.md Changes 2019-04-21 19:11:34 +02:00

README.md

Game Boy Emulator

Build StatusBuild StatusBuild StatusBuild Status

A Nintendo Game Boy Emulator written in Go

Please note that the majority of this Project is in a non-functional state and still a Work in progress.

Please check out the develop Branch for work progress.

Go to the Repository

Table of Contents

Motivation

I made this project in order to learn about platform architectures and methods of emulating them. It also is a good way about learning the Go Programming Language.

Getting Started

Prerequisites

In order to use this project you need to have the Go Binaries installed and having set the $GOPATH environment variable to your Go workspace.

Installation

# Clone Project and receive dependencies
go get git.phenomic.net/phenom/gameboyemulator/...

# Install Emulator & Debugger
cd $GOPATH/src/git.phenomic.net/phenom/gameboyemulator
go install ./cmd/...

Usage

Emulator

gbemulator ABSOLUTE_PATH_TO_GB_ROM_FILE.gb

Debugger

gbdebugger ABSOLUTE_PATH_TO_GB_ROM_FILE.gb

Dependencies

Game Boy Documentation

License

Distributed under the MIT License. See LICENSE for more information.