A GB emulator that is written in Rust 🦀!

João Magalhães

Last update: Jan 10, 2023

Related tags

Emulators emulator rust gameboy gameboy-emulator wasm

Overview

Boytacean

A Game Boy emulator that is written in Rust 🦀 .

This emulator has been written for educational purposes and shouldn't be taken too seriously. But yeahh it plays most Game Boy games, which is cool... 🕹️

Features

Game Boy (DMG) emulation
Simple navigable source-code
Web and SDL front-ends
Support for multiple MBCs: MBC1, MBC2, MBC3, and MBC5
Variable CPU clock speed
Accurate PPU - passes dmg-acid2 tests

For the Web front-end...

Mobile first experience
Transparent RAM saving using Web Storage API
GamePad support using Web Gamepad API
Unobstructive and effective on-screen GamePad
Cool bespoke display palettes built by TheWolfBunny64.
Fullscreen browser mode
Debug mode - VRAM and registers

What's missing...

Audio emulation APU
Game Boy Color (GBC) emulation

Deployments

Provider	Stable	URL
Cloudfare	`True`	boytacean.joao.me
Cloudfare	`True`	boytacean.pages.dev
Cloudfare	`True`	prod.boytacean.pages.dev
Cloudfare	`True`	stable.boytacean.pages.dev
Cloudfare	`False`	master.boytacean.pages.dev

Build

Library

cargo build

WASM for Node.js

cargo install wasm-pack
wasm-pack build --release --target=nodejs -- --features wasm

WASM for Web

cargo install wasm-pack
wasm-pack build --release --target=web --out-dir=frontends/web/lib -- --features wasm
cd frontends/web
npm install && npm run build
cd dist && python3 -m http.server

Web front-end

The Web front-end makes use of EmuKit which is a UI toolkit that provides the required infrastructure for the creation of interfaces for emulation in a Web context.

Configuration

You can use some GET parameters to control the initial behavior of the emulator.

Parameter	Type	Description
`rom_url`	String	The URL from which the initial ROM is going to be loaded, should support CORS.
`url`	String	The same as `rom_url`.
`fullscreen`	Boolean	If the emulator should start in fullscreen mode.
`fs`	Boolean	The same as `fullscreen`.
`debug`	Boolean	If the "debugger" should start visible.
`keyboard`	Boolean	If the on-screen keyboard should start visible.
`palette`	String	The name of the palette to be set at startup( eg: `christmas`, `hogwards`, `mariobros`, etc.).

Palettes

The palettes offered in the web version were provided by TheWolfBunny64.

Inspiration

To get some information about the resources that inspired me through the emulation creation journey check Inspiration.

License

Boytacian is currently licensed under the Apache License, Version 2.0.

Build Automation

Spaghetti Chip8 Emulator Written In Rust

How to run? Command is simple: cargo run FILENAME. files are stored in the /c8games folder, use one of them. Example: cargo run INVADERS Keymap use 1

5 Apr 15, 2022

Non cycle-accurate emulator of the 6502 cpu, written in pure rust

CPU 6502 A non cycle-accurate emulator implementing all legal 6502 opcodes. What does non cycle-accurate mean? Every instruction on the 6502 takes a n

10 Jul 15, 2022

Experimental Nintendo Switch Emulator written in Rust

Kaminari Experimental Nintendo Switch Emulator written in Rust Usage You'll need to install Rust. rusc = 1.55.0 rustup = 1.24.3 Disclaimer Kaminari

4 Dec 7, 2021

A barely functional terminal emulator written in Rust. For nothing but fun.

Nothing much to say now. The basic architecture (kind of) so far is: ┌────────┐ ┌──────────────────┐ │ ptm │◀──────▶│ device::Shell │ └─┬

4 Apr 29, 2022

A Chip8 Emulator written in Rust

Chipper: Chipper is a Chip8 Emulator written in Rust. It currently supports a few known quirks of the Chip8 varieties. I intend on making it support t

4 Aug 20, 2022

A CHIP-8 emulator written in Rust

damn8 A CHIP-8 emulator written in Rust To run, pass a path to a rom in the command line. TODO: Use function pointers to handle opcodes instead of a l

1 Jan 11, 2022

CHIP-8 emulator written in Rust as a side project.

marisa-rs a CHIP-8 emulator, with learning purposes in mind, written in Rust. this is mainly a learning project of mine for deeper knowledge in emulat

0 Jul 26, 2022

a work-in-progress NES emulator written in rust.

sayaka-rs a work-in-progress NES emulator, written in Rust. the project image is an edit of a frame from the Mahou Shoujo Madoka Magica manga. the Mik

1 Jan 16, 2022

A RISC-V emulator supoorting RV32I instruction set written in Rust

32-bit RISC-V Emulator in Rust This is a RISC-V emulator supoorting RV32I instruction set written in Rust, inspired by Francis Stokes's RISC-V Emulato