VaporBoy

An A E S T H E T I C GB / GBC Emulator PWA. Powered by wasmBoy.

Table of Contents

• Features
• Example Gifs & Screenshots
• Lighthouse Score
• Contributing
  • Installation
  • Npm Scripts & CLI Commands
• Special Thanks
• Other Notes & Links
• License

Features

• Emulates the Gameboy / Gameboy Color using wasmBoy, for Web Assembly awesome-ness. 🎮👾🕹️

• Built as a Progressive Web App(PWA), using Preact. ⚛️

• TODO Wrapped in Electron with electron-builder, and Cordova to offer standalone alternative "app" experiences on Windows, Mac, Linux, Android, and iOS. 🐱🐦

• Feel all of the N O S T A L G I A, and appreciate the A E S T H E T I C of aesthetic-css. 📼💜

• Upload your ROMs from anywhere. Local Device, Pre-loaded Open Source ROMS, and even cloud services! 🍺☁️

• Unique layouts for portrait (GBC), landscape (GBA), and desktop (SGB). 📱🖥️

• Keyboard, touch, and gamepad input support using responsive gamepad. ⌨️ 🎮

• Supports all major browsers (Chrome, Firefox, Safari). Meaning, you can play gameboy on your iPhone! 🌐

• Have complete control of your emulation and performance with configurable settings and save states. ⚙️💾

• Experience the gameboy like you never have before, with Video/Audio altering VaporBoy effects. 🌈🔈📹

Example Gifs & Screenshots

Lighthouse Score

Contributing

Feel free to fork and submit PRs! Any help is much appreciated, and would be a ton of fun! I would appreciate opening an issue, or replying to an already open issue to express intent of trying to solve the issue, and we discuss.

Installation

Just your standard node app. Install Node with nvm, git clone the project, and npm install, and you should be good to go!

Npm Scripts & CLI Commands

# Starts the preact development server.
npm run start

# Same as `npm run start`
npm run dev

# Runs all precommit hooks
npm run precommit

# Runs the prettier linter, and automagically fixes all linting errors
npm run prettier:fix

# Builds a production version of the PWA
npm run preact:build

# Watches for changes, and continually builds/servers a production version of the PWA
npm run preact:build:watch

# Serves the locally built PWA
npm run preact:serve

# Serves the preact development server, called by `npm run start`
npm run preact:dev

# Start the cordova browser platform for development
npm run cordova:serve

# Serves the cordova (mobile) development server
npm run cordova:dev

# Start the electron server
npm run electron:serve

# Start the electron development server
npm run electron:dev

Special Thanks

• Leah Rose Garza, Artist of the Vaporboy Logo.

• awesome gb-dev communitty, too many rad dudes to name!

• dcodeIO for building and fixing bugs with AssemblyScript. And for being awesome!

• r/emudev, especially to binjimint for helping me sooooo much!

Other Notes & Links

• SGB Borders

• GBA Border

• GBC Border

• Touchpad SVG Inspiration

• Cartridge Border Images

• App Icon Generator

License

Licensed under Apache 2.0. 🐦