mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-11-20 16:47:49 -06:00
docs: state only what the code proves
Each claim in the README and the wiki now matches the code or data it describes: line citations counted as such (93%), closed-source profiles named, severity tied to the check mode, installs limited to files the collection holds, and the demo labelled as a demonstration card.
This commit is contained in:
1 parent
36e42557dd
commit
f44ef8459e
15 files changed
+78
-49
No files matched your search
+7
-4
@@ -8,7 +8,9 @@ terms: ios, iphone, ipad
|
||||
|
||||
## Are BIOS files needed? { #do-i-need-bios-files }
|
||||
|
||||
- **Yes** for PlayStation 1 and 2, Saturn and Neo Geo.
|
||||
- **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.
|
||||
- **Usually not** for NES or Super Nintendo.
|
||||
|
||||
@@ -63,7 +65,7 @@ Game sets must match the emulator's version:
|
||||
- It stops if the installer does not match its expected fingerprint, and
|
||||
checks each file.
|
||||
- It fills the BIOS folder, some save folders and a games cache.
|
||||
- It never touches games or saves.
|
||||
- It never touches games or save files.
|
||||
- It keeps each file it replaces in `retrobios-backup`, for `--restore`.
|
||||
|
||||
Read them: [install.sh](https://github.com/Abdess/retrobios/blob/main/install.sh),
|
||||
@@ -78,7 +80,7 @@ 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
|
||||
setup's files and checks each one. `--dry-run` shows the list first.
|
||||
file the collection holds for each setup and checks each one. `--dry-run` shows the list first.
|
||||
|
||||
## Fill an SD card from a computer?
|
||||
|
||||
@@ -110,7 +112,8 @@ 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.
|
||||
Some come with the emulator. Others are not in the collection yet:
|
||||
[what is still missing](../gaps.md) names each one.
|
||||
|
||||
## A game shows a black screen { #my-game-shows-a-black-screen }
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ order: 30
|
||||
|
||||
# First install, step by step
|
||||
|
||||
From an empty BIOS folder to games that start.
|
||||
From an empty BIOS folder to every BIOS file the setup's list names.
|
||||
|
||||
**Needed:** internet and some free space.
|
||||
|
||||
@@ -102,7 +102,8 @@ Esc or Ctrl+C stops, B on a handheld. Run again to resume.
|
||||
|
||||
## 5. Read the result
|
||||
|
||||
- **Done**: all files are in place.
|
||||
- **Done**: every file the collection holds for this setup is in place. The
|
||||
screen names any file it does not hold.
|
||||
- **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).
|
||||
|
||||
+8
-5
@@ -871,8 +871,9 @@ computer, one subfolder per system. A run that asks nothing (`--yes`,
|
||||
the card, and says so. `--all-files` installs the whole list instead, as does
|
||||
a run narrowed by name (`--system`, `--core`, `--region`, `--emulator`).
|
||||
|
||||
The rule is that every game must start. Per system, the run keeps what the
|
||||
system's default core reads. One region is kept only where the game's own
|
||||
Per system, the run keeps what the system's default core reads for the games
|
||||
found. Another core can need more files: **Install everything** covers every
|
||||
core. One region is kept only where the game's own
|
||||
content proves it: a cartridge's crc32 found in No-Intro, a disc serial found
|
||||
in Redump, or a header the core reads. A file name such as `(Europe)` proves
|
||||
nothing. Where a core forces a region by an option, falls back to another
|
||||
@@ -1021,7 +1022,8 @@ what the options name, everything by default.
|
||||
when every one does, and 1 when the check itself failed. What it lists is under
|
||||
[Why a file is refused](#why-a-file-is-refused). An install leaves a file with
|
||||
the expected hash untouched and replaces any other, the old one kept beside
|
||||
the BIOS folder. Files the list does not name are never read, moved or deleted.
|
||||
the BIOS folder. Files the list does not name are never moved or deleted. A file whose size
|
||||
matches a listed one is read, to find a misplaced copy.
|
||||
|
||||
## Platform detection
|
||||
|
||||
@@ -1338,8 +1340,9 @@ exits 1.
|
||||
|
||||
Some files are read by a standalone emulator from its own data directory
|
||||
rather than from the platform's BIOS tree. `--standalone-copies` copies them
|
||||
there after the install, and only then: without the flag nothing is written
|
||||
outside the selected tree, apart from the files kept in `retrobios-backup`.
|
||||
there after the install, and only then: without the flag a run writes only to the BIOS
|
||||
folder, the save folders its list names, `retrobios-backup` and the
|
||||
installer's cache folder.
|
||||
|
||||
The manifest carries the list on the six platforms that declare one
|
||||
(Batocera, EmuDeck, Recalbox, RetroArch, RetroBat, RetroDECK). It has two
|
||||
|
||||
+3
-1
@@ -8,7 +8,9 @@ terms: license
|
||||
|
||||
It depends on the country. Nothing here is legal advice.
|
||||
|
||||
- Making an emulator is legal in the US. EU law allows it under conditions.
|
||||
- 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.
|
||||
- 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.
|
||||
|
||||
@@ -54,7 +54,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. A record is never changed once added.
|
||||
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.
|
||||
|
||||
The results so far ran on these computers:
|
||||
|
||||
|
||||
+8
-5
@@ -6,8 +6,8 @@ terms: privacy, cookies, analytics, tracking
|
||||
|
||||
# What is counted
|
||||
|
||||
No cookies. No account. Nothing is stored on the device, and nothing
|
||||
links a visit to a person.
|
||||
No cookies. No account. The browser keeps the chosen setup, tab and theme in
|
||||
its own storage, which is never sent. Nothing links a visit to a person.
|
||||
|
||||
## On this site
|
||||
|
||||
@@ -35,7 +35,9 @@ These actions are counted the same way, with the page they happened on:
|
||||
as "other", without its words;
|
||||
- the answer to "Did this page help?".
|
||||
|
||||
Not sent: the screen size, the language, a search that found results.
|
||||
The script adds neither the screen size nor the language, and nothing for a
|
||||
search that found results. GoatCounter reads the headers a browser sends with
|
||||
any request.
|
||||
|
||||
The totals are kept two years and are public:
|
||||
[retrobios.goatcounter.com](https://retrobios.goatcounter.com).
|
||||
@@ -46,8 +48,9 @@ stops GoatCounter changes nothing on the site.
|
||||
|
||||
## The installer
|
||||
|
||||
The installer sends nothing back. It downloads files from GitHub, which sees
|
||||
those requests as it sees any download.
|
||||
The installer sends no report of its own. It downloads files from GitHub,
|
||||
which sees those requests as it sees any download, with the Python or
|
||||
PowerShell version in their header.
|
||||
|
||||
## Search engines
|
||||
|
||||
|
||||
@@ -52,9 +52,9 @@ in its `--json` output. Not all missing files are equally important:
|
||||
|
||||
| Severity | Meaning | Action needed |
|
||||
|----------|---------|---------------|
|
||||
| CRITICAL | Required file missing on an MD5 or SHA1 platform | Must fix. Core won't function. |
|
||||
| WARNING | Optional file missing on an MD5 or SHA1 platform, hash mismatch (UNTESTED) on any hash platform, or a required file missing on an existence platform | Core works but with reduced functionality, or runs on content nobody verified. |
|
||||
| INFO | Optional file missing on an existence-only platform, or a missing file the core covers with an HLE fallback | Core works fine, BIOS improves accuracy. |
|
||||
| CRITICAL | Required file missing on an MD5 or SHA1 platform | The setup's own check fails. Whether the core starts without it is on the emulator's page. |
|
||||
| WARNING | Optional file missing on an MD5 or SHA1 platform, hash mismatch (UNTESTED) on any hash platform, or a required file missing on an existence platform | The setup's check warns, or a file it does not read is absent. The emulator's page says what the core does without it. |
|
||||
| INFO | Optional file missing on an existence-only platform, or a missing file the core covers with an HLE fallback | The profile records that the core runs without it. |
|
||||
| OK | File present and verified | No action needed. |
|
||||
|
||||
The full mapping, including how `hle_fallback` overrides the platform mode, is
|
||||
|
||||
@@ -38,7 +38,8 @@ Read the count line:
|
||||
|
||||
## 2. Fix the files
|
||||
|
||||
Without `--check`, it adds missing files and replaces wrong ones.
|
||||
Without `--check`, it adds the missing files the collection holds and
|
||||
replaces wrong ones.
|
||||
|
||||
## 3. Check the folder and the names
|
||||
|
||||
|
||||
@@ -19,9 +19,11 @@ Example: `scph5501.bin`, MD5 `490f666e1afb15b7362b406ed1cea246`. Any file named
|
||||
|
||||
This project's `verify.py` reproduces each setup's own check, so its report
|
||||
says what the setup itself would say. A missing file is then ranked by
|
||||
**severity**: CRITICAL when the setup cannot start that console, WARNING when
|
||||
it runs degraded or the file's version is in doubt, INFO when nothing visible
|
||||
changes ([severity matrix](#severity-matrix)).
|
||||
**severity**, from the setup's check mode and the `required` flag of its list:
|
||||
CRITICAL for a required file missing where the setup checks hashes, WARNING
|
||||
for a required file missing where it checks names, or a hash in doubt, INFO
|
||||
for an optional file or one the core replaces with a built-in fallback
|
||||
([severity matrix](#severity-matrix)).
|
||||
|
||||
<!-- image: verification-modes -->
|
||||
|
||||
|
||||
@@ -26,8 +26,9 @@ If step 3 fails, the screen says "BIOS missing" or stays black.
|
||||
|
||||
## Which consoles need one? { #do-i-need-one }
|
||||
|
||||
- **Yes:** PlayStation 1 and 2, Saturn, Neo Geo, PC Engine CD and many home
|
||||
computers.
|
||||
- **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.
|
||||
- **Better with it:** Dreamcast. Some games need it.
|
||||
- **Usually not:** NES, Super Nintendo, Mega Drive, Game Boy and Game Boy
|
||||
Advance.
|
||||
@@ -49,7 +50,8 @@ 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.
|
||||
|
||||
The files here are the versions each setup expects.
|
||||
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?
|
||||
|
||||
|
||||
Reference in new issue
Block a user