Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bokuweb/gopher-boy
:video_game: A Game Boy emulator written in Go
https://github.com/bokuweb/gopher-boy
emulator gameboy gameboy-emulator golang
Last synced: 3 months ago
JSON representation
:video_game: A Game Boy emulator written in Go
- Host: GitHub
- URL: https://github.com/bokuweb/gopher-boy
- Owner: bokuweb
- License: mit
- Archived: true
- Created: 2019-08-03T08:05:54.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-26T16:50:54.000Z (over 4 years ago)
- Last Synced: 2024-06-20T16:45:00.193Z (5 months ago)
- Topics: emulator, gameboy, gameboy-emulator, golang
- Language: Go
- Homepage: https://bokuweb.github.io/gopher-boy/
- Size: 2.74 MB
- Stars: 245
- Watchers: 8
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - bokuweb/gopher-boy - :video_game: A Game Boy emulator written in Go (Go)
README
# gopher-boy
[](https://circleci.com/gh/bokuweb/gopher-boy/tree/master) [](https://goreportcard.com/report/github.com/bokuweb/gopher-boy)
## Installation
you can install `gopher-boy` with following comand.
```sh
go get github.com/bokuweb/gopher-boy/cmd/gopher-boy
```
This emulator uses the go library [pixel](https://github.com/faiface/pixel), which requires OpenGL. You may need to install some requirements which can be found on the [pixels readme](https://github.com/faiface/pixel#requirements).
## Requirements
- go1.12.7
## Development
#### Native
```
GO111MODULE=on go run -tags="native" cmd/gopher-boy/main.go hello.gb
```
#### WebAssembly
```
make build-wasm
make serve
```
## Usage
```sh
gopher-boy YOUR_GAMEBOY_ROM.gb
```
### Keymap
| keyboard | game pad |
| -------------------- | ------------- |
| ← | ← button |
| ↑ | ↑ button |
| ↓ | ↓ button |
| → | → button |
| Z | A button |
| X | B button |
| Enter | Start button |
| Backspace | Select button |
## Testing
```
make test
```
### Current status
#### Blargg's test ROM
| ROM | Result |
| ------------ | --------- |
| cpu_instrs | ✅ |
| instr_timing | ❌ (#255) |
#### mooneye-gb's test ROM
| ROM | Result |
| ----------------------------- | ------ |
| emulator-only/mbc1/bits_bank1 | ✅ |
| acceptance/instr/daa | ✅ |
| acceptance/timer/div_write | ✅ |
| acceptance/timer/tim00 | ✅ |
| acceptance/timer/tim01 | ✅ |
| acceptance/timer/tim10 | ✅ |
| acceptance/timer/tim11 | ✅ |
| acceptance/if_ie_registers | ✅ |
### Visual regression test
Please install `reg-cli`.
```sh
npm i -g reg-cli
```
Execute regression test
```sh
make reg
```
Update expected images
```sh
make reg-update
```
## Credit
"gopher" by Renée French CC-BY-3.0
## Known Bugs and TODO list
PR welcome :)
- [ ] Implement APU
- [ ] Support scale option
- [x] Support WebAssembly
- [x] 8\*16 sprite
- [ ] LCD interrupt
- [ ] Keypad interrupt
- [ ] cartridges
- [x] Support ROM+MBC1+RAM+BATT catridge
- [ ] Support ROM+MBC2 catridge
- [ ] Support ROM+MBC2+BATTERY catridge
- [ ] Support ROM+RAM catridge
- [ ] Support ROM+RAM+BATTERY catridge
- [ ] Support ROM+MMM01 catridge
- [ ] Support ROM+MMM01+SRAM catridge
- [ ] Support ROM+MMM01+SRAM+BATT catridge
- [ ] Support ROM+MBC3+RAM catridge
- [ ] Support ROM+MBC3+RAM+BATT catridge
- [ ] Support ROM+MBC5 catridge
- [ ] Support ROM+MBC5+RAM catridge
- [ ] Support ROM+MBC5+RAM+BATT catridge
- [ ] Support ROM+MBC5+RUMBLE catridge
- [ ] Support ROM+MBC5+RUMBLE+SRAM catridge
- [ ] Support ROM+MBC5+RUMBLE+SRAM+BATT catridge
- [ ] Support Pocket Camera catridge
- [ ] Support Bandai TAMA5 catridge
- [ ] Support Hudson HuC-3 catridge