Skip to content

reddcarp/RustyBoy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RustyBoy Logo

RustyBoy

A Game Boy Color emulator written in Rust.

Language Platform License

Screenshots

Wario Land 3 Pokémon Crystal Link's Awakening DX
Sam Mallard Tetris black castle

Features

  • Gameboy color (CGB) support
  • Gameboy games (DMG) support
  • Save/Load support
  • Dynamic window resize
  • Palette swapping on boot for original GB games
  • MBC support for (MBC1, MBC1M, MBC2, MBC3 and MBC5)

Usage

  1. Clone the repository

    git clone https://github.com/reddcarp/RustyBoy.git
  2. Build binary

    cd RustyBoy
    cargo build --release
  3. Run binary

    ./target/release/RustyBoy <path_to_rom>

WSL

When trying to run the project in WSL (Windows Subsystem for Linux), an error might happen when trying to create the window using Wayland.

Following is a workaround to this issue, forcing X11 usage:

WAYLAND_DISPLAY= ./target/release/RustyBoy <path_to_rom>

Development

Compilation

WAYLAND_DISPLAY= cargo run -- <path_to_rom> 

Enabling logs

RUST_LOG=DEBUG WAYLAND_DISPLAY= cargo run -- <path_to_rom> 

Tests

cargo test

TO-DO

Resources

Documentation

PPU

CPU

Incremental tests

About

Gameboy Color emulator written in Rust

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages