From 7f6048008182ba155b6768c77d7f3e9f5fe14806 Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Mon, 9 Nov 2026 16:37:58 +0100 Subject: [PATCH 1/9] docs: read phoenix bios names as labels --- emulators/phoenix.yml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/emulators/phoenix.yml b/emulators/phoenix.yml index e56e2dd41..9944c2b96 100644 --- a/emulators/phoenix.yml +++ b/emulators/phoenix.yml @@ -13,6 +13,7 @@ display_name: "3DO, Atari Jaguar (Phoenix)" mode: standalone cores: - phoenix +found_by: content systems: - 3do - atari-jaguar @@ -50,8 +51,8 @@ files: required: true description: "3DO BIOS" note: >- - Any BIOS dump is accepted, registered as the 3DO BIOS. The name is the - one RetroBat registers. + Read from the path registered as the 3DO BIOS in phoenix.config.xml, + under any name. The name is a label for the Panasonic FZ-10 dump. - name: panafz10e-anvil.bin system: 3do @@ -72,4 +73,5 @@ files: required: true description: "Jaguar boot ROM" note: >- - Registered as the Jaguar BIOS. The name is the one RetroBat registers. + Read from the path registered as the Jaguar BIOS in phoenix.config.xml, + under any name. The name is a label for the No-Intro boot ROM dump. From 5f716b2cc71945b885efbe3e764ff50a4fb7d140 Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Mon, 9 Nov 2026 16:40:36 +0100 Subject: [PATCH 2/9] docs: cite the chihiro-ds package for its files --- emulators/chihiro-ds.yml | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/emulators/chihiro-ds.yml b/emulators/chihiro-ds.yml index 1a0c0d505..bd2a774e4 100644 --- a/emulators/chihiro-ds.yml +++ b/emulators/chihiro-ds.yml @@ -59,7 +59,7 @@ notes: | The four JVS base board images are memory mapped read/write when the system is Chihiro. Byte 0x1F00 of the QC firmware holds the board region and is rewritten in place to one the title's boot.id accepts, which is why the - copy RetroBat ships differs from the dump by that byte. + copy the package ships differs from the dump by that byte. ref: CI-6f32d89 src/core/hle/JVS/JVS.cpp:127-142, CI-6f32d89 src/core/hle/JVS/JVS.cpp:169-210, CI-6f32d89 src/core/hle/JVS/JVS.cpp:246-262 @@ -99,8 +99,8 @@ files: description: "SEGABOOT, old revision" note: >- Mounted as the mbrom0 device. Written from the first megabyte of the media - board ROM when either SEGABOOT file is missing. The copy RetroBat ships is - that first megabyte. + board ROM when either SEGABOOT file is missing. The copy the package ships + is that first megabyte. source_ref: "cxbxr-emu.dll 0x10624b98" - name: SEGABOOT_MBROM1.XBE @@ -115,9 +115,9 @@ files: note: >- Mounted as the mbrom1 device and launched as the XBE that boots a Chihiro title. Written from the second megabyte of the media board ROM when either - SEGABOOT file is missing. The copy RetroBat ships is not that half: it - differs in about 660000 bytes from the second megabyte of the ROM it ships - beside it. Hashes are those of the shipped copy. + SEGABOOT file is missing. The copy the package ships is not that half: it + differs in 661005 bytes from the second megabyte of the ROM beside it. + Hashes are those of the shipped copy. source_ref: "cxbxr-emu.dll 0x10624b7c" - name: ic10_g24lc64.bin @@ -133,7 +133,7 @@ files: Memory mapped read/write at JVS setup, the run ends when it cannot be opened. Byte 0x1F00 is dereferenced right after and rewritten to USA, export or Japan when the title's boot.id rejects the stored region. - Hashes are those of the copy RetroBat ships. + Hashes are those of the copy the package ships. source_ref: "cxbxr-emu.dll 0x1061c648, 0x1061c620" - name: pc20_g24lc64.bin @@ -196,8 +196,9 @@ files: description: "Xbox EEPROM image" note: >- Opened at startup and mapped read/write, created with defaults when - absent, and a file that is not 256 bytes ends the run. RetroBat ships one - in the package and writes the language into it only for the xbox system. + absent, and a file that is not 256 bytes ends the run. Hashes are those of + the copy the package ships. RetroBat writes the language into it only for + the xbox system. source_ref: "cxbxr-emu.dll 0x105f6084, 0x105f5d84" - name: keys.bin From ca9a493c08e029817f124f91d45c53389e4e631f Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Mon, 9 Nov 2026 16:42:37 +0100 Subject: [PATCH 3/9] docs: cite scummvm build flags for vkeybd files --- emulators/scummvm-sdl1.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/emulators/scummvm-sdl1.yml b/emulators/scummvm-sdl1.yml index 557b027f5..ecc886bdc 100644 --- a/emulators/scummvm-sdl1.yml +++ b/emulators/scummvm-sdl1.yml @@ -170,8 +170,8 @@ files: size: 184946 sha1: "4d787bd5a071c729c4f374e6e7c7d7b06d7f9f63" md5: "bf51a61f07625ea20e891058afaa892c" - source_ref: "backends/events/default/default-events.cpp:74-77, backends/vkeybd/virtual-keyboard.cpp:118-128" - note: "Default virtual keyboard pack, built in because RetroPie passes --enable-vkeybd. RetroPie also copies it to extra/." + source_ref: "backends/events/default/default-events.cpp:74-77, backends/vkeybd/virtual-keyboard.cpp:118-128, configure:229, Makefile.common:414-416" + note: "Default virtual keyboard pack, read and installed only when configure enables the virtual keyboard (ENABLE_VKEYBD, off by default). RetroPie passes --enable-vkeybd and also copies it to extra/." - name: "vkeybd_small.zip" path: "share/scummvm/vkeybd_small.zip" @@ -180,8 +180,8 @@ files: size: 86470 sha1: "e813795cbc79e87facf7d1560c1f5946eab72167" md5: "95a179198a8fa032c751e476042c8849" - source_ref: "backends/events/default/default-events.cpp:74-77" - note: "Smaller virtual keyboard pack, loaded when vkeybd_pack_name selects it. RetroPie also copies it to extra/." + source_ref: "backends/events/default/default-events.cpp:74-77, Makefile.common:414-416" + note: "Smaller virtual keyboard pack, loaded when vkeybd_pack_name selects it in a build with ENABLE_VKEYBD. RetroPie also copies it to extra/." - name: "Roland_SC-55.sf2" path: "share/scummvm/Roland_SC-55.sf2" @@ -190,8 +190,8 @@ files: size: 3283278 sha1: "9dba9212f2e34446ab034595665809f09f303d63" md5: "dbb97c34404b753724a66fe0108a32e1" - source_ref: "base/commandLine.cpp:349-351, audio/softsynth/fluidsynth.cpp:284-310" - note: "Default FluidSynth soundfont. Installed because RetroPie pulls libfluidsynth-dev in. FluidSynth music is off when no soundfont is found." + source_ref: "base/commandLine.cpp:349-351, audio/softsynth/fluidsynth.cpp:284-310, configure:178, Makefile.common:468-470" + note: "Default soundfont of a build with FluidSynth, installed with it. configure enables FluidSynth when the library is found, and RetroPie installs libfluidsynth-dev. FluidSynth music is off when no soundfont is found." # Engine data shared by every engine. - name: "achievements.dat" From 4140fbe72c1de3f5995777466486275ddbd50f67 Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Mon, 9 Nov 2026 16:43:56 +0100 Subject: [PATCH 4/9] docs: cite trx 1.12 zips for the tr1 demo --- emulators/tr1x.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/emulators/tr1x.yml b/emulators/tr1x.yml index 6935ed48a..3cf5e8829 100644 --- a/emulators/tr1x.yml +++ b/emulators/tr1x.yml @@ -687,7 +687,7 @@ files: md5: "20e22cddfb4b796e58c0a2b9fc8b1268" category: game_data source_ref: "data/trx/ship/games/tr1-demo-pc/gameflow.json5:39, src/trx/game/game_flow/reader.c:903-909, src/trx/game/paths.c:123-132, tools/download_assets:67, tools/installer/TRX_Installer/InstallComponentFactory.cs:83-87" - note: "Title level of the PC demo. A title level is also looked up in the levels directory of the game it extends, so games/tr1/levels/title.phd is used when this one is absent. Shipped in the TRX 1.11.1 Windows and Linux zips, not in the Batocera TR1X package." + note: "Title level of the PC demo. A title level is also looked up in the levels directory of the game it extends, so games/tr1/levels/title.phd is used when this one is absent. Shipped in the TRX 1.12 Windows and Linux zips and in tr1-demo-pc.zip, same bytes. The Batocera TR1X package leaves it out." - name: "level2.phd" path: "games/tr1-demo-pc/levels/level2.phd" @@ -699,4 +699,4 @@ files: md5: "3c41eefbd43d477991bee10e4568322b" category: game_data source_ref: "data/trx/ship/games/tr1-demo-pc/gameflow.json5:58, src/trx/game/level/format/format_tr1.c:74-99, 186-191, tools/download_assets:67, tools/installer/TRX_Installer/InstallComponentFactory.cs:83-87" - note: "City of Vilcabamba in the PC demo layout, which stores the palette before the cameras. The demo game does not load without it. Shipped in the TRX 1.11.1 Windows and Linux zips, not in the Batocera TR1X package." + note: "City of Vilcabamba in the PC demo layout, which stores the palette before the cameras. The demo game does not load without it. Shipped in the TRX 1.12 Windows and Linux zips and in tr1-demo-pc.zip, same bytes. The Batocera TR1X package leaves it out." From 9449cab7ab9800295bccb0137d13a41b2a98b993 Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Mon, 9 Nov 2026 16:44:44 +0100 Subject: [PATCH 5/9] docs: say how darkplaces mounts dopa --- emulators/darkplaces.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/emulators/darkplaces.yml b/emulators/darkplaces.yml index f0a8655c8..7a213dcc4 100644 --- a/emulators/darkplaces.yml +++ b/emulators/darkplaces.yml @@ -82,5 +82,5 @@ files: path: "dopa/pak0.pak" required: false source_ref: "fs.c:1448-1462, 2154-2168" - note: "Dimension of the Past data, added on top of id1 with -game dopa." + note: "Dimension of the Past data. The engine has no game mode for it and mounts it as a mod on top of id1 with -game dopa, which RetroPie's ports menu passes when this file exists." unsourceable: "retail data the collection does not hold, and a same-named file of another game must not stand in" From 4ae7576116e4381f27974bbe907e39ef883f3fe2 Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Mon, 9 Nov 2026 16:45:43 +0100 Subject: [PATCH 6/9] docs: read dsperate bios names as labels --- emulators/dsperate.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/emulators/dsperate.yml b/emulators/dsperate.yml index 483b5492d..ba5534c8c 100644 --- a/emulators/dsperate.yml +++ b/emulators/dsperate.yml @@ -21,6 +21,7 @@ display_name: "Nintendo - DS / DSi (DSperate)" cores: - "dsperate" - "dsperate-sa" +found_by: content systems: - nintendo-ds - nintendo-dsi @@ -38,8 +39,8 @@ notes: | No file name is built in: every system file is a [paths] key of the ini (or the matching command-line flag), and a key that is unset or names no file - counts as absent. The names below are the ones ROCKNIX's dsperate.ini gives, - all in /storage/roms/bios/. + counts as absent. The names below are labels for the dumps. ROCKNIX's + dsperate.ini gives the same ones, all in /storage/roms/bios/. ref: src/frontend/sdl/config.cpp:177-217, src/frontend/sdl/main.cpp:1175-1181 DS BIOS: both halves or neither, the ARM9 image 4 KB and the ARM7 image 16 KB From 7476579c355c0202785292124dc33c4830decec0 Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Mon, 9 Nov 2026 16:48:43 +0100 Subject: [PATCH 7/9] docs: cite rpix86 binary offsets for 4dos --- emulators/rpix86.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/emulators/rpix86.yml b/emulators/rpix86.yml index 62e7d5737..093b50660 100644 --- a/emulators/rpix86.yml +++ b/emulators/rpix86.yml @@ -44,5 +44,5 @@ files: sha1: "a44f65d6318582501d22e27831eb2b1f0df58f79" md5: "fc3a0078a13d98e611a62c1d6724f8c5" crc32: "8300d4cb" - source_ref: "rpix86 0.19 binary, strings C:\\4DOS.COM and C:\\4DOS\\4DOS.COM" + source_ref: "rpix86 0.19 binary, file offsets 0x1b2c48 (C:\\4DOS.COM), 0x1b2c34 (C:\\4DOS\\4DOS.COM), 0x1b515c (Unable to find 4DOS.COM), 0x1b504c (wget .../4DOS.COM -O%s/4DOS.COM)" note: "Same bytes at rpix86.patrickaalto.com/4DOS.COM, the URL the binary downloads from, and in RetroPie's 4dos.zip. Read from the emulated C: root, not a BIOS directory. The author's rpix86.zip and rpix86.tar.gz hold the binary alone, and RetroPie unpacks 4dos.zip into the install directory." From ac4bb877147a143a1dd0f2e8cc29f15701a6892f Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Mon, 9 Nov 2026 16:52:06 +0100 Subject: [PATCH 8/9] docs: record retropie install of uqm addons --- emulators/uqm.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/emulators/uqm.yml b/emulators/uqm.yml index a632b9547..3fd73e99c 100644 --- a/emulators/uqm.yml +++ b/emulators/uqm.yml @@ -72,9 +72,11 @@ files: system: ur-quan-masters category: game_data required: false + installed_on: [retropie] md5: "9e5801d45ca12028b486cdeb83568c02" validation: [md5] description: "UQM 3DO music track pack" + note: "The RetroPie scriptmodule downloads it into content/addons." source_ref: "sc2/build/win32_install/packages.nsh:6-8; sc2/build/win32_install/uqm-installer.nsi:315-327, sc2/src/options.c:393-402, 518-551, sc2/src/uqm/setup.c:118-132" - name: uqm-0.8.0-voice.uqm @@ -82,9 +84,11 @@ files: system: ur-quan-masters category: game_data required: false + installed_on: [retropie] md5: "fc89f77d7b66c2669abca6c157f5259a" validation: [md5] description: "UQM alien-race voice-over pack" + note: "The RetroPie scriptmodule downloads it into content/addons." source_ref: "sc2/build/win32_install/packages.nsh:9-11; sc2/build/win32_install/uqm-installer.nsi:329-341, sc2/src/options.c:393-402, 518-551, sc2/src/uqm/setup.c:118-132" - name: uqm-remix-disc1.uqm From 32fefebc903f5267d713422b4f91a1085d74ddb4 Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Mon, 9 Nov 2026 16:55:04 +0100 Subject: [PATCH 9/9] docs: read the xemu hdd name as a label --- emulators/xemu.yml | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/emulators/xemu.yml b/emulators/xemu.yml index 007248dcd..55f44153d 100644 --- a/emulators/xemu.yml +++ b/emulators/xemu.yml @@ -171,20 +171,19 @@ files: required: true installed_on: [batocera, emudeck, recalbox, retrodeck, rocknix] config_key: sys.files.hdd_path + found_by: content description: "Xbox hard disk image, 8 GB with the retail partition layout" note: >- Attached as the IDE drive at index 0 with locked=on when the path is set and the file opens. An unreadable file only queues an error and an empty - path attaches no drive. Snapshots are stored inside the image. The - project publishes a formatted image carrying its own unsigned dashboard - and empty TDATA and UDATA folders. - The xemu release does not carry the image. Batocera and Recalbox - package the 1.0 xemu-hdd-image and copy it into the saves folder at - launch when none is there, RetroDECK copies its packaged copy into the - BIOS folder during setup, and EmuDeck downloads it while setting xemu - up. ROCKNIX packages the same image and unzips it at launch into - bios/xemu/hdd/, the path its xemu.toml gives hdd_path. - source_ref: "system/vl.c:3060-3074, ui/xemu-snapshots.c:156" + path attaches no drive. Snapshots are stored inside the image. + hdd_path has no default, so the name is a label: it is the file of + the formatted image the project publishes apart from the xemu release + (xemu-hdd-image 1.0, xbox_hdd.qcow2.zip), which carries its own + unsigned dashboard and empty TDATA and UDATA folders. Batocera, + Recalbox, RetroDECK, EmuDeck and ROCKNIX install that image themselves + and point hdd_path at it. + source_ref: "system/vl.c:3060-3074, ui/xemu-snapshots.c:156, config_spec.yml:362-366" - name: xbox_hdd.qcow2 mode: libretro