mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-10-20 10:23:16 -05:00
docs: say what a pack holds in plain words
The README opened on a sales line. It now says what a pack holds: the files its emulators read, as their source code names them, minus what the emulators install themselves.
This commit is contained in:
Abdessamad Derraz committed
1 parent
2cba2383ca
commit
0ade9c8339
2 files changed
+26
-27
No files matched your search
@@ -6,9 +6,9 @@
|
||||
<a href="https://github.com/Abdess/retrobios/actions/workflows/deploy-site.yml"><img src="https://github.com/Abdess/retrobios/actions/workflows/deploy-site.yml/badge.svg" alt="Site"></a>
|
||||
</p>
|
||||
|
||||
Complete BIOS and firmware packs for Batocera, BizHawk, EmuDeck, Lakka, MiSTer FPGA, ROCKNIX, Recalbox, RetroArch, RetroBat, RetroDECK, RetroPie, and RomM.
|
||||
BIOS and firmware files for Batocera, BizHawk, EmuDeck, Lakka, MiSTer FPGA, ROCKNIX, Recalbox, RetroArch, RetroBat, RetroDECK, RetroPie, and RomM, one pack per platform.
|
||||
|
||||
Pick your platform below and extract the pack: it carries every file its emulators load, read from their source code. Nothing to configure, nothing to hunt down.
|
||||
A pack holds the files its emulators read, as their source code names them, and leaves out what the emulators install themselves.
|
||||
|
||||
## Quick Install
|
||||
|
||||
@@ -68,17 +68,17 @@ These are the files an emulator loads from disk instead of carrying inside itsel
|
||||
|
||||
Each file is checked the way your platform checks it. Most compare a checksum, the fingerprint of a file's contents, which catches a corrupt or unexpected copy. RetroArch, Lakka and RetroPie only look for the filename, because that is all their code does: the Coverage table says which applies to you. Independently of that, the collection records five fingerprints per file, and wherever an emulator's code states an expected size or hash, that value is read from its source and rechecked here.
|
||||
|
||||
- **423 files** the platforms' emulators load are still to be found, and 55 more cannot be sourced at all (per-user keys, user-filled slots, dumps nobody has made). Both are named in the [gap analysis](https://abdess.github.io/retrobios/gaps/)
|
||||
- **648 files** the platforms' emulators load are still to be found, and 134 more cannot be sourced at all (per-user keys, user-filled slots, dumps nobody has made). Both are named in the [gap analysis](https://abdess.github.io/retrobios/gaps/)
|
||||
- **12 platforms** supported with platform-specific verification
|
||||
- **531 emulators** profiled from source (RetroArch cores + standalone)
|
||||
- **514 systems** handled by those emulators (NES, SNES, PlayStation, Saturn, Dreamcast, ...)
|
||||
- **601 emulators** profiled from source (RetroArch cores + standalone)
|
||||
- **533 systems** handled by those emulators (NES, SNES, PlayStation, Saturn, Dreamcast, ...)
|
||||
- **20,382 files in the collection**, each with its SHA1, MD5, SHA256, CRC32 and Adler-32 fingerprints: 6,640 system files, 2,813 arcade ROM sets, 10,929 game and engine data files. That is every platform and emulator together, so no pack holds them all: each carries what its own emulators load, counted in the download table
|
||||
- **563 of 6,640 system files** matched to dump-preservation catalogs (No-Intro, Redump, TOSEC). Arcade sets and engine data fall outside what those catalogs index
|
||||
- **16822 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 480+ more.
|
||||
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 499+ more.
|
||||
|
||||
Full list with per-file details: **[https://abdess.github.io/retrobios/](https://abdess.github.io/retrobios/)**
|
||||
|
||||
@@ -86,17 +86,17 @@ Full list with per-file details: **[https://abdess.github.io/retrobios/](https:/
|
||||
|
||||
| Platform | On its BIOS list | Files its emulators load | Checked by |
|
||||
|----------|-----------------:|-------------------------:|------------|
|
||||
| Batocera | 353/353 | 13,641/14,075 | MD5 hash |
|
||||
| Batocera | 353/353 | 6,741/14,075 | MD5 hash |
|
||||
| BizHawk | 118/118 | - | SHA1 hash |
|
||||
| EmuDeck | 168/168 | 5,816/5,852 | MD5 hash |
|
||||
| Lakka | 532/532 | 5,270/5,302 | file presence |
|
||||
| EmuDeck | 168/168 | 5,808/5,852 | MD5 hash |
|
||||
| Lakka | 532/532 | 5,268/5,302 | file presence |
|
||||
| MiSTer FPGA | 81/81 | - | MD5 hash |
|
||||
| ROCKNIX | 38/38 | 5,933/6,015 | MD5 hash |
|
||||
| Recalbox | 351/351 | 4,073/4,091 | MD5 hash |
|
||||
| RetroArch | 526/526 | 5,282/5,314 | file presence |
|
||||
| RetroBat | 348/348 | 8,546/8,708 | MD5 hash |
|
||||
| RetroDECK | 2,007/2,008 | 5,328/5,382 | MD5 hash |
|
||||
| RetroPie * | 532/532 | 9,200/9,344 | file presence |
|
||||
| ROCKNIX | 38/38 | 5,914/6,015 | MD5 hash |
|
||||
| Recalbox | 351/351 | 2,745/4,098 | MD5 hash |
|
||||
| RetroArch | 526/526 | 5,280/5,314 | file presence |
|
||||
| RetroBat | 348/348 | 3,515/9,041 | MD5 hash |
|
||||
| RetroDECK | 2,007/2,008 | 5,321/5,382 | MD5 hash |
|
||||
| RetroPie * | 532/532 | 5,640/9,572 | file presence |
|
||||
| RomM | 383/383 | 61/792 | MD5 hash |
|
||||
|
||||
Each fraction is what the pack has over what is needed, counting required and optional files alike since both ship. The first column is the BIOS list the platform publishes. The second counts files its emulators load that this list never mentions, found by reading their source code, and it is routinely several times larger. A short fraction means files are still missing, and they are named in the [gap analysis](https://abdess.github.io/retrobios/gaps/).
|
||||
@@ -141,7 +141,7 @@ The [documentation site](https://abdess.github.io/retrobios/) provides:
|
||||
- **Per-emulator profiles** with source code references for every file
|
||||
- **Per-system pages** showing which emulators and platforms cover each console
|
||||
- **Gap analysis** identifying missing files and undeclared core requirements
|
||||
- **Cross-reference** mapping files across 12 platforms and 531 emulators
|
||||
- **Cross-reference** mapping files across 12 platforms and 601 emulators
|
||||
- **Versioned data access** through JSON, CSV and SQLite exports with published SHA-256 checksums
|
||||
|
||||
## How it works
|
||||
@@ -180,4 +180,4 @@ The scripts and tooling are released under the [MIT License](LICENSE).
|
||||
The BIOS and firmware files are not covered by that license: they are third-party system software, preserved and provided for personal backup, archival, and interoperability with emulation software. [NOTICE](NOTICE) sets out their status and how to ask for a file to be removed.
|
||||
The reasoning, and where it is weakest, is in the [FAQ](https://abdess.github.io/retrobios/wiki/faq/#is-this-legal).
|
||||
|
||||
*Auto-generated on 2026-10-20T03:40:18Z*
|
||||
*Auto-generated on 2026-10-20T04:06:59Z*
|
||||
@@ -187,6 +187,12 @@ def download_table(
|
||||
return lines
|
||||
|
||||
|
||||
def _names_list(coverages: dict) -> str:
|
||||
"""The platforms' names in reading order, the last after "and"."""
|
||||
names = sorted(c["platform"] for c in coverages.values())
|
||||
return ", ".join(names[:-1]) + f", and {names[-1]}" if len(names) > 1 else "".join(names)
|
||||
|
||||
|
||||
def collection_line(total_files: int, comp: dict) -> str:
|
||||
"""The size of the whole collection, said as such.
|
||||
|
||||
@@ -340,17 +346,10 @@ def generate_readme(db: dict, platforms_dir: str) -> str:
|
||||
'<img src="https://github.com/Abdess/retrobios/actions/workflows/deploy-site.yml/badge.svg" alt="Site"></a>',
|
||||
"</p>",
|
||||
"",
|
||||
f"Complete BIOS and firmware packs for "
|
||||
f"{', '.join(c['platform'] for c in sorted(coverages.values(), key=lambda x: x[
|
||||
'platform'
|
||||
])[:-1])}"
|
||||
f", and {sorted(coverages.values(), key=lambda x: x[
|
||||
'platform'
|
||||
])[-1]['platform']}.",
|
||||
f"BIOS and firmware files for {_names_list(coverages)}, one pack per platform.",
|
||||
"",
|
||||
f"Pick your platform below and extract the pack: it carries every file"
|
||||
f" its emulators load, read from their source code. Nothing to"
|
||||
f" configure, nothing to hunt down.",
|
||||
"A pack holds the files its emulators read, as their source code names"
|
||||
" them, and leaves out what the emulators install themselves.",
|
||||
"",
|
||||
"## Quick Install",
|
||||
"",
|
||||
|
||||
Reference in new issue
Block a user