- Notifications
You must be signed in to change notification settings - Fork44
mvdnes/rboy
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
A Gameboy Color Emulator written in Rust
You can clone this repository and build it using either themake
command orcargo build --release --features=gui
. Running the emulator can be done either viacargo run --release --features=gui
, or by running the generated binary found intarget/release
.You can copy the executable namedrboy
orrboy.exe
to some sort of binary directory such as~/.local/bin/
in linux or something under thePATH
in windows.
Then you can explore the ability of the emulator byrboy --help
. Which outputs
A Gameboy Colour emulator written in RustUsage: rboy [OPTIONS] <filename>Arguments: <filename> Sets the ROM file to loadOptions: -s, --serial Prints the data from the serial port to stdout -p, --printer Emulates a gameboy printer -c, --classic Forces the emulator to run in classic Gameboy mode -x, --scale <scale> Sets the scale of the interface. Default: 2 -a, --audio Enables audio --skip-checksum Skips verification of the cartridge checksum --test-mode Starts the emulator in a special test mode -h, --help Print help -V, --version Print version
Now you can look below for the Keybindings section below.
Key on Keyboard | Emulator Key |
---|---|
Z | A |
X | B |
Up/Down/Left/Right | Up/Down/Left/Right |
Space | Select |
Return/Enter | Start |
Key on Keyboard | Emulator Action |
---|---|
1 | Switch to 1:1 scale |
R | Restore scale given on command line |
Left Shift (Hold) | Unrestricted Speed Mode |
T | Change pixel interpolation |
- CPU
- All instructions correct
- All timings correct
- Double speed mode
- GPU
- Normal mode
- Color mode
- Keypad
- Timer
- Audio
- MMU
- MBC-less
- MBC1
- MBC3 (with RTC)
- MBC5
- save games
- Printing
The test mode, activated with the--test-mode
flag, provides some functionality for runningGBEmulatorShootout. This is still under development.