{"id":13601004,"url":"https://github.com/bokuweb/gopher-boy","last_synced_at":"2025-04-11T01:30:45.969Z","repository":{"id":57500393,"uuid":"200349535","full_name":"bokuweb/gopher-boy","owner":"bokuweb","description":":video_game: A Game Boy emulator written in Go","archived":true,"fork":false,"pushed_at":"2020-07-26T16:50:54.000Z","size":2871,"stargazers_count":243,"open_issues_count":1,"forks_count":15,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-11-07T03:42:41.845Z","etag":null,"topics":["emulator","gameboy","gameboy-emulator","golang"],"latest_commit_sha":null,"homepage":"https://bokuweb.github.io/gopher-boy/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bokuweb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-03T08:05:54.000Z","updated_at":"2024-09-26T18:27:00.000Z","dependencies_parsed_at":"2022-08-30T14:40:12.098Z","dependency_job_id":null,"html_url":"https://github.com/bokuweb/gopher-boy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bokuweb%2Fgopher-boy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bokuweb%2Fgopher-boy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bokuweb%2Fgopher-boy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bokuweb%2Fgopher-boy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bokuweb","download_url":"https://codeload.github.com/bokuweb/gopher-boy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248325000,"owners_count":21084848,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["emulator","gameboy","gameboy-emulator","golang"],"created_at":"2024-08-01T18:00:52.243Z","updated_at":"2025-04-11T01:30:41.860Z","avatar_url":"https://github.com/bokuweb.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# gopher-boy\n\n[![CircleCI](https://circleci.com/gh/bokuweb/gopher-boy/tree/master.svg?style=svg)](https://circleci.com/gh/bokuweb/gopher-boy/tree/master) [![Go Report Card](https://goreportcard.com/badge/github.com/bokuweb/gopher-boy)](https://goreportcard.com/report/github.com/bokuweb/gopher-boy)\n\n\u003cimg src=\"screenshot/mario.png\"\u003e　\u003cimg src=\"screenshot/tetris.png\"\u003e　\u003cimg src=\"screenshot/drmario.png\"\u003e　\u003cimg src=\"screenshot/tobu.png\"\u003e　\u003cimg src=\"screenshot/dino.png\"\u003e\n\n## Installation\n\nyou can install `gopher-boy` with following comand.\n\n```sh\ngo get github.com/bokuweb/gopher-boy/cmd/gopher-boy\n```\n\nThis 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).\n\n## Requirements\n\n- go1.12.7\n\n## Development\n\n#### Native\n\n```\nGO111MODULE=on go run -tags=\"native\" cmd/gopher-boy/main.go hello.gb\n```\n\n#### WebAssembly\n\n```\nmake build-wasm\nmake serve\n```\n\n## Usage\n\n```sh\ngopher-boy YOUR_GAMEBOY_ROM.gb\n```\n\n### Keymap\n\n| keyboard             | game pad      |\n| -------------------- | ------------- |\n| \u003ckbd\u003e\u0026larr;\u003c/kbd\u003e    | \u0026larr; button |\n| \u003ckbd\u003e\u0026uarr;\u003c/kbd\u003e    | \u0026uarr; button |\n| \u003ckbd\u003e\u0026darr;\u003c/kbd\u003e    | \u0026darr; button |\n| \u003ckbd\u003e\u0026rarr;\u003c/kbd\u003e    | \u0026rarr; button |\n| \u003ckbd\u003eZ\u003c/kbd\u003e         | A button      |\n| \u003ckbd\u003eX\u003c/kbd\u003e         | B button      |\n| \u003ckbd\u003eEnter\u003c/kbd\u003e     | Start button  |\n| \u003ckbd\u003eBackspace\u003c/kbd\u003e | Select button |\n\n## Testing\n\n```\nmake test\n```\n\n### Current status\n\n#### Blargg's test ROM\n\n| ROM          | Result    |\n| ------------ | --------- |\n| cpu_instrs   | ✅        |\n| instr_timing | ❌ (#255) |\n\n#### mooneye-gb's test ROM\n\n| ROM                           | Result |\n| ----------------------------- | ------ |\n| emulator-only/mbc1/bits_bank1 | ✅     |\n| acceptance/instr/daa          | ✅     |\n| acceptance/timer/div_write    | ✅     |\n| acceptance/timer/tim00        | ✅     |\n| acceptance/timer/tim01        | ✅     |\n| acceptance/timer/tim10        | ✅     |\n| acceptance/timer/tim11        | ✅     |\n| acceptance/if_ie_registers    | ✅     |\n\n### Visual regression test\n\nPlease install `reg-cli`.\n\n```sh\nnpm i -g reg-cli\n```\n\nExecute regression test\n\n```sh\nmake reg\n```\n\nUpdate expected images\n\n```sh\nmake reg-update\n```\n\n## Credit\n\n\"gopher\" by Renée French CC-BY-3.0\n\n## Known Bugs and TODO list\n\nPR welcome :)\n\n- [ ] Implement APU\n- [ ] Support scale option\n- [x] Support WebAssembly\n- [x] 8\\*16 sprite\n- [ ] LCD interrupt\n- [ ] Keypad interrupt\n- [ ] cartridges\n  - [x] Support ROM+MBC1+RAM+BATT catridge\n  - [ ] Support ROM+MBC2 catridge\n  - [ ] Support ROM+MBC2+BATTERY catridge\n  - [ ] Support ROM+RAM catridge\n  - [ ] Support ROM+RAM+BATTERY catridge\n  - [ ] Support ROM+MMM01 catridge\n  - [ ] Support ROM+MMM01+SRAM catridge\n  - [ ] Support ROM+MMM01+SRAM+BATT catridge\n  - [ ] Support ROM+MBC3+RAM catridge\n  - [ ] Support ROM+MBC3+RAM+BATT catridge\n  - [ ] Support ROM+MBC5 catridge\n  - [ ] Support ROM+MBC5+RAM catridge\n  - [ ] Support ROM+MBC5+RAM+BATT catridge\n  - [ ] Support ROM+MBC5+RUMBLE catridge\n  - [ ] Support ROM+MBC5+RUMBLE+SRAM catridge\n  - [ ] Support ROM+MBC5+RUMBLE+SRAM+BATT catridge\n  - [ ] Support Pocket Camera catridge\n  - [ ] Support Bandai TAMA5 catridge\n  - [ ] Support Hudson HuC-3 catridge\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbokuweb%2Fgopher-boy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbokuweb%2Fgopher-boy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbokuweb%2Fgopher-boy/lists"}