chore: merge origin/main

This commit is contained in:
Abdessamad Derraz committed 2026-11-09 10:54:08 +01:00
commit 045ad9e3af
49 files changed
+500 -117

No files matched your search

+2
View File
@@ -295,6 +295,8 @@ that text belongs in a guide field.
```yaml
logo: https://... # SVG or PNG for UI/docs
logo_flip: true # a raster stored bottom row first (a boot logo)
logo_trim: true # cut the plain background around the mark
inherits_from: retroarch # the parent, for readers: the merge reads
# inherits: in the platform YAML
case_insensitive_fs: true # if the platform runs on case-insensitive filesystems
+10 -12
View File
@@ -9,9 +9,8 @@ terms: ios, iphone, ipad
## Are BIOS files needed? { #do-i-need-bios-files }
- **Yes** for PlayStation 2 and Neo Geo.
- **Most emulators** for PlayStation 1 and Saturn. Some start games without
it, with a built-in replacement.
- **Better with it** for Dreamcast. Some games need it.
- **Most emulators** for PlayStation 1 and Saturn.
- **Better with it** for Dreamcast.
- **Usually not** for NES or Super Nintendo.
[What is a BIOS?](what-are-bios-files.md)
@@ -36,8 +35,8 @@ curl -fsSL https://abdess.github.io/retrobios/i | sh -s -- --system sony-playsta
## Does the BIOS set the game's language?
Rarely. It comes from the game. Some follow the console's setting, like Flycast's **Language**
option.
It mostly comes from the game. Some follow the console's setting, like Flycast's
**Language** option.
## Zip or unzip? { #zip-or-unzip }
@@ -62,7 +61,7 @@ Game sets must match the emulator's version:
## Is the command safe? { #is-piping-the-installer-into-a-shell-safe }
- It stops if the installer does not match its expected fingerprint, and
- It stops if the installer does not match its fingerprint, and
checks each file.
- It fills the BIOS folder, some save folders and a games cache.
- It never touches games or save files.
@@ -79,13 +78,13 @@ and download their files.
## Why is there no ZIP for a setup? { #why-is-there-no-zip-for-my-setup }
ZIPs are made for the setups most people download. The command installs every
file the collection holds for each setup and checks each one. `--dry-run` shows the list first.
ZIPs are made for the setups most people download. The command installs each
setup's listed files and checks each one. `--dry-run` shows the list first.
## Fill an SD card from a computer?
The interface finds a muOS, Onion, spruceOS, MinUI, KNULLI, ROCKNIX, Lakka or
MiSTer card. Else name the setup and its BIOS folder. For RetroArch on a Switch,
MiSTer card. Else name its setup and BIOS folder. For RetroArch on a Switch,
with the card in drive `E:`, run:
<!-- os-tabs windows: --platform retroarch --dest E:\retroarch\cores\system -->
@@ -112,12 +111,11 @@ Fill it from a computer or point `--from-pack` at the ZIP: [Without a network](i
## Why is a file missing from the ZIP?
Some come with the emulator. Others are not in the collection yet:
[what is still missing](../gaps.md) names each one.
Some come with the emulator. Others are still missing.
## A game shows a black screen { #my-game-shows-a-black-screen }
Often a missing BIOS: [When a game does not start](troubleshooting.md).
Maybe a missing BIOS: [When a game does not start](troubleshooting.md).
## Can an owned console's BIOS be copied? { #copy-your-own-bios }
+8 -8
View File
@@ -5,7 +5,7 @@ order: 30
# First install, step by step
From an empty BIOS folder to every BIOS file the setup's list names.
From an empty BIOS folder to a checked one.
**Needed:** internet and some free space.
@@ -102,13 +102,12 @@ Esc or Ctrl+C stops, B on a handheld. Run again to resume.
## 5. Read the result
- **Done**: every file the collection holds for this setup is in place. The
screen names any file it does not hold.
- **Done**: every file on the list is in place.
- **Finished with errors**: run it again. It retries only those.
- **Finished with files missing**: run it again online.
- **Nothing installed**: the screen says why. See [If it stops](#if-it-stops).
For line-by-line questions (screen readers), add `--plain`.
Screen readers: add `--plain`.
## What the command does
@@ -123,16 +122,17 @@ Add `--check` to the same command. It changes nothing.
curl -fsSL https://abdess.github.io/retrobios/i | sh -s -- --check
```
All good:
Result:
```
Everything is in place.
Every file on the list is in place.
```
Missing required files are named below it.
## Undo
Replaced files go to `retrobios-backup` beside the BIOS folder. The result
says how to restore them.
Replaced files go to `retrobios-backup`, and `--restore` puts them back.
## If it stops
+2 -2
View File
@@ -579,11 +579,11 @@ The same command with `--check` reads the folder and writes nothing:
Checking existing files...
18175 in place, 0 missing, 0 wrong copies
Everything is in place.
Every file on the list is in place.
```
<!-- /generated: run-check -->
`Everything is in place.` is said only when the data folders are complete
`Every file on the list is in place.` is said only when the data folders are complete
too. With the BIOS files in place and data files missing (PPSSPP's assets,
Dolphin's `Sys`), the line counts those instead (`169 data files to fetch`),
and `--check` exits with code 3. The files the collection does not hold are
+2 -3
View File
@@ -8,9 +8,8 @@ terms: license
It depends on the country. Nothing here is legal advice.
- US courts held that copying code to build a compatible emulator can be fair
use (*Sega v. Accolade*, *Sony v. Connectix*). EU law allows it under
conditions.
- US courts have held that building an emulator can be fair use. EU law allows
it under conditions.
- Sharing BIOS files is not settled law. The strongest case is old consoles no
longer sold. The weakest is encryption keys (Switch, 3DS, Wii U).
- The files are here for personal backup and preservation.
+3 -4
View File
@@ -53,10 +53,9 @@ file under the BIOS name: zeros, half the file, or another region's BIOS.
Each result is a full record in the
[`measurements/`](https://github.com/Abdess/retrobios/tree/main/measurements)
folder of this project. It names its method, the computer and the exact build
of the emulator. Records are added, not edited. A change to an existing record (scratch paths
removed on 2026-11-05 and 2026-11-06) is a commit of its own, visible in the
folder's history.
folder. It names its method, the computer and the exact build of the emulator.
Records are added. A change to one is a commit of its own.
The results so far ran on these computers:
+1 -1
View File
@@ -69,7 +69,7 @@ Every module in `tests/`, by the area it guards.
| Pack probe | the cores a platform runs for a system, staging grown to a fixed point, runs mapped to pack and manifest entries, the line and its schema, the probe lock per run, that no page shows its lines. One class builds a real pack narrowed to PlayStation and lays it out both ways, from the archive and with `install.py --dest`, and skips without the collection | `test_pack_probe` |
| Automation runner, disk cleanup, asset sync and bit-flip repair | fake jobs, git repositories with a bare origin and session worktrees, a committed file with one bit flipped, canned CI runs in place of `gh` | `test_autorun` |
| Truth and native export | synthetic + cached originals | `test_export_counts`, `test_export_native_layer`, `test_export_report`, `test_exporters`, `test_truth_data_dir_readers`, `test_truth_diff`, `test_truth_layout` |
| Scrapers, upstream and provenance | inline sources, synthetic | `test_batocera_md5_list`, `test_check_freshness`, `test_cited_lines`, `test_contributing_text`, `test_coverage_cache`, `test_data_dir_refs`, `test_dataclass_defaults`, `test_dedup`, `test_doc_pages`, `test_doc_surfaces`, `test_elec_scrapers`, `test_fbneo_parser`, `test_find_pinned_revision`, `test_hash_merge`, `test_launchers`, `test_launchers_emudeck`, `test_launchers_recalbox`, `test_launchers_retrobat`, `test_launchers_retrodeck`, `test_launchers_retropie`, `test_launchers_rocknix`, `test_mame_devices`, `test_mame_parser`, `test_mame_ref_audit`, `test_optional_dependencies`, `test_pin_build`, `test_profile_sync`, `test_prose_style`, `test_provenance`, `test_refresh_data_dirs`, `test_refresh_failures`, `test_refresh_stale`, `test_retrodeck_scraper_errors`, `test_retired_files`, `test_romset_recipes`, `test_schema_semantic_gate`, `test_scraper_contract`, `test_site_agents`, `test_site_arcade_boards`, `test_site_availability`, `test_site_bootstrap`, `test_site_built_gate`, `test_site_components`, `test_site_console_folders`, `test_site_content_data`, `test_site_copy`, `test_site_cores`, `test_site_css`, `test_site_demo`, `test_site_density_cards`, `test_site_emulator_page`, `test_site_emulators`, `test_site_entry`, `test_site_entry_tables`, `test_site_exports`, `test_site_funnel`, `test_site_images`, `test_site_inputs`, `test_site_insights`, `test_site_integration`, `test_site_nav`, `test_site_picker`, `test_site_platform_density`, `test_site_platform_hashes`, `test_site_privacy`, `test_site_pronouns`, `test_site_reference`, `test_site_render`, `test_site_search`, `test_site_steps`, `test_site_system_links`, `test_site_system_names`, `test_site_system_sections`, `test_site_systems`, `test_site_validation`, `test_site_weight`, `test_site_wiki`, `test_site_write`, `test_source_ref_targets`, `test_upstream`, `test_upstream_index`, `test_validate_pr`, `test_validate_pr_flow`, `test_validate_pr_hashes`, `test_version_basis`, `test_workflow_paths` |
| Scrapers, upstream and provenance | inline sources, synthetic | `test_batocera_md5_list`, `test_check_freshness`, `test_cited_lines`, `test_contributing_text`, `test_coverage_cache`, `test_data_dir_refs`, `test_dataclass_defaults`, `test_dedup`, `test_doc_pages`, `test_doc_surfaces`, `test_elec_scrapers`, `test_fbneo_parser`, `test_find_pinned_revision`, `test_hash_merge`, `test_launchers`, `test_launchers_emudeck`, `test_launchers_recalbox`, `test_launchers_retrobat`, `test_launchers_retrodeck`, `test_launchers_retropie`, `test_launchers_rocknix`, `test_mame_devices`, `test_mame_parser`, `test_mame_ref_audit`, `test_optional_dependencies`, `test_pin_build`, `test_profile_sync`, `test_prose_style`, `test_provenance`, `test_refresh_data_dirs`, `test_refresh_failures`, `test_refresh_stale`, `test_retrodeck_scraper_errors`, `test_retired_files`, `test_romset_recipes`, `test_schema_semantic_gate`, `test_scraper_contract`, `test_site_agents`, `test_site_arcade_boards`, `test_site_availability`, `test_site_bootstrap`, `test_site_built_gate`, `test_site_components`, `test_site_console_folders`, `test_site_content_data`, `test_site_copy`, `test_site_cores`, `test_site_css`, `test_site_demo`, `test_site_density_cards`, `test_site_emulator_page`, `test_site_emulators`, `test_site_entry`, `test_site_entry_tables`, `test_site_exports`, `test_site_freshness`, `test_site_funnel`, `test_site_images`, `test_site_inputs`, `test_site_insights`, `test_site_integration`, `test_site_nav`, `test_site_picker`, `test_site_platform_density`, `test_site_platform_hashes`, `test_site_privacy`, `test_site_pronouns`, `test_site_reference`, `test_site_render`, `test_site_search`, `test_site_steps`, `test_site_system_links`, `test_site_system_names`, `test_site_system_sections`, `test_site_systems`, `test_site_validation`, `test_site_weight`, `test_site_wiki`, `test_site_write`, `test_source_ref_targets`, `test_upstream`, `test_upstream_index`, `test_validate_pr`, `test_validate_pr_flow`, `test_validate_pr_hashes`, `test_version_basis`, `test_workflow_paths` |
| Games on the card | small DATs, listxml and setup sources, a fake fetcher, fixture install lists, and the committed data against its schemas | `test_arcade_parents`, `test_game_catalogs`, `test_game_headers`, `test_game_regions`, `test_games_index`, `test_romfolders_card`, `test_romfolders_es` |
## Test architecture
+2 -6
View File
@@ -27,8 +27,7 @@ If step 3 fails, the screen says "BIOS missing" or stays black.
## Which consoles need one? { #do-i-need-one }
- **Yes:** PlayStation 2, Neo Geo, PC Engine CD and many home computers.
- **Most emulators:** PlayStation 1 and Saturn. Some start games without it,
with a built-in replacement. The emulator's page says which.
- **Most emulators:** PlayStation 1 and Saturn.
- **Better with it:** Dreamcast. Some games need it.
- **Usually not:** NES, Super Nintendo, Mega Drive, Game Boy and Game Boy
Advance.
@@ -50,13 +49,10 @@ another for Europe.
Some setups check each file's **hash**, a fingerprint of its contents.
Batocera, Recalbox and EmuDeck report a version they do not expect.
Where the collection holds a file, it is the version each setup expects.
[What is still missing](../gaps.md) names the rest.
## Can a game start without it?
Sometimes. Some emulators carry their own code in place of the BIOS. Some games
then glitch or do not start. The real file works best, so the packs include it.
then glitch or do not start.
## Is it legal?