Browse Source

Changes

master
PHENOM 10 months ago
parent
commit
4de6b8ed90
3 changed files with 83 additions and 3 deletions
  1. 7
    0
      .vscode/GameBoyEmulator.code-workspace
  2. 1
    1
      LICENSE
  3. 75
    2
      README.md

+ 7
- 0
.vscode/GameBoyEmulator.code-workspace View File

@@ -0,0 +1,7 @@
{
"folders": [
{
"path": ".\\.."
}
]
}

+ 1
- 1
LICENSE View File

@@ -1,5 +1,5 @@
MIT License
Copyright (c) <year> <copyright holders>
Copyright (c) 2019 PHENOM
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ 75
- 2
README.md View File

@@ -1,3 +1,76 @@
# GameBoyEmulator
# Game Boy Emulator

A GameBoy Emulator written in Go
[![Build Status](https://ci.phenomic.net/job/git.phenomic.net/job/GameBoyEmulator/job/master/badge/icon?style=flat-square)](https://ci.phenomic.net/job/git.phenomic.net/job/GameBoyEmulator/job/master/)[![Build Status](https://ci.phenomic.net/job/git.phenomic.net/job/GameBoyEmulator/job/master/badge/icon?config=linuxbuild&style=flat-square)](https://ci.phenomic.net/job/git.phenomic.net/job/GameBoyEmulator/job/master/)[![Build Status](https://ci.phenomic.net/job/git.phenomic.net/job/GameBoyEmulator/job/master/badge/icon?config=winbuild&style=flat-square)](https://ci.phenomic.net/job/git.phenomic.net/job/GameBoyEmulator/job/master/)[![Build Status](https://ci.phenomic.net/job/git.phenomic.net/job/GameBoyEmulator/job/master/badge/icon?config=macbuild&style=flat-square)](https://ci.phenomic.net/job/git.phenomic.net/job/GameBoyEmulator/job/master/)

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](https://git.phenomic.net/PHENOM/GameBoyEmulator/src/branch/develop) for work progress.**

[Go to the Repository](https://git.phenomic.net/PHENOM/GameBoyEmulator)

## Table of Contents

- [Game Boy Emulator](#game-boy-emulator)
- [Table of Contents](#table-of-contents)
- [Motivation](#motivation)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Emulator](#emulator)
- [Debugger](#debugger)
- [Dependencies](#dependencies)
- [Game Boy Documentation](#game-boy-documentation)
- [License](#license)

## 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](https://golang.org/dl/) installed and having set the [$GOPATH](https://github.com/golang/go/wiki/SettingGOPATH) environment variable to your Go workspace.

### Installation

```bash
# 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

```bash
gbemulator ABSOLUTE_PATH_TO_GB_ROM_FILE.gb
```

### Debugger

```bash
gbdebugger ABSOLUTE_PATH_TO_GB_ROM_FILE.gb
```

## Dependencies

- [tview - Rich Interactive Widgets for Terminal UIs](https://github.com/rivo/tview)

## Game Boy Documentation

- [Classical Game Boy Specification](http://marc.rawer.de/Gameboy/Docs/GBCPUman.pdf)
- [Game Boy Memory Bank Controllers](http://gbdev.gg8.se/wiki/articles/Memory_Bank_Controllers)
- [Game Boy CPU (LR35902) instruction set](http://www.pastraiser.com/cpu/gameboy/gameboy_opcodes.html)
- [Game Boy Pan Docs](http://bgb.bircd.org/pandocs.htm)

## License

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

Loading…
Cancel
Save