1 Commits

Author SHA1 Message Date
Abdessamad Derraz
f45f93a5a6 fix: restore large files in release job
release job built packs without PS3UPDAT.PUP, PSVUPDAT.PUP, etc.
producing tiny non-functional ZIPs (2-14 MB instead of 200+ MB).
2026-03-25 07:03:51 +01:00
85 changed files with 1322 additions and 8214 deletions

View File

@@ -18,11 +18,13 @@ concurrency:
cancel-in-progress: true
jobs:
release:
if: false # disabled until pack generation is validated in production
regenerate:
runs-on: ubuntu-latest
permissions:
contents: write
pages: write
outputs:
changed: ${{ steps.commit.outputs.changed }}
steps:
- uses: actions/checkout@v6
@@ -32,9 +34,57 @@ jobs:
- run: pip install pyyaml
- name: Restore large files from release
run: |
mkdir -p .cache/large
gh release download large-files -D .cache/large/ 2>/dev/null || true
# Copy large files to their bios/ paths so generate_db sees them
for f in .cache/large/*; do
[ -f "$f" ] || continue
name=$(basename "$f")
# Match against .gitignore entries to find target path
target=$(grep "$name" .gitignore | head -1)
if [ -n "$target" ] && [ ! -f "$target" ]; then
mkdir -p "$(dirname "$target")"
cp "$f" "$target"
echo "Restored: $target"
fi
done
env:
GH_TOKEN: ${{ github.token }}
- name: Regenerate database, readme, and site
run: |
pip install mkdocs-material
python scripts/generate_db.py --force --bios-dir bios --output database.json
python scripts/generate_readme.py --db database.json --platforms-dir platforms
python scripts/generate_site.py
- name: Run tests
run: python -m unittest tests.test_e2e -v
- name: Deploy site to GitHub Pages
if: github.ref == 'refs/heads/main'
run: mkdocs gh-deploy --force --clean
- name: Commit if changed
id: commit
run: |
git diff --quiet database.json README.md CONTRIBUTING.md && echo "changed=false" >> "$GITHUB_OUTPUT" && exit 0
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git add database.json README.md CONTRIBUTING.md
git commit -m "regenerate database and docs"
git push
echo "changed=true" >> "$GITHUB_OUTPUT"
release:
needs: regenerate
if: (needs.regenerate.outputs.changed == 'true' || github.event.inputs.force_release == 'true')
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Rate limit
if: github.event.inputs.force_release != 'true'
id: rate
@@ -53,6 +103,20 @@ jobs:
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- uses: actions/checkout@v6
if: steps.rate.outputs.skip != 'true'
with:
ref: main
- uses: actions/setup-python@v6
if: steps.rate.outputs.skip != 'true'
with:
python-version: "3.12"
- name: Install dependencies
if: steps.rate.outputs.skip != 'true'
run: pip install pyyaml
- name: Restore large files from release
if: steps.rate.outputs.skip != 'true'
run: |
@@ -78,7 +142,9 @@ jobs:
- name: Build packs
if: steps.rate.outputs.skip != 'true'
run: python scripts/generate_pack.py --all --output-dir dist/
run: |
python scripts/generate_db.py --bios-dir bios --output database.json
python scripts/generate_pack.py --all --output-dir dist/
- name: Release
if: steps.rate.outputs.skip != 'true'
@@ -102,17 +168,14 @@ jobs:
${PACKS}
### Install
Download the pack matching your frontend, extract to the BIOS directory.
Download, extract to your emulator's BIOS directory.
| Platform | Pack | Path |
|----------|------|------|
| RetroArch / Lakka | RetroArch_Lakka_BIOS_Pack.zip | system/ |
| Batocera | Batocera_BIOS_Pack.zip | /userdata/bios/ |
| Recalbox | Recalbox_BIOS_Pack.zip | /recalbox/share/bios/ |
| RetroBat | RetroBat_BIOS_Pack.zip | bios/ |
| RetroDECK | RetroDECK_BIOS_Pack.zip | ~/retrodeck/bios/ |
| EmuDeck | EmuDeck_BIOS_Pack.zip | Emulation/bios/ |
| RomM | RomM_BIOS_Pack.zip | bios/{platform_slug}/ |
| Platform | Path |
|----------|------|
| RetroArch / Lakka | system/ |
| Batocera | /userdata/bios/ |
| Recalbox | /recalbox/share/bios/ |
| RetroBat | bios/ |
### Changes
${CHANGES}

View File

@@ -1,59 +0,0 @@
name: Deploy Site
on:
push:
branches: [main]
paths:
- "platforms/**"
- "emulators/**"
- "wiki/**"
- "scripts/generate_site.py"
- "scripts/generate_readme.py"
- "scripts/verify.py"
- "scripts/common.py"
- "database.json"
- "mkdocs.yml"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: deploy-site
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/setup-python@v6
with:
python-version: "3.12"
- run: pip install pyyaml mkdocs-material pymdown-extensions
- name: Generate site
run: |
python scripts/generate_site.py
python scripts/generate_readme.py --db database.json --platforms-dir platforms
mkdocs build
- name: Upload artifact
uses: actions/upload-pages-artifact@v4
with:
path: site/
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

9
.gitignore vendored
View File

@@ -11,8 +11,13 @@ site/
*.log
node_modules/
# Generated site pages (built by generate_site.py, deployed in CI)
docs/
# Generated site pages (built in CI)
docs/index.md
docs/platforms/
docs/systems/
docs/emulators/
docs/contributing.md
docs/gaps.md
# Large files stored as GitHub Release assets (> 50MB)
bios/Arcade/Arcade/Firmware.19.0.0.zip

View File

@@ -1,41 +1,21 @@
# RetroBIOS
# Retrogaming BIOS & Firmware Collection
Complete BIOS and firmware packs for RetroArch, Batocera, Recalbox, Lakka, RetroPie, EmuDeck, RetroBat, RetroDECK, and RomM.
Complete, verified collection of BIOS, firmware, and system files for retrogaming emulators.
**6,748** verified files across **294** systems, ready to extract into your emulator's BIOS directory.
> **6724** files | **5013.3 MB** | **8** platforms | **275** emulator profiles
## Download BIOS packs
## Download
Pick your platform, download the ZIP, extract to the BIOS path.
| Platform | BIOS files | Extract to | Download |
|----------|-----------|-----------|----------|
| Batocera | 359 | `/userdata/bios/` | [Download](../../releases/latest) |
| EmuDeck | 161 | `Emulation/bios/` | [Download](../../releases/latest) |
| Lakka | 448 | `system/` | [Download](../../releases/latest) |
| Recalbox | 346 | `/recalbox/share/bios/` | [Download](../../releases/latest) |
| RetroArch | 448 | `system/` | [Download](../../releases/latest) |
| RetroBat | 331 | `bios/` | [Download](../../releases/latest) |
| RetroDECK | 2007 | `~/retrodeck/bios/` | [Download](../../releases/latest) |
| RetroPie | 448 | `BIOS/` | [Download](../../releases/latest) |
| RomM | 374 | `bios/{platform_slug}/` | [Download](../../releases/latest) |
## What's included
BIOS, firmware, and system files for consoles from Atari to PlayStation 3.
Each file is checked against the emulator's source code to match what the code actually loads at runtime.
- **9 platforms** supported with platform-specific verification
- **306 emulators** profiled from source (RetroArch cores + standalone)
- **294 systems** covered (NES, SNES, PlayStation, Saturn, Dreamcast, ...)
- **6,748 files** verified with MD5, SHA1, CRC32 checksums
- **5251 MB** total collection size
## Supported systems
NES, SNES, Nintendo 64, GameCube, Wii, Game Boy, Game Boy Advance, Nintendo DS, Nintendo 3DS, Switch, PlayStation, PlayStation 2, PlayStation 3, PSP, PS Vita, Mega Drive, Saturn, Dreamcast, Game Gear, Master System, Neo Geo, Atari 2600, Atari 7800, Atari Lynx, Atari ST, MSX, PC Engine, TurboGrafx-16, ColecoVision, Intellivision, Commodore 64, Amiga, ZX Spectrum, Arcade (MAME), and 260+ more.
Full list with per-file details: **[https://abdess.github.io/retrobios/](https://abdess.github.io/retrobios/)**
| Platform | Files | Verification | Pack |
|----------|-------|-------------|------|
| Batocera | 359 | md5 | [Download](../../releases/latest) |
| EmuDeck | 161 | md5 | [Download](../../releases/latest) |
| Lakka | 448 | existence | [Download](../../releases/latest) |
| Recalbox | 346 | md5 | [Download](../../releases/latest) |
| RetroArch | 448 | existence | [Download](../../releases/latest) |
| RetroBat | 331 | md5 | [Download](../../releases/latest) |
| RetroDECK | 2007 | md5 | [Download](../../releases/latest) |
| RetroPie | 448 | existence | [Download](../../releases/latest) |
## Coverage
@@ -47,27 +27,15 @@ Full list with per-file details: **[https://abdess.github.io/retrobios/](https:/
| Recalbox | 346/346 (100.0%) | 346 | 0 | 0 |
| RetroArch | 448/448 (100.0%) | 448 | 0 | 0 |
| RetroBat | 331/331 (100.0%) | 331 | 0 | 0 |
| RetroDECK | 2007/2007 (100.0%) | 2007 | 0 | 0 |
| RetroDECK | 2007/2007 (100.0%) | 1698 | 309 | 0 |
| RetroPie | 448/448 (100.0%) | 448 | 0 | 0 |
| RomM | 374/374 (100.0%) | 359 | 15 | 0 |
## How it works
Documentation and metadata can drift from what emulators actually load.
To keep packs accurate, each file is checked against the emulator's source code.
1. **Read emulator source code** - trace every file the code loads, its expected hash and size
2. **Cross-reference with platforms** - match against what each platform declares
3. **Build packs** - include baseline files plus what each platform's cores need
4. **Verify** - run platform-native checks and emulator-level validation
## Documentation
Per-file hashes, emulator profiles, gap analysis, cross-reference: **[https://abdess.github.io/retrobios/](https://abdess.github.io/retrobios/)**
Full file listings, platform coverage, emulator profiles, and gap analysis: **[https://abdess.github.io/retrobios/](https://abdess.github.io/retrobios/)**
## Contributors
<a href="https://github.com/PixNyb"><img src="https://avatars.githubusercontent.com/u/40770831?v=4" width="50" title="PixNyb"></a>
<a href="https://github.com/monster-penguin"><img src="https://avatars.githubusercontent.com/u/266009589?v=4" width="50" title="monster-penguin"></a>
@@ -79,4 +47,4 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
This repository provides BIOS files for personal backup and archival purposes.
*Auto-generated on 2026-03-25T22:12:06Z*
*Auto-generated on 2026-03-20T19:10:25Z*

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because it is too large Load Diff

View File

@@ -1,10 +1,9 @@
emulator: Amiberry
type: standalone + libretro
core_classification: official_port
source: "https://github.com/BlitterStudio/amiberry"
upstream: "https://github.com/tonioni/WinUAE"
profiled_date: "2026-03-25"
core_version: "v8.1.1"
profiled_date: "2026-03-18"
core_version: "v6.3.4"
display_name: "Commodore - Amiga (Amiberry)"
cores: [amiberry]
systems:
@@ -13,179 +12,111 @@ systems:
- commodore-cdtv
notes: |
Amiberry is an Amiga emulator based on WinUAE, available as both standalone
and libretro core. No built-in kickstart — requires a real Kickstart ROM or
external AROS replacement files (aros-ext.bin + aros-rom.bin).
Amiberry is an Amiga emulator based on WinUAE, available as both
standalone and libretro core. No built-in kickstart fallback — a real
Kickstart ROM is required.
Core option "amiberry_kickstart" overrides ROM selection: auto, kick.rom,
kick13.rom, kick20.rom, kick31.rom, kick205.rom, kick40068.A1200,
kick40068.A4000, cd32.rom, cdtv.rom. "auto" selects per model.
ref: libretro/libretro.cpp:558,621-640
Core option "amiberry_kickstart" selects the ROM file:
auto, kick.rom, kick13.rom, kick20.rom, kick31.rom, kick205.rom,
kick40068.A1200, kick40068.A4000, cd32.rom, cdtv.rom.
"auto" selects based on the model option.
ref: BlitterStudio/amiberry/libretro/libretro.cpp:558,621-634
Default model is A500 (KS 1.3). ROM search directories:
save_dir/Kickstarts, system_dir/Kickstarts, system_dir/save-data/Kickstarts,
then system_dir as fallback.
ref: libretro/libretro.cpp:2740-2756
ROM identification uses SHA1 against WinUAE database (340+ entries) but does
not reject unknown ROMs. Cloanto encrypted ROMs supported with rom.key.
Munt MT-32/CM-32L emulation compiled in (WITH_MIDIEMU). ROMs loaded from
mt32-roms/ subdirectory of the ROM path.
ref: src/midiemu.cpp:120-157
WHDLoad autoboot requires whdboot/ directory in system_dir with boot-data.zip,
WHDLoad, AmiQuit, JST, whdload_db.xml. These ship with the standalone build
but must be obtained separately for the libretro core.
ref: libretro/libretro.cpp:1151-1184
Standalone mode ships with data/ directory (UI icons, virtual keyboards,
floppy sounds, AmigaTopaz.ttf font, gamecontrollerdb.txt). These are
compiled into the standalone binary but the libretro core may look for
them in the system directory.
files:
# --- Kickstart ROMs (searched by find_kickstart_in_system_dir) ---
# ref: libretro/libretro.cpp:1502-1565
# --- Required Kickstart ROMs (from .info) ---
# ref: BlitterStudio/amiberry/libretro/libretro.cpp:558
# ref: WinUAE rommgr.cpp for ROM identification
- name: kick13.rom
- name: kick34005.A500
system: commodore-amiga
required: true
size: 262144
note: "A500 Kickstart v1.3 rev 34.005, default for A500 model"
source_ref: "libretro/libretro.cpp:1516 candidates_a500"
crc32: c4f0f55f
note: "A500 Kickstart v1.3 rev 34.5"
source_ref: "libretro-super/dist/info/amiberry_libretro.info firmware0"
- name: kick12.rom
- name: kick37350.A600
system: commodore-amiga
required: false
size: 262144
note: "A500 Kickstart v1.2 rev 33.180, for A500OG model"
source_ref: "libretro/libretro.cpp:1515 candidates_a500og"
- name: kick20.rom
system: commodore-amiga
required: false
required: true
size: 524288
aliases: [kick204.rom]
note: "A500+ Kickstart v2.04 rev 37.175"
source_ref: "libretro/libretro.cpp:1517 candidates_a500p"
- name: kick205.rom
system: commodore-amiga
required: false
size: 524288
note: "A600 Kickstart v2.05 rev 37.350, also used for WHDLoad"
source_ref: "libretro/libretro.cpp:1518 candidates_a600, 1479 pick_whdload_kickstart"
- name: kick31.rom
system: commodore-amiga
required: false
size: 524288
note: "Kickstart v3.1 (generic), first candidate for A1200 and A4000"
source_ref: "libretro/libretro.cpp:1519-1520 candidates_a1200/a4000"
crc32: 43b0df7b
note: "A600 Kickstart v2.05 rev 37.350"
source_ref: "amiberry_libretro.info firmware1"
- name: kick40068.A1200
system: commodore-amiga
required: false
required: true
size: 524288
note: "A1200 Kickstart v3.1 rev 40.68, fallback after kick31.rom"
source_ref: "libretro/libretro.cpp:1519 candidates_a1200"
crc32: 1483a091
note: "A1200 Kickstart v3.1 rev 40.68"
source_ref: "amiberry_libretro.info firmware2"
# --- Optional Kickstart ROMs ---
- name: kick33180.A500
system: commodore-amiga
required: false
size: 262144
crc32: a6ce1636
note: "A500 Kickstart v1.2 rev 33.180"
source_ref: "amiberry_libretro.info firmware3"
- name: kick40068.A4000
system: commodore-amiga
required: false
size: 524288
note: "A4000 Kickstart v3.1 rev 40.68, fallback after kick31.rom"
source_ref: "libretro/libretro.cpp:1520 candidates_a4000"
crc32: d6bae334
note: "A4000 Kickstart v3.1 rev 40.68"
source_ref: "amiberry_libretro.info firmware4"
- name: kick.rom
system: commodore-amiga
required: false
note: "Generic name, any Kickstart ROM. Last resort fallback for all models."
source_ref: "libretro/libretro.cpp:1510-1521 last in all candidate lists"
# --- CD32 ROMs ---
- name: cd32.rom
- name: kick40060.CD32
system: commodore-cd32
required: false
size: 524288
aliases: [amiga-os-310-cd32.rom, kick40060.CD32]
crc32: 1e62d4a5
note: "CD32 Kickstart v3.1 rev 40.60"
source_ref: "libretro/libretro.cpp:1521 candidates_cd32"
source_ref: "amiberry_libretro.info firmware5"
- name: cd32ext.rom
- name: kick40060.CD32.ext
system: commodore-cd32
required: false
size: 524288
aliases: [amiga-ext-310-cd32.rom, "CD32 Extended.ROM"]
note: "CD32 extended ROM rev 40.60. Not needed if using a combined 1MB ROM."
source_ref: "libretro/libretro.cpp:1579 candidates_cd32 (find_ext_rom_in_system_dir)"
crc32: 87746be2
note: "CD32 Extended ROM rev 40.60"
source_ref: "amiberry_libretro.info firmware6"
# --- CDTV ROMs ---
# --- Alternative names accepted by core option ---
# these are common user-facing names, same ROMs as above
- name: cdtv.rom
- name: kick13.rom
system: commodore-amiga
required: false
note: "alias for kick34005.A500 (v1.3)"
source_ref: "libretro.cpp:630"
- name: kick34005.CDTV
system: commodore-cdtv
required: false
aliases: [kick34005.CDTV]
note: "CDTV extended ROM v1.00, used as kickstart candidate"
source_ref: "libretro/libretro.cpp:1522 candidates_cdtv"
note: "CDTV extended ROM"
source_ref: "libretro.cpp:558 cdtv.rom option"
- name: cdtvext.rom
system: commodore-cdtv
required: false
aliases: ["CDTV Extended.ROM"]
note: "CDTV extended ROM file"
source_ref: "libretro/libretro.cpp:1581 candidates_cdtv (find_ext_rom_in_system_dir)"
# --- Standalone data files ---
# --- AROS replacement ROMs ---
# ref: src/memory.cpp:1871-1930 load_kickstart_replacement
- name: aros-ext.bin
- name: AmigaTopaz.ttf
system: commodore-amiga
required: false
hle_fallback: true
note: "AROS extended ROM replacement. Used when no Kickstart ROM is found."
source_ref: "src/memory.cpp:1877 load_kickstart_replacement"
mode: standalone
note: "Amiga Topaz font for UI rendering"
source_ref: "BlitterStudio/amiberry/data/AmigaTopaz.ttf"
- name: aros-rom.bin
- name: gamecontrollerdb.txt
system: commodore-amiga
required: false
hle_fallback: true
note: "AROS main ROM replacement. Used with aros-ext.bin as Kickstart fallback."
source_ref: "src/memory.cpp:1910 load_kickstart_replacement"
# --- Cloanto key ---
- name: rom.key
system: commodore-amiga
required: false
note: "Decryption key for Cloanto Amiga Forever encrypted ROMs"
source_ref: "src/rommgr.cpp:1738 AMIROMTYPE1 decryption"
# --- Munt MT-32/CM-32L MIDI ROMs ---
# Located in mt32-roms/ subdirectory of the ROM path
# ref: src/midiemu.cpp:120-157 midi_emu_add_roms
- name: mt32-roms/mt32_control.rom
system: commodore-amiga
required: false
aliases: [mt32-roms/ctrl_mt32.rom, mt32-roms/MT32_CONTROL.rom]
note: "Roland MT-32 control ROM for Munt MIDI emulation"
source_ref: "src/midiemu.cpp:38-61 mt32ctl candidates, 151-156 load loop"
- name: mt32-roms/pcm_mt32.rom
system: commodore-amiga
required: false
aliases: [mt32-roms/mt32_pcm.rom, mt32-roms/MT32_PCM.rom, mt32-roms/PCM_MT32.rom]
note: "Roland MT-32 PCM ROM for Munt MIDI emulation"
source_ref: "src/midiemu.cpp:133-140 MT-32 PCM loading"
- name: mt32-roms/cm32l_control.rom
system: commodore-amiga
required: false
aliases: [mt32-roms/ctrl_cm32l.rom, mt32-roms/CM32L_CONTROL.rom]
note: "Roland CM-32L control ROM for Munt MIDI emulation"
source_ref: "src/midiemu.cpp:25-37 cm32lctl candidates, 151-156 load loop"
- name: mt32-roms/pcm_cm32l.rom
system: commodore-amiga
required: false
aliases: [mt32-roms/cm32l_pcm.rom, mt32-roms/PCM_CM32L.rom, mt32-roms/CM32L_PCM.rom]
note: "Roland CM-32L PCM ROM for Munt MIDI emulation"
source_ref: "src/midiemu.cpp:142-149 CM-32L PCM loading"
mode: standalone
note: "SDL gamepad mapping database"
source_ref: "BlitterStudio/amiberry/controllers/gamecontrollerdb.txt"

View File

@@ -3,7 +3,7 @@ type: libretro
core_classification: frozen_snapshot
source: "https://github.com/libretro/bsnes2014"
upstream: "https://github.com/bsnes-emu/bsnes"
profiled_date: "2026-03-25"
profiled_date: "2026-03-23"
core_version: "v094"
display_name: "Nintendo - SNES / SFC (bsnes 2014)"
cores: [bsnes2014_accuracy, bsnes2014_balanced, bsnes2014_performance]
@@ -15,23 +15,30 @@ systems:
notes: |
Frozen at bsnes v094. Three build profiles: accuracy (dot-based PPU),
balanced, performance (scanline PPU). All 3 share the same 16 firmware
balanced, performance (scanline PPU). All 3 share the same 18 firmware
files. Profiles only differ in PPU (sfc/profile-*.hpp), not coprocessors.
Performance .info is wrong (firmware_count=17, missing cx4.data.rom).
SPC700 IPL ROM (64 bytes) embedded in target-libretro/libretro.cpp:31.
No HLE fallback for any coprocessor in v094.
Firmware loaded from system_dir via file::exists() + mmapstream.
No hash or size validation on any firmware file.
Libretro build uses heuristics only (ananke/heuristics/), not the SHA256
database (ananke/database/). All DSP1 games use DSP1B filenames via
heuristic fallback. The database dsp1.program.rom / dsp1.data.rom names
are only in the standalone build (target-ethos via ananke).
.info accuracy/balanced: firmware_count=18 (overcounts by 2, includes
phantom dsp1.* from unused database). Performance .info: firmware_count=17
(also missing cx4.data.rom).
DSP1 (non-b) names used via embedded database for specific SHA256-matched
games; DSP1B names used via heuristic fallback for all DSP1/DSP1B games.
Upstream v094 source is contained within the libretro repo (sfc/, ananke/).
bsnes-emu/bsnes is the modern rewrite (v115+).
files:
- name: dsp1.program.rom
system: nintendo-snes
required: false
size: 6144
source_ref: "ananke/database/super-famicom.hpp:5658"
- name: dsp1.data.rom
system: nintendo-snes
required: false
size: 2048
source_ref: "ananke/database/super-famicom.hpp:5659"
- name: dsp1b.program.rom
system: nintendo-snes
required: false

View File

@@ -3,7 +3,7 @@ type: libretro
core_classification: enhanced_fork
source: "https://github.com/libretro/bsnes-mercury"
upstream: "https://byuu.org/higan"
profiled_date: "2026-03-25"
profiled_date: "2026-03-23"
core_version: "v094 (Mercury)"
display_name: "Nintendo - SNES / SFC (bsnes-mercury)"
cores: [bsnes_mercury_accuracy, bsnes_mercury_balanced, bsnes_mercury_performance]
@@ -22,7 +22,7 @@ notes: |
Firmware loaded from system_dir via file::exists + mmapstream.
No hash or size validation on any firmware file.
ref: target-libretro/libretro.cpp:242-264
ref: target-libretro/libretro.cpp:241-263
firmware_appended: firmware can be appended to end of ROM file.
ref: ananke/heuristics/super-famicom.hpp:83

View File

@@ -2,8 +2,7 @@ emulator: "Game & Watch"
type: libretro
core_classification: pure_libretro
source: "https://github.com/libretro/gw-libretro"
upstream: "http://www.madrigaldesign.it/sim/"
profiled_date: "2026-03-25"
profiled_date: "2026-03-21"
core_version: "Git"
display_name: "Handheld Electronic (GW)"
cores:

View File

@@ -3,7 +3,7 @@ type: libretro
core_classification: official_port
source: "https://github.com/timoinutilis/lowres-nx"
upstream: "https://github.com/timoinutilis/lowres-nx"
profiled_date: "2026-03-25"
profiled_date: "2026-03-22"
core_version: "v1.2"
display_name: "LowRes NX"
cores:
@@ -18,10 +18,9 @@ notes: |
the same repository.
retro_load_game() copies the .nx source code into memory
(libretro_main.c:490-493) and compiles it with the built-in interpreter.
The boot intro is a string constant embedded in boot_intro.c:26. Default
characters and charsets are compiled-in C arrays. The core never calls
RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY. No BIOS, firmware, or external
(libretro_main.c:490) and compiles it with the built-in interpreter.
The boot intro is a string constant embedded in boot_intro.c. The core
never accesses the system directory. No BIOS, firmware, or external
files required.
files: []

View File

@@ -7,7 +7,7 @@ type: libretro
core_classification: community_fork
source: "https://github.com/libretro/ps2"
upstream: "https://github.com/PCSX2/pcsx2"
profiled_date: "2026-03-25"
profiled_date: "2026-03-24"
core_version: "Git"
display_name: "Sony - PlayStation 2 (LRPS2)"
cores: [lrps2]
@@ -17,14 +17,12 @@ bios_directory: "pcsx2/bios/"
resources_directory: "pcsx2/resources/"
notes: |
Hard fork of PCSX2 (pre-Qt, 1.7-dev era) ported to libretro. x86_64 only.
BIOS detection is filename-agnostic: scans pcsx2/bios/ for any file between 4-8 MB
with a valid romdir structure (RESET + ROMVER entries). No hash validation.
Companion files (.rom1, .rom2, .nvm, .mec) derive paths from the selected BIOS.
DEV9 (network/HDD) and USB are stubbed in the libretro port.
Widescreen patches are largely compiled into the core (libretro/patches.cpp).
.info firmware_count=2 counts the bios folder and GameIndex.yaml.
.info description mentions EROM.BIN but no EROM loading path exists in the code.
Hard fork of PCSX2 ported to libretro. BIOS detection is filename-agnostic: the core
scans pcsx2/bios/ for any file between 4-8 MB with a valid romdir structure containing
RESET and ROMVER entries. The ROMVER entry determines region and version.
Companion files (.rom1, .rom2, .nvm, .mec) derive their paths from the selected BIOS.
DEV9 (network adapter) and USB are stubbed in the libretro port.
GameIndex.yaml in pcsx2/resources/ provides per-game patches for compatibility.
files:
- name: "<bios>.bin"
@@ -34,7 +32,7 @@ files:
min_size: 4194304
max_size: 8388608
validation: [size]
source_ref: "pcsx2/ps2/BiosTools.cpp:231-254,267-322"
source_ref: "pcsx2/ps2/BiosTools.cpp:230-254,266-322"
note: >
Scans pcsx2/bios/ for any file between 4 MB and 8 MB. Validates via romdir
structure parsing (RESET + ROMVER entries). User selects BIOS via core option
@@ -45,7 +43,7 @@ files:
required: false
max_size: 4194304
description: "DVD player ROM"
source_ref: "pcsx2/ps2/BiosTools.cpp:190-211,314"
source_ref: "pcsx2/ps2/BiosTools.cpp:189-210,313"
note: >
DVD player ROM. Tries <biospath>.rom1 (appended) then <biosbase>.rom1
(extension replaced). Silently skipped if not found.
@@ -53,9 +51,9 @@ files:
- name: "<bios>.rom2"
path: "pcsx2/bios/"
required: false
max_size: 524288
max_size: 4194304
description: "Chinese ROM extension"
source_ref: "pcsx2/ps2/BiosTools.cpp:190-211,315"
source_ref: "pcsx2/ps2/BiosTools.cpp:189-210,314"
note: >
Chinese region ROM extension. Same naming convention as rom1.
Only present on Chinese region consoles.

View File

@@ -3,7 +3,7 @@ type: libretro
core_classification: embedded_hle
source: "https://github.com/libretro/pcsx_rearmed"
upstream: "https://github.com/notaz/pcsx_rearmed"
profiled_date: "2026-03-25"
profiled_date: "2026-03-24"
core_version: "r25"
display_name: "Sony - PlayStation (PCSX ReARMed)"
cores: [pcsx_rearmed, pcsx_rearmed_neon, pcsx_rearmed_interpreter]

View File

@@ -1,39 +0,0 @@
emulator: trident
display_name: "Nintendo - 3DS (Trident)"
type: libretro
core_classification: community_fork
source: https://github.com/DanAlexMorton/3dsTrident
upstream: https://github.com/wheremyfoodat/Panda3DS
profiled_date: 2026-03-25
core_version: git
cores:
- trident
systems:
- 3ds
notes: >-
Libretro core wrapping Panda3DS, an HLE Nintendo 3DS emulator.
Shared font, Mii data, country list and bad word list are embedded in
the binary via CMRC and compiled-in headers. DSP firmware is loaded from
the game ROM at runtime, not from an external file.
DSP modes: HLE (default), LLE (Teakra), Null.
Files are resolved from the RetroArch save directory
(<save_dir>/Emulator Files/sysdata/), not the system directory.
files:
- name: aes_keys.txt
description: AES encryption keys for decrypting encrypted 3DS ROMs
required: false
source_ref: >-
src/emulator.cpp:234,242-244 (path construction and existence check);
src/core/crypto/aes_engine.cpp:13-92 (loadKeys, parses key=value text);
src/core/loader/ncch.cpp:151-164 (panic if encrypted ROM loaded without keys)
- name: seeddb.bin
description: seed database for seed-encrypted 3DS games
required: false
source_ref: >-
src/emulator.cpp:235,246-248 (path construction and existence check);
src/core/crypto/aes_engine.cpp:94-153 (setSeedPath, loadSeeds, getSeedFromDB)

View File

@@ -1,25 +1,27 @@
emulator: TyrQuake
type: libretro
core_classification: game_engine
source: "https://github.com/libretro/tyrquake"
upstream: "http://disenchant.net/tyrquake/"
profiled_date: "2026-03-25"
profiled_date: "2026-03-18"
core_version: "v0.62"
display_name: "Quake (TyrQuake)"
cores: [tyrquake]
systems: [quake]
verification: existence
notes: >
Quake engine source port by Kevin Shanahan (Tyrann). Plays Quake (id1), mission
packs Scourge of Armagon (hipnotic) and Dissolution of Eternity (rogue), Quoth
mod, and custom mods via -game parameter. Content is loaded directly from the
PAK file path — the directory containing the PAK becomes basedir
(libretro.c:988,1050). The engine auto-detects game variant by checking the
content path for id1, hipnotic, rogue, or quoth substrings
(libretro.c:1030-1070). All engine assets (gfx/palette.lmp, gfx/colormap.lmp,
gfx.wad, textures, models, sounds) are loaded from within PAK files via
COM_AddGameDirectory (common.c:1709), which tries pak0.pak through pak9.pak in
both lowercase and uppercase. The core never calls
RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY. BGM as OGG tracks in music/ subfolder
of each game directory.
Quake engine source port. Plays Quake (id1), mission packs Scourge of Armagon
(hipnotic) and Dissolution of Eternity (rogue), Quoth mod, and custom mods via
-game parameter. The core accepts .pak extensions (retro_get_system_info sets
valid_extensions = "pak"). Content is loaded directly from the PAK file path -
the directory containing the PAK becomes basedir (libretro.c:988,1050).
The engine auto-detects game variant by checking the content path for id1,
hipnotic, rogue, or quoth substrings (libretro.c:1030-1070) and passes the
corresponding command-line flag. For non-standard paths it uses -game with the
directory basename. PAK files are game data (maps, textures, models, sounds)
shipped with the original retail game, not engine firmware. The engine checks
for gfx/pop.lmp inside pak0.pak to distinguish registered vs shareware
(common.c:974-991). COM_AddGameDirectory (common.c:1709) loads pak0.pak through
pak9.pak sequentially from the game directory, trying both lowercase and
uppercase filenames. No engine data files are required in the RetroArch system
directory. The core needs no BIOS or firmware.
files: []

View File

@@ -1,64 +1,8 @@
emulator: uae4arm
type: libretro
core_classification: community_fork
cores: [uae4arm]
source: "https://github.com/libretro/uae4arm-libretro"
upstream: "https://github.com/PandTomB/uae4arm"
profiled_date: "2026-03-25"
emulator: "uae4arm"
type: alias
alias_of: "puae"
profiled_date: "2026-03-18"
core_version: "v0.5"
display_name: "Commodore - Amiga (UAE4ARM)"
systems:
- commodore-amiga
notes: |
ARM-optimized Amiga emulator by TomB, ported to libretro by Chips-fr.
Based on an older uae4arm version, intended for low-powered ARM hardware
where PUAE cannot maintain full speed.
Core options expose three models: A500, A600, A1200. Each selects its
Kickstart ROM automatically. Extended ROMs (CDTV/CD32) can be set via
.uae config files but CD32/CDTV hardware emulation is absent from
this port (no akiko chip, CD support listed as missing).
Built-in AROS Kickstart replacement used as fallback when no ROM is found.
Cloanto-encrypted ROMs require rom.key in the system directory.
files:
- name: "kick34005.A500"
description: "Amiga 500 Kickstart v1.3 rev 34.005"
required: false
hle_fallback: true
source_ref: "libretro/core/libretro-core.cpp:73,420 src/memory.cpp:2080-2180"
- name: "kick40063.A600"
description: "Amiga 600 Kickstart v3.1 rev 40.063"
required: false
hle_fallback: true
source_ref: "libretro/core/libretro-core.cpp:74,391 src/memory.cpp:2080-2180"
- name: "kick40068.A1200"
description: "Amiga 1200 Kickstart v3.1 rev 40.068"
required: false
hle_fallback: true
source_ref: "libretro/core/libretro-core.cpp:75,405 src/memory.cpp:2080-2180"
- name: "kick34005.CDTV"
description: "CDTV extended ROM v1.00 rev 34.005"
required: false
source_ref: "src/memory.cpp:1931-1971 (EXTENDED_ROM_CDTV via romextfile)"
- name: "kick40060.CD32"
description: "CD32 Kickstart v3.1 rev 40.060"
required: false
source_ref: "src/memory.cpp:2080-2180 (loaded via romfile from .uae config)"
- name: "kick40060.CD32.ext"
description: "CD32 extended ROM rev 40.060"
required: false
source_ref: "src/memory.cpp:1931-1971 (EXTENDED_ROM_CD32 via romextfile)"
- name: "rom.key"
description: "Cloanto Amiga Forever decryption key"
required: false
source_ref: "src/memory.cpp:598-613,625-700 (addkeydir, load_keyring)"
note: "This core uses the same BIOS/firmware as puae. See emulators/puae.yml for details."
files: []

View File

@@ -1,477 +1,8 @@
emulator: UME 2015
type: libretro
core_classification: frozen_snapshot
source: "https://github.com/libretro/mame2015-libretro"
upstream: "https://github.com/mamedev/mame/tree/mame0159"
logo: "https://raw.githubusercontent.com/mamedev/mame/master/docs/source/images/MAMElogo.svg"
profiled_date: "2026-03-25"
core_version: "0.159"
emulator: "ume2015"
type: alias
alias_of: "mame2016"
profiled_date: "2026-03-18"
core_version: "0.160"
display_name: "Multi (UME 2015)"
mame_version: "0.159"
cores:
- ume2015
systems:
- snk-neogeo-mvs
- snk-neogeo-aes
- igs-pgm
- sega-naomi
- sega-naomi2
- sega-naomigd
- sammy-atomiswave
- sega-stv
- sega-lindbergh
- sega-hikaru
- sega-chihiro
- sega-triforce
- deco-cassette
- nintendo-playch10
- sega-megaplay
- sega-megatech
- nintendo-sfcbox
- nintendo-nss
- philips-cdi
- commodore-cubo
- namco-system246
- namco-system256
- namco-system573
- konami-viper
- taito-gnet
- super-kaneko-nova
- capcom-zn1
- capcom-zn2
- konami-gv
- panasonic-3do
- hyper-neogeo64
- konami-twinkle
notes: |
Universal Machine Emulator — combined MAME + MESS before the official
merge at MAME 0.162. Same repo as mame2015 (mame2015-libretro), built
with -DWANT_UME including both mame.mak and mess.mak. 69 arcade BIOS
root sets (identical to mame2015), plus 619 MESS computer/console
drivers. Source version.c says 0.159, .info claims 0.160.
Paths under system_dir/ume2015/ (samples, artwork, cheat, hash, ini).
Software list hash XMLs in system_dir/ume2015/hash/ (375 files from
repo hash/ directory, required for MESS software list support).
Per-game XML cheats in system_dir/ume2015/cheat/.
hiscore.dat loaded via f.open("hiscore", ".dat") without explicit
search path (libretro-specific path code disabled via #if 0).
ROM naming follows MAME 0.159 conventions.
files:
# Data files (system_dir/ume2015/)
- name: hiscore.dat
required: false
category: game_data
source_ref: "src/emu/hiscore.c:335-337"
note: "high score definitions, external file, not embedded"
# SNK Neo Geo MVS/AES
- name: neogeo.zip
required: true
category: bios_zip
system: snk-neogeo-mvs
source_ref: "src/mame/drivers/neogeo.c:1529"
# IGS PGM
- name: pgm.zip
required: true
category: bios_zip
system: igs-pgm
source_ref: "src/mame/drivers/pgm.c:4147"
# Sega Naomi / Naomi 2 / Naomi GD-ROM / Atomiswave
- name: naomi.zip
required: true
category: bios_zip
system: sega-naomi
source_ref: "src/mame/drivers/naomi.c:8960"
- name: naomi2.zip
required: true
category: bios_zip
system: sega-naomi2
source_ref: "src/mame/drivers/naomi.c:8965"
- name: naomigd.zip
required: true
category: bios_zip
system: sega-naomigd
source_ref: "src/mame/drivers/naomi.c:8966"
- name: awbios.zip
required: true
category: bios_zip
system: sammy-atomiswave
source_ref: "src/mame/drivers/naomi.c:9275"
- name: hod2bios.zip
required: false
category: bios_zip
source_ref: "src/mame/drivers/naomi.c:8961"
note: "game-specific BIOS for House of the Dead 2"
- name: f355dlx.zip
required: false
category: bios_zip
source_ref: "src/mame/drivers/naomi.c:8962"
note: "game-specific BIOS for Ferrari F355 Challenge deluxe"
- name: f355bios.zip
required: false
category: bios_zip
source_ref: "src/mame/drivers/naomi.c:8963"
note: "game-specific BIOS for Ferrari F355 Challenge twin"
- name: airlbios.zip
required: false
category: bios_zip
source_ref: "src/mame/drivers/naomi.c:8964"
note: "game-specific BIOS for Airline Pilots deluxe"
# Sega ST-V
- name: stvbios.zip
required: true
category: bios_zip
system: sega-stv
source_ref: "src/mame/drivers/stv.c:3042"
# Sega Hikaru / Chihiro / Triforce / Lindbergh
- name: hikaru.zip
required: true
category: bios_zip
system: sega-hikaru
source_ref: "src/mame/drivers/hikaru.c:744"
- name: chihiro.zip
required: true
category: bios_zip
system: sega-chihiro
source_ref: "src/mame/drivers/chihiro.c:2192"
- name: triforce.zip
required: true
category: bios_zip
system: sega-triforce
source_ref: "src/mame/drivers/triforce.c:1021"
- name: lindbios.zip
required: true
category: bios_zip
system: sega-lindbergh
source_ref: "src/mame/drivers/lindbergh.c:569"
# DECO Cassette
- name: decocass.zip
required: true
category: bios_zip
system: deco-cassette
source_ref: "src/mame/drivers/decocass.c:1647"
# Nintendo arcade
- name: playch10.zip
required: true
category: bios_zip
system: nintendo-playch10
source_ref: "src/mame/drivers/playch10.c:1639"
- name: nss.zip
required: true
category: bios_zip
system: nintendo-nss
source_ref: "src/mame/drivers/nss.c:1058"
- name: sfcbox.zip
required: true
category: bios_zip
system: nintendo-sfcbox
source_ref: "src/mame/drivers/sfcbox.c:572"
# Sega Mega Drive arcade
- name: megaplay.zip
required: true
category: bios_zip
system: sega-megaplay
source_ref: "src/mame/drivers/megaplay.c:942"
- name: megatech.zip
required: true
category: bios_zip
system: sega-megatech
source_ref: "src/mame/drivers/megatech.c:1393"
# Philips CD-i
- name: cdibios.zip
required: true
category: bios_zip
system: philips-cdi
source_ref: "src/mame/drivers/cdi.c:611"
# Commodore Cubo (CD32-based)
- name: cubo.zip
required: true
category: bios_zip
system: commodore-cubo
source_ref: "src/mame/drivers/cubo.c:1362"
# Namco boards
- name: sys246.zip
required: true
category: bios_zip
system: namco-system246
source_ref: "src/mame/drivers/namcops2.c:672"
- name: sys256.zip
required: true
category: bios_zip
system: namco-system256
source_ref: "src/mame/drivers/namcops2.c:705"
- name: sys573.zip
required: true
category: bios_zip
system: namco-system573
source_ref: "src/mame/drivers/ksys573.c:4678"
# Konami
- name: kviper.zip
required: true
category: bios_zip
system: konami-viper
source_ref: "src/mame/drivers/viper.c:2609"
- name: konamigv.zip
required: true
category: bios_zip
system: konami-gv
source_ref: "src/mame/drivers/konamigv.c:822"
- name: konamigx.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/konamigx.c:3775"
- name: gq863.zip
required: true
category: bios_zip
system: konami-twinkle
source_ref: "src/mame/drivers/twinkle.c:1330"
# Taito
- name: taitogn.zip
required: true
category: bios_zip
system: taito-gnet
source_ref: "src/mame/drivers/taitogn.c:1081"
- name: taitotz.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/taitotz.c:2951"
- name: taitofx1.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/zn.c:4906"
# PSX-based arcade boards (ZN)
- name: cpzn1.zip
required: true
category: bios_zip
system: capcom-zn1
source_ref: "src/mame/drivers/zn.c:4800"
- name: cpzn2.zip
required: true
category: bios_zip
system: capcom-zn2
source_ref: "src/mame/drivers/zn.c:4823"
- name: atpsx.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/zn.c:4853"
- name: acpsx.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/zn.c:4862"
- name: tps.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/zn.c:4873"
- name: vspsx.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/zn.c:4896"
- name: psarc95.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/zn.c:4935"
- name: atluspsx.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/zn.c:4961"
# Super Kaneko Nova System
- name: skns.zip
required: true
category: bios_zip
system: super-kaneko-nova
source_ref: "src/mame/drivers/suprnova.c:1734"
- name: mac2bios.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/macs.c:747"
- name: macsbios.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/macs.c:746"
# Panasonic 3DO
- name: 3dobios.zip
required: true
category: bios_zip
system: panasonic-3do
source_ref: "src/mame/drivers/3do.c:253"
# Hyper Neo-Geo 64
- name: hng64.zip
required: true
category: bios_zip
system: hyper-neogeo64
source_ref: "src/mame/drivers/hng64.c:1991"
# Arcadia Systems
- name: ar_bios.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/arcadia.c:963"
# American Laser Games
- name: alg_bios.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/alg.c:772"
# Aleck64 (N64-based)
- name: aleck64.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/aleck64.c:1161"
# Atari System 1
- name: atarisy1.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/atarisy1.c:2368"
# Exidy Max-A-Flex
- name: maxaflex.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/maxaflex.c:536"
# Crystal System
- name: crysbios.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/crystal.c:1134"
# Galaxy Games
- name: galgbios.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/tmaster.c:1850"
# Aristocrat MK5/MK6
- name: aristmk5.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/aristmk5.c:739"
- name: aristmk6.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/aristmk6.c:224"
- name: mk6nsw11.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/aristmk6.c:225"
# Pinball
- name: allied.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/allied.c:711"
- name: gp_110.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/gp_1.c:531"
- name: gts1.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/gts1.c:978"
- name: gts1s.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/gts1.c:981"
# Other BIOS root sets
- name: bubsys.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/nemesis.c:2707"
- name: isgsm.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/segas16b.c:7501"
- name: iteagle.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/iteagle.c:315"
- name: pyson.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/pyson.c:251"
- name: sammymdl.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/sigmab98.c:2277"
- name: shtzone.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/shtzone.c:121"
- name: su2000.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/su2000.c:296"
- name: tourvis.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/tourvis.c:612"
- name: v4bios.zip
required: true
category: bios_zip
source_ref: "src/mame/drivers/mpu4vid.c:3655"
note: "This core uses the same BIOS/firmware as mame2016. See emulators/mame2016.yml for details."
files: []

View File

@@ -1,16 +1,13 @@
emulator: MicroW8
profiled_date: "2026-03-25"
profiled_date: "2026-03-18"
core_version: "0.2.2"
display_name: "MicroW8"
type: game
core_classification: pure_libretro
source: https://github.com/libretro/uw8-libretro
upstream: https://github.com/exoticorn/microw8
cores: [uw8]
systems: []
files: []
notes: >
WebAssembly-based fantasy console. 320x240 screen, 32-color palette,
256KB memory. The WASM runtime (platform + loader modules) is compiled
to C via wasm2c and embedded in the binary. No external files required.
firmware_count=0 in .info is correct.
MicroW8 is a WebAssembly-based fantasy console with a 320x240 screen,
32-color palette, and a 256KB memory limit. Programs are compiled to
compact WASM modules (.uw8 format). The runtime is fully self-contained
with no external dependencies. No BIOS or system directory files required.

View File

@@ -1,19 +1,15 @@
emulator: UXN
type: libretro
core_classification: community_fork
source: "https://codeberg.org/iyzsong/uxn-libretro"
upstream: "https://github.com/chmod222/zuxn"
profiled_date: "2026-03-25"
core_version: "0.0.1"
type: game
source: "https://github.com/libretro/uxn"
profiled_date: "2026-03-18"
core_version: "0.0.0"
display_name: "Uxn / Varvara (zuxn)"
cores: [uxn]
systems: []
files: []
exclusion_note: >
Uxn/Varvara is a software-defined stack machine with 64KB of memory.
The VM has no firmware or BIOS. ROMs compiled from Uxntal assembly are
loaded directly via libretro game_info. The .info declares no firmware.
notes: >
Libretro wrapper around the zuxn library (Zig implementation of the
Uxn/Varvara spec by Hundred Rabbits). The file device in Varvara handles
ROM-initiated I/O but does not load system files from the system directory.
Libretro port of the Varvara/UXN stack machine designed by Hundred Rabbits.
UXN is a portable 8-bit virtual computer with 64KB of memory and a
minimal instruction set. Loads .rom files compiled from Uxntal assembly.
The VM is entirely software-defined with no firmware or BIOS dependencies.
No system directory files required.

View File

@@ -1,38 +1,46 @@
emulator: uzem
type: libretro
core_classification: pure_libretro
source: "https://github.com/libretro/libretro-uzem"
upstream: "https://github.com/Uzebox/uzebox"
profiled_date: "2026-03-25"
core_version: "v2.0"
profiled_date: "2026-03-18"
core_version: "3.1"
display_name: "Uzem (Uzebox)"
display_name: "Uzebox (Uzem)"
cores:
- uzem
systems:
- uzebox
# No BIOS or firmware files required. The Uzebox is an open-source 8-bit game
# console (ATmega644 AVR MCU) with no proprietary firmware. Games are
# self-contained .uze files loaded directly into progmem
# (uzem_libretro.cpp:254-286, "UZEBOX" magic header + RomHeader + program data).
# Uzem emulates the Uzebox, an open-source 8-bit game console based on an
# ATmega644 AVR microcontroller. The console was designed by Alec Bourque (Uze)
# and all hardware/software is open-source.
#
# The libretro core does not call RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY.
# SD card emulation uses GET_CORE_ASSETS_DIRECTORY (uzem_libretro.cpp:186-192)
# for optional game data via virtual FAT16 filesystem (SDEmulator.cpp).
# EEPROM is handled via RETRO_MEMORY_SAVE_RAM (uzem_libretro.cpp:407-408).
# No BIOS or firmware files are required. The core loads .uze ROM files directly
# into progmem (uzem_libretro.cpp:254-286). The .uze format includes a "UZEBOX"
# magic header followed by a RomHeader struct (uzerom.h) and raw program data.
#
# The standalone uzem supports --boot (PC=0xF000) for bootloader mode
# (uzem.cpp:206) and .hex format loading, neither exposed in the libretro port.
# The standalone uzem (oldsrcs/uzem.cpp:90) has a --boot flag that sets PC to
# 0xF000 for bootloader mode, but this is NOT exposed in the libretro port.
# The libretro core has no retro_environment calls for RETRO_ENVIRONMENT_SET_SYSTEM_DIR
# or any firmware loading paths.
#
# The .info file declares no firmware entries (firmware_count absent).
# SD card emulation uses RETRO_ENVIRONMENT_GET_CORE_ASSETS_DIRECTORY
# (uzem_libretro.cpp:186-192) for virtual FAT16 filesystem access via SDEmulator.cpp,
# but this is optional game data, not system firmware.
#
# The .info file declares no firmware entries.
files: []
notes:
open_source_console: >
Fully open-source hardware and software designed by Alec Bourque.
No proprietary BIOS or bootloader. Games are self-contained .uze files.
The Uzebox is fully open-source hardware and software. There is no proprietary
BIOS or bootloader required. Games are self-contained .uze files that include
all code needed to run on the ATmega644 MCU emulation.
sd_card: >
Some games use SD card access for loading assets. The core reads from the
libretro core assets directory to emulate a FAT16 SD card (game data, not
system firmware).
libretro core assets directory to emulate a FAT16 SD card, but this is game
data, not system firmware.
standalone_bootloader: >
The original standalone uzem supports a --boot flag for bootloader mode
(PC starts at 0xF000 instead of 0x0000). This feature is not available in
the libretro port.

View File

@@ -1,17 +1,14 @@
emulator: VaporSpec
type: libretro
core_classification: official_port
source: "https://github.com/minkcv/vm"
upstream: "https://github.com/minkcv/vm"
profiled_date: "2026-03-25"
type: game
source: "https://github.com/libretro/libretro-vaporspec"
profiled_date: "2026-03-18"
core_version: "GIT"
display_name: "VaporSpec"
cores: [vaporspec]
systems: [vaporspec]
systems: []
files: []
notes: >
Fantasy console with fixed specs (256x192 display, 4-channel audio,
256-color palette). Runs .vaporbin cartridge bundles containing code
and optional ROM data. All content is self-contained in the bundle
passed by the frontend; no system directory files loaded.
firmware_count=0 confirmed by code analysis.
Fantasy console for libretro inspired by retro hardware aesthetics.
Provides a virtual machine with fixed specs (256x192 display, 4-channel
audio) for running homebrew .vaporbin cartridge files.
No BIOS, firmware, or system directory files required.

View File

@@ -1,9 +1,7 @@
emulator: VBA-Next
type: libretro
core_classification: frozen_snapshot
source: "https://github.com/libretro/vba-next"
upstream: "https://github.com/visualboyadvance-m/visualboyadvance-m"
profiled_date: "2026-03-25"
profiled_date: "2026-03-18"
core_version: "SVN"
display_name: "Nintendo - Game Boy Advance (VBA Next)"
cores:
@@ -12,34 +10,64 @@ systems:
- nintendo-gba
notes: |
Frozen snapshot of VBA-M circa 2011, optimized for libretro by Squarepusher.
VBA-Next is a Game Boy Advance emulator forked from VBA-M, optimized for
libretro. It includes a built-in HLE BIOS (myROM array in src/gba.cpp:8423)
that handles all standard SWI calls, so no external BIOS file is needed for
most games.
Built-in HLE BIOS (myROM array, src/gba.cpp:8423) handles all standard SWI
calls. No external BIOS file needed for most games.
BIOS loading is gated behind HAVE_HLE_BIOS (defined in build/Makefile.common)
and controlled by core option vbanext_bios (default: enabled). When enabled,
the libretro port looks for gba_bios.bin in RetroArch's system directory
(libretro/libretro.cpp:198-203). CPUInit() loads the file via utilLoad(),
validates it is exactly 0x4000 bytes (16 KB), and sets useBios = true
(src/gba.cpp:12413-12443). If loading fails or the option is off, the HLE
BIOS (myROM) is memcpy'd into the bios buffer instead.
BIOS loading gated by HAVE_HLE_BIOS (build/Makefile.common:3) and core option
vbanext_bios (default: enabled). When enabled, retro_init resolves gba_bios.bin
in system_dir (libretro/libretro.cpp:198-202). CPUInit loads via utilLoad(),
validates size == 0x4000, sets useBios = true (src/gba.cpp:12430-12438). On
failure, myROM is memcpy'd as HLE fallback (src/gba.cpp:12443).
With real BIOS, execution starts at 0x00000000 (BIOS entry point). Without,
jumps to 0x08000000 (ROM entry), skipping boot animation
(src/gba.cpp:12657-12675).
CPUIsGBABios accepts extensions: .gba, .agb, .bin, .bios, .rom
CPUIsGBABios() accepts extensions: .gba, .agb, .bin, .bios, .rom
(src/gba.cpp:8851-8873).
Upstream VBA-M CPUInit (src/core/gba/gba.cpp:3674-3702) is functionally
identical. No divergences in BIOS handling.
When useBios is true and skipBios is false, execution starts at 0x00000000
(real BIOS entry). Otherwise it jumps straight to 0x08000000 (ROM entry),
skipping the boot animation (src/gba.cpp:12657-12675).
The HLE BIOS covers: SoftReset, RegisterRamReset, Halt, VBlankIntrWait,
Div, Sqrt, ArcTan, ArcTan2, CpuSet, CpuFastSet, GetBiosChecksum,
BgAffineSet, ObjAffineSet, BitUnPack, LZ77UnComp (WRAM/VRAM),
HuffUnComp, RLUnComp (WRAM/VRAM), Diff8bitUnFilter (WRAM/VRAM),
Diff16bitUnFilter, MidiKey2Freq, SndDriverJmpTableCopy
(src/gba.cpp:2369-2578).
Some per-game overrides in gbaover[] (libretro/libretro.cpp:235) have a
useBios field, but all entries currently set it to 0 (no game forces BIOS).
files:
# -------------------------------------------------------
# Game Boy Advance - BIOS (optional, HLE fallback)
# -------------------------------------------------------
- name: gba_bios.bin
system: nintendo-gba
required: false
hle_fallback: true
size: 16384
validation: [size]
description: "GBA BIOS"
note: "Optional. HLE replacement handles all standard SWI calls. Real BIOS adds startup logo and may improve edge-case accuracy."
source_ref: "libretro/libretro.cpp:198-202, src/gba.cpp:12430-12438"
size: 16384 # 16 KB (0x4000)
note: "GBA BIOS. Optional -- HLE replacement (myROM) handles all standard SWI calls. Real BIOS adds startup logo and may improve edge-case accuracy."
source_ref: "libretro/libretro.cpp:198-203, src/gba.cpp:12413-12443"
platform_details:
gba:
bios_size: 16384 # 0x4000
hle_bios: true
source_ref: "src/gba.cpp:8423 (myROM), src/gba.cpp:2369-2578 (SWI handlers)"
notes: |
BIOS buffer is always allocated at 0x4000 bytes (src/gba.cpp:8963).
If the real BIOS loads successfully (exactly 0x4000 bytes), useBios is
set to true and CPUReset starts at address 0x00000000 with IRQ disabled.
Otherwise myROM (built-in HLE stub) is copied in and execution starts
at 0x08000000 with standard register init.
The core option vbanext_bios defaults to "enabled", so if gba_bios.bin
is present in the system directory it will be loaded automatically.
BIOS reads at runtime go through the memory map (src/gba.cpp:792-1076).
Address range 0x0000-0x3FFF maps to the bios buffer. A biosProtected[4]
array at 0x00f029e1 is returned when reading outside the current PC
region, matching real GBA BIOS protection behavior.

View File

@@ -1,49 +1,8 @@
emulator: VBA-M
type: "standalone + libretro"
core_classification: official_port
source: "https://github.com/libretro/vbam-libretro"
upstream: "https://github.com/visualboyadvance-m/visualboyadvance-m"
profiled_date: "2026-03-25"
emulator: "vbam"
type: alias
alias_of: "vba_next"
profiled_date: "2026-03-18"
core_version: "2.1.4"
display_name: "Nintendo - Game Boy Advance (VBA-M)"
cores:
- vbam
systems:
- nintendo-gba
- nintendo-gb
- nintendo-gbc
notes: |
Supports GB, GBC, GBA, and SGB (borders/palette only).
BIOS usage controlled by vbam_usebios core option (default: disabled).
Built-in HLE BIOS (myROM array) handles GBA SWI calls without external file.
GB/GBC boot sequence skipped when BIOS absent.
Upstream repo includes the libretro port in src/libretro/.
files:
- name: gba_bios.bin
system: nintendo-gba
required: false
hle_fallback: true
size: 16384
validation: [size]
description: "GBA BIOS"
source_ref: "src/gba/GBA.cpp:3262-3272 (CPUInit size check), src/libretro/libretro.cpp:846-851 (gba_init)"
- name: gb_bios.bin
system: nintendo-gb
required: false
hle_fallback: true
size: 256
validation: [size]
description: "Game Boy boot ROM"
source_ref: "src/gb/GB.cpp:2172-2192 (gbCPUInit size check), src/libretro/libretro.cpp:861-879 (gb_init)"
- name: gbc_bios.bin
system: nintendo-gbc
required: false
hle_fallback: true
size: 2304
validation: [size]
description: "Game Boy Color boot ROM"
source_ref: "src/gb/GB.cpp:2172-2192 (gbCPUInit size check), src/libretro/libretro.cpp:861-879 (gb_init)"
note: "This core uses the same BIOS/firmware as vba_next. See emulators/vba_next.yml for details."
files: []

View File

@@ -1,9 +1,7 @@
emulator: vecx
type: libretro
core_classification: community_fork
source: "https://github.com/libretro/libretro-vecx"
upstream: "https://github.com/jhawthorn/vecx"
profiled_date: "2026-03-25"
profiled_date: "2026-03-18"
core_version: "SVN"
display_name: "GCE - Vectrex (vecx)"
cores:

View File

@@ -1,9 +1,7 @@
emulator: VeMUlator
type: libretro
core_classification: official_port
source: "https://github.com/libretro/vemulator-libretro"
upstream: "closed-source Android app (removed from Google Play ~2020)"
profiled_date: "2026-03-25"
profiled_date: "2026-03-18"
core_version: "0.1"
display_name: "VeMUlator"
cores:
@@ -12,18 +10,32 @@ systems:
- sega-vmu
notes: |
Sega Dreamcast VMU/VMS emulator. Same author (Mahmoud Jaoune) ported
the original Android Java app to C++ for libretro. Emulates the Sanyo
LC8670 CPU, 128 KB flash, 48x32 LCD, piezo buzzer, and timers.
VeMUlator is a Sega Dreamcast Visual Memory Unit (VMU/VMS) emulator ported
from Android (Java) to C++ for libretro. It emulates the Sanyo LC8670
"Potato" CPU, 128 KB flash memory, 48x32 monochrome LCD, piezo buzzer,
and basic timer subsystems.
No BIOS files required. The core uses HLE exclusively: startCPU()
checks BIOSExists (always false), then initializeHLE() sets SFR
registers and system RAM directly (vmu.cpp:193-222).
No BIOS files are required. The core uses High Level Emulation (HLE) to
bypass the VMU firmware entirely:
A loadBIOS() function exists (vmu.cpp:82-137) handling encrypted and
unencrypted BIOS images, but is never called from the libretro
interface. retro_load_game() only loads game flash data, with no
system directory query. README lists BIOS support as planned.
- At startup, startCPU() checks the BIOSExists flag (vmu.cpp:195). When
false (always, in the libretro port), it calls initializeHLE() which
sets up SFR registers (SP=0x7F, PSW=0x02, IE=0x80, MCR=0x08, P7=0x02,
OCR=0xA3, BTCR=0x41) and system RAM variables directly (vmu.cpp:206-222).
- A loadBIOS() function exists in the VMU class (vmu.cpp:82-137) and can
handle both encrypted (XOR 0x37, 4-byte header stripped) and unencrypted
BIOS images (first byte must be 0x2A = JMPF opcode). Maximum accepted
size is 0xF004 (61444) bytes, loaded into 0xF000 (61440) bytes of ROM.
However, this function is never called by the libretro frontend code.
retro_load_game() in main.cpp only loads game flash data, with no BIOS
path resolution or RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY call.
- The README lists "BIOS support" as a planned future feature.
The .info file declares no firmware entries (firmware_count absent).
Supported ROM formats: VMS (.vms), DCI (.dci), raw flash dump (.bin).
The core option "enable_flash_write" allows persistent saves for .bin files.
files: []

View File

@@ -1,52 +0,0 @@
emulator: "VICE x128"
type: libretro
core_classification: community_fork
source: "https://github.com/libretro/vice-libretro"
upstream: "https://sourceforge.net/projects/vice-emu/"
profiled_date: "2026-03-25"
core_version: "3.10"
display_name: "Commodore - C128 (VICE x128)"
cores: [vice_x128]
systems: [commodore-c128]
notes: >
System ROMs embedded in binary: C128 kernal (318020-05), chargen (390059-01),
BASIC lo (318018-04), BASIC hi (318019-04), C64 kernal (901227-03), C64 BASIC (901226-01),
plus all drive ROMs (1540, 1541, 1541-II, 1551, 1570, 1571, 1571CR, 1581, 1001, 2031,
2040, 3040, 4040, 9000). Embedded ROM check in sysfile_load takes priority over filesystem.
Localized kernal/chargen variants (DE, FI, FR, IT, NO, SE, CH) are in the embedded list
with NULL data pointers; selecting a non-international model produces uninitialized ROM data.
JiffyDOS requires True Drive Emulation enabled and a 1541/1571/1581 drive type.
C64 BASIC/kernal use shared names (basic-901226-01.bin, kernal-901227-03.bin) instead of
upstream c128-specific names (basic64-901226-01.bin, kernal64-901227-03.bin) to share
files with the C64 core in RetroArch's shared system directory.
files:
- name: "JiffyDOS_C128.bin"
description: "JiffyDOS C128 kernal replacement"
required: false
source_ref: "retrodep/ui.c:309-310"
notes: "Loaded into KernalIntName when vice_jiffydos option is enabled."
- name: "JiffyDOS_C64.bin"
description: "JiffyDOS C64 kernal replacement (GO64 mode)"
required: false
source_ref: "retrodep/ui.c:307-308"
notes: "Loaded into Kernal64Name when vice_jiffydos option is enabled."
- name: "JiffyDOS_1541-II.bin"
description: "JiffyDOS 1541-II drive DOS replacement"
required: false
source_ref: "retrodep/ui.c:283-284"
notes: "Loaded into DosName1541ii when vice_jiffydos option is enabled."
- name: "JiffyDOS_1571_repl310654.bin"
description: "JiffyDOS 1571 drive DOS replacement"
required: false
source_ref: "retrodep/ui.c:285-286"
notes: "Loaded into DosName1571 when vice_jiffydos option is enabled."
- name: "JiffyDOS_1581.bin"
description: "JiffyDOS 1581 drive DOS replacement"
required: false
source_ref: "retrodep/ui.c:287-288"
notes: "Loaded into DosName1581 when vice_jiffydos option is enabled."

View File

@@ -1,68 +0,0 @@
emulator: "VICE x64"
type: libretro
core_classification: community_fork
source: "https://github.com/libretro/vice-libretro"
upstream: "https://sourceforge.net/projects/vice-emu/"
profiled_date: "2026-03-25"
core_version: "3.10"
display_name: "Commodore - C64 (VICE x64, fast)"
cores: [vice_x64]
systems: [commodore-c64]
notes: >
System ROMs embedded in binary: C64 BASIC (901226-01), chargen (901225-01),
chargen Japanese (906143-02), kernal Rev 3 (901227-03), kernal GS (390852-01),
kernal SX-64 (251104-04), kernal 4064 (901246-01), kernal Japanese (906145-02),
plus all drive ROMs (1540, 1541, 1541-II, 1551, 1570, 1571, 1571CR, 1581, 1001,
2031, 2040, 3040, 4040, 9000) and VIC-II palettes. Embedded ROM check in
sysfile_load takes priority over filesystem. Kernal Rev 1 (901227-01) and
Rev 2 (901227-02) are NOT embedded; selecting C64 OLD NTSC or C64 OLD PAL model
requires them on the filesystem in system/vice/C64/. JiffyDOS requires True Drive
Emulation enabled and a 1541/1571/1581 drive type. SX-64 models use a separate
JiffyDOS kernal (JiffyDOS_SX-64.bin) not declared in the .info.
files:
- name: "JiffyDOS_C64.bin"
description: "JiffyDOS C64 kernal replacement"
required: false
source_ref: "retrodep/ui.c:302-303"
notes: "Loaded into KernalName when vice_jiffydos option is enabled (non-SX64 models)."
- name: "JiffyDOS_SX-64.bin"
description: "JiffyDOS SX-64 kernal replacement"
required: false
source_ref: "retrodep/ui.c:295-296"
notes: "Loaded into KernalName when vice_jiffydos option is enabled and SX-64 model selected."
- name: "JiffyDOS_1541-II.bin"
description: "JiffyDOS 1541-II drive DOS replacement"
required: false
source_ref: "retrodep/ui.c:283-284"
notes: "Loaded into DosName1541ii when vice_jiffydos option is enabled."
- name: "JiffyDOS_1571_repl310654.bin"
description: "JiffyDOS 1571 drive DOS replacement"
required: false
source_ref: "retrodep/ui.c:285-286"
notes: "Loaded into DosName1571 when vice_jiffydos option is enabled."
- name: "JiffyDOS_1581.bin"
description: "JiffyDOS 1581 drive DOS replacement"
required: false
source_ref: "retrodep/ui.c:287-288"
notes: "Loaded into DosName1581 when vice_jiffydos option is enabled."
- name: "kernal-901227-01.bin"
description: "C64 Kernal Rev 1"
required: false
size: 8192
validation: [size]
source_ref: "vice/src/c64/c64-resources.c:253, vice/src/c64/c64model.c:131"
notes: "Not embedded. Loaded via sysfile from system/vice/C64/ when C64 OLD NTSC model selected."
- name: "kernal-901227-02.bin"
description: "C64 Kernal Rev 2"
required: false
size: 8192
validation: [size]
source_ref: "vice/src/c64/c64-resources.c:254, vice/src/c64/c64model.c:117"
notes: "Not embedded. Loaded via sysfile from system/vice/C64/ when C64 OLD PAL model selected."

View File

@@ -1,34 +0,0 @@
emulator: "VICE x64dtv"
type: libretro
core_classification: community_fork
source: "https://github.com/libretro/vice-libretro"
upstream: "https://sourceforge.net/projects/vice-emu/"
profiled_date: "2026-03-25"
core_version: "3.10"
display_name: "Commodore - C64DTV (VICE x64dtv)"
cores: [vice_x64dtv]
systems: [commodore-c64dtv]
notes: >
System ROMs embedded in binary: C64 BASIC (901226-01), kernal Rev 3
(901227-03), chargen (901225-01), plus all drive ROMs (1540, 1541, 1541-II,
1551, 1570, 1571, 1571CR, 1581, 1001, 2031, 2040, 3040, 4040, 9000).
Embedded ROM check in sysfile_load takes priority over filesystem.
DTV has its own color system (viciidtv-color.c); external palette loading
is disabled. JiffyDOS is not supported (excluded from build conditionals).
The .info declares 4 JiffyDOS firmware (firmware_count=4) but the code
never loads them for this core. The .info also omits dtvrom.bin.
files:
- name: "dtvrom.bin"
description: "C64 DTV 2MB flash ROM image"
required: false
hle_fallback: true
size: 2097152
source_ref: "vice/src/c64dtv/c64dtvflash.c:59-64,470-471,488-505"
notes: >
Loaded via sysfile_load from system/vice/C64DTV/. All model variants
(V2 PAL/NTSC, V3 PAL/NTSC, Hummer) default to this filename. If not
found, the core copies embedded BASIC, kernal and chargen ROMs into
flash memory. Without it, the DTV operates as a basic C64 without the
built-in DTV games and firmware. The original DTV ROM has distorted
colors; a patched ROM is recommended.

View File

@@ -1,69 +0,0 @@
emulator: "VICE x64sc"
type: libretro
core_classification: community_fork
source: "https://github.com/libretro/vice-libretro"
upstream: "https://sourceforge.net/projects/vice-emu/"
profiled_date: "2026-03-25"
core_version: "3.10"
display_name: "Commodore - C64 (VICE x64sc, accurate)"
cores: [vice_x64sc]
systems: [commodore-c64]
notes: >
Cycle-accurate C64 emulator using the viciisc VIC-II implementation.
System ROMs embedded in binary: C64 BASIC (901226-01), chargen (901225-01),
chargen Japanese (906143-02), kernal Rev 3 (901227-03), kernal GS (390852-01),
kernal SX-64 (251104-04), kernal 4064 (901246-01), kernal Japanese (906145-02),
plus all drive ROMs (1540, 1541, 1541-II, 1551, 1570, 1571, 1571CR, 1581, 1001,
2031, 2040, 3040, 4040, 9000) and VIC-II palettes. Embedded ROM check in
sysfile_load takes priority over filesystem. Kernal Rev 1 (901227-01) and
Rev 2 (901227-02) are NOT embedded; selecting C64 OLD NTSC or C64 OLD PAL model
requires them on the filesystem in system/vice/C64/. JiffyDOS requires True Drive
Emulation enabled and a 1541/1571/1581 drive type. SX-64 models use a separate
JiffyDOS kernal (JiffyDOS_SX-64.bin) not declared in the .info.
files:
- name: "JiffyDOS_C64.bin"
description: "JiffyDOS C64 kernal replacement"
required: false
source_ref: "retrodep/ui.c:302-303"
notes: "Loaded into KernalName when vice_jiffydos option is enabled (non-SX64 models)."
- name: "JiffyDOS_SX-64.bin"
description: "JiffyDOS SX-64 kernal replacement"
required: false
source_ref: "retrodep/ui.c:295-296"
notes: "Loaded into KernalName when vice_jiffydos option is enabled and SX-64 model selected."
- name: "JiffyDOS_1541-II.bin"
description: "JiffyDOS 1541-II drive DOS replacement"
required: false
source_ref: "retrodep/ui.c:283-284"
notes: "Loaded into DosName1541ii when vice_jiffydos option is enabled."
- name: "JiffyDOS_1571_repl310654.bin"
description: "JiffyDOS 1571 drive DOS replacement"
required: false
source_ref: "retrodep/ui.c:285-286"
notes: "Loaded into DosName1571 when vice_jiffydos option is enabled."
- name: "JiffyDOS_1581.bin"
description: "JiffyDOS 1581 drive DOS replacement"
required: false
source_ref: "retrodep/ui.c:287-288"
notes: "Loaded into DosName1581 when vice_jiffydos option is enabled."
- name: "kernal-901227-01.bin"
description: "C64 Kernal Rev 1"
required: false
size: 8192
validation: [size]
source_ref: "vice/src/c64/c64-resources.c:253, vice/src/c64/c64scmodel.c:141"
notes: "Not embedded. Loaded via sysfile from system/vice/C64/ when C64 OLD NTSC model selected."
- name: "kernal-901227-02.bin"
description: "C64 Kernal Rev 2"
required: false
size: 8192
validation: [size]
source_ref: "vice/src/c64/c64-resources.c:254, vice/src/c64/c64scmodel.c:123"
notes: "Not embedded. Loaded via sysfile from system/vice/C64/ when C64 OLD PAL model selected."

View File

@@ -1,22 +0,0 @@
emulator: "VICE xcbm2"
type: libretro
core_classification: community_fork
source: "https://github.com/libretro/vice-libretro"
upstream: "https://sourceforge.net/projects/vice-emu/"
profiled_date: "2026-03-25"
core_version: "3.10"
display_name: "Commodore - CBM-II 6x0/7x0 (VICE xcbm2)"
cores: [vice_xcbm2]
systems: [commodore-cbm-ii]
notes: >
System ROMs embedded in binary: chargen 600 (901237-01), chargen 700 (901232-01),
kernal (901244-04a), BASIC 128K (901242+3-04a), BASIC 256K (901240+1-03), plus
all drive ROMs (1001, 2031, 2040, 3040, 4040, 9000) and CRTC palettes (amber,
green, white). Embedded ROM check in sysfile_load takes priority over filesystem.
Models: 610 PAL/NTSC, 620 PAL/NTSC, 620+ PAL/NTSC, 710 NTSC, 720 NTSC,
720+ NTSC. 600 series uses CRTC with 8 scanlines/char, 700 series uses 14
scanlines/char (different chargen ROM). CBM-II uses IEEE-488 bus (not IEC serial),
so no JiffyDOS support. Cartridge slots (Cart1-Cart6) are user content, not system
files.
files: []

View File

@@ -1,19 +0,0 @@
emulator: "VICE xcbm5x0"
type: libretro
core_classification: community_fork
source: "https://github.com/libretro/vice-libretro"
upstream: "https://sourceforge.net/projects/vice-emu/"
profiled_date: "2026-03-25"
core_version: "3.10"
display_name: "Commodore - CBM-II 5x0 (VICE xcbm5x0)"
cores: [vice_xcbm5x0]
systems: [commodore-cbm-ii]
notes: >
System ROMs embedded in binary: chargen 500 (901225-01), kernal 500
(901234-02), BASIC 500 (901235+6-02), plus all drive ROMs (1001, 2031, 2040,
3040, 4040, 9000) and VIC-II palettes. Embedded ROM check in sysfile_load
takes priority over filesystem. Models: 510 PAL/NTSC. CBM-5x0 (P500/C510)
uses VIC-II chip instead of CRTC. IEEE-488 bus (not IEC serial), no JiffyDOS
support. Cartridge slots (Cart1-Cart6) are user content, not system files.
files: []

View File

@@ -1,24 +0,0 @@
emulator: "VICE xpet"
type: libretro
core_classification: community_fork
source: "https://github.com/libretro/vice-libretro"
upstream: "https://sourceforge.net/projects/vice-emu/"
profiled_date: "2026-03-25"
core_version: "3.10"
display_name: "Commodore - PET (VICE xpet)"
cores: [vice_xpet]
systems: [commodore-pet]
notes: >
System ROMs embedded in binary: kernal 1 (901439-04-07), kernal 2 (901465-03),
kernal 4 (901465-22), BASIC 1 (901439-09-05-02-06), BASIC 2 (901465-01-02),
BASIC 4 (901465-23-20-21), chargen 1 (901447-08), chargen 2 (901447-10),
SuperPET chargen (901640-01), 6 editor ROMs (1g40, 2b40, 2g40, 4b40, 4b80, 4g40),
6 SuperPET Waterloo 6809 ROMs (a000-f000), plus all drive ROMs (1540, 1541, 1541-II,
1551, 1570, 1571, 1571CR, 1581, 1001, 2031, 2040, 3040, 4040, 9000) and CRTC
palettes (amber, green, white). Embedded ROM check in sysfile_load takes priority
over filesystem. Models: 2001, 3008, 3016, 3032, 3032B, 4016, 4032, 4032B, 8032,
8096, 8296, SuperPET. PET uses IEEE-488 bus (not IEC serial), so no JiffyDOS support.
No cartridge support. Extension ROM slots ($9000/$A000/$B000) and German chargen
(chargen.de) are standalone-only features not exposed via libretro core options.
files: []

View File

@@ -1,23 +0,0 @@
emulator: "VICE xplus4"
type: libretro
core_classification: community_fork
source: "https://github.com/libretro/vice-libretro"
upstream: "https://sourceforge.net/projects/vice-emu/"
profiled_date: "2026-03-25"
core_version: "3.10"
display_name: "Commodore - PLUS/4 (VICE xplus4)"
cores: [vice_xplus4]
systems: [commodore-plus4]
notes: >
All system ROMs embedded in binary: BASIC (318006-01), kernal PAL (318004-05),
kernal NTSC (318005-05), kernal V232 (318004-01), kernal V364 (364),
3+1 function low (317053-01), 3+1 function high (317054-01), V364 speech ROM
(c2lo-364). All drive ROMs embedded (1540, 1541, 1541-II, 1551, 1570, 1571,
1571CR, 1581, 1001, 2031, 2040, 3040, 4040, 9000). TED palettes embedded
(colodore_ted, BT601, BT709, BT2020, yape-pal, yape-ntsc). Embedded check in
sysfile_load takes priority over filesystem. Models: C16 PAL/NTSC, Plus/4
PAL/NTSC, V364 NTSC, 232 NTSC — all use embedded kernal variants. No JiffyDOS
support (C64/C128/SCPU64 only). 3+1 function ROMs loaded for Plus/4 and V364
models, cleared to 0xFF for C16 and 232 models. c2lo loaded only for V364 model.
files: []

View File

@@ -1,59 +0,0 @@
emulator: "VICE xscpu64"
type: libretro
core_classification: community_fork
source: "https://github.com/libretro/vice-libretro"
upstream: "https://sourceforge.net/projects/vice-emu/"
profiled_date: "2026-03-25"
core_version: "3.10"
display_name: "Commodore - C64 SuperCPU (VICE xscpu64)"
cores: [vice_xscpu64]
systems: [commodore-c64-supercpu]
notes: >
Embedded SCPU64 ROM V0.07 (free replacement by Soci/Singular, 64 KB), chargen
(901225-01, 906143-02), C64 BASIC (901226-01), all C64 kernals (Rev 3, GS,
SX-64, 4064, Japanese), all drive ROMs (1540 through 9000), and VIC-II palettes.
Embedded ROM check in sysfile_load takes priority over filesystem. External
scpu-dos-*.bin provide the original CMD SuperCPU DOS kernals, loaded from
system/vice/SCPU64/ when SuperCPU Kernal core option is changed from Internal.
JiffyDOS requires True Drive Emulation enabled and a non-internal SuperCPU
kernal (the internal ROM is not JiffyDOS-compatible). The .info incorrectly
declares JiffyDOS_C64.bin (firmware_count=4); the C64 kernal replacement is
only loaded for x64/x64sc/x128, never for xscpu64. Correct firmware_count=5
(2 SCPU64 kernals + 3 JiffyDOS drive DOSes).
files:
- name: "scpu-dos-2.04.bin"
description: "CMD SuperCPU Kernal v2.04"
required: false
min_size: 65536
max_size: 524288
validation: [size]
source_ref: "retrodep/ui.c:262-263, vice/src/scpu64/scpu64rom.c:75-89"
notes: "Loaded as SCPU64Name when SuperCPU Kernal option set to 2.04. Size must be power of 2 between 64 KB and 512 KB. Stored in system/vice/SCPU64/."
- name: "scpu-dos-1.4.bin"
description: "CMD SuperCPU Kernal v1.4"
required: false
min_size: 65536
max_size: 524288
validation: [size]
source_ref: "retrodep/ui.c:265-266, vice/src/scpu64/scpu64rom.c:75-89"
notes: "Loaded as SCPU64Name when SuperCPU Kernal option set to 1.40. Size must be power of 2 between 64 KB and 512 KB. Stored in system/vice/SCPU64/."
- name: "JiffyDOS_1541-II.bin"
description: "JiffyDOS 1541-II drive DOS replacement"
required: false
source_ref: "retrodep/ui.c:282-283"
notes: "Loaded as DosName1541ii when JiffyDOS option enabled."
- name: "JiffyDOS_1571_repl310654.bin"
description: "JiffyDOS 1571 drive DOS replacement"
required: false
source_ref: "retrodep/ui.c:285-286"
notes: "Loaded as DosName1571 when JiffyDOS option enabled."
- name: "JiffyDOS_1581.bin"
description: "JiffyDOS 1581 drive DOS replacement"
required: false
source_ref: "retrodep/ui.c:287-288"
notes: "Loaded as DosName1581 when JiffyDOS option enabled."

View File

@@ -1,36 +0,0 @@
emulator: "VICE xvic"
type: libretro
core_classification: community_fork
source: "https://github.com/libretro/vice-libretro"
upstream: "https://sourceforge.net/projects/vice-emu/"
profiled_date: "2026-03-25"
core_version: "3.10"
display_name: "Commodore - VIC-20 (VICE xvic)"
cores: [vice_xvic]
systems: [commodore-vic20]
notes: >
System ROMs embedded in binary: BASIC (901486-01), chargen (901460-03),
kernal PAL Rev 7 (901486-07), kernal NTSC Rev 6 (901486-06), plus all
drive ROMs (1540, 1541, 1541-II, 1551, 1570, 1571, 1571CR, 1581, 1001,
2031, 2040, 3040, 4040, 9000) and VIC palettes. Embedded ROM check in
sysfile_load takes priority over filesystem. Japanese VIC-1001 model
requires kernal Rev 2 (901486-02) and chargen (901460-02) on the
filesystem in system/vice/VIC20/; this model is not exposed via core
options (only via vicerc). No JiffyDOS support for VIC-20.
files:
- name: "kernal.901486-02.bin"
description: "VIC-1001 Kernal Rev 2 (Japanese NTSC)"
required: false
size: 8192
validation: [size]
source_ref: "vice/src/vic20/vic20rom.h:49, vice/src/vic20/vic20model.c:60, vice/src/vic20/vic20rom.c:112-120"
notes: "Not embedded. Loaded via sysfile from system/vice/VIC20/ when VIC-1001 Japanese model selected via vicerc."
- name: "chargen-901460-02.bin"
description: "VIC-1001 Character ROM (Japanese)"
required: false
size: 4096
validation: [size]
source_ref: "vice/src/vic20/vic20rom.h:53, vice/src/vic20/vic20model.c:60, vice/src/vic20/vic20rom.c:173-179"
notes: "Not embedded. Loaded via sysfile from system/vice/VIC20/ when VIC-1001 Japanese model selected via vicerc."

View File

@@ -1,8 +1,7 @@
emulator: vidtest
type: test
core_classification: pure_libretro
source: "https://github.com/schellingb/vidtest_libretro"
profiled_date: "2026-03-25"
source: "https://github.com/libretro/RetroArch"
profiled_date: "2026-03-18"
core_version: "0.1"
display_name: "VidTest"
cores:
@@ -10,9 +9,11 @@ cores:
systems: []
notes: |
Video mode and input test core for libretro frontends. Provides interactive
GUI (Nuklear) to adjust resolution, aspect ratio, timing, and inspect full
input state across all device types. Renders directly to a software surface.
No system files required.
Video test core built into RetroArch (not from libretro-samples). Tests
video driver capabilities: pixel format negotiation, resolution switching,
aspect ratio handling, and frame pacing. Renders test patterns for visual
validation of the video output chain.
No system files, BIOS, or firmware required. Not an emulator.
files: []

View File

@@ -1,10 +1,8 @@
emulator: Vircon32
type: libretro
core_classification: official_port
source: "https://github.com/vircon32/vircon32-libretro"
upstream: "https://github.com/vircon32/ComputerSoftware"
profiled_date: "2026-03-25"
core_version: "2026.2.18"
profiled_date: "2026-03-18"
core_version: "2024.08.28"
display_name: "Vircon32"
cores:
- vircon32
@@ -20,7 +18,7 @@ notes: |
C header (embedded/StandardBios.h), generated from Assets/StandardBios.v32
at build time. The core never strictly requires an external BIOS file.
BIOS loading logic (libretro.cpp:415-429):
BIOS loading logic (libretro.cpp:416-429):
1. Check if system_dir/Vircon32Bios.v32 exists on disk
2. If found, load it via Console.LoadBiosFile() (external override)
3. If not found, load the embedded BIOS via LoadEmbeddedBios()
@@ -46,7 +44,7 @@ files:
size: 1073060
md5: "73f04397cbb2dafcf2047b19a856153a"
sha1: "67ddbcd018f03ed74b6e013074d92cc5f1f51c80"
source_ref: "libretro.cpp:422-425"
source_ref: "libretro.cpp:423-426"
notes: |
Optional external BIOS placed in the system directory root.
If present, overrides the embedded Standard BIOS v1.2.

View File

@@ -1,9 +1,7 @@
emulator: Virtual Jaguar
type: libretro
core_classification: community_fork
source: "https://github.com/libretro/virtualjaguar-libretro"
upstream: "http://shamusworld.gotdns.org/git/virtualjaguar"
profiled_date: "2025-03-25"
profiled_date: "2026-03-18"
core_version: "v2.1.0"
display_name: "Atari - Jaguar (Virtual Jaguar)"
cores:

View File

@@ -1,32 +1,55 @@
emulator: VirtualXT
type: libretro
core_classification: pure_libretro
source: "https://codeberg.org/virtualxt/virtualxt"
upstream: "https://codeberg.org/virtualxt/virtualxt"
profiled_date: "2026-03-25"
core_version: "2.1.0"
source: "https://github.com/libretro/virtualxt"
profiled_date: "2026-03-18"
core_version: "0.9.0"
display_name: "VirtualXT"
cores: [virtualxt]
systems: [ibm-pc]
# All BIOS ROMs are embedded at compile time via Odin's #load() directive.
# No external files are loaded from system_dir in standard operation.
# VirtualXT is a Turbo PC/XT emulator (Intel 8088/186). Written in Odin.
# All BIOS ROMs are embedded at compile time via #load() directives in
# src/frontend/core.odin. No external BIOS files are required at runtime.
# The default machine setup (setup_default_machine) loads these embedded ROMs:
# - BIOS: GLaBIOS 0.2.6 or Turbo XT BIOS 3.1 (user selects via core option)
# - VGA BIOS: vgabios.bin (loaded when VGA video mode is selected)
# - Disk Extension: vxtx.bin (always loaded)
# - RTC BIOS: GLaTICK 0.8.4 (loaded when RTC is enabled)
# Core option "virtualxt_bios" selects between GLaBIOS and TurboXT at startup.
# Core option "virtualxt_video" selects CGA or VGA (VGA loads vgabios.bin).
# Core option "virtualxt_rtc" selects GLaTICK or none (loads GLaTICK_0.8.4_AT.ROM).
# INI config files (.ini extension) can reference external ROM paths, but the
# standard usage path does not require any files in the system directory.
# Embedded BIOS files (shipped inside the compiled core binary):
#
# Embedded ROMs (core.odin:323-394, edge branch):
# GLABIOS.ROM, pcxtbios.bin, vgabios.bin, vxtx.bin, GLaTICK_0.8.4_AT.ROM
#
# INI config files can reference external ROM paths via load_from_file
# (rom.odin:42-68), but this is not the standard usage path.
#
# source_ref: src/frontend/core.odin:323-394 (setup_default_machine, #load)
# source_ref: src/modules/rom/rom.odin:42-68 (load_from_file, INI only)
# source_ref: src/frontend/options.odin:55 (core option virtualxt_bios)
# GLABIOS.ROM 8192 bytes md5:bbeb6f7e2175732eebc3f0b49976347a sha1:701bb8ab0f9797581f795394a5c09eb147ff93d2
# pcxtbios.bin 8192 bytes md5:336bf8888a22075caa09e2e8e4d96a3b sha1:f7b73e441fd7b582a493837658fa17407e851d7c
# vgabios.bin 32768 bytes md5:9c80b0a0784dcf80f84c35b1cc8db81b sha1:251d85a90d3df3d116c30568167587ee3819f623
# vxtx.bin 2048 bytes md5:c6c7eef021e5e40503cb5ae860f02fde sha1:ccd27f24e5d7bd7d14b336be5b79b7ef8ba6e6be
# GLaTICK_0.8.4_AT.ROM 2048 bytes md5:06ead46b977ffb4a056844e2965653eb sha1:025c5d6d9391698488cebad11623ee239ce070a2
# Source references:
# src/frontend/core.odin:295-370 - BIOS embedding via #load("bios:...", []byte)
# src/frontend/options.odin:55 - core option "virtualxt_bios" (GLaBIOS|TurboXT)
# src/modules/rom/rom.odin:42-67 - load_from_file (INI path only)
# bios/ - open-source BIOS files (GLaBIOS, TurboXT, vgabios)
files: []
notes:
bios_approach: >
All BIOS ROMs embedded at compile time via Odin #load() directive.
Open-source replacements: GLaBIOS (GPL), Turbo XT BIOS 3.1, vgabios.
No proprietary IBM PC/XT BIOS needed.
VirtualXT embeds all BIOS ROMs into the core binary at compile time using
Odin's #load() directive. The bios/ directory in the source tree contains
open-source replacements: GLaBIOS (GPL), Turbo XT BIOS 3.1, and vgabios.
No proprietary IBM PC/XT BIOS is needed.
ini_config: >
When loading an .ini file, the core can instantiate ROM modules with external
file paths (rom.odin handles string values for "mem" via load_from_file).
This is an advanced usage path; standard operation needs no external files.
supported_extensions: "img, ini, exe, com"
supported_features: >
Intel 8088/186 CPU, CGA/VGA graphics, EMS memory, ethernet adapter,
host file sharing (RIFS2), GDB server, floppy and hard disk images.

View File

@@ -1,9 +1,7 @@
emulator: vitaQuakeII
type: libretro
core_classification: official_port
source: "https://github.com/libretro/vitaquake2"
upstream: "https://github.com/Rinnegatamante/vitaQuakeII"
profiled_date: "2026-03-25"
profiled_date: "2026-03-18"
core_version: "git"
display_name: "Quake II (vitaQuake 2)"
cores: [vitaquake2, vitaquake2-rogue, vitaquake2-xatrix, vitaquake2-zaero]

View File

@@ -1,21 +1,22 @@
emulator: vitaQuakeIII
type: game
core_classification: community_fork
source: "https://github.com/libretro/vitaquake3"
upstream: "https://github.com/ioquake/ioq3"
profiled_date: "2026-03-25"
profiled_date: "2026-03-18"
core_version: "git"
display_name: "Quake III: Arena (vitaQuake 3)"
cores: [vitaquake3]
cores: [vitaquake3, vitavoyager]
systems: [quake3]
notes: >
Quake III Arena source port built from ioquake3 with the libretro backend.
Also supports Team Arena (missionpack), OpenArena (baseoa), Quake3Rally
(baseq3r), and Urban Terror (q3ut4) via path detection. Content is loaded
from the .pk3 file path - the engine resolves the parent directory structure
to find baseq3/ and loads pak0.pk3 through pak8.pk3 sequentially. Game data
files (.pk3 archives) come from the retail game. No files are required in
the RetroArch system directory.
Quake III Arena and Star Trek Voyager Elite Force source ports. Built from
ioquake3 with the libretro backend. vitaquake3 plays Quake III Arena and
Team Arena, vitavoyager plays Star Trek Voyager Elite Force (Holomatch
multiplayer). Both cores accept .pk3 extensions. Content is loaded from the
.pk3 file path - the engine resolves the parent directory structure to find
baseq3/ (or baseEF/ for vitavoyager) and loads pak0.pk3 through pak8.pk3
sequentially. Game data files (.pk3 archives containing maps, textures,
models, shaders, sounds) come from the retail game, not engine firmware.
No files are required in the RetroArch system directory. The cores need
no BIOS or firmware.
files: []

View File

@@ -1,20 +1,8 @@
emulator: vitavoyager
type: game
core_classification: community_fork
source: "https://github.com/libretro/vitavoyager"
upstream: "https://github.com/zturtleman/lilium-voyager"
profiled_date: "2026-03-25"
emulator: "vitavoyager"
type: alias
alias_of: "vitaquake3"
profiled_date: "2026-03-18"
core_version: "git"
display_name: "Star Trek: Voyager - Elite Force (vitaVoyager)"
cores: [vitavoyager]
systems: [quake3]
notes: >
Star Trek Voyager Elite Force Holomatch (multiplayer) source port built from
Lilium Voyager (itself an ioquake3 fork) with the libretro backend. Content
is loaded from the .pk3 file path - the engine resolves the parent directory
structure to find baseEF/ and loads pak0.pk3 through pak3.pk3 sequentially.
Game data files (.pk3 archives) come from the retail game. No files are
required in the RetroArch system directory.
note: "This core uses the same BIOS/firmware as vitaquake3. See emulators/vitaquake3.yml for details."
files: []

View File

@@ -1,15 +1,15 @@
emulator: WASM-4
type: game
core_classification: game_engine
source: "https://github.com/aduros/wasm4"
upstream: "https://github.com/aduros/wasm4"
profiled_date: "2026-03-25"
profiled_date: "2026-03-18"
core_version: "2.1.0"
display_name: "WASM-4"
cores: [wasm4]
systems: []
files: []
notes: >
Fantasy game console for WebAssembly. 160x160 display, 4-color palette,
1024 bytes persistent storage. Self-contained runtime, no external file
dependencies. Libretro backend is in the upstream repo (no separate fork).
WASM-4 is a low-level fantasy game console for building small games with
WebAssembly. It provides a fixed 160x160 display, 4-color palette, gamepad
input, and 1024 bytes of persistent storage. Games are standalone .wasm
cartridges. The runtime is fully self-contained with no external file
dependencies. No BIOS or system directory files required.

View File

@@ -1,92 +1,83 @@
emulator: "X Millennium"
type: libretro
core_classification: community_fork
source: "https://github.com/libretro/xmil-libretro"
upstream: "http://amethyst.yui.ne.jp/svn/x1/xmil/trunk/"
profiled_date: "2026-03-25"
core_version: "0.60a"
profiled_date: "2026-03-18"
core_version: "0.60"
display_name: "Sharp X1 (X Millennium)"
cores:
- x1
systems:
- sharp-x1
# X Millennium (XMIL) is a Sharp X1 series emulator by yui, ported to libretro
# by r-type. Supports X1, X1 Turbo, and X1 TurboZ models via the "X1_ROMTYPE"
# core option (X1 = ROM_TYPE 1, TURBO = 2, TURBOZ = 3).
#
# SUPPORT_TURBOZ is not compiled in the libretro build (compiler.h), so TurboZ
# extended color modes are unavailable. ROM_TYPE 3 still selects IPLROM.X1T.
# X Millennium (XMIL) is a Sharp X1 series emulator by yui. The libretro port
# supports X1, X1 Turbo, and X1 TurboZ models via the "X1_ROMTYPE" core option
# (values: X1, TURBO, TURBOZ; default: X1 = ROM_TYPE 1).
#
# All system files go under: <system_dir>/xmil/
# retro_init() builds: retro_system_conf = "<system_dir>/xmil" (libretro.c:597)
# (libretro.c:597 builds the path as "<system_dir>/xmil")
#
# IPL ROM loading (memio.c:87-121):
# biosmem is initialized with defaultiplrom (575-byte boot stub from defipl.res).
# ROM_TYPE >= 1: loads external IPL ROM into biosmem, overwriting the stub.
# ROM_TYPE 1 (X1): xmil/IPLROM.X1
# ROM_TYPE >= 2 (Turbo/TurboZ): xmil/IPLROM.X1T
# Path built explicitly: sprintf(rtmp, "%s%c%s", retro_system_conf, slash, iplfile)
# If file missing, the 575-byte stub remains (limited boot capability).
# IPL ROM loading (memio.c:88-116):
# ROM_TYPE 0: uses built-in default IPL (575 bytes, basic boot stub from defipl.res)
# ROM_TYPE 1 (X1): loads xmil/IPLROM.X1 (32 KB)
# ROM_TYPE 2 (Turbo): loads xmil/IPLROM.X1T (32 KB)
# ROM_TYPE 3 (TurboZ): loads xmil/IPLROM.X1T (32 KB, same file as Turbo)
# If the file is missing, the core falls back to the built-in default IPL.
#
# Font loading (fontx1.c:69-122, font.c:89-127):
# font_load(NULL, TRUE) called from pccore_initialize() (pccore.c:67).
# Built-in defaults (defrom_ank, defrom_txt from fontdata.c) provide basic ASCII.
# x1fontread() tries to load external font files via fontopen().
# Font path resolution uses file_getcd() which defaults to "./" in the libretro
# port (file_setcd() is never called). Upstream win9x/sdl2 calls file_setcd()
# to set the working dir. Fonts may not be found from xmil/ in practice.
# Font loading (font.c:90-127, fontx1.c:70-123):
# font_load() calls x1fontread() which looks for font files using fontopen().
# fontopen() resolves paths relative to the working directory (file_getcd()),
# which in libretro context is the xmil subdirectory.
# Built-in defaults (defrom_ank, defrom_txt) are used for basic ASCII rendering.
# External font ROMs add full Japanese character support.
#
# .info declares firmware_count=2 (IPL ROMs only). Font files are not declared.
# .info firmware1_desc incorrectly says "8x8 Font ROM" (actually Turbo IPL ROM).
# The .info file only lists IPLROM.X1 and IPLROM.X1T as required BIOS files.
# Font ROMs are optional -- the core renders basic text without them but Japanese
# kanji display requires the external font files.
notes: |
Place all files in: <system_dir>/xmil/
The core selects between IPLROM.X1 and IPLROM.X1T based on the "X1_ROMTYPE"
core option. A 575-byte built-in IPL stub provides limited boot without the
real ROMs. Font files add Japanese character support; the libretro port has a
path resolution quirk where fonts are searched in "./" instead of "xmil/"
(missing file_setcd call).
core option. A built-in fallback IPL exists but lacks full boot functionality.
Font files are optional; without them, kanji/JIS characters won't render.
files:
# -- IPL ROMs --
- name: IPLROM.X1
path: xmil/IPLROM.X1
size: 32768
required: false
hle_fallback: true
description: "X1 IPL ROM. Loaded when ROM_TYPE=1 (X1 model)."
source_ref: "io/memio.c:82,96-108"
md5: eeeea1cd29c6e0e8b094790ae969bfa7
required: true
note: "X1 IPL ROM (32 KB). Loaded when ROM_TYPE=1 (X1 model). Listed in .info."
source_ref: "io/memio.c:82,96-103"
- name: IPLROM.X1T
path: xmil/IPLROM.X1T
size: 32768
required: false
hle_fallback: true
description: "X1 Turbo/TurboZ IPL ROM. Loaded when ROM_TYPE=2 or 3."
source_ref: "io/memio.c:83,97-108"
md5: 851e4a5936f17d13f8c39a980cf00d77
required: true
note: "X1 Turbo/TurboZ IPL ROM (32 KB). Loaded when ROM_TYPE=2 or 3. Listed in .info."
source_ref: "io/memio.c:83,97-99"
# -- Font ROMs (optional, for Japanese text rendering) --
- name: FNT0808.X1
path: xmil/FNT0808.X1
size: 2048
validation: [size]
required: false
hle_fallback: true
description: "8x8 ANK font ROM. Built-in defrom_ank fallback provides basic ASCII."
note: "8x8 ANK font ROM (2 KB). Provides half-width ASCII/kana characters."
source_ref: "font/fontdata.c:6, font/fontx1.c:79-87"
- name: FNT0816.X1
path: xmil/FNT0816.X1
size: 4096
validation: [size]
required: false
hle_fallback: true
description: "8x16 ANK font ROM. Built-in fallback derived from defrom_ank/defrom_txt."
note: "8x16 ANK font ROM (4 KB). Provides taller half-width characters for text mode."
source_ref: "font/fontdata.c:7, font/fontx1.c:89-103"
- name: FNT1616.X1
path: xmil/FNT1616.X1
size: 306176
validation: [size]
required: false
description: "16x16 Kanji font ROM. No built-in kanji data (zeroed). Required for Japanese text."
note: "16x16 Kanji font ROM (~299 KB). Full JIS kanji character set for Japanese text."
source_ref: "font/fontdata.c:8, font/fontx1.c:105-120"

View File

@@ -1,181 +1,20 @@
emulator: x64sdl
type: libretro
core_classification: community_fork
source: "https://github.com/r-type/sdlvice-libretro"
upstream: "https://sourceforge.net/projects/vice-emu/"
profiled_date: "2026-03-25"
core_version: "3.1"
source: "https://github.com/libretro/vice-libretro"
profiled_date: "2026-03-18"
core_version: "v3.1"
display_name: "Commodore - C64 (VICE SDL)"
cores: [x64sdl]
systems: [commodore-c64]
notes: >
Old port of VICE 3.1 using an SDL-to-libretro shim (r-type/sdlvice-libretro).
Separate codebase from the newer vice-libretro port. Marked experimental and
superseded. Unlike the newer port, this core does NOT embed system ROMs; all ROMs
must be on disk in <system_dir>/data/C64/ and <system_dir>/data/DRIVES/.
The .info declares firmware_count=0 which is incorrect. No JiffyDOS support.
No save states, no netplay, no cheats.
cores:
- vice_x64
systems:
- commodore-c64
files:
# C64 system ROMs (required, path: data/C64/)
- name: "kernal"
description: "C64 Kernal ROM"
required: true
size: 8192
path: "data/C64/kernal"
source_ref: "src/c64/c64rom.c:133, src/c64/c64-resources.c:255"
notes: |
Alias for the VICE x64 core. x64sdl is an alternate build name
referencing the SDL-based VICE x64 Commodore 64 emulator. In the
libretro ecosystem this maps to the same vice_x64 core binary.
- name: "basic"
description: "C64 BASIC ROM"
required: true
size: 8192
path: "data/C64/basic"
source_ref: "src/c64/c64rom.c:192, src/c64/c64-resources.c:258"
See vice.yml for full ROM and BIOS details. All standard ROMs are
embedded in the core binary.
- name: "chargen"
description: "C64 character generator ROM"
required: true
size: 4096
path: "data/C64/chargen"
source_ref: "src/c64/c64rom.c:207, src/c64/c64-resources.c:252"
# C64 variant kernals (optional, for alternate models via c64model.c)
- name: "sxkernal"
description: "SX-64 Kernal ROM"
required: false
size: 8192
path: "data/C64/sxkernal"
source_ref: "src/c64/c64model.c:142,147"
notes: "Loaded when SX64 PAL or SX64 NTSC model selected."
- name: "jpkernal"
description: "Japanese C64 Kernal ROM"
required: false
size: 8192
path: "data/C64/jpkernal"
source_ref: "src/c64/c64model.c:152"
notes: "Loaded when C64 JAP NTSC model selected."
- name: "jpchrgen"
description: "Japanese C64 character generator ROM"
required: false
size: 4096
path: "data/C64/jpchrgen"
source_ref: "src/c64/c64model.c:152"
notes: "Loaded when C64 JAP NTSC model selected."
- name: "gskernal"
description: "C64 Games System Kernal ROM"
required: false
size: 8192
path: "data/C64/gskernal"
source_ref: "src/c64/c64model.c:157"
notes: "Loaded when C64 GS PAL model selected."
- name: "edkernal"
description: "PET64/Educator64 Kernal ROM"
required: false
size: 8192
path: "data/C64/edkernal"
source_ref: "src/c64/c64model.c:162,167"
notes: "Loaded when PET64 PAL or PET64 NTSC model selected."
# IEC drive ROMs (optional, path: data/DRIVES/)
- name: "dos1540"
description: "1540 floppy drive ROM"
required: false
path: "data/DRIVES/dos1540"
source_ref: "src/drive/iec/iecrom.c:99, src/drive/iec/iec-resources.c:182"
notes: "Hardware-level 1540 drive emulation. Absence disables this drive type."
- name: "dos1541"
description: "1541 floppy drive ROM"
required: false
path: "data/DRIVES/dos1541"
source_ref: "src/drive/iec/iecrom.c:106, src/drive/iec/iec-resources.c:185"
notes: "Hardware-level 1541 drive emulation. Most common C64 drive."
- name: "d1541II"
description: "1541-II floppy drive ROM"
required: false
path: "data/DRIVES/d1541II"
source_ref: "src/drive/iec/iecrom.c:113, src/drive/iec/iec-resources.c:187"
- name: "dos1570"
description: "1570 floppy drive ROM"
required: false
path: "data/DRIVES/dos1570"
source_ref: "src/drive/iec/iecrom.c:121, src/drive/iec/iec-resources.c:189"
- name: "dos1571"
description: "1571 floppy drive ROM"
required: false
path: "data/DRIVES/dos1571"
source_ref: "src/drive/iec/iecrom.c:127, src/drive/iec/iec-resources.c:191"
- name: "dos1581"
description: "1581 floppy drive ROM"
required: false
path: "data/DRIVES/dos1581"
source_ref: "src/drive/iec/iecrom.c:133, src/drive/iec/iec-resources.c:193"
- name: "dos2000"
description: "CMD FD-2000 drive ROM"
required: false
path: "data/DRIVES/dos2000"
source_ref: "src/drive/iec/iecrom.c:139, src/drive/iec/iec-resources.c:195"
notes: "Not shipped with VICE 3.1 data files."
- name: "dos4000"
description: "CMD FD-4000 drive ROM"
required: false
path: "data/DRIVES/dos4000"
source_ref: "src/drive/iec/iecrom.c:145, src/drive/iec/iec-resources.c:197"
notes: "Not shipped with VICE 3.1 data files."
# IEEE drive ROMs (optional, path: data/DRIVES/)
- name: "dos2031"
description: "2031 IEEE drive ROM"
required: false
path: "data/DRIVES/dos2031"
source_ref: "src/drive/ieee/ieee.c:115, src/drive/ieee/ieee-resources.c:93"
notes: "IEEE488 interface drive. Requires parallel IEEE488 extension."
- name: "dos2040"
description: "2040 IEEE drive ROM"
required: false
path: "data/DRIVES/dos2040"
source_ref: "src/drive/ieee/ieee.c:116, src/drive/ieee/ieee-resources.c:96"
- name: "dos3040"
description: "3040 IEEE drive ROM"
required: false
path: "data/DRIVES/dos3040"
source_ref: "src/drive/ieee/ieee.c:117, src/drive/ieee/ieee-resources.c:98"
- name: "dos4040"
description: "4040 IEEE drive ROM"
required: false
path: "data/DRIVES/dos4040"
source_ref: "src/drive/ieee/ieee.c:118, src/drive/ieee/ieee-resources.c:100"
- name: "dos1001"
description: "1001/8050/8250 IEEE drive ROM"
required: false
path: "data/DRIVES/dos1001"
source_ref: "src/drive/ieee/ieee.c:119, src/drive/ieee/ieee-resources.c:102"
# Printer ROMs (optional, path: data/PRINTER/)
- name: "mps803"
description: "MPS-803 printer character ROM"
required: false
path: "data/PRINTER/mps803"
source_ref: "src/printerdrv/drv-mps803.c:420"
notes: "Loaded on demand when MPS-803 printer opened."
- name: "nl10-cbm"
description: "NL10 printer ROM"
required: false
path: "data/PRINTER/nl10-cbm"
source_ref: "src/printerdrv/drv-nl10.c:2210"
notes: "Loaded on demand when NL10 printer opened."
files: []

View File

@@ -1,9 +1,7 @@
emulator: XRick
type: libretro
core_classification: game_engine
source: "https://github.com/libretro/xrick-libretro"
upstream: "https://github.com/fabiensanglard/xrick"
profiled_date: "2026-03-25"
profiled_date: "2026-03-18"
core_version: "1.0.0.6"
display_name: "Rick Dangerous (XRick)"
cores:

View File

@@ -1,55 +1,8 @@
emulator: yabasanshiro
type: libretro
core_classification: official_port
source: "https://github.com/libretro/yabause/tree/yabasanshiro"
upstream: "https://github.com/devmiyax/yabause"
profiled_date: "2026-03-25"
emulator: "yabasanshiro"
type: alias
alias_of: "kronos"
profiled_date: "2026-03-18"
core_version: "v2.6.8"
display_name: "Sega - Saturn (YabaSanshiro)"
cores:
- yabasanshiro
systems:
- sega-saturn
notes: |
YabaSanshiro is a Sega Saturn emulator by devmiyax, forked from Yabause.
Requires OpenGL 3.3 or OpenGL ES 3.0.
Saturn BIOS search order:
1. {system}/saturn_bios.bin
2. {system}/sega_101.bin
3. {system}/mpr-17933.bin
First file found wins. Real BIOS required for normal operation.
HLE available via yabasanshiro_force_hle_bios core option (deprecated,
debug only).
Addon cartridges: 1M/4M RAM expansion via core option (no files needed).
ROM cartridge and MPEG card ROM loading disabled in libretro port
(cartpath = empty, mpegpath = NULL).
BIOS loading: libretro.c retro_load_game() lines 1048-1069.
Core load: memory.c LoadBios() line 1353, T123Load() memory.h lines 219-280.
files:
- name: "saturn_bios.bin"
system: sega-saturn
required: true
hle_fallback: true
note: "Primary Saturn BIOS. Any region accepted."
source_ref: "libretro.c:1048"
- name: "sega_101.bin"
system: sega-saturn
region: [japan]
required: false
hle_fallback: true
note: "Saturn BIOS v1.01 (Japan). Fallback if saturn_bios.bin missing."
source_ref: "libretro.c:1052"
- name: "mpr-17933.bin"
system: sega-saturn
region: [north-america, europe]
required: false
hle_fallback: true
note: "Saturn BIOS v1.003 (NA/EU). Last fallback."
source_ref: "libretro.c:1056"
note: "This core uses the same BIOS/firmware as kronos. See emulators/kronos.yml for details."
files: []

View File

@@ -1,61 +1,8 @@
emulator: yabause
type: libretro
core_classification: community_fork
source: "https://github.com/libretro/yabause"
upstream: "https://github.com/Yabause/yabause"
profiled_date: "2026-03-25"
emulator: "yabause"
type: alias
alias_of: "kronos"
profiled_date: "2026-03-18"
core_version: "v0.9.15"
display_name: "Sega - Saturn (Yabause)"
cores:
- yabause
systems:
- sega-saturn
notes: |
Yabause is a software-rendered Sega Saturn emulator. Upstream project is
dead; libretro port maintained by the community on the master branch of
libretro/yabause.
Saturn BIOS search order:
1. {system}/saturn_bios.bin
2. {system}/sega_101.bin
3. {system}/mpr-17933.bin
First file found wins. HLE BIOS available via yabause_force_hle_bios core
option (reduced compatibility). Multi-disc (m3u) requires real BIOS.
Addon cartridges: 1M/4M RAM expansion via core option (no files needed).
ROM cartridge loading, SH1 ROM (CD Block LLE), and MPEG card ROM are
standalone-only features disabled in the libretro port.
BIOS loading: libretro.c retro_load_game() lines 1035-1049.
Core load: memory.c LoadBios() line 1260, T123Load() memory.h lines 196-264.
files:
- name: "saturn_bios.bin"
system: sega-saturn
required: true
hle_fallback: true
max_size: 524288
validation: [max_size]
note: "Primary Saturn BIOS. Any region accepted."
source_ref: "libretro.c:1035"
- name: "sega_101.bin"
system: sega-saturn
region: [japan]
required: false
hle_fallback: true
max_size: 524288
validation: [max_size]
note: "Saturn BIOS v1.01 (Japan). Fallback if saturn_bios.bin missing."
source_ref: "libretro.c:1039"
- name: "mpr-17933.bin"
system: sega-saturn
region: [north-america, europe]
required: false
hle_fallback: true
max_size: 524288
validation: [max_size]
note: "Saturn BIOS (NA/EU). Last fallback."
source_ref: "libretro.c:1043"
note: "This core uses the same BIOS/firmware as kronos. See emulators/kronos.yml for details."
files: []

View File

@@ -1,72 +0,0 @@
emulator: ymir
type: standalone + libretro
core_classification: community_fork
source: "https://github.com/warmenhoven/Ymir/tree/libretro"
upstream: "https://github.com/StrikerX3/Ymir"
profiled_date: "2026-03-25"
core_version: "PR#746"
display_name: "Sega - Saturn (Ymir)"
cores:
- ymir
systems:
- sega-saturn
notes: |
Ymir is a Sega Saturn emulator by StrikerX3. The libretro port by
warmenhoven wraps the shared ymir-core library (PR #746, not yet merged).
No .info file exists in libretro-core-info.
Saturn BIOS search order:
1. {system}/sega_101.bin
2. {system}/mpr-17933.bin
3. {system}/saturn_bios.bin
First file found with exact 512 KiB size wins. No HLE fallback for IPL.
CD Block LLE: optional low-level CD drive emulation. Scans {system}/cdb/
for any 64 KiB file. Falls back to HLE when disabled or no ROM found.
Known versions in upstream db: 1.04, 1.05, 1.06.
ROM cartridges: KoF95 and Ultraman shipped with physical ROM carts. The
core auto-detects required cartridge from its game database.
Addon cartridges: 1M/4M DRAM expansion handled via core option (no files).
Upstream uses XXH128 hashes for ROM identification only, not validation.
All file loading validates size only.
files:
- name: "sega_101.bin"
system: sega-saturn
required: true
size: 524288
validation: [size]
aliases: [mpr-17933.bin, saturn_bios.bin]
description: "Saturn IPL ROM (BIOS). Any region accepted."
source_ref: "libretro.cpp:260-263,534-558"
- name: "cdb/cdb_rom.bin"
system: sega-saturn
required: false
hle_fallback: true
size: 65536
validation: [size]
description: "SH1 CD Block ROM for low-level CD drive emulation. Core scans cdb/ subdirectory for any matching file."
source_ref: "libretro.cpp:567-591"
- name: "mpr-18811-mx.ic1"
system: sega-saturn
required: false
category: game_data
size: 2097152
validation: [size]
description: "ROM cartridge for The King of Fighters '95."
source_ref: "libretro.cpp:619-620,597-616"
- name: "mpr-19367-mx.ic1"
system: sega-saturn
required: false
category: game_data
size: 2097152
validation: [size]
description: "ROM cartridge for Ultraman: Hikari no Kyojin Densetsu."
source_ref: "libretro.cpp:619,621,597-616"

View File

@@ -24,7 +24,6 @@ theme:
- navigation.tabs
- navigation.sections
- navigation.top
- navigation.indexes
- search.suggest
- search.highlight
- content.tabs.link
@@ -33,13 +32,8 @@ markdown_extensions:
- tables
- admonition
- attr_list
- md_in_html
- toc:
permalink: true
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
plugins:
- search
nav:
@@ -52,9 +46,7 @@ nav:
- Recalbox: platforms/recalbox.md
- RetroArch: platforms/retroarch.md
- RetroBat: platforms/retrobat.md
- RetroDECK: platforms/retrodeck.md
- RetroPie: platforms/retropie.md
- RomM: platforms/romm.md
- Systems:
- Overview: systems/index.md
- 3DO Company: systems/3do-company.md
@@ -64,7 +56,6 @@ nav:
- Apple: systems/apple.md
- Arcade: systems/arcade.md
- Atari: systems/atari.md
- BBK: systems/bbk.md
- Bally: systems/bally.md
- Bandai: systems/bandai.md
- Bit Corporation: systems/bit-corporation.md
@@ -88,27 +79,20 @@ nav:
- GamePark: systems/gamepark.md
- Grundy: systems/grundy.md
- Hartung: systems/hartung.md
- IBM: systems/ibm.md
- Id Software: systems/id-software.md
- Infocom: systems/infocom.md
- Java: systems/java.md
- Jupiter: systems/jupiter.md
- Lambda: systems/lambda.md
- Lexaloffle: systems/lexaloffle.md
- Magnavox: systems/magnavox.md
- Mattel: systems/mattel.md
- Microdigital: systems/microdigital.md
- Microsoft: systems/microsoft.md
- NEC: systems/nec.md
- Nintendo: systems/nintendo.md
- Nokia: systems/nokia.md
- Oric: systems/oric.md
- Other: systems/other.md
- Palm: systems/palm.md
- Philips: systems/philips.md
- Pioneer: systems/pioneer.md
- RPG Maker: systems/rpg-maker.md
- Ringo: systems/ringo.md
- SNK: systems/snk.md
- ScummVM: systems/scummvm.md
- Sega: systems/sega.md
@@ -119,7 +103,6 @@ nav:
- Tandy: systems/tandy.md
- Texas Instruments: systems/texas-instruments.md
- Tiger: systems/tiger.md
- Timex: systems/timex.md
- Tomy: systems/tomy.md
- VTech: systems/vtech.md
- Videoton: systems/videoton.md
@@ -128,294 +111,192 @@ nav:
- xrick: systems/xrick.md
- Emulators:
- Overview: emulators/index.md
- Official ports (60):
- amiarcadia: emulators/amiarcadia.md
- Amiberry: emulators/amiberry.md
- Ardens: emulators/ardens.md
- Atari800: emulators/atari800.md
- BlastEm: emulators/blastem.md
- Boytacean: emulators/boytacean.md
- bsnes: emulators/bsnes.md
- ClownMDEmu: emulators/clownmdemu.md
- CrocoDS: emulators/crocods.md
- DirkSimple: emulators/dirksimple.md
- DuckStation: emulators/duckstation.md
- emux (CHIP-8): emulators/emux_chip8.md
- emux (Game Boy): emulators/emux_gb.md
- emux (NES): emulators/emux_nes.md
- emux (SMS): emulators/emux_sms.md
- FinalBurn Neo: emulators/fbneo.md
- FinalBurn Neo (CPS-1/CPS-2): emulators/fbneo_cps12.md
- FinalBurn Neo (Neo Geo): emulators/fbneo_neogeo.md
- fixGB: emulators/fixgb.md
- fixNES: emulators/fixnes.md
- Flycast: emulators/flycast.md
- FreeJ2ME: emulators/freej2me.md
- galaksija: emulators/galaksija.md
- Gearboy: emulators/gearboy.md
- Gearcoleco: emulators/gearcoleco.md
- Geargrafx: emulators/geargrafx.md
- Gearlynx: emulators/gearlynx.md
- Gearsystem: emulators/gearsystem.md
- Geolith: emulators/geolith.md
- Holani: emulators/holani.md
- JAXE: emulators/jaxe.md
- JollyCV: emulators/jollycv.md
- Kronos: emulators/kronos.md
- LowRes NX: emulators/lowresnx.md
- M2000: emulators/m2000.md
- MAME: emulators/mame.md
- MAME Arcade: emulators/mamearcade.md
- MAME MESS: emulators/mamemess.md
- Mesen: emulators/mesen.md
- mesen-s: emulators/mesen-s.md
- mGBA: emulators/mgba.md
- Mr.Boom: emulators/mrboom.md
- Panda3DS: emulators/panda3ds.md
- PicoDrive: emulators/picodrive.md
- play: emulators/play.md
- PPSSPP: emulators/ppsspp.md
- Rustation: emulators/rustation.md
- RVVM: emulators/rvvm.md
- SameBoy: emulators/sameboy.md
- sameduck: emulators/sameduck.md
- SDLPAL: emulators/sdlpal.md
- skyemu: emulators/skyemu.md
- snes9x: emulators/snes9x.md
- SquirrelJME: emulators/squirreljme.md
- VaporSpec: emulators/vaporspec.md
- VBA-M: emulators/vbam.md
- VeMUlator: emulators/vemulator.md
- Vircon32: emulators/vircon32.md
- vitaQuakeII: emulators/vitaquake2.md
- yabasanshiro: emulators/yabasanshiro.md
- Community forks (104):
- EightyOne: emulators/81.md
- a5200: emulators/a5200.md
- Anarch: emulators/anarch.md
- AppleWin: emulators/applewin.md
- Azahar: emulators/azahar.md
- b2: emulators/b2.md
- Beetle Lynx (Mednafen Lynx): emulators/beetle_lynx.md
- Beetle NGP (Mednafen Neo Geo Pocket): emulators/beetle_ngp.md
- Beetle PCE (Mednafen PCE): emulators/beetle_pce.md
- Beetle PC-FX (Mednafen): emulators/beetle_pcfx.md
- Beetle PSX (Mednafen PSX): emulators/beetle_psx.md
- beetle_saturn: emulators/beetle_saturn.md
- Beetle VB (Mednafen Virtual Boy): emulators/beetle_vb.md
- BennuGD: emulators/bennugd.md
- bk-emulator: emulators/bk.md
- blueMSX: emulators/bluemsx.md
- bsnes-jg: emulators/bsnes-jg.md
- Caprice32: emulators/cap32.md
- ChimeraSNES: emulators/chimerasnes.md
- Citra: emulators/citra.md
- Citra Canary: emulators/citra_canary.md
- Daphne: emulators/daphne.md
- DeSmuME: emulators/desmume.md
- DICE: emulators/dice.md
- Dolphin: emulators/dolphin.md
- DOSBox: emulators/dosbox.md
- DOSBox-core: emulators/dosbox_core.md
- DOSBox-SVN: emulators/dosbox_svn.md
- DOSBox-SVN CE: emulators/dosbox_svn_ce.md
- EmuSCV: emulators/emuscv.md
- ep128emu_core: emulators/ep128emu_core.md
- FCEUmm: emulators/fceumm.md
- fMSX: emulators/fmsx.md
- Frodo: emulators/frodo.md
- FS-UAE: emulators/fsuae.md
- Fuse: emulators/fuse.md
- Gambatte: emulators/gambatte.md
- Genesis Plus GX: emulators/genesis_plus_gx.md
- gpSP: emulators/gpsp.md
- Handy: emulators/handy.md
- higan (SFC Accuracy): emulators/higan_sfc.md
- LRPS2: emulators/lrps2.md
- mednafen_pce: emulators/mednafen_pce.md
- mednafen_pce_fast: emulators/mednafen_pce_fast.md
- mednafen_supafaust: emulators/mednafen_supafaust.md
- mednafen_supergrafx: emulators/mednafen_supergrafx.md
- melonDS: emulators/melonds.md
- melonDS DS: emulators/melonds_ds.md
- Meteor GBA: emulators/meteor.md
- Mini vMac: emulators/minivmac.md
- Moonlight: emulators/moonlight.md
- mpv: emulators/mpv.md
- nekop2: emulators/nekop2.md
- nes: emulators/nes.md
- Nestopia UE: emulators/nestopia.md
- NooDS: emulators/noods.md
- Numero: emulators/numero.md
- O2EM: emulators/o2em.md
- Oberon: emulators/oberon.md
- ONScripter: emulators/onscripter.md
- Opera (4DO): emulators/opera.md
- ParaLLEl N64: emulators/parallel_n64.md
- PCem: emulators/pcem.md
- PCSX1: emulators/pcsx1.md
- PD777: emulators/pd777.md
- PokeMini: emulators/pokemini.md
- Potator: emulators/potator.md
- ProSystem: emulators/prosystem.md
- PUAE (P-UAE): emulators/puae.md
- px68k: emulators/px68k.md
- QEMU: emulators/qemu.md
- QUASI88: emulators/quasi88.md
- QuickNES: emulators/quicknes.md
- RACE (Neo Geo Pocket): emulators/race.md
- REminiscence: emulators/reminiscence.md
- RetroDream: emulators/retrodream.md
- SAME CDi: emulators/same_cdi.md
- SimCoupe: emulators/simcp.md
- swanstation: emulators/swanstation.md
- Syobon Action: emulators/syobonaction.md
- TamaLIBretro: emulators/tamalibretro.md
- TempGBA: emulators/tempgba.md
- TGB Dual: emulators/tgbdual.md
- trident: emulators/trident.md
- uae4arm: emulators/uae4arm.md
- UXN: emulators/uxn.md
- vecx: emulators/vecx.md
- VICE x128: emulators/vice_x128.md
- VICE x64: emulators/vice_x64.md
- VICE x64dtv: emulators/vice_x64dtv.md
- VICE x64sc: emulators/vice_x64sc.md
- VICE xcbm2: emulators/vice_xcbm2.md
- VICE xcbm5x0: emulators/vice_xcbm5x0.md
- VICE xpet: emulators/vice_xpet.md
- VICE xplus4: emulators/vice_xplus4.md
- VICE xscpu64: emulators/vice_xscpu64.md
- VICE xvic: emulators/vice_xvic.md
- Virtual Jaguar: emulators/virtualjaguar.md
- vitaQuakeIII: emulators/vitaquake3.md
- vitavoyager: emulators/vitavoyager.md
- X Millennium: emulators/x1.md
- x64sdl: emulators/x64sdl.md
- yabause: emulators/yabause.md
- ymir: emulators/ymir.md
- Pure libretro (29):
- '2048': emulators/2048.md
- 3DEngine: emulators/3dengine.md
- Arduous: emulators/arduous.md
- Beetle WonderSwan (Mednafen WonderSwan): emulators/beetle_wswan.md
- Craft: emulators/craft.md
- Cruzes: emulators/cruzes.md
- DirectXBox: emulators/directxbox.md
- FFmpeg: emulators/ffmpeg.md
- FreeChaF: emulators/freechaf.md
- FreeIntv: emulators/freeintv.md
- GAM4980: emulators/gam4980.md
- Game Music Emu: emulators/gme.md
- Gong: emulators/gong.md
- Game & Watch: emulators/gw.md
- Image Viewer: emulators/imageviewer.md
- MCSoftserve: emulators/mcsoftserve.md
- MojoZork: emulators/mojozork.md
- Mu: emulators/mu.md
- NeoCD: emulators/neocd.md
- Pascal Pong: emulators/pascal_pong.md
- PocketCDG: emulators/pocketcdg.md
- Redbook: emulators/redbook.md
- RemoteJoy: emulators/remotejoy.md
- ROM Cleaner: emulators/romcleaner.md
- Theodore: emulators/theodore.md
- The Powder Toy: emulators/thepowdertoy.md
- MicroW8: emulators/uw8.md
- uzem: emulators/uzem.md
- VirtualXT: emulators/virtualxt.md
- Game engines (24):
- boom3: emulators/boom3.md
- Cannonball: emulators/cannonball.md
- ChaiLove: emulators/chailove.md
- Dinothawr: emulators/dinothawr.md
- doukutsu-rs: emulators/doukutsu_rs.md
- EasyRPG Player: emulators/easyrpg.md
- ECWolf: emulators/ecwolf.md
- FAKE-08: emulators/fake08.md
- Jump 'n Bump: emulators/jumpnbump.md
- Lutro: emulators/lutro.md
- mkxp-z: emulators/mkxp_z.md
- NXEngine: emulators/nxengine.md
- ONScripter Yuri: emulators/onsyuri.md
- OpenLara: emulators/openlara.md
- OpenTyrian: emulators/opentyrian.md
- PrBoom: emulators/prboom.md
- PuzzleScript: emulators/puzzlescript.md
- Retro8: emulators/retro8.md
- ScummVM: emulators/scummvm.md
- Super Bros War: emulators/superbroswar.md
- TIC-80: emulators/tic80.md
- TyrQuake: emulators/tyrquake.md
- WASM-4: emulators/wasm4.md
- XRick: emulators/xrick.md
- Enhanced forks (12):
- bsnes-hd beta: emulators/bsnes_hd_beta.md
- bsnes-mercury: emulators/bsnes_mercury.md
- DOSBox Pure: emulators/dosbox_pure.md
- DoubleCherryGB: emulators/doublecherrygb.md
- Genesis Plus GX Wide: emulators/genesis_plus_gx_wide.md
- HBMAME (Homebrew MAME): emulators/hbmame.md
- nSide (SFC Balanced): emulators/higan_sfc_balanced.md
- Ishiiruka: emulators/ishiiruka.md
- MAME 2003-Plus: emulators/mame2003_plus.md
- Mupen64Plus-Next: emulators/mupen64plus_next.md
- NP2kai: emulators/np2kai.md
- SMS Plus GX: emulators/smsplus.md
- Frozen snapshots (32):
- bnes: emulators/bnes.md
- bsnes 2014: emulators/bsnes2014.md
- bsnes C++98: emulators/bsnes_cplusplus98.md
- CDi 2015: emulators/cdi2015.md
- Citra 2018: emulators/citra2018.md
- DeSmuME 2015: emulators/desmume2015.md
- FB Alpha 2012: emulators/fbalpha2012.md
- FB Alpha 2012 CPS-1: emulators/fbalpha2012_cps1.md
- FB Alpha 2012 CPS-2: emulators/fbalpha2012_cps2.md
- FB Alpha 2012 CPS-3: emulators/fbalpha2012_cps3.md
- FB Alpha 2012 Neo Geo: emulators/fbalpha2012_neogeo.md
- Hatari: emulators/hatari.md
- MAME 2000: emulators/mame2000.md
- MAME 2003: emulators/mame2003.md
- MAME 2003 Midway: emulators/mame2003_midway.md
- MAME 2009: emulators/mame2009.md
- MAME 2010: emulators/mame2010.md
- MAME 2015: emulators/mame2015.md
- MAME 2016: emulators/mame2016.md
- mednafen_gba: emulators/mednafen_gba.md
- mednafen_snes: emulators/mednafen_snes.md
- MESS 2015: emulators/mess2015.md
- PUAE 2021: emulators/puae2021.md
- Snes9x 2002: emulators/snes9x2002.md
- Snes9x 2005: emulators/snes9x2005.md
- Snes9x 2005 Plus: emulators/snes9x2005_plus.md
- Snes9x 2010: emulators/snes9x2010.md
- Stella 2014: emulators/stella2014.md
- Stella 2023: emulators/stella2023.md
- Stone Soup: emulators/stonesoup.md
- UME 2015: emulators/ume2015.md
- VBA-Next: emulators/vba_next.md
- Embedded HLE (1):
- PCSX-ReARMed: emulators/pcsx_rearmed.md
- Launchers (1):
- Dolphin Launcher: emulators/dolphin_launcher.md
- Other (10):
- Beetle GBA (Mednafen): emulators/beetle_gba.md
- Cemu: emulators/cemu.md
- ep128emu-core: emulators/ep128emu.md
- PCSX2: emulators/pcsx2.md
- Redream: emulators/redream.md
- RPCS3: emulators/rpcs3.md
- VBA-M: emulators/vba_m.md
- VICE: emulators/vice.md
- Vita3K: emulators/vita3k.md
- Xemu: emulators/xemu.md
- Cross-reference: cross-reference.md
- '2048': emulators/2048.md
- 3DEngine: emulators/3dengine.md
- EightyOne: emulators/81.md
- a5200: emulators/a5200.md
- amiarcadia: emulators/amiarcadia.md
- Anarch: emulators/anarch.md
- AppleWin: emulators/applewin.md
- Ardens: emulators/ardens.md
- Arduous: emulators/arduous.md
- Atari800: emulators/atari800.md
- b2: emulators/b2.md
- Beetle Lynx (Mednafen Lynx): emulators/beetle_lynx.md
- Beetle NGP (Mednafen Neo Geo Pocket): emulators/beetle_ngp.md
- Beetle PCE (Mednafen PCE): emulators/beetle_pce.md
- Beetle PC-FX (Mednafen): emulators/beetle_pcfx.md
- Beetle PSX (Mednafen PSX): emulators/beetle_psx.md
- Beetle Saturn (Mednafen): emulators/beetle_saturn.md
- Beetle VB (Mednafen Virtual Boy): emulators/beetle_vb.md
- Beetle WonderSwan (Mednafen WonderSwan): emulators/beetle_wswan.md
- BennuGD: emulators/bennugd.md
- bk-emulator: emulators/bk.md
- BlastEm: emulators/blastem.md
- blueMSX: emulators/bluemsx.md
- bnes: emulators/bnes.md
- boom3: emulators/boom3.md
- Boytacean: emulators/boytacean.md
- bsnes: emulators/bsnes.md
- Cannonball: emulators/cannonball.md
- Caprice32: emulators/cap32.md
- Cemu: emulators/cemu.md
- ChaiLove: emulators/chailove.md
- Citra / Lime3DS / Azahar: emulators/citra.md
- ClownMDEmu: emulators/clownmdemu.md
- Craft: emulators/craft.md
- CrocoDS: emulators/crocods.md
- Cruzes: emulators/cruzes.md
- Daphne: emulators/daphne.md
- DeSmuME: emulators/desmume.md
- DICE: emulators/dice.md
- Dinothawr: emulators/dinothawr.md
- DirectXBox: emulators/directxbox.md
- Dolphin: emulators/dolphin.md
- Dolphin Launcher: emulators/dolphin_launcher.md
- DOSBox-core: emulators/dosbox_core.md
- DOSBox Pure: emulators/dosbox_pure.md
- DoubleCherryGB: emulators/doublecherrygb.md
- doukutsu-rs: emulators/doukutsu_rs.md
- DuckStation: emulators/duckstation.md
- EasyRPG Player: emulators/easyrpg.md
- ECWolf: emulators/ecwolf.md
- EmuSCV: emulators/emuscv.md
- emux (CHIP-8): emulators/emux_chip8.md
- ep128emu-core: emulators/ep128emu.md
- FAKE-08: emulators/fake08.md
- FinalBurn Neo: emulators/fbneo.md
- FCEUmm: emulators/fceumm.md
- FFmpeg: emulators/ffmpeg.md
- fixGB: emulators/fixgb.md
- Flycast: emulators/flycast.md
- fMSX: emulators/fmsx.md
- FreeChaF: emulators/freechaf.md
- FreeIntv: emulators/freeintv.md
- FreeIntv (Touchscreen Overlay): emulators/freeintv_ts_overlay.md
- FreeJ2ME: emulators/freej2me.md
- Frodo: emulators/frodo.md
- Fuse: emulators/fuse.md
- galaksija: emulators/galaksija.md
- GAM4980: emulators/gam4980.md
- Gambatte: emulators/gambatte.md
- Gearcoleco: emulators/gearcoleco.md
- Geargrafx: emulators/geargrafx.md
- Gearlynx: emulators/gearlynx.md
- Gearsystem: emulators/gearsystem.md
- Genesis Plus GX: emulators/genesis_plus_gx.md
- Geolith: emulators/geolith.md
- Game Music Emu: emulators/gme.md
- Gong: emulators/gong.md
- gpSP: emulators/gpsp.md
- Game & Watch: emulators/gw.md
- Handy: emulators/handy.md
- Hatari: emulators/hatari.md
- HBMAME (Homebrew MAME): emulators/hbmame.md
- Holani: emulators/holani.md
- Image Viewer: emulators/imageviewer.md
- Ishiiruka: emulators/ishiiruka.md
- JAXE: emulators/jaxe.md
- JollyCV: emulators/jollycv.md
- Jump 'n Bump: emulators/jumpnbump.md
- Kronos: emulators/kronos.md
- LowRes NX: emulators/lowresnx.md
- Lutro: emulators/lutro.md
- M2000: emulators/m2000.md
- MAME 2003-Plus: emulators/mame2003_plus.md
- MAME 2010: emulators/mame2010.md
- MAME 2016: emulators/mame2016.md
- MCSoftserve: emulators/mcsoftserve.md
- MelonDS: emulators/melonds.md
- Mesen: emulators/mesen.md
- Meteor GBA: emulators/meteor.md
- mGBA: emulators/mgba.md
- Mini vMac: emulators/minivmac.md
- mkxp-z: emulators/mkxp_z.md
- MojoZork: emulators/mojozork.md
- Moonlight: emulators/moonlight.md
- mpv: emulators/mpv.md
- Mr.Boom: emulators/mrboom.md
- Mu: emulators/mu.md
- Mupen64Plus-Next: emulators/mupen64plus.md
- NeoCD: emulators/neocd.md
- Nestopia UE: emulators/nestopia.md
- NooDS: emulators/noods.md
- NP2kai: emulators/np2kai.md
- Numero: emulators/numero.md
- NXEngine: emulators/nxengine.md
- O2EM: emulators/o2em.md
- Oberon: emulators/oberon.md
- ONScripter: emulators/onscripter.md
- ONScripter Yuri: emulators/onsyuri.md
- OpenLara: emulators/openlara.md
- OpenTyrian: emulators/opentyrian.md
- Opera (4DO): emulators/opera.md
- Panda3DS: emulators/panda3ds.md
- Pascal Pong: emulators/pascal_pong.md
- PCem: emulators/pcem.md
- PCSX2: emulators/pcsx2.md
- PCSX-ReARMed: emulators/pcsx_rearmed.md
- PD777: emulators/pd777.md
- PicoDrive: emulators/picodrive.md
- Play!: emulators/play.md
- PocketCDG: emulators/pocketcdg.md
- PokeMini: emulators/pokemini.md
- PPSSPP: emulators/ppsspp.md
- PrBoom: emulators/prboom.md
- ProSystem: emulators/prosystem.md
- PUAE (P-UAE): emulators/puae.md
- PuzzleScript: emulators/puzzlescript.md
- px68k: emulators/px68k.md
- QEMU: emulators/qemu.md
- QUASI88: emulators/quasi88.md
- RACE (Neo Geo Pocket): emulators/race.md
- Redbook: emulators/redbook.md
- REminiscence: emulators/reminiscence.md
- RemoteJoy: emulators/remotejoy.md
- Retro8: emulators/retro8.md
- RetroDream: emulators/retrodream.md
- ROM Cleaner: emulators/romcleaner.md
- RPCS3: emulators/rpcs3.md
- Rustation: emulators/rustation.md
- RVVM: emulators/rvvm.md
- SAME CDi: emulators/same_cdi.md
- SameBoy: emulators/sameboy.md
- ScummVM: emulators/scummvm.md
- SDLPAL: emulators/sdlpal.md
- SimCoupe: emulators/simcp.md
- SMS Plus GX: emulators/smsplus.md
- snes9x: emulators/snes9x.md
- SquirrelJME: emulators/squirreljme.md
- Stella: emulators/stella.md
- Stone Soup: emulators/stonesoup.md
- Super Bros War: emulators/superbroswar.md
- Syobon Action: emulators/syobonaction.md
- TamaLIBretro: emulators/tamalibretro.md
- TempGBA: emulators/tempgba.md
- TGB Dual: emulators/tgbdual.md
- Theodore: emulators/theodore.md
- The Powder Toy: emulators/thepowdertoy.md
- TIC-80: emulators/tic80.md
- TyrQuake: emulators/tyrquake.md
- MicroW8: emulators/uw8.md
- UXN: emulators/uxn.md
- uzem: emulators/uzem.md
- VaporSpec: emulators/vaporspec.md
- VBA-Next: emulators/vba_next.md
- vecx: emulators/vecx.md
- VeMUlator: emulators/vemulator.md
- VICE: emulators/vice.md
- Vircon32: emulators/vircon32.md
- Virtual Jaguar: emulators/virtualjaguar.md
- VirtualXT: emulators/virtualxt.md
- Vita3K: emulators/vita3k.md
- vitaQuakeII: emulators/vitaquake2.md
- vitaQuakeIII: emulators/vitaquake3.md
- WASM-4: emulators/wasm4.md
- X Millennium: emulators/x1.md
- x64sdl: emulators/x64sdl.md
- Xemu: emulators/xemu.md
- XRick: emulators/xrick.md
- Gap Analysis: gaps.md
- Wiki:
- Overview: wiki/index.md
- Architecture: wiki/architecture.md
- Tools: wiki/tools.md
- Profiling guide: wiki/profiling.md
- Data model: wiki/data-model.md
- Contributing: contributing.md
- Contributing: contributing.md

View File

@@ -93,5 +93,3 @@ Full libretro docs: `https://docs.libretro.com/library/<core>/`
| RetroBat | md5 | MD5 check via JSON config | `batocera-systems.json` |
| EmuDeck | md5 | MD5 whitelist per system | `checkBIOS.sh` |
| Recalbox | md5 | multi-hash comma-separated | `es_bios.xml` + `Bios.cpp` |
| RetroDECK | md5 | MD5 per file via component manifests | `api_data_processing.sh` |
| RomM | md5 | size + any hash (MD5/SHA1/CRC32) | `firmware.py` |

View File

@@ -86,17 +86,6 @@ platforms:
# Each component/<name>/component_manifest.json declares BIOS requirements
# Scraper enumerates top-level dirs via GitHub API, fetches each manifest directly
romm:
config: romm.yml
status: active
logo: "https://avatars.githubusercontent.com/u/168586850"
scraper: romm
source_url: "https://raw.githubusercontent.com/rommapp/romm/master/backend/models/fixtures/known_bios_files.json"
source_format: json
hash_type: sha1
schedule: monthly
inherits_from: emulatorjs # cores inherited from emulatorjs.yml
retropie:
config: retropie.yml
status: archived # Last release: v4.8 (March 2022) - no update in 4 years

View File

@@ -1,57 +0,0 @@
# EmulatorJS base config (not a standalone platform).
# Provides the core list for platforms that use EmulatorJS as their emulation engine.
# Source: emulatorjs/emulatorjs data/src/consts.js + emulatorjs/build cores.json
# RomM mapping: rommapp/romm frontend/src/utils/index.ts (_EJS_CORES_MAP)
platform: EmulatorJS
version: "4.2.3"
homepage: "https://emulatorjs.org"
source: "https://github.com/emulatorjs/emulatorjs"
cores:
- a5200
- beetle_vb
- cap32
- crocods
- desmume
- desmume2015
- dosbox_pure
- fbalpha2012_cps1
- fbalpha2012_cps2
- fbneo
- fceumm
- freeintv
- fuse
- gambatte
- gearcoleco
- genesis_plus_gx
- handy
- mame2003
- mame2003_plus
- mednafen_ngp
- mednafen_pce
- mednafen_pcfx
- mednafen_psx_hw
- mednafen_wswan
- melonds
- mgba
- mupen64plus_next
- nestopia
- opera
- parallel_n64
- pcsx_rearmed
- picodrive
- ppsspp
- prboom
- prosystem
- puae
- same_cdi
- smsplus
- snes9x
- stella2014
- vice_x128
- vice_x64
- vice_x64sc
- vice_xpet
- vice_xplus4
- vice_xvic
- virtualjaguar
- yabause

File diff suppressed because it is too large Load Diff

View File

@@ -26,7 +26,7 @@ import urllib.error
from pathlib import Path
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
from common import list_registered_platforms, load_database, load_platform_config
from common import load_database, load_platform_config
try:
import yaml
@@ -381,9 +381,10 @@ def main():
db = load_database(args.db)
if args.all:
platforms = list_registered_platforms(
args.platforms_dir, include_archived=True,
)
platforms = []
for f in Path(args.platforms_dir).glob("*.yml"):
if not f.name.startswith("_"):
platforms.append(f.stem)
elif args.platform:
platforms = [args.platform]
else:

View File

@@ -9,8 +9,6 @@ from __future__ import annotations
import hashlib
import json
import os
import urllib.error
import urllib.request
import zipfile
import zlib
from pathlib import Path
@@ -167,31 +165,6 @@ def load_data_dir_registry(platforms_dir: str = "platforms") -> dict:
return data.get("data_directories", {})
def list_registered_platforms(
platforms_dir: str = "platforms",
include_archived: bool = False,
) -> list[str]:
"""List platforms registered in _registry.yml.
Only registered platforms generate packs and appear in CI.
Unregistered YAMLs (e.g., emulatorjs.yml) are base configs for inheritance.
"""
registry_path = os.path.join(platforms_dir, "_registry.yml")
if not os.path.exists(registry_path):
return []
with open(registry_path) as f:
registry = yaml.safe_load(f) or {}
platforms = []
for name, meta in sorted(registry.get("platforms", {}).items()):
status = meta.get("status", "active")
if status == "archived" and not include_archived:
continue
config_path = os.path.join(platforms_dir, meta.get("config", f"{name}.yml"))
if os.path.exists(config_path):
platforms.append(name)
return platforms
def resolve_local_file(
file_entry: dict,
db: dict,
@@ -443,23 +416,16 @@ def group_identical_platforms(
"""Group platforms that produce identical packs (same files + base_destination).
Returns [(group_of_platform_names, representative), ...].
The representative is the root platform (one that does not inherit).
"""
fingerprints: dict[str, list[str]] = {}
representatives: dict[str, str] = {}
inherits: dict[str, bool] = {}
for platform in platforms:
try:
raw_path = os.path.join(platforms_dir, f"{platform}.yml")
with open(raw_path) as f:
raw = yaml.safe_load(f) or {}
inherits[platform] = "inherits" in raw
config = load_platform_config(platform, platforms_dir)
except FileNotFoundError:
fingerprints.setdefault(platform, []).append(platform)
representatives.setdefault(platform, platform)
inherits[platform] = False
continue
base_dest = config.get("base_destination", "")
@@ -474,16 +440,9 @@ def group_identical_platforms(
fp = hashlib.sha1("|".join(sorted(entries)).encode()).hexdigest()
fingerprints.setdefault(fp, []).append(platform)
# Prefer the root platform (no inherits) as representative
if fp not in representatives or (not inherits[platform] and inherits.get(representatives[fp], False)):
representatives[fp] = platform
representatives.setdefault(fp, platform)
result = []
for fp, group in fingerprints.items():
rep = representatives[fp]
ordered = [rep] + [p for p in group if p != rep]
result.append((ordered, rep))
return result
return [(group, representatives[fp]) for fp, group in fingerprints.items()]
def resolve_platform_cores(
@@ -578,10 +537,8 @@ def _build_validation_index(profiles: dict) -> dict[str, dict]:
"min_size": None, "max_size": None,
"crc32": set(), "md5": set(), "sha1": set(), "sha256": set(),
"adler32": set(), "crypto_only": set(),
"emulators": set(),
}
sources[fname] = {}
index[fname]["emulators"].add(emu_name)
index[fname]["checks"].update(checks)
# Track non-reproducible crypto checks
index[fname]["crypto_only"].update(
@@ -627,7 +584,6 @@ def _build_validation_index(profiles: dict) -> dict[str, dict]:
for v in index.values():
v["checks"] = sorted(v["checks"])
v["crypto_only"] = sorted(v["crypto_only"])
v["emulators"] = sorted(v["emulators"])
# Keep hash sets as frozensets for O(1) lookup in check_file_validation
return index
@@ -721,59 +677,6 @@ def filter_files_by_mode(files: list[dict], standalone: bool) -> list[dict]:
return result
LARGE_FILES_RELEASE = "large-files"
LARGE_FILES_REPO = "Abdess/retrobios"
LARGE_FILES_CACHE = ".cache/large"
def fetch_large_file(name: str, dest_dir: str = LARGE_FILES_CACHE,
expected_sha1: str = "", expected_md5: str = "") -> str | None:
"""Download a large file from the 'large-files' GitHub release if not cached."""
cached = os.path.join(dest_dir, name)
if os.path.exists(cached):
if expected_sha1 or expected_md5:
hashes = compute_hashes(cached)
if expected_sha1 and hashes["sha1"].lower() != expected_sha1.lower():
os.unlink(cached)
elif expected_md5:
md5_list = [m.strip().lower() for m in expected_md5.split(",") if m.strip()]
if hashes["md5"].lower() not in md5_list:
os.unlink(cached)
else:
return cached
else:
return cached
else:
return cached
encoded_name = urllib.request.quote(name)
url = f"https://github.com/{LARGE_FILES_REPO}/releases/download/{LARGE_FILES_RELEASE}/{encoded_name}"
try:
req = urllib.request.Request(url, headers={"User-Agent": "retrobios/1.0"})
with urllib.request.urlopen(req, timeout=300) as resp:
os.makedirs(dest_dir, exist_ok=True)
with open(cached, "wb") as f:
while True:
chunk = resp.read(65536)
if not chunk:
break
f.write(chunk)
except (urllib.error.URLError, urllib.error.HTTPError):
return None
if expected_sha1 or expected_md5:
hashes = compute_hashes(cached)
if expected_sha1 and hashes["sha1"].lower() != expected_sha1.lower():
os.unlink(cached)
return None
if expected_md5:
md5_list = [m.strip().lower() for m in expected_md5.split(",") if m.strip()]
if hashes["md5"].lower() not in md5_list:
os.unlink(cached)
return None
return cached
def safe_extract_zip(zip_path: str, dest_dir: str) -> None:
"""Extract a ZIP file safely, preventing zip-slip path traversal."""
dest = os.path.realpath(dest_dir)

View File

@@ -25,7 +25,7 @@ except ImportError:
sys.exit(1)
sys.path.insert(0, os.path.dirname(__file__))
from common import list_registered_platforms, load_database, load_emulator_profiles, load_platform_config
from common import load_database, load_emulator_profiles, load_platform_config
DEFAULT_EMULATORS_DIR = "emulators"
DEFAULT_PLATFORMS_DIR = "platforms"
@@ -36,8 +36,10 @@ def load_platform_files(platforms_dir: str) -> tuple[dict[str, set[str]], dict[s
"""Load all platform configs and collect declared filenames + data_directories per system."""
declared = {}
platform_data_dirs = {}
for platform_name in list_registered_platforms(platforms_dir, include_archived=True):
config = load_platform_config(platform_name, platforms_dir)
for f in sorted(Path(platforms_dir).glob("*.yml")):
if f.name.startswith("_"):
continue
config = load_platform_config(f.stem, platforms_dir)
for sys_id, system in config.get("systems", {}).items():
for fe in system.get("files", []):
name = fe.get("name", "")

View File

@@ -18,7 +18,7 @@ from datetime import datetime, timezone
from pathlib import Path
sys.path.insert(0, os.path.dirname(__file__))
from common import compute_hashes, list_registered_platforms
from common import compute_hashes
CACHE_DIR = ".cache"
CACHE_FILE = os.path.join(CACHE_DIR, "db_cache.json")
@@ -216,62 +216,6 @@ def save_cache(cache_path: str, cache: dict):
json.dump(cache, f)
def _load_gitignored_large_files() -> dict[str, str]:
"""Read .gitignore and return {filename: bios_path} for large files."""
gitignore = Path(".gitignore")
if not gitignore.exists():
return {}
entries = {}
for line in gitignore.read_text().splitlines():
line = line.strip()
if line.startswith("bios/") and not line.startswith("#"):
name = Path(line).name
entries[name] = line
return entries
def _preserve_large_file_entries(files: dict, db_path: str) -> int:
"""Preserve database entries for large files not on disk.
Large files (>50 MB) are stored as GitHub release assets and listed
in .gitignore. When generate_db runs locally without them, their
entries would be lost. This reads the existing database, downloads
missing files from the release, and re-adds entries with paths
pointing to the local cache.
"""
from common import fetch_large_file
large_files = _load_gitignored_large_files()
if not large_files:
return 0
try:
with open(db_path) as f:
existing_db = json.load(f)
except (FileNotFoundError, json.JSONDecodeError):
return 0
count = 0
for sha1, entry in existing_db.get("files", {}).items():
if sha1 in files:
continue
name = entry.get("name", "")
path = entry.get("path", "")
# Match by gitignored bios/ path OR by filename of a known large file
if path not in large_files.values() and name not in large_files:
continue
cached = fetch_large_file(
name,
expected_sha1=entry.get("sha1", ""),
expected_md5=entry.get("md5", ""),
)
if cached:
entry = {**entry, "path": cached}
files[sha1] = entry
count += 1
return count
def main():
parser = argparse.ArgumentParser(description="Generate multi-indexed BIOS database")
parser.add_argument("--force", action="store_true", help="Force rehash all files")
@@ -292,11 +236,6 @@ def main():
if not files:
print("Warning: No BIOS files found", file=sys.stderr)
# Preserve entries for large files stored as release assets (.gitignore)
preserved = _preserve_large_file_entries(files, args.output)
if preserved:
print(f" Preserved {preserved} large file entries from existing database")
platform_aliases = _collect_all_aliases(files)
for sha1, name_list in platform_aliases.items():
for alias_entry in name_list:
@@ -353,8 +292,9 @@ def _collect_all_aliases(files: dict) -> dict:
if platforms_dir.is_dir():
try:
import yaml
for platform_name in list_registered_platforms(str(platforms_dir), include_archived=True):
config_file = platforms_dir / f"{platform_name}.yml"
for config_file in platforms_dir.glob("*.yml"):
if config_file.name.startswith("_"):
continue
try:
with open(config_file) as f:
config = yaml.safe_load(f) or {}

View File

@@ -26,11 +26,10 @@ from pathlib import Path
sys.path.insert(0, os.path.dirname(__file__))
from common import (
_build_validation_index, build_zip_contents_index, check_file_validation,
check_inside_zip, compute_hashes, fetch_large_file, filter_files_by_mode,
group_identical_platforms, list_emulator_profiles, list_registered_platforms,
list_system_ids, load_database, load_data_dir_registry,
load_emulator_profiles, load_platform_config, md5_composite,
resolve_local_file,
check_inside_zip, compute_hashes, filter_files_by_mode,
group_identical_platforms, list_emulator_profiles, list_system_ids,
load_database, load_data_dir_registry, load_emulator_profiles,
load_platform_config, md5_composite, resolve_local_file,
)
from deterministic_zip import rebuild_zip_deterministic
@@ -44,48 +43,55 @@ DEFAULT_PLATFORMS_DIR = "platforms"
DEFAULT_DB_FILE = "database.json"
DEFAULT_OUTPUT_DIR = "dist"
DEFAULT_BIOS_DIR = "bios"
LARGE_FILES_RELEASE = "large-files"
LARGE_FILES_REPO = "Abdess/retrobios"
MAX_ENTRY_SIZE = 512 * 1024 * 1024 # 512MB
def _find_candidate_satisfying_both(
file_entry: dict,
db: dict,
local_path: str,
validation_index: dict,
bios_dir: str,
) -> str | None:
"""Search for a repo file that satisfies both platform MD5 and emulator validation.
def _verify_file_hash(path: str, expected_sha1: str = "",
expected_md5: str = "") -> bool:
if not expected_sha1 and not expected_md5:
return True
hashes = compute_hashes(path)
if expected_sha1:
return hashes["sha1"].lower() == expected_sha1.lower()
md5_list = [m.strip().lower() for m in expected_md5.split(",") if m.strip()]
return hashes["md5"].lower() in md5_list
When the current file passes platform verification but fails emulator checks,
search all candidates with the same name for one that passes both.
Returns a better path, or None if no upgrade found.
"""
fname = file_entry.get("name", "")
if not fname:
return None
entry = validation_index.get(fname)
if not entry:
def fetch_large_file(name: str, dest_dir: str = ".cache/large",
expected_sha1: str = "", expected_md5: str = "") -> str | None:
"""Download a large file from the 'large-files' GitHub release if not cached."""
cached = os.path.join(dest_dir, name)
if os.path.exists(cached):
if expected_sha1 or expected_md5:
if _verify_file_hash(cached, expected_sha1, expected_md5):
return cached
os.unlink(cached)
else:
return cached
encoded_name = urllib.request.quote(name)
url = f"https://github.com/{LARGE_FILES_REPO}/releases/download/{LARGE_FILES_RELEASE}/{encoded_name}"
try:
req = urllib.request.Request(url, headers={"User-Agent": "retrobios-pack/1.0"})
with urllib.request.urlopen(req, timeout=300) as resp:
os.makedirs(dest_dir, exist_ok=True)
with open(cached, "wb") as f:
while True:
chunk = resp.read(65536)
if not chunk:
break
f.write(chunk)
except (urllib.error.URLError, urllib.error.HTTPError):
return None
md5_expected = file_entry.get("md5", "")
md5_set = {m.strip().lower() for m in md5_expected.split(",") if m.strip()} if md5_expected else set()
by_name = db.get("indexes", {}).get("by_name", {})
files_db = db.get("files", {})
for sha1 in by_name.get(fname, []):
candidate = files_db.get(sha1, {})
path = candidate.get("path", "")
if not path or not os.path.exists(path) or os.path.realpath(path) == os.path.realpath(local_path):
continue
# Must still satisfy platform MD5
if md5_set and candidate.get("md5", "").lower() not in md5_set:
continue
# Check emulator validation
reason = check_file_validation(path, fname, validation_index, bios_dir)
if reason is None:
return path
return None
if expected_sha1 or expected_md5:
if not _verify_file_hash(cached, expected_sha1, expected_md5):
os.unlink(cached)
return None
return cached
def _sanitize_path(raw: str) -> str:
@@ -112,11 +118,10 @@ def resolve_file(file_entry: dict, db: dict, bios_dir: str,
path, status = resolve_local_file(file_entry, db, zip_contents,
dest_hint=dest_hint)
if path and status != "hash_mismatch":
if path:
return path, status
# Large files from GitHub release assets — tried when local file is
# missing OR has a hash mismatch (wrong variant on disk)
# Last resort: large files from GitHub release assets
name = file_entry.get("name", "")
sha1 = file_entry.get("sha1")
md5_raw = file_entry.get("md5", "")
@@ -126,10 +131,6 @@ def resolve_file(file_entry: dict, db: dict, bios_dir: str,
if cached:
return cached, "release_asset"
# Fall back to hash_mismatch local file if release asset unavailable
if path:
return path, status
return None, "not_found"
@@ -242,9 +243,7 @@ def generate_pack(
platform_display = config.get("platform", platform_name)
base_dest = config.get("base_destination", "")
version = config.get("version", config.get("dat_version", ""))
version_tag = f"_{version.replace(' ', '')}" if version else ""
zip_name = f"{platform_display.replace(' ', '_')}{version_tag}_BIOS_Pack.zip"
zip_name = f"{platform_display.replace(' ', '_')}_BIOS_Pack.zip"
zip_path = os.path.join(output_dir, zip_name)
os.makedirs(output_dir, exist_ok=True)
@@ -363,28 +362,20 @@ def generate_pack(
else:
file_status.setdefault(dedup_key, "ok")
# Emulator-level validation: informational only for platform packs.
# Platform verification (existence/md5) is the authority for pack status.
# Emulator checks are supplementary — logged but don't downgrade.
# When a discrepancy is found, try to find a file satisfying both.
# Emulator-level validation (matches verify.py behavior)
# In existence mode: validation is informational (warning, not downgrade)
# In md5 mode: validation downgrades OK to UNTESTED
if (file_status.get(dedup_key) == "ok"
and local_path and validation_index):
fname = file_entry.get("name", "")
reason = check_file_validation(local_path, fname, validation_index,
bios_dir)
reason = check_file_validation(local_path, fname, validation_index)
if reason:
better = _find_candidate_satisfying_both(
file_entry, db, local_path, validation_index, bios_dir,
)
if better:
local_path = better
if verification_mode == "existence":
# Existence mode: file present = OK, validation is extra info
file_reasons.setdefault(dedup_key, reason)
else:
ventry = validation_index.get(fname, {})
emus = ", ".join(ventry.get("emulators", []))
file_reasons.setdefault(
dedup_key,
f"{platform_display} says OK but {emus} says {reason}",
)
file_status[dedup_key] = "untested"
file_reasons[dedup_key] = reason
if already_packed:
continue
@@ -484,7 +475,7 @@ def generate_pack(
for key, reason in sorted(file_reasons.items()):
status = file_status.get(key, "")
label = "UNTESTED" if status == "untested" else "DISCREPANCY"
label = "UNTESTED"
print(f" {label}: {key}{reason}")
for name in missing_files:
print(f" MISSING: {name}")
@@ -821,8 +812,13 @@ def generate_system_pack(
def list_platforms(platforms_dir: str) -> list[str]:
"""List available platform names from registry."""
return list_registered_platforms(platforms_dir, include_archived=True)
"""List available platform names from YAML files."""
platforms = []
for f in sorted(Path(platforms_dir).glob("*.yml")):
if f.name.startswith("_"):
continue
platforms.append(f.stem)
return platforms
def main():
@@ -897,9 +893,9 @@ def main():
# Platform mode (existing)
if args.all:
platforms = list_registered_platforms(
args.platforms_dir, include_archived=args.include_archived,
)
sys.path.insert(0, os.path.dirname(__file__))
from list_platforms import list_platforms as _list_active
platforms = _list_active(include_archived=args.include_archived)
elif args.platform:
platforms = [args.platform]
else:
@@ -919,11 +915,10 @@ def main():
groups = group_identical_platforms(platforms, args.platforms_dir)
for group_platforms, representative in groups:
variants = [p for p in group_platforms if p != representative]
if variants:
all_names = [load_platform_config(p, args.platforms_dir).get("platform", p) for p in group_platforms]
label = " / ".join(all_names)
print(f"\nGenerating pack for {label}...")
if len(group_platforms) > 1:
names = [load_platform_config(p, args.platforms_dir).get("platform", p) for p in group_platforms]
combined_name = " + ".join(names)
print(f"\nGenerating shared pack for {combined_name}...")
else:
print(f"\nGenerating pack for {representative}...")
@@ -934,13 +929,10 @@ def main():
zip_contents=zip_contents, data_registry=data_registry,
emu_profiles=emu_profiles,
)
if zip_path and variants:
rep_cfg = load_platform_config(representative, args.platforms_dir)
ver = rep_cfg.get("version", rep_cfg.get("dat_version", ""))
ver_tag = f"_{ver.replace(' ', '')}" if ver else ""
all_names = [load_platform_config(p, args.platforms_dir).get("platform", p) for p in group_platforms]
combined = "_".join(n.replace(" ", "") for n in all_names) + f"{ver_tag}_BIOS_Pack.zip"
new_path = os.path.join(os.path.dirname(zip_path), combined)
if zip_path and len(group_platforms) > 1:
names = [load_platform_config(p, args.platforms_dir).get("platform", p) for p in group_platforms]
combined_filename = "_".join(n.replace(" ", "") for n in names) + "_BIOS_Pack.zip"
new_path = os.path.join(os.path.dirname(zip_path), combined_filename)
if new_path != zip_path:
os.rename(zip_path, new_path)
print(f" Renamed -> {os.path.basename(new_path)}")

View File

@@ -18,7 +18,7 @@ from datetime import datetime, timezone
from pathlib import Path
sys.path.insert(0, os.path.dirname(__file__))
from common import list_registered_platforms, load_database, load_platform_config
from common import load_database, load_platform_config
from verify import verify_platform
def compute_coverage(platform_name: str, platforms_dir: str, db: dict) -> dict:
@@ -80,7 +80,10 @@ def generate_readme(db: dict, platforms_dir: str) -> str:
size_mb = total_size / (1024 * 1024)
ts = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
platform_names = list_registered_platforms(platforms_dir, include_archived=True)
platform_names = sorted(
p.stem for p in Path(platforms_dir).glob("*.yml")
if not p.name.startswith("_")
)
coverages = {}
for name in platform_names:
@@ -93,88 +96,26 @@ def generate_readme(db: dict, platforms_dir: str) -> str:
1 for f in Path("emulators").glob("*.yml")
) if Path("emulators").exists() else 0
# Count systems from emulator profiles
system_ids: set[str] = set()
emu_dir = Path("emulators")
if emu_dir.exists():
try:
import yaml
for f in emu_dir.glob("*.yml"):
with open(f) as fh:
p = yaml.safe_load(fh) or {}
system_ids.update(p.get("systems", []))
except ImportError:
pass
lines = [
"# RetroBIOS",
"# Retrogaming BIOS & Firmware Collection",
"",
f"Complete BIOS and firmware packs for RetroArch, Batocera, Recalbox, Lakka,"
f" RetroPie, EmuDeck, RetroBat, and RetroDECK.",
"Complete, verified collection of BIOS, firmware, and system files for retrogaming emulators.",
"",
f"**{total_files:,}** verified files across **{len(system_ids)}** systems,"
f" ready to extract into your emulator's BIOS directory.",
f"> **{total_files}** files | **{size_mb:.1f} MB** | **{len(coverages)}** platforms | **{emulator_count}** emulator profiles",
"",
"## Download BIOS packs",
"## Download",
"",
"Pick your platform, download the ZIP, extract to the BIOS path.",
"",
"| Platform | BIOS files | Extract to | Download |",
"|----------|-----------|-----------|----------|",
"| Platform | Files | Verification | Pack |",
"|----------|-------|-------------|------|",
]
extract_paths = {
"RetroArch": "`system/`",
"Lakka": "`system/`",
"Batocera": "`/userdata/bios/`",
"Recalbox": "`/recalbox/share/bios/`",
"RetroBat": "`bios/`",
"RetroPie": "`BIOS/`",
"RetroDECK": "`~/retrodeck/bios/`",
"EmuDeck": "`Emulation/bios/`",
"RomM": "`bios/{platform_slug}/`",
}
for name, cov in sorted(coverages.items(), key=lambda x: x[1]["platform"]):
display = cov["platform"]
path = extract_paths.get(display, "")
lines.append(
f"| {display} | {cov['total']} | {path} | "
f"| {cov['platform']} | {cov['total']} | {cov['mode']} | "
f"[Download]({RELEASE_URL}) |"
)
lines.extend([
"",
"## What's included",
"",
"BIOS, firmware, and system files for consoles from Atari to PlayStation 3.",
f"Each file is checked against the emulator's source code to match what the"
f" code actually loads at runtime.",
"",
f"- **{len(coverages)} platforms** supported with platform-specific verification",
f"- **{emulator_count} emulators** profiled from source (RetroArch cores + standalone)",
f"- **{len(system_ids)} systems** covered (NES, SNES, PlayStation, Saturn, Dreamcast, ...)",
f"- **{total_files:,} files** verified with MD5, SHA1, CRC32 checksums",
f"- **{size_mb:.0f} MB** total collection size",
"",
"## Supported systems",
"",
])
# Show well-known systems for SEO, link to full list
well_known = [
"NES", "SNES", "Nintendo 64", "GameCube", "Wii", "Game Boy", "Game Boy Advance",
"Nintendo DS", "Nintendo 3DS", "Switch",
"PlayStation", "PlayStation 2", "PlayStation 3", "PSP", "PS Vita",
"Mega Drive", "Saturn", "Dreamcast", "Game Gear", "Master System",
"Neo Geo", "Atari 2600", "Atari 7800", "Atari Lynx", "Atari ST",
"MSX", "PC Engine", "TurboGrafx-16", "ColecoVision", "Intellivision",
"Commodore 64", "Amiga", "ZX Spectrum", "Arcade (MAME)",
]
lines.extend([
", ".join(well_known) + f", and {len(system_ids) - len(well_known)}+ more.",
"",
f"Full list with per-file details: **[{SITE_URL}]({SITE_URL})**",
"",
"## Coverage",
"",
@@ -190,20 +131,10 @@ def generate_readme(db: dict, platforms_dir: str) -> str:
)
lines.extend([
"",
"## How it works",
"",
"Documentation and metadata can drift from what emulators actually load.",
"To keep packs accurate, each file is checked against the emulator's source code.",
"",
"1. **Read emulator source code** - trace every file the code loads, its expected hash and size",
"2. **Cross-reference with platforms** - match against what each platform declares",
"3. **Build packs** - include baseline files plus what each platform's cores need",
"4. **Verify** - run platform-native checks and emulator-level validation",
"",
"## Documentation",
"",
f"Per-file hashes, emulator profiles, gap analysis, cross-reference: **[{SITE_URL}]({SITE_URL})**",
f"Full file listings, platform coverage, emulator profiles, and gap analysis: **[{SITE_URL}]({SITE_URL})**",
"",
])

File diff suppressed because it is too large Load Diff

View File

@@ -17,16 +17,45 @@ import argparse
import json
import os
import sys
from pathlib import Path
sys.path.insert(0, os.path.dirname(__file__))
from common import list_registered_platforms
try:
import yaml
except ImportError:
yaml = None
PLATFORMS_DIR = "platforms"
def _load_registry(platforms_dir: str = PLATFORMS_DIR) -> dict:
"""Load _registry.yml if available."""
registry_path = Path(platforms_dir) / "_registry.yml"
if yaml and registry_path.exists():
with open(registry_path) as f:
return yaml.safe_load(f) or {}
return {}
def list_platforms(include_archived: bool = False) -> list[str]:
"""List platform config files, filtering by status from _registry.yml."""
return list_registered_platforms(PLATFORMS_DIR, include_archived=include_archived)
platforms_dir = Path(PLATFORMS_DIR)
if not platforms_dir.is_dir():
return []
registry = _load_registry(str(platforms_dir))
registry_platforms = registry.get("platforms", {})
platforms = []
for f in sorted(platforms_dir.glob("*.yml")):
if f.name.startswith("_"):
continue
name = f.stem
status = registry_platforms.get(name, {}).get("status", "active")
if status == "archived" and not include_archived:
continue
platforms.append(name)
return platforms
def main():

View File

@@ -1,5 +1,5 @@
#!/usr/bin/env python3
"""Run the full retrobios pipeline.
"""Run the full retrobios pipeline: generate DB, verify, generate packs.
Steps:
1. generate_db.py --force (rebuild database.json from bios/)
@@ -7,14 +7,11 @@ Steps:
3. verify.py --all (check all platforms)
4. generate_pack.py --all (build ZIP packs)
5. consistency check (verify counts == pack counts)
6. generate_readme.py (rebuild README.md + CONTRIBUTING.md)
7. generate_site.py (rebuild MkDocs pages)
Usage:
python scripts/pipeline.py # active platforms
python scripts/pipeline.py --include-archived # all platforms
python scripts/pipeline.py --skip-packs # steps 1-3 only
python scripts/pipeline.py --skip-docs # skip steps 6-7
python scripts/pipeline.py --offline # skip step 2
"""
from __future__ import annotations
@@ -97,7 +94,7 @@ def check_consistency(verify_output: str, pack_output: str) -> bool:
v = parse_verify_counts(verify_output)
p = parse_pack_counts(pack_output)
print("\n--- 5/7 consistency check ---")
print("\n--- 5/5 consistency check ---")
all_ok = True
for v_label, (v_ok, v_total) in sorted(v.items()):
@@ -131,8 +128,6 @@ def main():
help="Include archived platforms")
parser.add_argument("--skip-packs", action="store_true",
help="Only regenerate DB and verify, skip pack generation")
parser.add_argument("--skip-docs", action="store_true",
help="Skip README and site generation")
parser.add_argument("--offline", action="store_true",
help="Skip data directory refresh")
parser.add_argument("--output-dir", default="dist",
@@ -150,7 +145,7 @@ def main():
ok, out = run(
[sys.executable, "scripts/generate_db.py", "--force",
"--bios-dir", "bios", "--output", "database.json"],
"1/7 generate database",
"1/5 generate database",
)
results["generate_db"] = ok
if not ok:
@@ -161,18 +156,18 @@ def main():
if not args.offline:
ok, out = run(
[sys.executable, "scripts/refresh_data_dirs.py"],
"2/7 refresh data directories",
"2/5 refresh data directories",
)
results["refresh_data"] = ok
else:
print("\n--- 2/7 refresh data directories: SKIPPED (--offline) ---")
print("\n--- 2/5 refresh data directories: SKIPPED (--offline) ---")
results["refresh_data"] = True
# Step 3: Verify
verify_cmd = [sys.executable, "scripts/verify.py", "--all"]
if args.include_archived:
verify_cmd.append("--include-archived")
ok, verify_output = run(verify_cmd, "3/7 verify all platforms")
ok, verify_output = run(verify_cmd, "3/5 verify all platforms")
results["verify"] = ok
all_ok = all_ok and ok
@@ -189,11 +184,11 @@ def main():
pack_cmd.append("--offline")
if args.include_extras:
pack_cmd.append("--include-extras")
ok, pack_output = run(pack_cmd, "4/7 generate packs")
ok, pack_output = run(pack_cmd, "4/5 generate packs")
results["generate_packs"] = ok
all_ok = all_ok and ok
else:
print("\n--- 4/7 generate packs: SKIPPED (--skip-packs) ---")
print("\n--- 4/5 generate packs: SKIPPED (--skip-packs) ---")
results["generate_packs"] = True
# Step 5: Consistency check
@@ -202,34 +197,9 @@ def main():
results["consistency"] = ok
all_ok = all_ok and ok
else:
print("\n--- 5/7 consistency check: SKIPPED ---")
print("\n--- 5/5 consistency check: SKIPPED ---")
results["consistency"] = True
# Step 6: Generate README
if not args.skip_docs:
ok, _ = run(
[sys.executable, "scripts/generate_readme.py",
"--db", "database.json", "--platforms-dir", "platforms"],
"6/7 generate readme",
)
results["generate_readme"] = ok
all_ok = all_ok and ok
else:
print("\n--- 6/7 generate readme: SKIPPED (--skip-docs) ---")
results["generate_readme"] = True
# Step 7: Generate site pages
if not args.skip_docs:
ok, _ = run(
[sys.executable, "scripts/generate_site.py"],
"7/7 generate site",
)
results["generate_site"] = ok
all_ok = all_ok and ok
else:
print("\n--- 7/7 generate site: SKIPPED (--skip-docs) ---")
results["generate_site"] = True
# Summary
total_elapsed = time.monotonic() - total_start
print(f"\n{'=' * 60}")

View File

@@ -1,224 +0,0 @@
#!/usr/bin/env python3
"""Scraper for RomM BIOS requirements.
Source: https://github.com/rommapp/romm
Format: JSON fixture mapping "slug:filename" to {size, crc, md5, sha1}
Hash: SHA1 primary (all four hashes available per entry)
RomM stores known BIOS hashes in known_bios_files.json. At startup, the
fixture is loaded into Redis. When scanning or uploading firmware, RomM
verifies: file size must match AND at least one hash (MD5, SHA1, CRC32)
must match (firmware.py:verify_file_hashes).
RomM hashes files as opaque blobs (no ZIP content inspection). Arcade
BIOS ZIPs are matched by their container hash, which varies by MAME
version and ZIP tool. This is a known limitation (rommapp/romm#2888).
Folder structure: {library}/bios/{platform_slug}/{filename} (flat).
Slugs are IGDB-style platform identifiers.
"""
from __future__ import annotations
import json
import sys
try:
from .base_scraper import BaseScraper, BiosRequirement, fetch_github_latest_version
except ImportError:
from base_scraper import BaseScraper, BiosRequirement, fetch_github_latest_version
PLATFORM_NAME = "romm"
SOURCE_URL = (
"https://raw.githubusercontent.com/rommapp/romm/"
"master/backend/models/fixtures/known_bios_files.json"
)
GITHUB_REPO = "rommapp/romm"
# IGDB slug -> retrobios system ID
SLUG_MAP: dict[str, str] = {
"3do": "3do",
"64dd": "nintendo-64dd",
"acpc": "amstrad-cpc",
"amiga": "commodore-amiga",
"arcade": "arcade",
"atari-st": "atari-st",
"atari5200": "atari-5200",
"atari7800": "atari-7800",
"atari8bit": "atari-400-800",
"colecovision": "coleco-colecovision",
"dc": "sega-dreamcast",
"doom": "doom",
"enterprise": "enterprise-64-128",
"fairchild-channel-f": "fairchild-channel-f",
"fds": "nintendo-fds",
"gamegear": "sega-game-gear",
"gb": "nintendo-gb",
"gba": "nintendo-gba",
"gbc": "nintendo-gbc",
"genesis": "sega-mega-drive",
"intellivision": "mattel-intellivision",
"j2me": "j2me",
"lynx": "atari-lynx",
"mac": "apple-macintosh-ii",
"msx": "microsoft-msx",
"msx2": "microsoft-msx",
"nds": "nintendo-ds",
"neo-geo-cd": "snk-neogeo-cd",
"nes": "nintendo-nes",
"ngc": "nintendo-gamecube",
"odyssey-2-slash-videopac-g7000": "magnavox-odyssey2",
"pc-9800-series": "nec-pc-98",
"pc-fx": "nec-pc-fx",
"pokemon-mini": "nintendo-pokemon-mini",
"ps2": "sony-playstation-2",
"psp": "sony-psp",
"psx": "sony-playstation",
"satellaview": "nintendo-satellaview",
"saturn": "sega-saturn",
"scummvm": "scummvm",
"segacd": "sega-mega-cd",
"sharp-x68000": "sharp-x68000",
"sms": "sega-master-system",
"snes": "nintendo-snes",
"sufami-turbo": "nintendo-sufami-turbo",
"super-gb": "nintendo-sgb",
"tg16": "nec-pc-engine",
"tvc": "videoton-tvc",
"videopac-g7400": "philips-videopac",
"wolfenstein": "wolfenstein-3d",
"x1": "sharp-x1",
"xbox": "microsoft-xbox",
"zxs": "sinclair-zx-spectrum",
}
class Scraper(BaseScraper):
"""Scraper for RomM known_bios_files.json."""
def __init__(self, url: str = SOURCE_URL):
super().__init__(url=url)
self._parsed: dict | None = None
def _parse_json(self) -> dict:
if self._parsed is not None:
return self._parsed
raw = self._fetch_raw()
try:
self._parsed = json.loads(raw)
except json.JSONDecodeError as e:
raise ValueError(f"Failed to parse JSON: {e}") from e
return self._parsed
def fetch_requirements(self) -> list[BiosRequirement]:
"""Parse known_bios_files.json and return BIOS requirements."""
raw = self._fetch_raw()
if not self.validate_format(raw):
raise ValueError("known_bios_files.json format validation failed")
data = self._parse_json()
requirements = []
for key, entry in data.items():
if ":" not in key:
continue
igdb_slug, filename = key.split(":", 1)
system = SLUG_MAP.get(igdb_slug)
if not system:
print(f"Warning: unmapped IGDB slug '{igdb_slug}'", file=sys.stderr)
continue
sha1 = (entry.get("sha1") or "").strip() or None
md5 = (entry.get("md5") or "").strip() or None
crc32 = (entry.get("crc") or "").strip() or None
size = int(entry["size"]) if entry.get("size") else None
requirements.append(BiosRequirement(
name=filename,
system=system,
sha1=sha1,
md5=md5,
crc32=crc32,
size=size,
destination=f"{igdb_slug}/{filename}",
required=True,
))
return requirements
def validate_format(self, raw_data: str) -> bool:
"""Validate that raw_data is a JSON dict with slug:filename keys."""
try:
data = json.loads(raw_data)
except (json.JSONDecodeError, TypeError):
return False
if not isinstance(data, dict):
return False
for key in list(data.keys())[:5]:
if ":" not in key:
return False
_, entry = key.split(":", 1), data[key]
if not isinstance(data[key], dict):
return False
if "md5" not in data[key] and "sha1" not in data[key]:
return False
return len(data) > 0
def generate_platform_yaml(self) -> dict:
"""Generate a platform YAML config dict from scraped data."""
requirements = self.fetch_requirements()
systems: dict[str, dict] = {}
for req in requirements:
if req.system not in systems:
systems[req.system] = {"files": []}
entry: dict = {
"name": req.name,
"destination": req.destination,
"required": req.required,
}
if req.sha1:
entry["sha1"] = req.sha1
if req.md5:
entry["md5"] = req.md5
if req.crc32:
entry["crc32"] = req.crc32
if req.size:
entry["size"] = req.size
systems[req.system]["files"].append(entry)
version = ""
tag = fetch_github_latest_version(GITHUB_REPO)
if tag:
version = tag
return {
"inherits": "emulatorjs",
"platform": "RomM",
"version": version,
"homepage": "https://romm.app",
"source": SOURCE_URL,
"base_destination": "bios",
"hash_type": "sha1",
"verification_mode": "md5",
"systems": systems,
}
def main():
from scripts.scraper.base_scraper import scraper_cli
scraper_cli(Scraper, "Scrape RomM BIOS requirements")
if __name__ == "__main__":
main()

View File

@@ -25,7 +25,7 @@ import sys
from pathlib import Path
sys.path.insert(0, os.path.dirname(__file__))
from common import compute_hashes, list_registered_platforms, load_database as _load_database
from common import compute_hashes, load_database as _load_database
try:
import yaml
@@ -107,8 +107,9 @@ def load_platform_hashes(platforms_dir: str) -> dict:
if not os.path.isdir(platforms_dir) or yaml is None:
return known
for name in list_registered_platforms(platforms_dir, include_archived=True):
f = Path(platforms_dir) / f"{name}.yml"
for f in Path(platforms_dir).glob("*.yml"):
if f.name.startswith("_"):
continue
with open(f) as fh:
try:
config = yaml.safe_load(fh) or {}

View File

@@ -80,14 +80,12 @@ def verify_entry_existence(
required = file_entry.get("required", True)
if not local_path:
return {"name": name, "status": Status.MISSING, "required": required}
result = {"name": name, "status": Status.OK, "required": required}
if validation_index:
reason = check_file_validation(local_path, name, validation_index)
if reason:
ventry = validation_index.get(name, {})
emus = ", ".join(ventry.get("emulators", []))
result["discrepancy"] = f"file present (OK) but {emus} says {reason}"
return result
return {"name": name, "status": Status.UNTESTED, "required": required,
"path": local_path, "reason": reason}
return {"name": name, "status": Status.OK, "required": required}
def verify_entry_md5(
@@ -320,34 +318,6 @@ def find_exclusion_notes(
# Platform verification
# ---------------------------------------------------------------------------
def _find_best_variant(
file_entry: dict, db: dict, current_path: str,
validation_index: dict,
) -> str | None:
"""Search for a repo file that passes both platform MD5 and emulator validation."""
fname = file_entry.get("name", "")
if not fname or fname not in validation_index:
return None
md5_expected = file_entry.get("md5", "")
md5_set = {m.strip().lower() for m in md5_expected.split(",") if m.strip()} if md5_expected else set()
by_name = db.get("indexes", {}).get("by_name", {})
files_db = db.get("files", {})
for sha1 in by_name.get(fname, []):
candidate = files_db.get(sha1, {})
path = candidate.get("path", "")
if not path or not os.path.exists(path) or os.path.realpath(path) == os.path.realpath(current_path):
continue
if md5_set and candidate.get("md5", "").lower() not in md5_set:
continue
reason = check_file_validation(path, fname, validation_index)
if reason is None:
return path
return None
def verify_platform(
config: dict, db: dict,
emulators_dir: str = DEFAULT_EMULATORS_DIR,
@@ -391,20 +361,13 @@ def verify_platform(
)
else:
result = verify_entry_md5(file_entry, local_path, resolve_status)
# Emulator-level validation: informational for platform packs.
# Platform verification (MD5) is the authority. Emulator
# mismatches are reported as discrepancies, not failures.
# Apply emulator-level validation on top of MD5 check
if result["status"] == Status.OK and local_path and validation_index:
fname = file_entry.get("name", "")
reason = check_file_validation(local_path, fname, validation_index)
if reason:
better = _find_best_variant(
file_entry, db, local_path, validation_index,
)
if not better:
ventry = validation_index.get(fname, {})
emus = ", ".join(ventry.get("emulators", []))
result["discrepancy"] = f"{platform} says OK but {emus} says {reason}"
result["status"] = Status.UNTESTED
result["reason"] = reason
result["system"] = sys_id
result["hle_fallback"] = hle_index.get(file_entry.get("name", ""), False)
details.append(result)
@@ -507,14 +470,6 @@ def print_platform_result(result: dict, group: list[str]) -> None:
req = "required" if d.get("required", True) else "optional"
hle = ", HLE available" if d.get("hle_fallback") else ""
print(f" MISSING ({req}{hle}): {key}")
for d in result["details"]:
disc = d.get("discrepancy")
if disc:
key = f"{d['system']}/{d['name']}"
if key in seen_details:
continue
seen_details.add(key)
print(f" DISCREPANCY: {key}{disc}")
# Cross-reference: undeclared files used by cores
undeclared = result.get("undeclared_files", [])

View File

@@ -763,15 +763,15 @@ class TestE2E(unittest.TestCase):
self.assertIn("crc32 mismatch", reason)
def test_75_validation_applied_in_existence_mode(self):
"""Existence mode reports discrepancy when validation fails, keeps OK."""
"""Existence platform downgrades OK to UNTESTED when validation fails."""
config = load_platform_config("test_existence", self.platforms_dir)
profiles = load_emulator_profiles(self.emulators_dir)
result = verify_platform(config, self.db, self.emulators_dir, profiles)
# present_opt.bin exists but has wrong expected size - OK with discrepancy
# present_opt.bin exists but has wrong expected size → UNTESTED
for d in result["details"]:
if d["name"] == "present_opt.bin":
self.assertEqual(d["status"], Status.OK)
self.assertIn("size mismatch", d.get("discrepancy", ""))
self.assertEqual(d["status"], Status.UNTESTED)
self.assertIn("size mismatch", d.get("reason", ""))
break
else:
self.fail("present_opt.bin not found in details")

View File

@@ -1,144 +0,0 @@
# Architecture - RetroBIOS
## Directory structure
```
bios/ BIOS and firmware files, organized by Manufacturer/Console/
Manufacturer/Console/ canonical files (one per unique content)
.variants/ alternate versions (different hash, same purpose)
emulators/ one YAML profile per core (285 profiles)
platforms/ one YAML config per platform (scraped from upstream)
_shared.yml shared file groups across platforms
_registry.yml platform metadata (logos, scrapers, status)
_data_dirs.yml data directory definitions (Dolphin Sys, PPSSPP...)
scripts/ all tooling (Python, pyyaml only dependency)
scraper/ upstream scrapers (libretro, batocera, recalbox...)
data/ cached data directories (not BIOS, fetched at build)
schemas/ JSON schemas for validation
tests/ E2E test suite with synthetic fixtures
dist/ generated packs (gitignored)
.cache/ hash cache and large file downloads (gitignored)
```
## Data flow
```
Upstream sources Scrapers parse generate_db.py scans
System.dat (libretro) + fetch versions bios/ on disk
batocera-systems builds database.json
es_bios.xml (recalbox) (SHA1 primary key,
core-info .info files indexes: by_md5, by_name,
by_crc32, by_path_suffix)
emulators/*.yml verify.py checks generate_pack.py resolves
source-verified platform-native files by hash, builds ZIP
from code verification packs per platform
```
## Three layers of data
| Layer | Source | Role |
|-------|--------|------|
| Platform YAML | Scraped from upstream | What the platform declares it needs |
| `_shared.yml` | Curated | Shared files across platforms, reflects actual behavior |
| Emulator profiles | Source-verified | What the code actually loads. Used for cross-reference and gap detection |
The pack combines platform baseline (layer 1) with core requirements (layer 3).
Neither too much (no files from unused cores) nor too few (no missing files for active cores).
## Pack grouping
Platforms that produce identical packs are grouped automatically.
RetroArch and Lakka share the same files and `base_destination` (`system/`),
so they produce one combined pack (`RetroArch_Lakka_BIOS_Pack.zip`).
RetroPie uses `BIOS/` as base path, so it gets a separate pack.
## Storage tiers
| Tier | Meaning |
|------|---------|
| `embedded` (default) | file is in the `bios/` directory, included in packs |
| `external` | file has a `source_url`, downloaded at pack build time |
| `user_provided` | user must provide the file (instructions included in pack) |
## Verification severity
How missing or mismatched files are reported:
| Mode | required + missing | optional + missing | hash mismatch |
|------|-------------------|-------------------|--------------|
| existence | WARNING | INFO | N/A |
| md5 | CRITICAL | WARNING | UNTESTED |
Files with `hle_fallback: true` are downgraded to INFO when missing
(the emulator has a software fallback).
## Discrepancy detection
When a file passes platform verification (MD5 match) but fails
emulator-level validation (wrong CRC32, wrong size), a DISCREPANCY is reported.
The pack generator searches the repo for a variant that satisfies both.
If none exists, the platform version is kept.
## Security
- `safe_extract_zip()` prevents zip-slip path traversal attacks
- `deterministic_zip` rebuilds MAME ZIPs so same ROMs always produce the same hash
- `crypto_verify.py` and `sect233r1.py` verify 3DS RSA-2048 signatures and AES-128-CBC integrity
- ZIP inner ROM verification via `checkInsideZip()` replicates Batocera's behavior
- `md5_composite()` replicates Recalbox's composite ZIP hash
## Edge cases
| Case | Handling |
|------|---------|
| Batocera truncated MD5 (29 chars) | prefix match in resolution |
| `zippedFile` entries | MD5 is of the ROM inside the ZIP, not the ZIP itself |
| Regional variants (same filename) | `by_path_suffix` index disambiguates |
| MAME BIOS ZIPs | `contents` field documents inner structure |
| RPG Maker/ScummVM | excluded from dedup (NODEDUP) to preserve directory structure |
| `strip_components` in data dirs | flattens cache prefix to match expected path |
| case-insensitive dedup | prevents `font.rom` + `FONT.ROM` conflicts on Windows/macOS |
## Platform inheritance
Platform configs support `inherits:` to share definitions.
Lakka inherits from RetroArch, RetroPie inherits from RetroArch with `base_destination: BIOS`.
`overrides:` allows child platforms to modify specific systems from the parent.
Core resolution (`resolve_platform_cores`) uses three strategies:
- `cores: all_libretro` - include all profiles with `libretro` in their type
- `cores: [list]` - include only named profiles
- `cores:` absent - fallback to system ID intersection between platform and profiles
## MAME clone map
`_mame_clones.json` at repo root maps MAME clone ROM names to their canonical parent.
When a clone ZIP was deduplicated, `resolve_local_file` uses this map to find the canonical file.
## Tests
`tests/test_e2e.py` contains 75 end-to-end tests with synthetic fixtures.
Covers: file resolution, verification, severity, cross-reference, aliases,
inheritance, shared groups, data dirs, storage tiers, HLE, launchers,
platform grouping, core resolution (3 strategies + alias exclusion).
```bash
python -m unittest tests.test_e2e -v
```
## CI workflows
| Workflow | File | Trigger | Role |
|----------|------|---------|------|
| Build & Release | `build.yml` | `workflow_dispatch` (manual) | restore large files, build packs, deploy site, create GitHub release |
| PR Validation | `validate.yml` | pull request on `bios/`/`platforms/` | validate BIOS hashes, schema check, run tests, auto-label PR |
| Weekly Sync | `watch.yml` | cron (Monday 6 AM UTC) + manual | scrape upstream sources, detect changes, create update PR |
Build workflow has a 7-day rate limit between releases and keeps the 3 most recent.
## License
See `LICENSE` at repo root. Files are provided for personal backup and archival.

View File

@@ -1,19 +0,0 @@
# Wiki - RetroBIOS
Technical documentation for the RetroBIOS toolchain.
## Pages
- **[Architecture](architecture.md)** - directory structure, data flow, platform inheritance, pack grouping, security, edge cases, CI workflows
- **[Tools](tools.md)** - CLI reference for every script, pipeline usage, scrapers
- **[Profiling guide](profiling.md)** - how to create an emulator profile from source code, step by step, with YAML field reference
- **[Data model](data-model.md)** - database.json structure, indexes, file resolution order, YAML formats
## For users
If you just want to download BIOS packs, see the [home page](../index.md).
## For contributors
Start with the [profiling guide](profiling.md) to understand how emulator profiles are built,
then see [contributing](../contributing.md) for submission guidelines.

View File

@@ -1,132 +0,0 @@
# Profiling guide - RetroBIOS
How to create an emulator profile from source code.
## Approach
A profile documents what an emulator loads at runtime.
The source code is the reference because it reflects actual behavior.
Documentation, .info files, and wikis are useful starting points
but are verified against the code.
## Steps
### 1. Find the source code
Check these locations in order:
1. Upstream original (the emulator's own repository)
2. Libretro fork (may have adapted paths or added files)
3. If not on GitHub: GitLab, Codeberg, SourceForge, archive.org
Always clone both upstream and libretro port to compare.
### 2. Trace file loading
Read the code flow. Don't grep keywords by assumption.
Each emulator has its own way of loading files.
Look for:
- `fopen`, `open`, `read_file`, `load_rom`, `load_bios` calls
- `retro_system_directory` / `system_dir` in libretro cores
- File existence checks (`path_is_valid`, `file_exists`)
- Hash validation (MD5, CRC32, SHA1 comparisons in code)
- Size validation (`fseek`/`ftell`, `stat`, fixed buffer sizes)
### 3. Determine required vs optional
This is decided by code behavior, not by judgment:
- **required**: the core does not start or function without the file
- **optional**: the core works with degraded functionality without it
- **hle_fallback: true**: the core has a high-level emulation path when the file is missing
### 4. Document divergences
When the libretro port differs from the upstream:
- `mode: libretro` - file only used by the libretro core
- `mode: standalone` - file only used in standalone mode
- `mode: both` - used by both (default, can be omitted)
Path differences (current dir vs system_dir) are normal adaptation,
not a divergence. Name changes (e.g. `naomi2_` to `n2_`) may be intentional
to avoid conflicts in the shared system directory.
### 5. Write the YAML profile
```yaml
emulator: Dolphin
type: standalone + libretro
core_classification: community_fork
source: https://github.com/libretro/dolphin
upstream: https://github.com/dolphin-emu/dolphin
profiled_date: 2026-03-25
core_version: 5.0-21264
systems:
- nintendo-gamecube
- nintendo-wii
files:
- name: GC/USA/IPL.bin
system: nintendo-gamecube
required: false
hle_fallback: true
size: 2097152
validation: [size, adler32]
known_hash_adler32: 0x4f1f6f5c
region: north-america
source_ref: Source/Core/Core/Boot/Boot_BS2Emu.cpp:42
```
### 6. Validate
```bash
python scripts/cross_reference.py --emulator dolphin --json
python scripts/verify.py --emulator dolphin
```
## YAML field reference
### Profile fields
| Field | Required | Description |
|-------|----------|-------------|
| `emulator` | yes | display name |
| `type` | yes | `libretro`, `standalone`, `standalone + libretro`, `alias`, `launcher` |
| `core_classification` | no | `pure_libretro`, `official_port`, `community_fork`, `frozen_snapshot`, `enhanced_fork`, `game_engine`, `embedded_hle`, `alias`, `launcher` |
| `source` | yes | libretro core repository URL |
| `upstream` | no | original emulator repository URL |
| `profiled_date` | yes | date of source analysis |
| `core_version` | yes | version analyzed |
| `systems` | yes | list of system IDs this core handles |
| `cores` | no | list of core names (default: profile filename) |
| `files` | yes | list of file entries |
| `notes` | no | free-form technical notes |
| `exclusion_note` | no | why the profile has no files |
| `data_directories` | no | references to data dirs in `_data_dirs.yml` |
### File entry fields
| Field | Description |
|-------|-------------|
| `name` | filename as the core expects it |
| `required` | true if the core needs this file to function |
| `system` | system ID this file belongs to |
| `size` | expected size in bytes |
| `md5`, `sha1`, `crc32`, `sha256` | expected hashes from source code |
| `validation` | list of checks the code performs: `size`, `crc32`, `md5`, `sha1` |
| `aliases` | alternate filenames for the same file |
| `mode` | `libretro`, `standalone`, or `both` |
| `hle_fallback` | true if a high-level emulation path exists |
| `category` | `bios` (default), `game_data`, `bios_zip` |
| `region` | geographic region (e.g. `north-america`, `japan`) |
| `source_ref` | source file and line number |
| `path` | path relative to system directory |
| `description` | what this file is |
| `note` | additional context |
| `archive` | parent ZIP if this file is inside an archive |
| `contents` | structure of files inside a BIOS ZIP |
| `storage` | `embedded` (default), `external`, `user_provided` |

View File

@@ -1,130 +0,0 @@
# Tools - RetroBIOS
All tools are Python scripts in `scripts/`. Single dependency: `pyyaml`.
## Pipeline
Run everything in sequence:
```bash
python scripts/pipeline.py --offline # DB + verify + packs + readme + site
python scripts/pipeline.py --offline --skip-packs # DB + verify only
python scripts/pipeline.py --skip-docs # skip readme + site generation
```
## Individual tools
### generate_db.py
Scan `bios/` and build `database.json` with multi-indexed lookups.
Large files in `.gitignore` are preserved from the existing database
and downloaded from GitHub release assets if not cached locally.
```bash
python scripts/generate_db.py --force --bios-dir bios --output database.json
```
### verify.py
Check BIOS coverage for each platform using its native verification mode.
```bash
python scripts/verify.py --all # all platforms
python scripts/verify.py --platform batocera # single platform
python scripts/verify.py --emulator dolphin # single emulator
python scripts/verify.py --system atari-lynx # single system
```
Verification modes per platform:
| Platform | Mode | Logic |
|----------|------|-------|
| RetroArch, Lakka, RetroPie | existence | file present = OK |
| Batocera, RetroBat | md5 | MD5 hash match |
| Recalbox | md5 | MD5 multi-hash, 3 severity levels |
| EmuDeck | md5 | MD5 whitelist per system |
| RetroDECK | md5 | MD5 per file via component manifests |
| RomM | md5 | size + any hash (MD5/SHA1/CRC32) |
### generate_pack.py
Build platform-specific BIOS ZIP packs.
```bash
python scripts/generate_pack.py --all --output-dir dist/
python scripts/generate_pack.py --platform batocera
python scripts/generate_pack.py --emulator dolphin
python scripts/generate_pack.py --system atari-lynx
```
Packs include platform baseline files plus files required by the platform's cores.
When a file passes platform verification but fails emulator validation,
the tool searches for a variant that satisfies both.
If none exists, the platform version is kept and the discrepancy is reported.
### cross_reference.py
Compare emulator profiles against platform configs.
Reports files that cores need but platforms don't declare.
```bash
python scripts/cross_reference.py # all
python scripts/cross_reference.py --emulator dolphin # single
```
### refresh_data_dirs.py
Fetch data directories (Dolphin Sys, PPSSPP assets, blueMSX databases)
from upstream repositories into `data/`.
```bash
python scripts/refresh_data_dirs.py
python scripts/refresh_data_dirs.py --key dolphin-sys --force
```
### Other tools
| Script | Purpose |
|--------|---------|
| `dedup.py` | Deduplicate `bios/`, move duplicates to `.variants/`. RPG Maker and ScummVM excluded (NODEDUP) |
| `validate_pr.py` | Validate BIOS files in pull requests |
| `auto_fetch.py` | Fetch missing BIOS files from known sources |
| `list_platforms.py` | List active platforms (used by CI) |
| `download.py` | Download packs from GitHub releases |
| `common.py` | Shared library: hash computation, file resolution, platform config loading, emulator profiles |
| `generate_readme.py` | Generate README.md and CONTRIBUTING.md from database |
| `generate_site.py` | Generate all MkDocs site pages (this documentation) |
| `deterministic_zip.py` | Rebuild MAME BIOS ZIPs deterministically (same ROMs = same hash) |
| `crypto_verify.py` | 3DS RSA signature and AES crypto verification |
| `sect233r1.py` | Pure Python ECDSA verification on sect233r1 curve (3DS OTP cert) |
| `batch_profile.py` | Batch profiling automation for libretro cores |
| `migrate.py` | Migrate flat bios structure to Manufacturer/Console/ hierarchy |
## Large files
Files over 50 MB are stored as assets on the `large-files` GitHub release.
They are listed in `.gitignore` so they don't bloat the git repository.
`generate_db.py` downloads them from the release when rebuilding the database,
using `fetch_large_file()` from `common.py`. The same function is used by
`generate_pack.py` when a file has a hash mismatch with the local variant.
## Scrapers
Located in `scripts/scraper/`. Each inherits `BaseScraper` and implements `fetch_requirements()`.
| Scraper | Source | Format |
|---------|--------|--------|
| `libretro_scraper` | System.dat + core-info .info files | clrmamepro DAT |
| `batocera_scraper` | batocera-systems script | Python dict |
| `recalbox_scraper` | es_bios.xml | XML |
| `retrobat_scraper` | batocera-systems.json | JSON |
| `emudeck_scraper` | checkBIOS.sh | Bash + CSV |
| `retrodeck_scraper` | component manifests | JSON per component |
| `coreinfo_scraper` | .info files from libretro-core-info | INI-like |
Internal modules: `base_scraper.py` (abstract base with `_fetch_raw()` caching
and shared CLI), `dat_parser.py` (clrmamepro DAT format parser).
Adding a scraper: inherit `BaseScraper`, implement `fetch_requirements()`,
call `scraper_cli(YourScraper)` in `__main__`.