Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xkevio/kevboy

A Game Boy and Game Boy Color emulator in Rust.
https://github.com/xkevio/kevboy

dmg emulator gameboy gbc rust

Last synced: 2 days ago
JSON representation

A Game Boy and Game Boy Color emulator in Rust.

Host: GitHub
URL: https://github.com/xkevio/kevboy
Owner: xkevio
License: mit
Created: 2022-09-26T09:34:52.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-02-06T00:31:43.000Z (about 1 year ago)
Last Synced: 2024-05-16T04:17:10.699Z (9 months ago)
Topics: dmg, emulator, gameboy, gbc, rust
Language: Rust
Homepage: https://xkev.io/gameboy
Size: 30 MB
Stars: 32
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # WIP Game Boy & Game Boy Color Emulator









## Installation

#### Pre-built Binaries:

Check the [`Releases`](https://github.com/xkevio/kevboy/releases) page and download an already built version of `Kevboy`.

Our CI workflow currently produces binaries for:

- Windows 64-bit (`x86_64-pc-windows-msvc`)

- Ubuntu 64-bit (`x86_64-unknown-linux-gnu`)

- Mac OS x86 (`x86_64-apple-darwin`)

#### Manual:

- Clone with `[email protected]:xkevio/kevboy.git`

- Build the project in release mode with [`cargo`](https://rustup.rs/): `cargo build --release`

## Usage

Open a ROM via `File > Open ROM`.

A boot rom is not provided, the state of the Game Boy after the boot rom finishes is emulated.

Serial (link cable) is emulated in so far that games that rely on it do work, though no emulation of actual linking between two Game Boys is implemented.

**Supported Memory Bank Controllers:**

- **MBC0**

- **MBC1**

- **MBC2**

- **MBC3** (without RTC)

- **MBC5**

## Controls:

Controls may be customized via `Options > Controls`. For manual editing (not recommended, key order needs to be preserved), settings are stored here:

- Linux: `/home/UserName/.local/share/Kevboy`

- macOS: `/Users/UserName/Library/Application Support/Kevboy`

- Windows: `C:\Users\UserName\AppData\Roaming\Kevboy`

Some keys might not be supported.

For a full list, see: https://docs.rs/egui/latest/egui/enum.Key.html

|   **Keyboard**   | **Game Boy** |

|:----------------:|:------------:|

|   O   |     `B`      |

|   P   |     `A`      |

|   W   |     `Up`     |

|   A   |    `Left`    |

|   S   |    `Down`    |

|   D   |   `Right`    |

| Enter |   `Start`    |

|   Q   |   `Shift`    |

## Passed tests:

### CPU tests:

| Test              | Status |

|-------------------|--------|

| `cpu_instrs.gb`   | ✅      |

| `mem-timing.gb`   | ✅      |

| `instr_timing.gb` | ✅      |

### PPU tests:

| Test                           | Status |

|--------------------------------|--------|

| `dmg-acid2.gb`, `cgb-acid2.gb` | ✅      |

| `sprite_priority.gb`           | ✅      |

#### Timer tests:

| Test                      | Status |

|---------------------------|---------|

| `div_write.gb`            | ✅      |

| `tim00.gb`                | ✅      |

| `tim00_div_trigger.gb`    | ✅      |

| `tim01.gb`                | ✅      |

| `tim01_div_trigger.gb`    | ✅      |

| `tim10.gb`                | ✅      |

| `tim10_div_trigger.gb`    | ✅      |

| `tim11.gb`                | ✅      |

| `tim11_div_trigger.gb`    | ✅      |

| `tima_reload.gb`          | ✅      |

| `tima_write_reloading.gb` | ✅      |

| `tma_write_reloading.gb`  | ✅      |

## TODO

- [x] Implement fast-forward feature

- [x] Gamepad support

- [x] Implement enabling and disabling individual sound channels

- [ ] More automatic saving (`mmap`)

- [ ] Implement the Real Time Clock (RTC) in MBC3