Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattcurrie/mealybug-tearoom-tests
🪲☕️ Game Boy emulator test ROMs
https://github.com/mattcurrie/mealybug-tearoom-tests
game-boy gameboy gameboy-emulator
Last synced: 2 months ago
JSON representation
🪲☕️ Game Boy emulator test ROMs
- Host: GitHub
- URL: https://github.com/mattcurrie/mealybug-tearoom-tests
- Owner: mattcurrie
- License: mit
- Created: 2018-04-26T06:25:56.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-19T22:12:48.000Z (over 3 years ago)
- Last Synced: 2024-01-24T12:08:12.859Z (5 months ago)
- Topics: game-boy, gameboy, gameboy-emulator
- Language: Assembly
- Homepage:
- Size: 60.8 MB
- Stars: 53
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-gbdev - Mealybug Tearoom Tests
- awesome-gb-dev-zh - 粉蚧茶室测试
README
# Mealybug Tearoom Tests
Game Boy emulator test ROMs.
## About
This project contains some test ROMs I wrote to verify the correctness of my Game Boy emulator - [Beaten Dying Moon](https://mattcurrie.com/bdm-demo/).
Currently the tests focus on changes made to the PPU registers during STAT mode 3. This allows you to verify correct timing of the background tile and sprite data fetches as each scanline is rendered.
These tests examine very specific PPU behaviour/timings, so produce different results on a DMG compared to a CGB. There are expected result screenshots for when running on a DMG, and CPU CGB C and CPU CGB D (for most tests).
These tests are written to be easily automated. See the usage section below for details.
## Screenshots
Pictures are always interesting so here are some screenshots showing the expected results on DMG:
## Requirements
- RGBDS is required if you want to build the test ROMs yourself
- A Game Boy emulator and/or real Game Boy and flash cart to test on
## Usage
- Clone or download the project and run ```make``` from the root directory. The test ROMs will be placed in the ```build``` directory. You can also download an [archive of the ROMs](mealybug-tearoom-tests.zip).
- Check the results. You can check in the ```expected``` directory for screenshots from my Game Boy emulator (which I believe to be correct), and the ```photos``` directory contains blurry photos of the ROMs running on real devices.
- Automated testing can be achieved using the ```compare``` command from imagemagick to get the number of pixels that are different when comparing the expected image to a screenshot from an emulator.
- The screenshot from the emulator should be generated when the ```LD B,B``` software breakpoint is encountered.
- A DMG emulator should use these 8-bit values in greyscale images or in RGB components to ensure the images can be compared correctly: ```$00```, ```$55```, ```$AA```, ```$FF```
- A CGB emulator should use this formula to convert 5-bit CGB palette components to 8-bit: ```(r << 3) | (r >> 2)```
An example imagemagick compare command is below. ```result``` will contain the number of pixels that differ between the two images, so ```0``` indicates success.
```result=$(compare -metric AE emulator-screenshot.png expected-result.png NULL: 2>&1)```