Add DocBoy emulator. by Docheinstein · Pull Request #26 · gbdev/GBEmulatorShootout

Docheinstein · 2024-04-16T20:58:59Z

Changes introduced by this PR:

Adds DocBoy emulator to the suite (Add DocBoy #24).
Remove the CGB requirement of the ax6 test roms: now they run on DMG too (ax6 roms don't actually need CGB #25).

As a consequence, this PR also update usages of Windows commands and Python packages that are not supported yet by the GitHub actions.

Commits:

b5f23e5: Add DocBoy emulator.
868c6ea: Replace Extract-7Zip with Expand-7ZipArchive.
50436ed: Replace distutils.dir_util.copy_tree with shutil.copytree.
7c3fc90: Run ax6 roms on DMG.
8a74c6f: Explicitly set DocBoy scaling factor to 1.

Closes #24.
Closes #25.

The Extract-7Zip command is not supported anymore by GitHub actions. It has been replaced with the Expand-7ZipArchive. Source: actions/runner-images#9361 (comment)

The distutils package has been removed with Python 3.12 (that is the Python version run by the GitHub actions at the moment). We were using it for distutils.dir_util.copy_tree, which has been replaced with shutil.copytree. Source: https://docs.python.org/3.11/whatsnew/3.10.html#distutils-deprecated

ax6's RTC tests do not actually need CGB; DMG is fully capable of run these roms. Therefore, the CGB requirement has been removed and the screenshots of such roms have been updated with the DMG's one.

Docheinstein · 2024-05-18T12:40:08Z

I guess the workflow failed because I don't have the permissions/I am not a contributor??

By the way, feel free to tell me if there's something of this PR I could improve or change.

vulcandth · 2026-03-20T18:13:54Z

I'm going to work on this in a bit once I get the other emulators updated.

avivace

The changes related to DocBoy seem ok to me but:

ax6 test roms results are updated (?)
there are some unrelated changes in the ares emulator and in the main pipeline

avivace · 2026-03-20T18:12:19Z

.github/workflows/main.yml

          Start-Service audio*
          Invoke-WebRequest https://github.com/duncanthrax/scream/releases/download/3.6/Scream3.6.zip -OutFile C:\Scream3.6.zip
-          Extract-7Zip -Path C:\Scream3.6.zip -DestinationPath C:\Scream
+          Expand-7ZipArchive -Path C:\Scream3.6.zip -DestinationPath C:\Scream


unrelated change?

avivace · 2026-03-20T18:12:22Z

emulators/ares.py

 import PIL.Image
 import PIL.ImageOps
-from distutils.dir_util import copy_tree
+from shutil import copytree


unrelated change?

At the time of my PR this was making the pipeline fail, as distutils has been removed starting from Python 3.12 release note.

I'll revert this and the other changes, as they have already been fixed in the main branch.

avivace · 2026-03-20T18:12:26Z

emulators/ares.py


        if not os.path.exists("emu/ares/ares.exe"):
-          copy_tree(os.path.join("emu/ares", os.listdir("emu/ares")[0]), "emu/ares")
+          copytree(os.path.join("emu/ares", os.listdir("emu/ares")[0]), "emu/ares")


unrelated change?

Docheinstein · 2026-03-21T10:19:25Z

Hi everyone.

I've just noticed that the original repo has been moved and has been updated recently, great.

I've noticed that there a few conflicts now: I'll update my branch so that we can make the merge smoother.

Furthermore, now DocBoy also CGB in addition to DMG, so I'll consider add it as well.

vulcandth · 2026-03-21T12:21:35Z

testroms/ax6.py

-    Test("ax6/rtc3test-1.gb", runtime=9.5, model=CGB),
-    Test("ax6/rtc3test-2.gb", runtime=7.5, model=CGB),
-    Test("ax6/rtc3test-3.gb", runtime=20.0, model=CGB),
+    Test("ax6/rtc3test-1.gb", runtime=9.5),
+    Test("ax6/rtc3test-2.gb", runtime=7.5),
+    Test("ax6/rtc3test-3.gb", runtime=20.0),


Please revert the ax6 test changes for now. This will be changed, but not in this PR. Thanks!

Sure. Done!

vulcandth

This looks good, but we need to add the emulator into the CI as well. I can take care of this and push an update to this PR myself.

Furthermore, I have change I am making to fix #65 and #66 and I'd like to wait to merge this until after that PR is created/merged.

avivace · 2026-03-21T18:33:42Z

This looks good, but we need to add the emulator into the CI as well. I can take care of this and push an update to this PR myself.

Furthermore, I have change I am making to fix #65 and #66 and I'd like to wait to merge this until after that PR is created/merged.

Can we merge without the CI part at the moment? That shouldn't need any other fix, right? Then we can work on the CI part after those other things you mentioned are fixed.

vulcandth · 2026-03-21T18:45:11Z

This needs a CI workflow like the other emulators.

See the GitHub CI workflow files

Docheinstein · 2026-03-21T18:49:42Z

This needs a CI workflow like the other emulators.

See the GitHub CI workflow files

All right, didn't know about the CI files, I'll add it later then.

avivace · 2026-03-21T18:51:46Z

This needs a CI workflow like the other emulators.

See the GitHub CI workflow files

I know, but merging what we have won't hurt (we simply won't have the results just yet in the gh-pages branch) and CI can be added later - I just don't want to have this blocked nor blocking if there's not a real reason for it.

vulcandth · 2026-03-21T19:08:39Z

This needs a CI workflow like the other emulators.

See the GitHub CI workflow files

I know, but merging what we have won't hurt (we simply won't have the results just yet in the gh-pages branch) and CI can be added later - I just don't want to have this blocked nor blocking if there's not a real reason for it.

The main blocker was that other PR that just got merged because I expected a merge conflict.

My full intent was to fix the merge conflict here and add the CI myself then merge this PR after. Next on my to-do list. But I'm about to see a movie with the wife now so it would be after.

If you would like to fix the merge conflict and merge without the CI that is fine. I'll add the CI later. No worries. 😊

Rangi42 · 2026-03-21T19:32:57Z

Although also, it's not really "blocking" anything to leave this open, since whether or not it gets merged as-is, Vulcandth's next intended task is to add CI for it. Unless somebody else's intended tasks need this merged first too, and they don't need CI to work for it.

Docheinstein · 2026-03-21T23:08:49Z

In the latest commits I've solved the conflicts with upstream, added the ci-docboy.yml to the workflows and added support for DocBoy in CGB as well. Let me know if that's fine.

Docheinstein added 5 commits April 16, 2024 21:59

Add DocBoy emulator

b5f23e5

Update deprecated Extract-7Zip command

868c6ea

The Extract-7Zip command is not supported anymore by GitHub actions. It has been replaced with the Expand-7ZipArchive. Source: actions/runner-images#9361 (comment)

Run ax6 RTC test also on DMG

7c3fc90

ax6's RTC tests do not actually need CGB; DMG is fully capable of run these roms. Therefore, the CGB requirement has been removed and the screenshots of such roms have been updated with the DMG's one.

Explicitly set DocBoy scaling factor to 1

8a74c6f

Rangi42 mentioned this pull request Feb 15, 2026

Add DocBoy vulcandth/GBEmulatorShootout#22

Closed

Rangi42 mentioned this pull request Mar 16, 2026

Add DocBoy #24

Closed

avivace requested review from Rangi42, avivace and vulcandth March 20, 2026 18:10

avivace requested changes Mar 20, 2026

View reviewed changes

Docheinstein added 2 commits March 21, 2026 11:22

Merge remote-tracking branch 'upstream/main' into add-docboy

73acc66

Add missing newlines at end of files

a5f4437

vulcandth requested changes Mar 21, 2026

View reviewed changes

vulcandth changed the title ~~Add DocBoy emulator. Run ax6 roms on DMG too.~~ Add DocBoy emulator. Mar 21, 2026

vulcandth added the new-emulator An emulator to be added label Mar 21, 2026

Revert ax6 tests changes

c3fc761

vulcandth requested changes Mar 21, 2026

View reviewed changes

Rangi42 removed their request for review March 21, 2026 14:24

Update download accordingly to latest DocBoy release deploy

daff829

Merge remote-tracking branch 'upstream/main' into add-docboy

81cb6e4

Docheinstein added 5 commits March 21, 2026 21:26

Add ci-docboy to workflows

e31963d

Add 5th color to dmg_palette (default LCD color)

f071226

Add PCM to supported features

4f7c163

Remove custom title_check, as the default is fine

3223282

Add DocBoy in CGB version too

e49c24a

avivace approved these changes Mar 22, 2026

View reviewed changes

avivace merged commit 38ab949 into gbdev:main Mar 22, 2026
1 check passed

Docheinstein deleted the add-docboy branch March 22, 2026 11:46

avivace mentioned this pull request Mar 23, 2026

ax6 roms don't actually need CGB #25

Open

Conversation

Docheinstein commented Apr 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Docheinstein commented May 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vulcandth commented Mar 20, 2026

Uh oh!

avivace left a comment

Choose a reason for hiding this comment

Uh oh!

avivace Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

avivace Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

Docheinstein Mar 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

avivace Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

Docheinstein commented Mar 21, 2026

Uh oh!

vulcandth Mar 21, 2026

Choose a reason for hiding this comment

Uh oh!

Docheinstein Mar 21, 2026

Choose a reason for hiding this comment

Uh oh!

vulcandth left a comment

Choose a reason for hiding this comment

Uh oh!

avivace commented Mar 21, 2026

Uh oh!

vulcandth commented Mar 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Docheinstein commented Mar 21, 2026

Uh oh!

avivace commented Mar 21, 2026

Uh oh!

vulcandth commented Mar 21, 2026

Uh oh!

Rangi42 commented Mar 21, 2026

Uh oh!

Docheinstein commented Mar 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Docheinstein commented Apr 16, 2024 •

edited

Loading

Docheinstein commented May 18, 2024 •

edited

Loading

Docheinstein Mar 21, 2026 •

edited

Loading

vulcandth commented Mar 21, 2026 •

edited

Loading