mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-11-11 12:33:53 -06:00
docs: write the site without personal pronouns
This commit is contained in:
1 parent
77fef7289f
commit
a70f8bcb34
46 files changed
+273
-273
No files matched your search
Binary file not shown.
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 36 KiB |
+2
-2
@@ -54,8 +54,8 @@ notes: |
|
||||
Place all ROM files directly in the RetroArch system directory. No subdirectory
|
||||
needed. The core does chdir() to system_dir before loading.
|
||||
|
||||
The default model is MSX2+, which needs MSX2P.ROM and MSX2PEXT.ROM. If you only
|
||||
play cartridge ROMs, these two files are sufficient. For disk games (.dsk), also
|
||||
The default model is MSX2+, which needs MSX2P.ROM and MSX2PEXT.ROM. For cartridge
|
||||
ROMs alone, these two files are sufficient. For disk games (.dsk), also
|
||||
add DISK.ROM and enable "Simulate DiskROM" in core options.
|
||||
|
||||
KANJI.ROM and FMPAC.ROM are loaded automatically when present, no option needed.
|
||||
|
||||
+40
-40
@@ -28,10 +28,10 @@ install_base: https://abdess.github.io/retrobios
|
||||
# (place_save_entries), and retrobios-backup beside the folder written to.
|
||||
trust_items:
|
||||
- It checks each file before saving it.
|
||||
- It writes in your BIOS folder. For some emulators it also adds files to your save folder.
|
||||
- It writes in the BIOS folder. For some emulators it also adds files to the save folder.
|
||||
- It never changes or deletes a game or a save.
|
||||
- >-
|
||||
It keeps any file it replaces in a `retrobios-backup` folder, next to your BIOS folder.
|
||||
It keeps any file it replaces in a `retrobios-backup` folder, next to the BIOS folder.
|
||||
`--restore` puts it back.
|
||||
|
||||
# Order of the groups on the picker, in the navigation and on the home page.
|
||||
@@ -57,7 +57,7 @@ device_groups:
|
||||
anchor: game-systems
|
||||
handheld:
|
||||
label: Handhelds and TV boxes (Anbernic, Retroid, Miyoo)
|
||||
description: The system your handheld or TV box starts.
|
||||
description: The system a handheld or TV box starts.
|
||||
anchor: handhelds
|
||||
also_runs:
|
||||
- setup: Android (Retroid Pocket, AYN Odin and others)
|
||||
@@ -88,7 +88,7 @@ device_groups:
|
||||
anchor: fpga
|
||||
server:
|
||||
label: Self-hosted game library
|
||||
description: A RomM server. It plays games in your web browser.
|
||||
description: A RomM server. It plays games in the web browser.
|
||||
anchor: self-hosted
|
||||
|
||||
# Ways to run the installer: the tab label, how to open a terminal there, and
|
||||
@@ -132,7 +132,7 @@ terminals:
|
||||
server:
|
||||
label: On the server
|
||||
how: >-
|
||||
Open a terminal on the machine that holds your RomM library. Put the path of its
|
||||
Open a terminal on the machine that holds the RomM library. Put the path of its
|
||||
`bios` folder after `--dest`.
|
||||
shell: sh
|
||||
|
||||
@@ -287,18 +287,18 @@ guides:
|
||||
pack_manual: |
|
||||
Option B: Manual (PC)
|
||||
---------------------
|
||||
1. Find your RetroArch system directory:
|
||||
1. Find the RetroArch system directory:
|
||||
- RetroArch > Settings > Directory > System/BIOS
|
||||
- Default: retroarch/system/
|
||||
2. Extract all files from this archive directly into your system directory
|
||||
2. Extract all files from this archive directly into the system directory
|
||||
3. Overwrite if asked
|
||||
|
||||
Option C: Manual (handheld / SD card)
|
||||
-------------------------------------
|
||||
1. Connect your SD card to your PC
|
||||
1. Connect the SD card to a PC
|
||||
2. Find the BIOS folder in the list below
|
||||
3. Extract all files from this archive directly into that folder
|
||||
4. Eject SD card and reboot your device
|
||||
4. Eject the SD card and reboot the device
|
||||
|
||||
Folders by device:
|
||||
{folders}
|
||||
@@ -318,9 +318,9 @@ guides:
|
||||
root@batocera.local`, password `linux`. Paste the line. Press Enter.
|
||||
folders:
|
||||
- where: On Batocera
|
||||
- where: From Windows, over your home network
|
||||
- where: From Windows, over the home network
|
||||
path: '`\\BATOCERA\share\bios\`'
|
||||
- where: From a Mac or Linux, over your home network
|
||||
- where: From a Mac or Linux, over the home network
|
||||
path: '`smb://batocera/share/bios/`'
|
||||
run: [device]
|
||||
download_hint: From a computer, use the network folder above.
|
||||
@@ -330,7 +330,7 @@ guides:
|
||||
|
||||
Option B: Manual (network share)
|
||||
--------------------------------
|
||||
1. On your PC, open the Batocera network share:
|
||||
1. On a PC, open the Batocera network share:
|
||||
- Windows: \\BATOCERA\share\bios\
|
||||
- Mac/Linux: smb://batocera/share/bios/
|
||||
2. Extract all files from this archive directly into the share
|
||||
@@ -338,13 +338,13 @@ guides:
|
||||
|
||||
Option C: Manual (SD card)
|
||||
--------------------------
|
||||
1. Put the SD card in your PC
|
||||
1. Put the SD card in a PC
|
||||
2. Open the bios folder at the root of the SHARE drive
|
||||
(Batocera itself names it /userdata/bios/)
|
||||
3. Extract all files from this archive directly into that folder
|
||||
|
||||
NOTE: Dreamcast flash memory is named dc_nvmem.bin
|
||||
(if your setup asks for dc_flash.bin, same file).
|
||||
(if the setup asks for dc_flash.bin, same file).
|
||||
logo_owner: Batocera
|
||||
logo_licence: repository licence MIT
|
||||
recalbox:
|
||||
@@ -355,24 +355,24 @@ guides:
|
||||
# a keyboard. SSH user root, password recalboxroot or the one set when flashing 10.0+.
|
||||
terminal: >-
|
||||
With a keyboard, press **Alt+F2**. From a computer, open a terminal over the network
|
||||
with `ssh root@recalbox`, password `recalboxroot` or the one you set. Paste the line.
|
||||
with `ssh root@recalbox`, password `recalboxroot` or the one set when flashing. Paste the line.
|
||||
Press Enter.
|
||||
folders:
|
||||
- where: On Recalbox
|
||||
- where: From Windows, over your home network
|
||||
- where: From Windows, over the home network
|
||||
path: '`\\RECALBOX\share\bios\`'
|
||||
run: [device]
|
||||
download_hint: From a computer, use the network folder above.
|
||||
pack_manual: |
|
||||
Option B: Manual (network share)
|
||||
--------------------------------
|
||||
1. On your PC, open the Recalbox network share:
|
||||
1. On a PC, open the Recalbox network share:
|
||||
- Windows: \\RECALBOX\share\bios\
|
||||
2. Extract all files from this archive directly into the share
|
||||
|
||||
Option C: Manual (SD card)
|
||||
--------------------------
|
||||
1. Put the SD card in your PC
|
||||
1. Put the SD card in a PC
|
||||
2. Open the bios folder at the root of the SHARE drive
|
||||
(Recalbox itself names it /recalbox/share/bios/)
|
||||
3. Extract all files from this archive directly into that folder
|
||||
@@ -388,7 +388,7 @@ guides:
|
||||
path: '`C:\RetroBat\bios\`'
|
||||
run: [windows]
|
||||
notes:
|
||||
- The command finds RetroBat wherever you installed it.
|
||||
- The command finds RetroBat wherever it is installed.
|
||||
reference_notes:
|
||||
- >-
|
||||
RetroBat records its own folder each time it starts, and the installer reads it
|
||||
@@ -396,15 +396,15 @@ guides:
|
||||
pack_manual: |
|
||||
Option B: Manual
|
||||
----------------
|
||||
1. Open your RetroBat installation folder
|
||||
1. Open the RetroBat installation folder
|
||||
2. Navigate to the bios\ subfolder
|
||||
(default: C:\RetroBat\bios\)
|
||||
3. Extract all files from this archive directly into your bios\ folder
|
||||
3. Extract all files from this archive directly into the bios\ folder
|
||||
4. Overwrite if asked
|
||||
logo_owner: RetroBat
|
||||
logo_licence: repository states no licence
|
||||
emudeck:
|
||||
summary: Installs your emulators and adds your games to Steam.
|
||||
summary: Installs emulators and adds the games to Steam.
|
||||
folders:
|
||||
- where: Steam Deck and Linux
|
||||
# EmuDeck functions/helperFunctions.sh:89-99 (getSDPath, the card's mount point)
|
||||
@@ -418,7 +418,7 @@ guides:
|
||||
run: [steamdeck, linux, windows, macos]
|
||||
notes:
|
||||
- >-
|
||||
The `bios` folder is inside the Emulation folder you chose in EmuDeck.
|
||||
The `bios` folder is inside the Emulation folder chosen in EmuDeck.
|
||||
# emudeck-electron src/renderer/translations/en.json:416-418 (b06bfcf5): the
|
||||
# "Bios files checker".
|
||||
finish: >-
|
||||
@@ -444,7 +444,7 @@ guides:
|
||||
folders:
|
||||
- where: On Lakka
|
||||
# lakka.tv/doc/Accessing-Lakka-filesystem: Samba in Settings > Services, share System.
|
||||
- where: From Windows, over your home network
|
||||
- where: From Windows, over the home network
|
||||
path: '`\\LAKKA\System\`'
|
||||
run: [device]
|
||||
notes:
|
||||
@@ -467,7 +467,7 @@ guides:
|
||||
Option B: Via network share
|
||||
--------------------------
|
||||
1. On Lakka: Settings > Services > Samba Enable
|
||||
2. On your PC, open the System share: \\LAKKA\System\
|
||||
2. On a PC, open the System share: \\LAKKA\System\
|
||||
3. Extract all files from this archive directly into that share
|
||||
|
||||
Option C: Via SSH
|
||||
@@ -501,7 +501,7 @@ guides:
|
||||
logo_licence: repository licence GPL-3.0
|
||||
romm:
|
||||
summary: >-
|
||||
A game library on your own server. It plays games in the web browser.
|
||||
A game library on a self-hosted server. It plays games in the web browser.
|
||||
folders:
|
||||
- where: In the RomM library
|
||||
path: '`bios/`, one subfolder per platform'
|
||||
@@ -510,7 +510,7 @@ guides:
|
||||
path: '`<platform>/bios/` for each platform'
|
||||
run: [server]
|
||||
notes:
|
||||
- 'You can also add BIOS files in RomM''s web page.'
|
||||
- 'BIOS files can also be added in RomM''s web page.'
|
||||
dest: /path/to/library/bios
|
||||
# RomM 5.4 places firmware by filesystem.structure.firmware in config.yml,
|
||||
# bios/{platform} by default, and suggests {platform}/bios for a library
|
||||
@@ -543,7 +543,7 @@ guides:
|
||||
run: [device]
|
||||
notes:
|
||||
- >-
|
||||
You can also reach the folder from a computer, over your home network.
|
||||
The folder is also reachable from a computer, over the home network.
|
||||
# rocknix.org/faqs and rocknix.org/play/add-games: SSH off by default, turned on in
|
||||
# Network Settings, user root, the password shown in System Settings > Security.
|
||||
terminal: >-
|
||||
@@ -565,7 +565,7 @@ guides:
|
||||
# AmberELEC 5a3882cb packages/network/samba/config/smb.conf:59-60 shares
|
||||
# /storage/roms as "roms". smbd runs unless samba.disabled exists
|
||||
# (system.d.opt/smbd.service:5).
|
||||
- where: From Windows, over your home network
|
||||
- where: From Windows, over the home network
|
||||
path: '`\\AmberELEC\roms\`'
|
||||
run: [device]
|
||||
# amberelec.org/guides/getting-to-know-amberelec.html: host AmberELEC, root, amberelec.
|
||||
@@ -588,7 +588,7 @@ guides:
|
||||
- where: On EmuELEC
|
||||
# EmuELEC wiki (35b92c78) Backup-and-Recovery-options.md:4 (\\EMUELEC, roms share)
|
||||
# and Bios.md (/storage/roms/bios).
|
||||
- where: From Windows, over your home network
|
||||
- where: From Windows, over the home network
|
||||
path: '`\\EMUELEC\roms\`'
|
||||
run: [device]
|
||||
# EmuELEC wiki How-to-SSH-into-EmuELEC.md:38-44: root, password emuelec.
|
||||
@@ -610,7 +610,7 @@ guides:
|
||||
- where: On KNULLI
|
||||
# knulli.org/play/add-games/network-transfer: \\KNULLI, its share folder, Samba
|
||||
# off by default. The share is /userdata, so bios is under it.
|
||||
- where: From Windows, over your home network
|
||||
- where: From Windows, over the home network
|
||||
path: '`\\KNULLI\share\bios\`'
|
||||
run: [device]
|
||||
notes:
|
||||
@@ -636,7 +636,7 @@ guides:
|
||||
- where: On the Raspberry Pi
|
||||
# RetroPie-Setup scriptmodules/supplementary/samba.sh:49-52 (46128cd2) shares
|
||||
# $home/RetroPie/BIOS as "bios", and docs/Transferring-Roms.md:29 names \\RETROPIE.
|
||||
- where: From Windows, over your home network
|
||||
- where: From Windows, over the home network
|
||||
path: '`\\RETROPIE\bios\`'
|
||||
run: [device]
|
||||
# RetroPie docs/FAQ.md:193 (F4 in EmulationStation, its game menu), 175f5b15. The computer route
|
||||
@@ -657,12 +657,12 @@ guides:
|
||||
pack_manual: |
|
||||
Option B: Via network share
|
||||
--------------------------
|
||||
1. On your PC, open: \\RETROPIE\bios\
|
||||
1. On a PC, open: \\RETROPIE\bios\
|
||||
2. Extract all files from this archive directly into that folder
|
||||
|
||||
Option C: Via SSH
|
||||
-----------------
|
||||
1. SSH into your Pi: ssh pi@retropie
|
||||
1. SSH into the Pi: ssh pi@retropie
|
||||
2. Copy files to ~/RetroPie/BIOS/
|
||||
|
||||
NOTE: the BIOS folder is on the card's Linux partition,
|
||||
@@ -684,10 +684,10 @@ guides:
|
||||
pack_manual: |
|
||||
Option B: Manual
|
||||
----------------
|
||||
1. Open the folder you extracted BizHawk to, the one holding
|
||||
1. Open the folder BizHawk was extracted to, the one holding
|
||||
EmuHawk.exe (Windows) or EmuHawkMono.sh (Linux)
|
||||
2. Navigate to its Firmware subfolder
|
||||
3. Extract all files from this archive directly into your Firmware folder
|
||||
3. Extract all files from this archive directly into the Firmware folder
|
||||
4. In BizHawk: Config > Paths > Firmware should
|
||||
point to this folder
|
||||
logo_owner: TASVideos
|
||||
@@ -702,7 +702,7 @@ guides:
|
||||
path: '`/media/fat/games/`, one subfolder per core'
|
||||
# mister-devel.github.io/MkDocs_MiSTer/setup/games: run samba_on from the Scripts
|
||||
# menu, then \\MiSTer\sdcard\.
|
||||
- where: From Windows, over your home network
|
||||
- where: From Windows, over the home network
|
||||
path: '`\\MiSTer\sdcard\games\`'
|
||||
run: [device]
|
||||
# mister-devel.github.io/MkDocs_MiSTer/advanced/network: F9 for a Linux terminal,
|
||||
@@ -734,7 +734,7 @@ guides:
|
||||
- >-
|
||||
Each console has its own folder, named after the tag in its Roms folder. `Roms/Sony
|
||||
PlayStation (PS)/` uses `Bios/PS/`.
|
||||
- The command makes each console's folder for you.
|
||||
- The command makes each console's folder.
|
||||
on_card: true
|
||||
reference_notes:
|
||||
- >-
|
||||
@@ -759,7 +759,7 @@ guides:
|
||||
- >-
|
||||
Each console has its own folder, named after the tag in its Roms folder. `Roms/Sony
|
||||
PlayStation (PS)/` uses `Bios/PS/`.
|
||||
- The command makes each console's folder for you.
|
||||
- The command makes each console's folder.
|
||||
on_card: true
|
||||
reference_notes:
|
||||
- >-
|
||||
@@ -779,7 +779,7 @@ guides:
|
||||
- >-
|
||||
Each console has its own folder, named after the tag in its Roms folder. `Roms/Sony
|
||||
PlayStation (PS)/` uses `Bios/PS/`.
|
||||
- The command makes each console's folder for you.
|
||||
- The command makes each console's folder.
|
||||
on_card: true
|
||||
reference_notes:
|
||||
- >-
|
||||
|
||||
+56
-56
@@ -488,13 +488,13 @@ def generate_home(
|
||||
works_with = ", ".join(named) + (f" and {others} more" if others else "")
|
||||
|
||||
lines = [
|
||||
"# BIOS files for your emulators",
|
||||
"# BIOS files for emulators",
|
||||
"",
|
||||
"Some consoles need a small program to start their games. It is called "
|
||||
"the **BIOS**. Your emulator needs a copy of it. We put the right copy "
|
||||
"the **BIOS**. The emulator needs a copy of it. RetroBIOS puts the right copy "
|
||||
"in the right folder.",
|
||||
"",
|
||||
markup.button("Get your files", "which-pack.md", primary=True) + " "
|
||||
markup.button("Get the files", "which-pack.md", primary=True) + " "
|
||||
+ markup.button("What is a BIOS?", "wiki/what-are-bios-files.md"),
|
||||
"",
|
||||
f"Free. No account. Works with {works_with}.",
|
||||
@@ -503,9 +503,9 @@ def generate_home(
|
||||
"[When a game does not start](wiki/troubleshooting.md)",
|
||||
"- Have a file? [Check it](files/index.md)",
|
||||
"",
|
||||
"## Do I need it?",
|
||||
"## Is it needed? { #do-i-need-it }",
|
||||
"",
|
||||
"- **Yes**, if your emulator says a BIOS is missing.",
|
||||
"- **Yes**, if the emulator says a BIOS is missing.",
|
||||
"- **Yes** for PlayStation 1 and 2, Saturn and Neo Geo.",
|
||||
"- **Better with it** for Dreamcast: some games need it.",
|
||||
"- **Usually not** for NES, Super Nintendo, Mega Drive and Game Boy.",
|
||||
@@ -515,12 +515,12 @@ def generate_home(
|
||||
"## Three steps",
|
||||
"",
|
||||
*markup.steps([
|
||||
"**Pick your device.** Its page shows your BIOS folder.",
|
||||
"**Pick the device.** Its page shows the BIOS folder.",
|
||||
"**Run one command.** Some setups have a ZIP.",
|
||||
"**Start a game.**",
|
||||
]),
|
||||
*install_demo(),
|
||||
"## Pick your device",
|
||||
"## Pick the device { #pick-your-device }",
|
||||
"",
|
||||
*setup_picker(registry, display),
|
||||
"## Is it safe?",
|
||||
@@ -574,7 +574,7 @@ def generate_explore_index(db: dict, coverages: dict, profiles: dict) -> str:
|
||||
"",
|
||||
"## Help the project",
|
||||
"",
|
||||
"A file you hold, an emulator profile or a correction fills a gap for "
|
||||
"A file sent in, an emulator profile or a correction fills a gap for "
|
||||
"every setup at once. For contributors: [How to contribute](contributing.md).",
|
||||
"",
|
||||
]
|
||||
@@ -752,7 +752,7 @@ def _folder_words(display: str, extract_to: str | None) -> str:
|
||||
"""The folder a pack or a copy goes into, in words: the device's path,
|
||||
or a folder of the setup named as the setup's."""
|
||||
if not extract_to:
|
||||
return "your BIOS folder"
|
||||
return "the BIOS folder"
|
||||
if _setup_relative(extract_to):
|
||||
return f"{display}'s `{extract_to.rstrip('/')}` folder"
|
||||
return f"`{extract_to}`"
|
||||
@@ -824,7 +824,7 @@ def generate_get_page(platform_name: str) -> str:
|
||||
"",
|
||||
f"- {_fmt_size(pack['download_size'])} to download, "
|
||||
f"{_fmt_size(pack['extracted_size'])} once unzipped.",
|
||||
*(["- You need both parts." if parts == 2 else f"- You need all {parts} parts."]
|
||||
*(["- Both parts are needed." if parts == 2 else f"- All {parts} parts are needed."]
|
||||
if parts > 1 else []),
|
||||
*_unzip_into(platform_name, display, extract_to, parts),
|
||||
*(line for text in release for line in (text, "")),
|
||||
@@ -2349,7 +2349,7 @@ def generate_data_page(exports: list[dict], measurements_sqlite: Path | None = N
|
||||
"per `bios/<Manufacturer>/<Console>/` folder of the collection, named "
|
||||
"`Manufacturer\\Console` so the tools look in that subfolder, each file a "
|
||||
"rom named by its path below that folder. It audits a copy of the "
|
||||
"collection's `bios/` tree, or rebuilds that layout from your own dumps.",
|
||||
"collection's `bios/` tree, or rebuilds that layout from a reader's own dumps.",
|
||||
"",
|
||||
"A setup's DAT, `downloads/dat/<platform>.dat`, describes its BIOS folder "
|
||||
"once installed: one game named after the folder (`bios`, `system`), each "
|
||||
@@ -2449,7 +2449,7 @@ def _browser_title(relative: Path, title: str) -> str:
|
||||
# Material appends " - RetroBIOS": the home title says what the site
|
||||
# is, instead of "RetroBIOS - RetroBIOS".
|
||||
"index.md": "BIOS and firmware packs for RetroArch, Batocera and more",
|
||||
"platforms/index.md": "Your setup",
|
||||
"platforms/index.md": "Setups",
|
||||
"systems/index.md": "Systems",
|
||||
"emulators/index.md": "Emulators",
|
||||
"wiki/index.md": "Reference",
|
||||
@@ -2510,7 +2510,7 @@ def _shorten(plain: str, limit: int = 157) -> str:
|
||||
def _page_description(markdown: str, relative: Path, title: str) -> str:
|
||||
key = relative.as_posix()
|
||||
specific = {
|
||||
"index.md": "The BIOS files your emulators need, for RetroArch, Batocera, EmuDeck and more: the folder they go in, one command that installs and checks them, and packs to download.",
|
||||
"index.md": "The BIOS files emulators need, for RetroArch, Batocera, EmuDeck and more: the folder they go in, one command that installs and checks them, and packs to download.",
|
||||
"data.md": "Versioned RetroBIOS JSON API, CSV exports, SQLite snapshot, schemas, checksums and data interpretation guidance.",
|
||||
"cross-reference.md": "Every emulator core each retrogaming platform runs, the systems it emulates and the upstream project it comes from.",
|
||||
"gaps.md": "Current RetroBIOS verification gaps, platform-to-emulator divergences, missing files and documented source limitations.",
|
||||
@@ -2518,7 +2518,7 @@ def _page_description(markdown: str, relative: Path, title: str) -> str:
|
||||
sitemeasurements.EXPLORER_PAGE: "The records of emulator cores run headless on demand, each with its claim, verdict, the BIOS it ran, method, computer and full record, filterable, and as SQLite.",
|
||||
"provenance.md": "Hash-based comparison of RetroBIOS metadata with No-Intro, Redump and TOSEC catalog snapshots.",
|
||||
"explore.md": "Systems, emulators and installer options to explore, with the figures of the BIOS collection.",
|
||||
"which-pack.md": "Pick your device or setup and get its BIOS files: the folder they go in, one command that installs and checks them, or a ZIP pack to extract.",
|
||||
"which-pack.md": "Pick a device or setup and get its BIOS files: the folder they go in, one command that installs and checks them, or a ZIP pack to extract.",
|
||||
"contributing.md": "Add a BIOS file the collection lacks from the browser, checked on arrival, or add a platform or an emulator profile.",
|
||||
}
|
||||
if key in specific:
|
||||
@@ -2571,7 +2571,7 @@ def _lead(markdown: str) -> str:
|
||||
|
||||
def _emulator_description(markdown: str, key: str, title: str, intro: str) -> str:
|
||||
"""An emulator page by its intro sentence ("DuckStation emulates Sony
|
||||
PlayStation. It picks the BIOS for your game's region: ..."), or by
|
||||
PlayStation. It picks the BIOS for the game's region: ..."), or by
|
||||
its profile table when the profile names no system."""
|
||||
notes = re.search(r"<summary>Technical notes</summary>\s*\n\n(.+?)(?:\n\n|$)", markdown, re.S)
|
||||
if not intro and notes:
|
||||
@@ -3357,12 +3357,12 @@ def decorate_markdown_pages(docs: Path) -> dict[str, str]:
|
||||
|
||||
|
||||
def generate_platform_index(coverages: dict, registry: dict | None = None) -> str:
|
||||
"""The Your setup tab: every platform by the device it runs on, and one
|
||||
"""The Setups tab: every platform by the device it runs on, and one
|
||||
line to the table that sets them side by side (setup_table), which is
|
||||
reference matter and sits with how each setup checks its files."""
|
||||
registry = registry or {}
|
||||
lines = [
|
||||
"# Your setup",
|
||||
"# Setups",
|
||||
"",
|
||||
"Each setup's page gives the folder and the command.",
|
||||
"",
|
||||
@@ -4241,7 +4241,7 @@ def _share_tabs(name: str, share: str) -> tuple[dict[str, str], dict[str, str]]:
|
||||
how = {
|
||||
"macos": (f"In Finder, Go > Connect to Server: `{url}`. Then paste the line in "
|
||||
"**Terminal**."),
|
||||
"linux": (f"Open `{url}` in your file manager. Paste the line in a terminal, "
|
||||
"linux": (f"Open `{url}` in the file manager. Paste the line in a terminal, "
|
||||
f"with the folder it opened for `/path/to/{volume}`."),
|
||||
}
|
||||
return args, how
|
||||
@@ -4282,7 +4282,7 @@ def _card_route(name: str, display: str, guide: Guide) -> list[str]:
|
||||
return [lead, "", *terminal_tabs(tabs, args, steps=False)]
|
||||
# A folder on the card's Linux partition: Windows and macOS show the
|
||||
# small boot partition alone, and no folder there fits --dest.
|
||||
put = ("Put the device's card in your computer." if "windows" in tabs
|
||||
put = ("Put the device's card in a computer." if "windows" in tabs
|
||||
else "Only a Linux computer opens the card.")
|
||||
lead = (f"No network? {put} After `--dest`, "
|
||||
f"name the folder the device calls `{extract_to}`.")
|
||||
@@ -4309,14 +4309,14 @@ def _setup_routes(name: str, display: str, page_link: bool = False) -> list[str]
|
||||
card = _card_route(name, display, guide)
|
||||
shared = _get_page_line(name, display) if page_link else []
|
||||
if share or (card and guide.run == ("device",)):
|
||||
computer = ["## From your computer { #from-your-computer }", ""]
|
||||
computer = ["## From a computer { #from-your-computer }", ""]
|
||||
if share:
|
||||
args, how = _share_tabs(name, share)
|
||||
# The setup page stays in its word budget: its Mac and Linux
|
||||
# lines are on the get/ page, the one the command is shared from.
|
||||
tabs = ("windows",) if page_link else ("windows", "macos", "linux")
|
||||
computer += [
|
||||
"Needs the device on your network.",
|
||||
"Needs the device on the same network.",
|
||||
"",
|
||||
*terminal_tabs(tabs, args, how=how),
|
||||
*([f"[Mac or Linux](../{get_page_link(name)}#from-your-computer)", ""]
|
||||
@@ -4330,7 +4330,7 @@ def _setup_routes(name: str, display: str, page_link: bool = False) -> list[str]
|
||||
|
||||
|
||||
# Shown in the "On the device" tab of a guide that has no `terminal:` of its own.
|
||||
DEVICE_TERMINAL_FALLBACK = "Or fill the folder from your computer, with the ZIP."
|
||||
DEVICE_TERMINAL_FALLBACK = "Or fill the folder from a computer, with the ZIP."
|
||||
|
||||
|
||||
def _computer_first(name: str, guide: Guide) -> bool:
|
||||
@@ -4365,11 +4365,11 @@ def _guide_download(name: str, display: str, guide: Guide, extract_to: str | Non
|
||||
f"{_fmt_size(pack['extracted_size'])} once unzipped."
|
||||
]
|
||||
if parts > 1:
|
||||
bullets.append("You need both parts." if parts == 2 else f"You need all {parts} parts.")
|
||||
bullets.append("Both parts are needed." if parts == 2 else f"All {parts} parts are needed.")
|
||||
if _computer_first(name, guide) and network:
|
||||
target = "the network folder above"
|
||||
else:
|
||||
target = f"`{extract_to}`" if extract_to else "your BIOS folder"
|
||||
target = f"`{extract_to}`" if extract_to else "the BIOS folder"
|
||||
bullets.append(f"Unzip {'them all' if parts > 1 else 'it'} into {target}."
|
||||
+ (" Files like `neogeo.zip` stay zipped." if _ships_neogeo(name) else ""))
|
||||
if guide.download_hint and not _computer_first(name, guide):
|
||||
@@ -4395,7 +4395,7 @@ def _guide_download(name: str, display: str, guide: Guide, extract_to: str | Non
|
||||
|
||||
|
||||
def only_some_consoles(name: str, prefix: str = "") -> list[str]:
|
||||
"""The way to a smaller download, in the words Get your files uses."""
|
||||
"""The way to a smaller download, in the words Get the files uses."""
|
||||
return [
|
||||
f"Only some consoles? [Pick them]({prefix}which-pack.md?platform={name}"
|
||||
f"#only-some-consoles), or the command's **{_installer().TUI_SYSTEMS_ROW}**.",
|
||||
@@ -4486,7 +4486,7 @@ def generate_handheld_guide(guide: HandheldGuide) -> str:
|
||||
"",
|
||||
"## Where the files go { #where-the-files-go }",
|
||||
"",
|
||||
"Put the SD card in a computer. Find your system below.",
|
||||
"Put the SD card in a computer. Find the system below.",
|
||||
"",
|
||||
"| System | Devices | BIOS folder on the card |",
|
||||
"|--------|---------|-------------------------|",
|
||||
@@ -4542,7 +4542,7 @@ def _platform_guide(name: str, display: str, cov: dict, registry: dict, no_list:
|
||||
if _computer_first(name, guide):
|
||||
lines += [
|
||||
*_guide_download(name, display, guide, extract_to,
|
||||
"## From your computer { #download }"),
|
||||
"## From a computer { #download }"),
|
||||
*_offline_line(name),
|
||||
*_guide_install(name, guide, "## On the device { #install }"),
|
||||
]
|
||||
@@ -5505,7 +5505,7 @@ def generate_provenance_page(
|
||||
"",
|
||||
*([f'<p class="rb-timestamp">Catalogs as of: {as_of}.</p>', ""] if as_of else []),
|
||||
"Provenance says whether a file is, byte for byte, a dump that Redump, "
|
||||
"No-Intro or TOSEC catalogues. It tells you where a dump is known from, "
|
||||
"No-Intro or TOSEC catalogues. It says where a dump is known from, "
|
||||
"not whether an emulator accepts it: that is the emulator's code, read "
|
||||
"in its profile. Example: `scph5501.bin` is Redump's `ps-30a.bin`.",
|
||||
"",
|
||||
@@ -5542,7 +5542,7 @@ def generate_provenance_page(
|
||||
"arcade sets tracked by MAME driver source instead.",
|
||||
"",
|
||||
"When the two views disagree, this project follows the code, because "
|
||||
"that is what decides whether your emulator boots. The reasoning is in "
|
||||
"that is what decides whether the emulator boots. The reasoning is in "
|
||||
"the [technical questions](wiki/technical-faq.md#are-these-files-verified-against-original-"
|
||||
"hardware-dumps).",
|
||||
"",
|
||||
@@ -6996,7 +6996,7 @@ def _group_lines(
|
||||
lines += [f"- **{key}**: {text.lstrip(': ')}"
|
||||
for key, block in blocks.items() for _lead, text in block]
|
||||
return [*lines, ""]
|
||||
lines = ["**Start with** the files of your machine:", ""]
|
||||
lines = ["**Start with** the files of the machine:", ""]
|
||||
for key, block in blocks.items():
|
||||
for lead, text in block:
|
||||
if lead == "*":
|
||||
@@ -7208,7 +7208,7 @@ def _start_lines(block: list[tuple[str, str]], console: str = "") -> list[str]:
|
||||
below = " They come first below." if _sep else ""
|
||||
return [" ".join(filter(None, [f"**Start with**: {named}.{below}", instead])), ""]
|
||||
bios = f"the {console} BIOS" if console else "the BIOS"
|
||||
lines = [f"**Start with** {bios} for the region of your games:", ""]
|
||||
lines = [f"**Start with** {bios} for the region of the games:", ""]
|
||||
for lead, text in block:
|
||||
lines.append(f"- **{lead or 'Some emulators also require'}**: {text}")
|
||||
if instead:
|
||||
@@ -7265,7 +7265,7 @@ def _romset_note(consoles: dict[str, list]) -> list[str]:
|
||||
|
||||
|
||||
_NEXT_FROM_SYSTEMS = [
|
||||
"[Get your files](../which-pack.md), for the setup you play on",
|
||||
"[Get the files](../which-pack.md), for the setup in use",
|
||||
"[When a game does not start](../wiki/troubleshooting.md)",
|
||||
"[Every emulator](../emulators/index.md), and the files each one reads",
|
||||
]
|
||||
@@ -8979,7 +8979,7 @@ def _install_block(name: str, profile: dict) -> list[str]:
|
||||
f"BIOS folder, then downloads only the files {emu} reads there and checks "
|
||||
"each one.")
|
||||
else:
|
||||
lead = ("The installer finds your setup and its BIOS folder, then downloads "
|
||||
lead = ("The installer finds the setup and its BIOS folder, then downloads "
|
||||
"only the files this emulator reads there and checks each one.")
|
||||
if profile.get("type") == "standalone + libretro":
|
||||
# The command fills a setup, never the app's own folder.
|
||||
@@ -9245,7 +9245,7 @@ def _install_picker(declared: list[tuple[str, str]]) -> list[str]:
|
||||
"",
|
||||
'<div class="rb-install" data-rb-install="" hidden>',
|
||||
"",
|
||||
f'<label class="rb-install-setup">Your setup <select>{options}</select></label>',
|
||||
f'<label class="rb-install-setup">Setup <select>{options}</select></label>',
|
||||
"",
|
||||
*terminal_tabs(INSTALL_PICKER_OSES, args, steps=False),
|
||||
"",
|
||||
@@ -9508,7 +9508,7 @@ def _emulator_file_summary(files: list[dict]) -> list[str]:
|
||||
if _regional_choice([f for f in files if f.get("required") is True and not comes_with_app(f)]):
|
||||
# DuckStation takes the BIOS of the game's region: "3 required"
|
||||
# read as "get all three".
|
||||
line = (f"{total}. One of {req_count:,} is required, for your games' region. "
|
||||
line = (f"{total}. One of {req_count:,} is required, for the games' region. "
|
||||
f"{len(slots) - req_count:,} {'is' if len(slots) - req_count == 1 else 'are'} "
|
||||
"optional.")
|
||||
if hle_count:
|
||||
@@ -9916,7 +9916,7 @@ def _any_name_folder(profile: dict, entry: dict) -> str:
|
||||
own = ("[the app's data folder](#data-folder)" if profile.get("data_root")
|
||||
else "the app's own data folder")
|
||||
return f"the {_code(folder.strip('/'))} folder inside {own}"
|
||||
return f"{_code(folder)}, inside your BIOS folder"
|
||||
return f"{_code(folder)}, inside the BIOS folder"
|
||||
|
||||
|
||||
def _any_name_steps(emu_name: str, profile: dict, entry: dict, href: str,
|
||||
@@ -10001,7 +10001,7 @@ def _emulator_intro(emu_name: str, profile: dict, href: str = "", name: str = ""
|
||||
# DuckStation needs the BIOS of the game's region, not all three: the
|
||||
# page said "3 of them required" and read as "get all of these".
|
||||
others = len(files) - len(required)
|
||||
sentences.append(f"It picks the BIOS for your game's region: {by_region}.")
|
||||
sentences.append(f"It picks the BIOS for the game's region: {by_region}.")
|
||||
if others:
|
||||
sentences.append(
|
||||
f"The {_count(others, 'other file')} {'is' if others == 1 else 'are'} optional.")
|
||||
@@ -10293,7 +10293,7 @@ def emulator_pages(
|
||||
lines[trees_start:] = search_excluded(lines[trees_start:])
|
||||
|
||||
lines.extend(_next_block([
|
||||
"[Get your files](../which-pack.md), for the setup you play on",
|
||||
"[Get the files](../which-pack.md), for the setup in use",
|
||||
"[Every system](../systems/index.md), and the files each one needs",
|
||||
"[When a game does not start](../wiki/troubleshooting.md)",
|
||||
]))
|
||||
@@ -10855,15 +10855,15 @@ def generate_gap_analysis(
|
||||
lines = [
|
||||
"# What the packs do not hold",
|
||||
"",
|
||||
"What each pack still cannot give you, and why. Most gaps are not "
|
||||
"What each pack still cannot give, and why. Most gaps are not "
|
||||
"firmware: a platform's list can also name game files, such as "
|
||||
"Diablo's `diabdat.mpq`, which you copy from your own game, or files "
|
||||
"Diablo's `diabdat.mpq`, which comes from an owned copy of the game, or files "
|
||||
"no emulator of that platform opens. Those are counted apart. A missing "
|
||||
"firmware file means a console that does not start, and each one is "
|
||||
"named below with the platforms that list it.",
|
||||
"",
|
||||
"Each file here is a request: if you hold one of the files under "
|
||||
"\"Files to source\", [adding it](contributing.md) fills the gap for "
|
||||
"Each file here is a request: for a file under \"Files to source\", "
|
||||
"[adding it](contributing.md) fills the gap for "
|
||||
"every platform at once.",
|
||||
"",
|
||||
" ".join([
|
||||
@@ -11584,7 +11584,7 @@ def generate_not_found() -> str:
|
||||
'<p><button type="button" class="rb-notfound-search" data-rb-open-search>Search the site</button></p>',
|
||||
"",
|
||||
"- [Start here](index.md): what BIOS files are and how to install them",
|
||||
"- [Get your files](which-pack.md): the pack or the command for your device",
|
||||
"- [Get the files](which-pack.md): the pack or the command for each device",
|
||||
"- Browse [platforms](platforms/index.md), [systems](systems/index.md) "
|
||||
"or [emulators](emulators/index.md)",
|
||||
"",
|
||||
@@ -11625,7 +11625,7 @@ def generate_wiki_data_model(db: dict, profiles: dict) -> str:
|
||||
"lists every file the collection holds, keyed by its SHA1. A platform YAML "
|
||||
"copies the BIOS list a setup publishes. An emulator profile records what "
|
||||
"one emulator opens, read from its code. The sections below show the "
|
||||
"fields of each, with a real entry, so you can read the data or build on it.",
|
||||
"fields of each, with a real entry, to read the data or build on it.",
|
||||
"",
|
||||
"Example: `scph5501.bin` is one entry of `database.json` (key "
|
||||
"`0555c6fa...`), one entry of `platforms/batocera.yml` (its MD5) and one "
|
||||
@@ -11955,17 +11955,17 @@ def generate_which_pack() -> str:
|
||||
f"terms: {', '.join(IOS_TERMS)}",
|
||||
"---",
|
||||
"",
|
||||
"# Get your files",
|
||||
"# Get the files",
|
||||
"",
|
||||
"Pick your setup. Its page gives the folder and the command.",
|
||||
"Pick the setup. Its page gives the folder and the command.",
|
||||
"",
|
||||
"## Pick your setup",
|
||||
"## Pick the setup { #pick-your-setup }",
|
||||
"",
|
||||
*setup_picker(registry, display),
|
||||
"## Folders and ZIP files { #manual-download }",
|
||||
"",
|
||||
"- A big ZIP comes in parts, like `Pack.part1of2.zip`. Download every part.",
|
||||
"- Unzip them into your BIOS folder. Put the files straight in it, "
|
||||
"- Unzip them into the BIOS folder. Put the files straight in it, "
|
||||
"not in a new folder.",
|
||||
"- Leave the ZIPs inside, like `neogeo.zip`, as they are.",
|
||||
"- A few ZIPs hold their own top folder. Their setup's page says where "
|
||||
@@ -11994,20 +11994,20 @@ def generate_which_pack() -> str:
|
||||
*ios_section(),
|
||||
"## Not in the list? One command finds it { #quick-install }",
|
||||
"",
|
||||
"A **terminal** is a window where you type commands.",
|
||||
"A **terminal** is a window for typing commands.",
|
||||
"",
|
||||
*terminal_tabs(box_tabs, {}, under_steps=box_steps, under_command=box_demos),
|
||||
"On Batocera, Recalbox and other game systems, run it on the device. "
|
||||
"Your setup's page shows how.",
|
||||
"The setup's page shows how.",
|
||||
"",
|
||||
*first_screen_words(),
|
||||
"",
|
||||
*trust_box(""),
|
||||
"**Check your folder later.** Add `--check`. It changes nothing.",
|
||||
"**Check the folder later.** Add `--check`. It changes nothing.",
|
||||
"",
|
||||
*terminal_tabs(all_tabs, dict.fromkeys(TERMINALS, "--check"), steps=False),
|
||||
*markup.details("note", "Fill an SD card from a computer", [
|
||||
"Name your setup and the BIOS folder on the card. For RetroArch on a "
|
||||
"Name the setup and the BIOS folder on the card. For RetroArch on a "
|
||||
"Nintendo Switch:",
|
||||
"",
|
||||
"Linux, macOS:",
|
||||
@@ -12020,7 +12020,7 @@ def generate_which_pack() -> str:
|
||||
*fence("powershell", install_command(
|
||||
"powershell", "--platform retroarch --dest E:\\retroarch\\cores\\system")),
|
||||
]),
|
||||
*markup.details("note", "Copy the BIOS files from your old card", [
|
||||
*markup.details("note", "Copy the BIOS files from an old card", [
|
||||
"Plug the old card in and add `--from` with its folder. The BIOS files "
|
||||
"found there are copied, and the rest downloaded. The old card is only read.",
|
||||
"",
|
||||
@@ -12112,7 +12112,7 @@ def _platform_nav(coverages: dict, registry: dict) -> list:
|
||||
# The tabs in reading order, by the level their pages declare.
|
||||
TABS = {
|
||||
"start": "Start here",
|
||||
"setup": "Your setup",
|
||||
"setup": "Setups",
|
||||
"explore": "Explore",
|
||||
"reference": "Reference",
|
||||
"contribute": "Contribute",
|
||||
@@ -12212,7 +12212,7 @@ def generate_nav(
|
||||
) -> list:
|
||||
"""The navigation, five tabs in reading order.
|
||||
|
||||
Start here is for someone who knows nothing yet, Your setup for someone
|
||||
Start here is for someone who knows nothing yet, Setups for someone
|
||||
who knows their device, Explore for one system or emulator, Reference for
|
||||
checking the work, Contribute for adding to it. Each tab opens on its
|
||||
index page.
|
||||
@@ -12223,7 +12223,7 @@ def generate_nav(
|
||||
own order.
|
||||
"""
|
||||
generated: dict[str, list[tuple]] = {
|
||||
"start": [(0, "index.md"), (20, {"Get your files": "which-pack.md"})],
|
||||
"start": [(0, "index.md"), (20, {"Get the files": "which-pack.md"})],
|
||||
"setup": [(10 * i, item)
|
||||
for i, item in enumerate(_platform_nav(coverages, registry or {}))],
|
||||
"explore": [
|
||||
|
||||
@@ -32,7 +32,7 @@ QUOTING = (f"A folder goes in single quotes, attached to its option. One that ho
|
||||
"command and refuses such a folder.")
|
||||
|
||||
START_PAGES = (
|
||||
("Which pack do I need", "which-pack/", "pick a device or setup, get the folder its BIOS files go in, "
|
||||
("Which pack is needed", "which-pack/", "pick a device or setup, get the folder its BIOS files go in, "
|
||||
"one command that installs and checks them, or a ZIP pack"),
|
||||
("First install", "wiki/first-install/", "the steps from nothing to a working BIOS folder"),
|
||||
("What are BIOS files", "wiki/what-are-bios-files/", "why emulators need them and where they come from"),
|
||||
@@ -57,7 +57,7 @@ MORE = (
|
||||
("Emulators", "emulators/", "one page per emulator"),
|
||||
("Systems", "systems/", "one page per console maker, every file with its hashes"),
|
||||
("Installer", "wiki/installer/", "every option of install.py"),
|
||||
("What we count", "wiki/privacy/", "the site's cookie-free counting"),
|
||||
("What is counted", "wiki/privacy/", "the site's cookie-free counting"),
|
||||
("Is it legal?", "wiki/legal/", "the project's position"),
|
||||
("Contributing", "contributing/", "add a missing file or an emulator profile"),
|
||||
)
|
||||
@@ -142,7 +142,7 @@ ANSWER_RULES = (
|
||||
f"up: {SITE}files/?hash=<value> (the page) or api/v1/lookup/<first two hex>.json (the data).",
|
||||
"Prefer the installer to a manual copy: it puts each file in its folder and checks its hash. "
|
||||
"Give the command the setup's page gives, with `--for-games --required-only` for the fewest files.",
|
||||
"Say where an answer comes from: link the page you read.",
|
||||
"Say where an answer comes from: link the source page.",
|
||||
"On a page of the site, the WebMCP tools answer from the data: setup_bios_files (folder and "
|
||||
"files of a setup), emulator_bios_files, lookup_bios_hash, device_setup_command, search_retrobios.",
|
||||
f"Whether sharing BIOS files is legal depends on the country: point to [Is it legal?]({SITE}wiki/legal/), "
|
||||
@@ -173,7 +173,7 @@ def skill_md() -> str:
|
||||
"",
|
||||
"## Steps",
|
||||
"",
|
||||
"1. Ask where the games are: on the device itself (you have its terminal or SSH), or on "
|
||||
"1. Ask where the games are: on the device itself (with its terminal or SSH), or on "
|
||||
"its card plugged into this computer.",
|
||||
f"2. Preview, nothing is written: `{SH} --for-games --required-only --dry-run` "
|
||||
f"(Windows PowerShell: `{PS} --for-games --required-only --dry-run`).",
|
||||
@@ -221,9 +221,9 @@ def ard_manifest() -> dict:
|
||||
"description": "An agent skill that installs the BIOS files a device needs, only "
|
||||
"what the games on its card need to start.",
|
||||
"representativeQueries": [
|
||||
"install the minimum BIOS files for the games on my R36S running dArkOS",
|
||||
"set up BIOS files for RetroArch on my Steam Deck",
|
||||
"my emulator says BIOS missing, fix it",
|
||||
"install the minimum BIOS files for the games on an R36S running dArkOS",
|
||||
"set up BIOS files for RetroArch on a Steam Deck",
|
||||
"the emulator says BIOS missing, fix it",
|
||||
],
|
||||
"capabilities": ["SetupBios"],
|
||||
"tags": ["bios", "firmware", "emulation", "retrogaming"],
|
||||
|
||||
@@ -397,8 +397,8 @@ def _emulator_names_in(emulators_dir: str) -> dict[str, str]:
|
||||
def _bios_chain_boxes() -> list[Box]:
|
||||
platform, _emulator = CHAIN_EXAMPLES[0]
|
||||
return [
|
||||
Box("Your device", ["A PC, a Steam Deck, a handheld or a TV box"], number="1"),
|
||||
Box("Setup", ["The menu you pick a game from"], number="2"),
|
||||
Box("The device", ["A PC, a Steam Deck, a handheld or a TV box"], number="1"),
|
||||
Box("Setup", ["The menu that picks a game"], number="2"),
|
||||
Box("Emulator", ["Starts the game and reads its BIOS"], number="3"),
|
||||
Box("BIOS folder", [f"{_display(platform)} reads", Mono(_folder(platform))],
|
||||
accent=True, number="4"),
|
||||
@@ -421,8 +421,8 @@ def _bios_chain_caption() -> str:
|
||||
|
||||
def _install_boxes() -> list[Box]:
|
||||
return [
|
||||
Box("Finds your setup", ["And the folder it reads"], number="1"),
|
||||
Box("Looks at your files", ["The ones already in the folder"], number="2"),
|
||||
Box("Finds the setup", ["And the folder it reads"], number="1"),
|
||||
Box("Looks at the files", ["The ones already in the folder"], number="2"),
|
||||
Box("Downloads the rest", ["Only what is missing or different"], number="3"),
|
||||
Box("Checks each file", ["Before saving it"], accent=True, number="4"),
|
||||
]
|
||||
@@ -604,7 +604,7 @@ def _figures() -> dict[str, Figure]:
|
||||
"install-flow": Figure(
|
||||
"install-flow",
|
||||
"What the command does",
|
||||
"The command finds your setup and its BIOS folder, looks at the files already "
|
||||
"The command finds the setup and its BIOS folder, looks at the files already "
|
||||
"there, downloads what is missing or different, then checks each file before "
|
||||
"saving it.",
|
||||
"Running the command again repeats the same steps and downloads only what changed.",
|
||||
@@ -904,7 +904,7 @@ GLANCE_GROUPS: tuple[tuple[str, tuple[str, ...]], ...] = (
|
||||
"--cores-dir")),
|
||||
("Look first", ("--check", "--dry-run", "--list-platforms", "--list-targets",
|
||||
"--list-systems", "--list-cores", "--list-emulators")),
|
||||
("From files you have", ("--from", "--from-pack", "--manifest", "--offline", "--restore")),
|
||||
("From files on hand", ("--from", "--from-pack", "--manifest", "--offline", "--restore")),
|
||||
("How the run talks", ("--tui", "--plain", "--no-input", "--yes", "--quiet", "--verbose",
|
||||
"--events", "--jobs", "--version", "--help")),
|
||||
)
|
||||
@@ -999,7 +999,7 @@ def prepare_page(markdown: str, page: Path) -> str:
|
||||
OG_SECTIONS: dict[str, tuple[str, str]] = {
|
||||
"home": ("BIOS and firmware packs", "Checked file by file, for {frontends}"),
|
||||
"start": ("Start here", "What BIOS files are, and how to install them with one command"),
|
||||
"setup": ("Your setup", "Where the files go on each device and frontend"),
|
||||
"setup": ("Setups", "Where the files go on each device and frontend"),
|
||||
"explore": ("Systems and emulators", "Which files each console and emulator reads"),
|
||||
"reference": ("Reference", "Verification modes, gaps, provenance and the data API"),
|
||||
"contribute": ("Contribute", "Adding files, emulator profiles and platforms"),
|
||||
|
||||
@@ -651,8 +651,8 @@ def _sidebar_link(rel: str) -> str:
|
||||
PRUNED_TABS = ("explore",)
|
||||
|
||||
# Reading runs from one tab into the next only here: the last Start here
|
||||
# page leads to Your setup. Every other tab is read on its own.
|
||||
CHAINED_TABS = (("start-here", "your-setup"),)
|
||||
# page leads to Setups. Every other tab is read on its own.
|
||||
CHAINED_TABS = (("start-here", "setups"),)
|
||||
|
||||
|
||||
def topic_id(label: str) -> str:
|
||||
@@ -804,7 +804,7 @@ def sidebar(nav: list, present: set[str], anchors: dict[str, set[str]] | None =
|
||||
|
||||
def _reading(nav: list, present: set[str]) -> list[list[dict]]:
|
||||
"""The previous and next links, in runs. An overview is named after the
|
||||
group or tab it opens ("Your setup", not "Overview")."""
|
||||
group or tab it opens ("Setups", not "Overview")."""
|
||||
def walk(value: list, name: str) -> Iterator[dict]:
|
||||
for entry in value:
|
||||
if isinstance(entry, str):
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
"""What the install box of Get your files shows under each tab.
|
||||
"""What the install box of Get the files shows under each tab.
|
||||
|
||||
Two things per tab, both drawn from data:
|
||||
|
||||
|
||||
@@ -271,10 +271,10 @@ class EndUsersCheckTheirOwnFolder(unittest.TestCase):
|
||||
files points at the installer's --check, which hashes their folder."""
|
||||
|
||||
USER_SECTIONS = (
|
||||
("wiki/troubleshooting.md", "## 1. Check my BIOS folder { #checking-what-you-installed }"),
|
||||
("wiki/troubleshooting.md", "## 1. Check the BIOS folder { #checking-what-you-installed }"),
|
||||
("wiki/troubleshooting.md", "## 2. Fix the files"),
|
||||
("wiki/faq.md", "## My game shows a black screen"),
|
||||
("wiki/faq.md", "## How do I know which BIOS I need?"),
|
||||
("wiki/faq.md", "## A game shows a black screen { #my-game-shows-a-black-screen }"),
|
||||
("wiki/faq.md", "## How to tell which BIOS is needed? { #how-do-i-know-which-bios-i-need }"),
|
||||
)
|
||||
|
||||
def test_user_sections_never_send_to_verify(self):
|
||||
|
||||
@@ -290,7 +290,7 @@ class EverySurfaceSaysWhy(unittest.TestCase):
|
||||
|
||||
def test_the_faq_answers_why(self):
|
||||
faq = (REPO_ROOT / "wiki" / "faq.md").read_text(encoding="utf-8")
|
||||
section = faq.split("## Why is there no ZIP for my setup?", 1)[1].split("\n## ", 1)[0]
|
||||
section = faq.split("## Why is there no ZIP for a setup?", 1)[1].split("\n## ", 1)[0]
|
||||
self.assertIn("most people download", section)
|
||||
self.assertIn("checks each one", section)
|
||||
self.assertIn("--dry-run", section)
|
||||
|
||||
@@ -124,7 +124,7 @@ class EveryPageHasAMarkdownCopy(unittest.TestCase):
|
||||
pages = sorted(DIST.rglob("index.html"))
|
||||
missing = [p for p in pages if not (p.parent / "index.md").is_file()]
|
||||
self.assertEqual(missing, [])
|
||||
self.assertIn("# Get your files", (DIST / "which-pack" / "index.md").read_text(encoding="utf-8"))
|
||||
self.assertIn("# Get the files", (DIST / "which-pack" / "index.md").read_text(encoding="utf-8"))
|
||||
self.assertTrue((DIST / "llms-full.txt").is_file())
|
||||
|
||||
|
||||
|
||||
@@ -183,7 +183,7 @@ class SectionTabsInTheHeader(unittest.TestCase):
|
||||
nav = re.search(r'<nav class="rb-tabs[^"]*"[^>]*>(.*?)</nav>', html, re.S)
|
||||
self.assertIsNotNone(nav)
|
||||
labels = [re.sub(r"<[^>]+>", "", a).strip() for a in re.findall(r"<a\b[^>]*>.*?</a>", nav.group(1), re.S)]
|
||||
self.assertEqual(labels, ["Start here", "Your setup", "Explore", "Reference", "Contribute"])
|
||||
self.assertEqual(labels, ["Start here", "Setups", "Explore", "Reference", "Contribute"])
|
||||
self.assertEqual(nav.group(1).count('aria-current="true"'), 1)
|
||||
self.assertRegex(nav.group(1), r'aria-current="true"[^>]*>\s*Start here')
|
||||
|
||||
@@ -198,7 +198,7 @@ class LevelBadgeOnlyWhereItAddsSomething(unittest.TestCase):
|
||||
def test_badge_follows_the_crumb(self):
|
||||
# A tab root: the header tab already says it.
|
||||
self.assertNotIn('class="rb-level ', _title_block(_built("platforms")))
|
||||
# Under the "Start here" or "Your setup" crumb the badge repeated it.
|
||||
# Under the "Start here" or "Setups" crumb the badge repeated it.
|
||||
for page in ("which-pack", "platforms/batocera"):
|
||||
with self.subTest(page=page):
|
||||
block = _title_block(_built(page))
|
||||
|
||||
@@ -157,7 +157,7 @@ class NavFromFrontMatter(unittest.TestCase):
|
||||
tabs = self._nav(WIKI)
|
||||
self.assertEqual(tabs["Explore"][0], "explore.md")
|
||||
self.assertEqual([next(iter(e)) for e in tabs["Explore"][1:]], ["Systems", "Emulators"])
|
||||
self.assertEqual(tabs["Your setup"][-1], {"All installer options": "wiki/installer.md"})
|
||||
self.assertEqual(tabs["Setups"][-1], {"All installer options": "wiki/installer.md"})
|
||||
start = [e if isinstance(e, str) else next(iter(e)) for e in tabs["Start here"]]
|
||||
self.assertEqual(start.index("Is it legal?"), start.index("Common questions") + 1)
|
||||
self.assertEqual(tabs["Reference"][0], "wiki/index.md")
|
||||
|
||||
@@ -258,7 +258,7 @@ class TheSetupListLooksLikeAList(unittest.TestCase):
|
||||
self.assertEqual(len(re.findall(r"--rb-select-arrow:", css)), 2)
|
||||
# The box's select sits in Markdown content, where the shared rule applies.
|
||||
box = "\n".join(gs._console_install_block("PlayStation Portable", PAIRS))
|
||||
self.assertIn('<label class="rb-install-setup">Your setup <select>', box)
|
||||
self.assertIn('<label class="rb-install-setup">Setup <select>', box)
|
||||
|
||||
def test_the_built_select_shows_the_arrow(self) -> None:
|
||||
if not (DIST / "systems").is_dir():
|
||||
|
||||
@@ -67,7 +67,7 @@ class TheIntroSaysWhatIsNeeded(unittest.TestCase):
|
||||
profile = _profile("duckstation")
|
||||
intro = gs._emulator_intro("DuckStation", profile)
|
||||
self.assertIn(
|
||||
"It picks the BIOS for your game's region: scph5500.bin (Japan), "
|
||||
"It picks the BIOS for the game's region: scph5500.bin (Japan), "
|
||||
"scph5501.bin (North America and Latin America) or scph5502.bin "
|
||||
"(Europe and Oceania).", intro)
|
||||
others = len(profile["files"]) - 3
|
||||
@@ -417,7 +417,7 @@ class AnAppThatReadsAnyBios(unittest.TestCase):
|
||||
# LRPS2 runs in RetroArch, whose BIOS folder the installer finds.
|
||||
page = _pages("lrps2")["lrps2"]
|
||||
self.assertIn("--emulator lrps2", page)
|
||||
self.assertIn("2. Put it in `pcsx2/bios/`, inside your BIOS folder.", page)
|
||||
self.assertIn("2. Put it in `pcsx2/bios/`, inside the BIOS folder.", page)
|
||||
self.assertIn("a Sony PlayStation 2 BIOS, any file name", page)
|
||||
|
||||
def test_only_found_by_content_with_one_bios(self):
|
||||
@@ -752,7 +752,7 @@ class SmallFixes(unittest.TestCase):
|
||||
|
||||
def test_region_choice_summary(self) -> None:
|
||||
lines = gs._emulator_file_summary(_profile("duckstation")["files"])
|
||||
self.assertIn("One of 3 is required, for your games' region.", lines[0])
|
||||
self.assertIn("One of 3 is required, for the games' region.", lines[0])
|
||||
self.assertNotIn("3 required", lines[0])
|
||||
|
||||
def test_no_emulator_part_says_where_it_sits(self) -> None:
|
||||
|
||||
+11
-11
@@ -190,7 +190,7 @@ class GetYourFilesOrder(unittest.TestCase):
|
||||
def test_choice_then_tables_then_picker_then_command(self):
|
||||
text = _page("which-pack.md")
|
||||
order = [text.index(mark) for mark in (
|
||||
"## Pick your setup", "| Setup | Runs on | BIOS folder | ZIP |", "<FilePicker",
|
||||
"## Pick the setup { #pick-your-setup }", "| Setup | Runs on | BIOS folder | ZIP |", "<FilePicker",
|
||||
"## Not in the list? One command finds it", "It asks **",
|
||||
"<summary>Is it safe?</summary>",
|
||||
)]
|
||||
@@ -221,7 +221,7 @@ class GetYourFilesOrder(unittest.TestCase):
|
||||
class GuideRoutes(unittest.TestCase):
|
||||
def test_a_device_system_opens_on_the_computer_route(self):
|
||||
text = _page("platforms/batocera.md")
|
||||
self.assertLess(text.index("## From your computer"), text.index("## On the device"))
|
||||
self.assertLess(text.index("## From a computer"), text.index("## On the device"))
|
||||
self.assertIn("{ #install }", "\n".join(generate_site._guide_install(
|
||||
"batocera", siteguides.GUIDES["batocera"], "## On the device { #install }")))
|
||||
self.assertIn("Unzip them all into the network folder above", text)
|
||||
@@ -347,7 +347,7 @@ class HomeLinksTheOtherTasks(unittest.TestCase):
|
||||
for target in ("/retrobios/wiki/troubleshooting/", "/retrobios/files/",
|
||||
"/retrobios/wiki/legal/"):
|
||||
self.assertIn(f"]({target})", home)
|
||||
self.assertLess(home.index("/retrobios/wiki/troubleshooting/"), home.index("## Do I need it?"))
|
||||
self.assertLess(home.index("/retrobios/wiki/troubleshooting/"), home.index("## Is it needed? { #do-i-need-it }"))
|
||||
|
||||
|
||||
GUIDE = siteguides.HANDHELD_GUIDE
|
||||
@@ -425,7 +425,7 @@ class HandheldWayIn(unittest.TestCase):
|
||||
def test_the_guide_is_in_the_handheld_group_of_the_navigation(self):
|
||||
coverages = {key: {"platform": _display(key)} for key in REGISTRY}
|
||||
nav = generate_site.generate_nav(coverages, {}, {}, REGISTRY)
|
||||
setup = next(tab["Your setup"] for tab in nav if "Your setup" in tab)
|
||||
setup = next(tab["Setups"] for tab in nav if "Setups" in tab)
|
||||
groups = {next(iter(item)): next(iter(item.values()))
|
||||
for item in setup if isinstance(item, dict)}
|
||||
label = siteguides.DEVICE_GROUPS["handheld"][0]
|
||||
@@ -526,7 +526,7 @@ class SafetyListIsLinked(unittest.TestCase):
|
||||
class OfflineLine(unittest.TestCase):
|
||||
def test_under_from_your_computer(self):
|
||||
text = _page("platforms/batocera.md")
|
||||
start = text.index("## From your computer")
|
||||
start = text.index("## From a computer")
|
||||
line = text.index("No internet on the device?")
|
||||
self.assertLess(start, line)
|
||||
self.assertLess(line, text.index("## On the device"))
|
||||
@@ -682,24 +682,24 @@ class NoZipNoUnzipText(unittest.TestCase):
|
||||
def test_the_minui_family_makes_each_folder(self):
|
||||
for name in ("minui", "myminui", "nextui"):
|
||||
with self.subTest(setup=name):
|
||||
self.assertIn("The command makes each console's folder for you.",
|
||||
self.assertIn("The command makes each console's folder.",
|
||||
_plain_page(f"platforms/{name}.md"))
|
||||
|
||||
def test_knulli_is_filled_over_the_network_with_the_samba_switch_cited(self):
|
||||
text = _guide_part(_plain_page("platforms/knulli.md"))
|
||||
self.assertIn("## From your computer { #from-your-computer }", text)
|
||||
self.assertIn("## From a computer { #from-your-computer }", text)
|
||||
self.assertIn("--platform knulli --dest \\\\KNULLI\\share\\bios\n", text)
|
||||
self.assertRegex(text, r"turn on \*\*SAMBA\*\* in \*\*System Settings > Services\*\*\s*"
|
||||
r"\(\[KNULLI docs\]\(https://github\.com/knulli-cfw/knulli\.org/blob/"
|
||||
r"[0-9a-f]{40}/docs/play/add-games/network-transfer\.md")
|
||||
# The computer route comes before the SSH one.
|
||||
self.assertLess(text.index("## From your computer"), text.index("## On the device"))
|
||||
self.assertLess(text.index("## From a computer"), text.index("## On the device"))
|
||||
|
||||
def test_the_elec_systems_say_they_need_the_network(self):
|
||||
for name, share in (("amberelec", "\\\\AmberELEC\\roms"), ("emuelec", "\\\\EMUELEC\\roms")):
|
||||
text = _guide_part(_plain_page(f"platforms/{name}.md"))
|
||||
with self.subTest(setup=name):
|
||||
self.assertIn("Needs the device on your network.", text)
|
||||
self.assertIn("Needs the device on the same network.", text)
|
||||
self.assertIn(f"--platform {name} --dest {share}\n", text)
|
||||
|
||||
def test_a_mac_and_a_linux_desktop_reach_the_share_too(self):
|
||||
@@ -935,14 +935,14 @@ class ARouteWithoutANetwork(unittest.TestCase):
|
||||
for page in (f"platforms/{name}.md", f"get/{name}.md"):
|
||||
text = _plain_page(page)
|
||||
with self.subTest(page=page):
|
||||
self.assertIn("## From your computer { #from-your-computer }", text)
|
||||
self.assertIn("## From a computer { #from-your-computer }", text)
|
||||
self.assertIn(CARD_FAQ, text)
|
||||
self.assertIn(f"the folder the device calls `{extract_to}`", text)
|
||||
self.assertIn(f"--platform {name} --dest /path/to/", text)
|
||||
|
||||
def test_rocknix_has_a_computer_route(self):
|
||||
text = _guide_part(_plain_page("platforms/rocknix.md"))
|
||||
self.assertLess(text.index("## From your computer"), text.index("## On the device"))
|
||||
self.assertLess(text.index("## From a computer"), text.index("## On the device"))
|
||||
|
||||
def test_retropie_card_is_read_from_linux_only(self):
|
||||
self.assertEqual(siteguides.GUIDES["retropie"].card_run, ("linux",))
|
||||
|
||||
@@ -56,14 +56,14 @@ class FiveTabs(unittest.TestCase):
|
||||
nav = generate_site.generate_nav({}, {}, {}, {})
|
||||
self.assertEqual(
|
||||
[next(iter(tab)) for tab in nav],
|
||||
["Start here", "Your setup", "Explore", "Reference", "Contribute"],
|
||||
["Start here", "Setups", "Explore", "Reference", "Contribute"],
|
||||
)
|
||||
|
||||
def test_each_tab_opens_on_an_index_or_a_first_page(self):
|
||||
nav = generate_site.generate_nav({}, {}, {}, {})
|
||||
tabs = {next(iter(tab)): next(iter(tab.values())) for tab in nav}
|
||||
self.assertEqual(tabs["Start here"][0], "index.md")
|
||||
self.assertEqual(tabs["Your setup"][0], "platforms/index.md")
|
||||
self.assertEqual(tabs["Setups"][0], "platforms/index.md")
|
||||
self.assertEqual(tabs["Reference"][0], "wiki/index.md")
|
||||
self.assertEqual(tabs["Contribute"][0], "contributing.md")
|
||||
|
||||
@@ -125,7 +125,7 @@ class EveryPlatformOnThePicker(unittest.TestCase):
|
||||
for key in _registered()
|
||||
}
|
||||
nav = generate_site.generate_nav(coverages, {}, {}, registry)
|
||||
setup = next(tab["Your setup"] for tab in nav if "Your setup" in tab)
|
||||
setup = next(tab["Setups"] for tab in nav if "Setups" in tab)
|
||||
groups = {next(iter(item)): next(iter(item.values()))
|
||||
for item in setup if isinstance(item, dict)}
|
||||
for key in coverages:
|
||||
@@ -278,7 +278,7 @@ class GuidePagesEndOnANextStep(unittest.TestCase):
|
||||
text = sitepages.page("platforms/batocera.md").read_text(encoding="utf-8")
|
||||
# Batocera runs on its own device: the computer route comes first.
|
||||
order = [text.index(h) for h in (
|
||||
"## Where the files go", "## From your computer", "## On the device",
|
||||
"## Where the files go", "## From a computer", "## On the device",
|
||||
"## How to check", "## Reference: every file by system",
|
||||
)]
|
||||
self.assertEqual(order, sorted(order))
|
||||
|
||||
@@ -210,7 +210,7 @@ class FaqInstallsFromWhatYouHold(unittest.TestCase):
|
||||
|
||||
def test_no_unzip_before_from_pack(self):
|
||||
section = " ".join(self._section("No internet on the device?").split())
|
||||
self.assertIn("point `--from-pack` at your ZIP:", section)
|
||||
self.assertIn("point `--from-pack` at the ZIP:", section)
|
||||
self.assertNotIn("unzip", section)
|
||||
install = (REPO_ROOT / "install.py").read_text(encoding="utf-8")
|
||||
self.assertIn("Install from a pack already downloaded: its ZIP, one of its parts",
|
||||
|
||||
@@ -118,7 +118,7 @@ class GroupsAreGroups(unittest.TestCase):
|
||||
self.groups = self.side["groups"]
|
||||
|
||||
def test_setup_groups_stay_groups_and_point_at_their_section(self):
|
||||
setup = {key: value for key, value in self.groups.items() if key.startswith("Your setup/")}
|
||||
setup = {key: value for key, value in self.groups.items() if key.startswith("Setups/")}
|
||||
self.assertTrue(setup)
|
||||
for key, group in setup.items():
|
||||
with self.subTest(group=key):
|
||||
@@ -206,7 +206,7 @@ class OneNextPerPage(unittest.TestCase):
|
||||
|
||||
def test_an_overview_is_named_after_what_it_opens(self):
|
||||
labels = {entry["link"]: entry["label"] for run in self.runs for entry in run}
|
||||
self.assertEqual(labels["/retrobios/platforms/"], "Your setup")
|
||||
self.assertEqual(labels["/retrobios/platforms/"], "Setups")
|
||||
self.assertEqual(labels["/retrobios/systems/"], "Systems")
|
||||
self.assertNotIn("Overview", labels.values())
|
||||
|
||||
|
||||
@@ -534,7 +534,7 @@ class NoTooltipInsideAName(unittest.TestCase):
|
||||
import sitestarlight
|
||||
|
||||
terms = {"Emulator": "An app that acts like a console.",
|
||||
"Terminal": "A window where you type commands.",
|
||||
"Terminal": "A window for typing commands.",
|
||||
"BIOS": "The console's built-in software."}
|
||||
for line in ("Fuse (Free Unix Spectrum Emulator) reads it.",
|
||||
"Open Windows Terminal (WSL).",
|
||||
|
||||
@@ -228,7 +228,7 @@ class Descriptions(unittest.TestCase):
|
||||
self.addCleanup(lambda: (gs.PAGE_DATA.clear(), gs.PAGE_DATA.update(saved)))
|
||||
gs.PAGE_DATA["emulators/duckstation.md"] = {"hasPart": [{"name": "scph5501.bin"}]}
|
||||
body = ("# DuckStation\n\nDuckStation emulates Sony PlayStation. It picks the BIOS for "
|
||||
"your game's region.\n\n<details>\n\nThe installer finds your platform.\n")
|
||||
"the game's region.\n\n<details>\n\nThe installer finds the platform.\n")
|
||||
text = gs._page_description(body, Path("emulators/duckstation.md"), "DuckStation")
|
||||
self.assertTrue(text.startswith("DuckStation emulates Sony PlayStation."))
|
||||
self.assertNotIn("source-pinned", text)
|
||||
@@ -308,10 +308,10 @@ class Descriptions(unittest.TestCase):
|
||||
self.assertEqual(text, "Dreamcast BIOS files (Sega). Start with dc_boot.bin, dc_flash.bin.")
|
||||
|
||||
def test_the_faq_is_described_by_its_questions(self) -> None:
|
||||
body = ("# Common questions\n\n## Do I need BIOS files?\n\nYes.\n\n## Which one?\n\n"
|
||||
body = ("# Common questions\n\n## Are BIOS files needed?\n\nYes.\n\n## Which one?\n\n"
|
||||
"Run the command with --dry-run.\n\n## Zip or not?\n\nZip.\n")
|
||||
text = gs._page_description(body, Path("wiki/faq.md"), "Common questions")
|
||||
self.assertTrue(text.startswith("Common questions: Do I need BIOS files?"))
|
||||
self.assertTrue(text.startswith("Common questions: Are BIOS files needed?"))
|
||||
|
||||
def test_a_written_description_wins(self) -> None:
|
||||
source = (REPO_ROOT / "scripts" / "generate_site.py").read_text(encoding="utf-8")
|
||||
@@ -359,7 +359,7 @@ class GetPagesSitInYourSetup(unittest.TestCase):
|
||||
def test_every_get_page_joins_your_setup(self):
|
||||
side, get_pages = _sidebar_with_get_pages()
|
||||
self.assertEqual(side["options"]["exclude"], [])
|
||||
setup = set(side["options"]["topics"].get("your-setup", []))
|
||||
setup = set(side["options"]["topics"].get("setups", []))
|
||||
for rel in get_pages:
|
||||
with self.subTest(page=rel):
|
||||
self.assertIn("/" + sitestarlight._sidebar_link(rel).strip("/"), setup)
|
||||
|
||||
@@ -129,7 +129,7 @@ class TheConsoleBiosComesFirst(unittest.TestCase):
|
||||
|
||||
def test_the_section_opens_on_the_bios_by_region(self):
|
||||
lines = gs._start_with(self.files, self.required_only())
|
||||
self.assertEqual(lines[0], "**Start with** the BIOS for the region of your games:")
|
||||
self.assertEqual(lines[0], "**Start with** the BIOS for the region of the games:")
|
||||
self.assertIn("- **North America**: [`scph5501.bin`](#sha1-444444444444)", lines)
|
||||
self.assertIn("- **Japan**: [`scph5500.bin`](#sha1-555555555555)", lines)
|
||||
self.assertLess(lines.index("- **North America**: [`scph5501.bin`](#sha1-444444444444)"),
|
||||
|
||||
+15
-15
@@ -435,7 +435,7 @@ class TheFaqAnswersWithACommand(unittest.TestCase):
|
||||
is the lever the installer itself names."""
|
||||
|
||||
def test_every_file_of_a_console(self):
|
||||
section = _section(_wiki("faq.md"), "Do I need every file of a console?")
|
||||
section = _section(_wiki("faq.md"), "Is every file of a console needed?")
|
||||
self.assertIn("<!-- os-tabs -->", section)
|
||||
self.assertIn("--system sony-playstation --core pcsx1", section)
|
||||
self.assertNotIn("only your region", section)
|
||||
@@ -450,7 +450,7 @@ class LegalOpensInPlainWords(unittest.TestCase):
|
||||
|
||||
def test_the_answer_comes_before_the_reasoning(self):
|
||||
self.assertIn("## The reasoning in detail", self.text)
|
||||
self.assertIn("It depends on your country. Nothing here is legal advice.", self.opening)
|
||||
self.assertIn("It depends on the country. Nothing here is legal advice.", self.opening)
|
||||
for case in ("Connectix", "Accolade", "DMCA", "CFR", "Chamberlain", "Yuzu"):
|
||||
with self.subTest(case=case):
|
||||
self.assertNotIn(case, self.opening)
|
||||
@@ -500,7 +500,7 @@ class ArcadeAnswerWherePlayersLook(unittest.TestCase):
|
||||
self.assertIn(words, section)
|
||||
|
||||
def test_the_faq_links_the_technical_answer(self):
|
||||
section = _section(_wiki("faq.md"), "My arcade game fails (which MAME version?)")
|
||||
section = _section(_wiki("faq.md"), "An arcade game fails (which MAME version?)")
|
||||
anchor = "technical-faq.md#which-mame-version-do-the-arcade-bios-sets-match"
|
||||
self.assertIn(anchor, section)
|
||||
self.assertIn("## Which MAME version do the arcade BIOS sets match?", _wiki("technical-faq.md"))
|
||||
@@ -513,7 +513,7 @@ class ArcadeAnswerWherePlayersLook(unittest.TestCase):
|
||||
self.assertTrue(profile.get("core_version") or profile.get("version"))
|
||||
|
||||
def test_the_check_step_holds_the_searched_words(self):
|
||||
self.assertIn("## 1. Check my BIOS folder { #checking-what-you-installed }",
|
||||
self.assertIn("## 1. Check the BIOS folder { #checking-what-you-installed }",
|
||||
_wiki("troubleshooting.md"))
|
||||
|
||||
|
||||
@@ -583,7 +583,7 @@ class SetupsWithoutAPage(unittest.TestCase):
|
||||
"""N9, J13: ES-DE, LaunchBox and iOS found nothing."""
|
||||
|
||||
def test_the_answer(self):
|
||||
section = _flat(_section(_wiki("faq.md"), "My setup is not in the list"))
|
||||
section = _flat(_section(_wiki("faq.md"), "A setup is not in the list"))
|
||||
for words in ("--dest", "ES-DE", "LaunchBox", "iPhone"):
|
||||
with self.subTest(words=words):
|
||||
self.assertIn(words, section)
|
||||
@@ -604,7 +604,7 @@ class LinkLabelsMatchPages(unittest.TestCase):
|
||||
for name in ("first-install.md", "troubleshooting.md", "faq.md"):
|
||||
with self.subTest(page=name):
|
||||
for label in re.findall(r"\[([^\]]+)\]\(\.\./which-pack\.md\)", _wiki(name)):
|
||||
self.assertEqual(label, "Get your files")
|
||||
self.assertEqual(label, "Get the files")
|
||||
|
||||
|
||||
class ExitStatusAndPinnedInstaller(unittest.TestCase):
|
||||
@@ -712,7 +712,7 @@ class TroubleshootingSaysTheWordsOnScreen(unittest.TestCase):
|
||||
self.text = _wiki("troubleshooting.md")
|
||||
|
||||
def test_step_one_opens_on_the_messages(self):
|
||||
step = _flat(_section(self.text, "1. Check my BIOS folder"))
|
||||
step = _flat(_section(self.text, "1. Check the BIOS folder"))
|
||||
self.assertIn("**BIOS not found**, **BIOS missing** or **firmware missing**?", step)
|
||||
self.assertLess(step.index("BIOS not found"), step.index("```"))
|
||||
|
||||
@@ -792,7 +792,7 @@ class ArcadeVersionTable(unittest.TestCase):
|
||||
|
||||
def test_the_section_opens_on_the_answer(self):
|
||||
self.assertTrue(self.section.lstrip().startswith(
|
||||
"Your game sets and BIOS sets must come from the same version as your arcade\nemulator."))
|
||||
"Game sets and BIOS sets must come from the same version as the arcade\nemulator."))
|
||||
self.assertIn("| Emulator, as RetroArch names it | Sets from |", self.section)
|
||||
self.assertLess(self.section.index("| Emulator"), self.section.index("### How this is known"))
|
||||
|
||||
@@ -818,7 +818,7 @@ class ArcadeVersionTable(unittest.TestCase):
|
||||
self.assertIn(ARCADE_ANCHOR, arcade)
|
||||
self.assertNotIn("emulators/index.md", arcade)
|
||||
faq = _wiki("faq.md")
|
||||
self.assertIn("## My arcade game fails (which MAME version?) "
|
||||
self.assertIn("## An arcade game fails (which MAME version?) "
|
||||
"{ #my-arcade-game-does-not-start }", faq)
|
||||
|
||||
|
||||
@@ -830,7 +830,7 @@ class FaqLabels(unittest.TestCase):
|
||||
|
||||
def test_no_reference_label(self):
|
||||
self.assertNotRegex(self.text, r"(?m)^Reference:")
|
||||
arcade = _section(self.text, "My arcade game fails (which MAME version?)")
|
||||
arcade = _section(self.text, "An arcade game fails (which MAME version?)")
|
||||
self.assertIn(f"Game sets must match the emulator's version:\n[the list]({ARCADE_ANCHOR}).",
|
||||
arcade)
|
||||
|
||||
@@ -845,7 +845,7 @@ class CopyYourOwnBios(unittest.TestCase):
|
||||
"""C-other, need 12: no page answered the legal route."""
|
||||
|
||||
def test_each_console_has_a_guide(self):
|
||||
section = _section(_wiki("faq.md"), "Can I copy my own console's BIOS?")
|
||||
section = _section(_wiki("faq.md"), "Can an owned console's BIOS be copied?")
|
||||
links = re.findall(r"\[([^\]]+)\]\((https://[^)]+)\)", section)
|
||||
self.assertEqual(dict(links), {
|
||||
"PCSX2": "https://pcsx2.net/docs/setup/bios/",
|
||||
@@ -1093,15 +1093,15 @@ class FaqAnswersLeadSomewhere(unittest.TestCase):
|
||||
self.generator = (REPO_ROOT / "scripts" / "generate_site.py").read_text(encoding="utf-8")
|
||||
|
||||
def test_ios_goes_to_the_iphone_section(self):
|
||||
section = _flat(_section(self.text, "My setup is not in the list"))
|
||||
self.assertIn("iPhone, iPad (iOS): no terminal. [Pick your consoles and copy them "
|
||||
section = _flat(_section(self.text, "A setup is not in the list"))
|
||||
self.assertIn("iPhone, iPad (iOS): no terminal. [Pick the consoles and copy them "
|
||||
"to the app](../which-pack.md#iphone-and-ipad).", section)
|
||||
self.assertNotIn("Use the ZIP", section)
|
||||
self.assertIn('"## iPhone and iPad { #iphone-and-ipad }"', self.generator)
|
||||
|
||||
def test_antivirus_answer_covers_setups_without_a_zip(self):
|
||||
section = _flat(_section(self.text, "Windows or my antivirus blocks the command"))
|
||||
self.assertIn("Use your setup's ZIP. None? [Pick your consoles]"
|
||||
section = _flat(_section(self.text, "Windows or an antivirus blocks the command"))
|
||||
self.assertIn("Use the setup's ZIP. None? [Pick the consoles]"
|
||||
"(../which-pack.md#only-some-consoles) and download their files.",
|
||||
section)
|
||||
self.assertNotIn("if any", section)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
// "Which files do I need": pick a setup and systems, get the file list and
|
||||
// "Which files are needed": pick a setup and systems, get the file list and
|
||||
// the install command. Client side only: reads public/data/picker/*.json,
|
||||
// which convert.py derives from install/<platform>.json. The selection
|
||||
// follows install.py narrow(): a file is kept when one of its systems is
|
||||
@@ -22,7 +22,7 @@ const packs = Object.fromEntries(
|
||||
|
||||
<div class="rb-picker" data-base={base} data-release={JSON.stringify({ tag: release.tag ?? '', packs })}>
|
||||
<fieldset>
|
||||
<label for="rb-pick-platform">Your setup</label>
|
||||
<label for="rb-pick-platform">Setup</label>
|
||||
<select id="rb-pick-platform" name="platform">
|
||||
<option value="">Choose a setup</option>
|
||||
</select>
|
||||
|
||||
@@ -31,7 +31,7 @@ const LABELS = {
|
||||
// The tab each level is read in, as the header names it.
|
||||
const TABS = {
|
||||
start: 'Start here',
|
||||
setup: 'Your setup',
|
||||
setup: 'Setups',
|
||||
explore: 'Explore',
|
||||
reference: 'Reference',
|
||||
contribute: 'Contribute',
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
// page or the section that introduces it, never to a sibling page. A
|
||||
// group of names by their first letter (A, B) is no crumb;
|
||||
// - previous and next: the reading order of `reading`. Start here runs on
|
||||
// into Your setup, every other tab is read on its own, and a system,
|
||||
// into Setups, every other tab is read on its own, and a system,
|
||||
// emulator or platform page has none;
|
||||
// - a pruned sidebar: in the tabs listing every system and emulator, a
|
||||
// group that does not hold the page becomes one link to its overview, so
|
||||
|
||||
@@ -630,7 +630,7 @@ const renderMatches = async (status: HTMLElement, result: HTMLElement, matched:
|
||||
list.append(row);
|
||||
}
|
||||
blocks.push(
|
||||
paragraph(strong('Wanted.'), ' The collection does not hold this dump yet. If you dumped it yourself, ', link('contributing/', 'add it'), '.'),
|
||||
paragraph(strong('Wanted.'), ' The collection does not hold this dump yet. Anyone who dumped it can ', link('contributing/', 'add it'), '.'),
|
||||
list,
|
||||
);
|
||||
}
|
||||
@@ -692,7 +692,7 @@ const WANTED = 'provenance/#wanted-catalogued-dumps-this-project-does-not-have';
|
||||
const renderNoMatch = (status: HTMLElement, result: HTMLElement) => {
|
||||
status.textContent = 'No file, setup or emulator the site knows has this hash.';
|
||||
result.replaceChildren(
|
||||
paragraph('If you dumped it yourself, ', link('contributing/', 'add it'), '.'),
|
||||
paragraph('Anyone who dumped it can ', link('contributing/', 'add it'), '.'),
|
||||
paragraph('The ', link(WANTED, 'wanted list'), ' names the catalogued dumps the collection still lacks.'),
|
||||
);
|
||||
};
|
||||
|
||||
@@ -179,7 +179,7 @@ platforms:
|
||||
```
|
||||
|
||||
`device_group` places the platform among the devices a reader picks from: on
|
||||
the site's "Get your files" page, in the "Your setup" navigation and on the home
|
||||
the site's "Get the files" page, in the "Setups" navigation and on the home
|
||||
page. The groups, their labels and their anchors are under `device_groups` in
|
||||
`platforms/_guides.yml`, beside the platform's [guide text](#guide-text).
|
||||
|
||||
@@ -520,7 +520,7 @@ The YAML is the scraper's output and is never edited by hand: the next scrape
|
||||
would undo the edit, and the file would stop describing the platform. Anything
|
||||
an export has to write back (the platform's own system id, path, name) is
|
||||
recorded by the scraper and never reconstructed later, because several of the
|
||||
platform's systems can fold into one of ours. A rescrape can add systems, so
|
||||
platform's systems can fold into one of the collection's. A rescrape can add systems, so
|
||||
read `verify.py --platform` before committing the regenerated YAML.
|
||||
|
||||
Verify the result:
|
||||
@@ -602,7 +602,7 @@ of files:
|
||||
- `can_add()` - `False` when an entry is code rather than a row of data
|
||||
(BizHawk), so nothing is added.
|
||||
- `keys_by_system()` - `True` when the platform finds a file by the name of its
|
||||
own system, so an entry filed under one of our system ids is never written.
|
||||
own system, so an entry filed under one of the collection's system ids is never written.
|
||||
- `needs_original()` - `True` as soon as `native_sources()` names a file.
|
||||
|
||||
Those methods say what the format could hold. The report counts what `render()`
|
||||
@@ -631,7 +631,7 @@ will not find in the diff.
|
||||
|
||||
The scraper and the exporter are checked against each other as
|
||||
[round-trip testing](adding-a-scraper.md#round-trip-testing) describes. The
|
||||
export must not lose anything the platform already declares. If your
|
||||
export must not lose anything the platform already declares. If the
|
||||
format carries code as well as data (a script, a C# database, a manifest
|
||||
whose BIOS list sits beside launch configuration), name the file in
|
||||
`native_sources()` and patch it rather than writing a new one. An exporter
|
||||
|
||||
@@ -456,7 +456,7 @@ manipulation rather than load-dump to maintain human-readable formatting.
|
||||
|
||||
The scrape and the export are two directions of the same transcription, so
|
||||
run them against each other: scrape upstream, export it back, and diff the
|
||||
result against the file you started from. Nothing the platform declares may
|
||||
result against the original file. Nothing the platform declares may
|
||||
be missing from the round trip.
|
||||
|
||||
```bash
|
||||
|
||||
@@ -3,7 +3,7 @@ level: contribute
|
||||
order: 80
|
||||
---
|
||||
|
||||
# Build your own packs
|
||||
# Build custom packs
|
||||
|
||||
Fine-grained control over pack generation, hardware filtering, truth analysis (the file
|
||||
list a platform would have if it were written from the emulators' code) and
|
||||
@@ -23,7 +23,7 @@ A clone carries the whole collection, several gigabytes, and `git clone
|
||||
--depth 1` leaves its history out. From that clone, `python scripts/generate_pack.py --platform
|
||||
retroarch --region us` builds a narrower pack, `--required-only` the bare
|
||||
minimum each core needs to start, and `--no-game-data` keeps the firmware and
|
||||
leaves out the files a game reads. `--help` lists every way to build your own,
|
||||
leaves out the files a game reads. `--help` lists every way to build one,
|
||||
and the sections below describe each one.
|
||||
|
||||
## Custom packs
|
||||
@@ -47,8 +47,8 @@ carries one hash (MD5, SHA-1 or CRC32), alone or beside a file name as
|
||||
python scripts/generate_pack.py --platform batocera --from-md5-file missing.txt
|
||||
```
|
||||
|
||||
This is useful when a platform reports missing files and you want to generate a targeted pack
|
||||
rather than re-downloading the full archive.
|
||||
This builds a targeted pack when a platform reports missing files, rather than
|
||||
downloading the full archive again.
|
||||
|
||||
### Split packs
|
||||
|
||||
@@ -79,7 +79,7 @@ python scripts/verify.py --platform batocera --system psx
|
||||
```
|
||||
|
||||
Beside `--platform`, `--system` accepts the platform's own name for a system
|
||||
as well as our id: `psx` is what Batocera calls `sony-playstation`, and both
|
||||
as well as the collection's id: `psx` is what Batocera calls `sony-playstation`, and both
|
||||
build the same pack. The names come from `native_system` in the platform
|
||||
YAML, the mapping the installer reads as `system_names`, and
|
||||
`--platform batocera --list-systems` shows them after each id. A comma-separated
|
||||
@@ -527,7 +527,7 @@ README, site generation) run normally using cached data.
|
||||
|
||||
### Partial runs
|
||||
|
||||
Skip pack generation when you only need verification results:
|
||||
Skip pack generation when only verification results are needed:
|
||||
|
||||
```bash
|
||||
python scripts/pipeline.py --offline --skip-packs
|
||||
|
||||
@@ -5,7 +5,7 @@ order: 60
|
||||
|
||||
# Architecture
|
||||
|
||||
How a BIOS list on a platform's site becomes a pack on your drive. Scrapers
|
||||
How a BIOS list on a platform's site becomes a pack on a drive. Scrapers
|
||||
copy each platform's own list. Emulator profiles record what each emulator's
|
||||
code opens. `database.json` indexes every file the collection holds by its
|
||||
contents. The pack builder joins the three and ships every file a platform's
|
||||
@@ -147,7 +147,7 @@ Every part of the toolchain follows from a few rules.
|
||||
folders, file names or database, nor to one platform's conventions. The
|
||||
toolchain resolves a profile against the collection.
|
||||
- **Other projects are peers.** A finding about another project says what
|
||||
changes, never who erred, and comes with its evidence. Our data can be
|
||||
changes, never who erred, and comes with its evidence. The data here can be
|
||||
wrong too, and an issue that shows it is as welcome as a finding sent
|
||||
upstream.
|
||||
- **An inconsistency found is fixed now.** A fix comes with a test that fails
|
||||
|
||||
@@ -16,13 +16,13 @@ Projects built on RetroBIOS data.
|
||||
- **Repository:** [github.com/monster-penguin/BIOS-Preservation-Tool](https://github.com/monster-penguin/BIOS-Preservation-Tool)
|
||||
- **License:** MIT
|
||||
|
||||
A local tool for managing your own BIOS collection. Point it at your files, it verifies them against RetroBIOS platform YAMLs, stores them in a deduplicated database, and produces ready-to-use directories for each platform. Supports scanning directories, archives, and URLs.
|
||||
A local tool for managing a personal BIOS collection. Point it at the files, it verifies them against RetroBIOS platform YAMLs, stores them in a deduplicated database, and produces ready-to-use directories for each platform. Supports scanning directories, archives, and URLs.
|
||||
|
||||
See the project's [README](https://github.com/monster-penguin/BIOS-Preservation-Tool#readme) for setup and usage.
|
||||
|
||||
---
|
||||
|
||||
:::note[Add your project]
|
||||
Open an issue with a link to your repository.
|
||||
:::note[Add a project]
|
||||
Open an issue with a link to the repository.
|
||||
:::
|
||||
|
||||
+17
-17
@@ -6,7 +6,7 @@ terms: ios, iphone, ipad
|
||||
|
||||
# Common questions
|
||||
|
||||
## Do I need BIOS files?
|
||||
## Are BIOS files needed? { #do-i-need-bios-files }
|
||||
|
||||
- **Yes** for PlayStation 1 and 2, Saturn and Neo Geo.
|
||||
- **Better with it** for Dreamcast. Some games need it.
|
||||
@@ -14,7 +14,7 @@ terms: ios, iphone, ipad
|
||||
|
||||
[What is a BIOS?](what-are-bios-files.md)
|
||||
|
||||
## How do I know which BIOS I need?
|
||||
## How to tell which BIOS is needed? { #how-do-i-know-which-bios-i-need }
|
||||
|
||||
`--dry-run` lists them and changes nothing.
|
||||
|
||||
@@ -23,7 +23,7 @@ terms: ios, iphone, ipad
|
||||
curl -fsSL https://abdess.github.io/retrobios/i | sh -s -- --dry-run
|
||||
```
|
||||
|
||||
## Do I need every file of a console?
|
||||
## Is every file of a console needed? { #do-i-need-every-file-of-a-console }
|
||||
|
||||
No. `--core pcsx1` keeps what PCSX reads:
|
||||
|
||||
@@ -39,14 +39,14 @@ option.
|
||||
|
||||
## Zip or unzip? { #zip-or-unzip }
|
||||
|
||||
Unzip into the folder your setup's page names. Keep
|
||||
Unzip into the folder the setup's page names. Keep
|
||||
inner ZIPs zipped, like `neogeo.zip`.
|
||||
|
||||
## Does a BIOS work on every setup?
|
||||
|
||||
Usually. The command installs each setup's own, like `neogeo.zip`.
|
||||
|
||||
## My arcade game fails (which MAME version?) { #my-arcade-game-does-not-start }
|
||||
## An arcade game fails (which MAME version?) { #my-arcade-game-does-not-start }
|
||||
|
||||
Game sets must match the emulator's version:
|
||||
[the list](technical-faq.md#which-mame-version-do-the-arcade-bios-sets-match).
|
||||
@@ -70,12 +70,12 @@ Read them: [install.sh](https://github.com/Abdess/retrobios/blob/main/install.sh
|
||||
[install.ps1](https://github.com/Abdess/retrobios/blob/main/install.ps1),
|
||||
[install.py](https://github.com/Abdess/retrobios/blob/main/install.py).
|
||||
|
||||
## Windows or my antivirus blocks the command
|
||||
## Windows or an antivirus blocks the command { #windows-or-my-antivirus-blocks-the-command }
|
||||
|
||||
Use your setup's ZIP. None? [Pick your consoles](../which-pack.md#only-some-consoles)
|
||||
Use the setup's ZIP. None? [Pick the consoles](../which-pack.md#only-some-consoles)
|
||||
and download their files.
|
||||
|
||||
## Why is there no ZIP for my setup?
|
||||
## 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.
|
||||
@@ -83,7 +83,7 @@ setup's 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 your setup and its BIOS folder. For RetroArch on a Switch,
|
||||
MiSTer card. Else name the setup and its BIOS folder. For RetroArch on a Switch,
|
||||
with the card in drive `E:`, run:
|
||||
|
||||
<!-- os-tabs windows: --platform retroarch --dest E:\retroarch\cores\system -->
|
||||
@@ -94,38 +94,38 @@ curl -fsSL https://abdess.github.io/retrobios/i \
|
||||
|
||||
## No internet on the device?
|
||||
|
||||
Fill it from a computer or point `--from-pack` at your ZIP: [Without a network](installer.md#without-a-network-offline-install).
|
||||
Fill it from a computer or point `--from-pack` at the ZIP: [Without a network](installer.md#without-a-network-offline-install).
|
||||
|
||||
## Lost or wiped card?
|
||||
|
||||
`--from` copies BIOS files from an old card or backup:
|
||||
[Copy from an old card](installer.md#copy-from-an-old-card).
|
||||
|
||||
## My setup is not in the list
|
||||
## A setup is not in the list { #my-setup-is-not-in-the-list }
|
||||
|
||||
- Name your emulator's BIOS folder with `--dest`.
|
||||
- Name the emulator's BIOS folder with `--dest`.
|
||||
- ES-DE or LaunchBox? It fills their emulators' folders.
|
||||
- iPhone, iPad (iOS): no terminal.
|
||||
[Pick your consoles and copy them to the app](../which-pack.md#iphone-and-ipad).
|
||||
[Pick the consoles and copy them to the app](../which-pack.md#iphone-and-ipad).
|
||||
|
||||
## Why is a file missing from the ZIP?
|
||||
|
||||
Some come with the emulator.
|
||||
|
||||
## My game shows a black screen
|
||||
## A game shows a black screen { #my-game-shows-a-black-screen }
|
||||
|
||||
Often a missing BIOS: [When a game does not start](troubleshooting.md).
|
||||
|
||||
## Can I copy my own console's BIOS? { #copy-your-own-bios }
|
||||
## Can an owned console's BIOS be copied? { #copy-your-own-bios }
|
||||
|
||||
Yes: [PCSX2](https://pcsx2.net/docs/setup/bios/) for PlayStation 2,
|
||||
[melonDS](https://melonds.kuribo64.net/faq.php) for DS and DSi.
|
||||
|
||||
## Is this legal?
|
||||
|
||||
[It depends on your country](legal.md).
|
||||
[It depends on the country](legal.md).
|
||||
|
||||
## Next steps
|
||||
|
||||
- [Get your files](../which-pack.md)
|
||||
- [Get the files](../which-pack.md)
|
||||
- [Words used on this site](glossary.md)
|
||||
@@ -7,11 +7,11 @@ order: 30
|
||||
|
||||
From an empty BIOS folder to games that start.
|
||||
|
||||
**You need:** internet and some free space.
|
||||
**Needed:** internet and some free space.
|
||||
|
||||
## 1. Open a terminal and paste
|
||||
|
||||
A **terminal** is a window where you type commands. Paste your system's
|
||||
A **terminal** is a window for typing commands. Paste the matching
|
||||
line, then press Enter.
|
||||
|
||||
<Tabs syncKey="os">
|
||||
@@ -64,7 +64,7 @@ curl -fsSL https://abdess.github.io/retrobios/i | sh
|
||||
</Tabs>
|
||||
|
||||
On Batocera, Recalbox and similar setups, see
|
||||
[Get your files](../which-pack.md).
|
||||
[Get the files](../which-pack.md).
|
||||
|
||||
## 2. Check the setup it found
|
||||
|
||||
@@ -88,8 +88,8 @@ touch screen, tap a row twice to open it, once to tick a box.
|
||||
|
||||
## 3. Install
|
||||
|
||||
Press Enter on **Install**. **Choose systems** keeps the consoles you
|
||||
play.
|
||||
Press Enter on **Install**. **Choose systems** picks the consoles to
|
||||
keep.
|
||||
|
||||
**Game data** (only a game reads it) has its own row.
|
||||
|
||||
@@ -130,14 +130,14 @@ All good:
|
||||
|
||||
## Undo
|
||||
|
||||
Replaced files go to `retrobios-backup` beside your BIOS folder. The result
|
||||
Replaced files go to `retrobios-backup` beside the BIOS folder. The result
|
||||
says how to restore them.
|
||||
|
||||
## If it stops
|
||||
|
||||
### Nothing was found here.
|
||||
|
||||
Choose your setup, then its folder. Where the screen offers
|
||||
Choose the setup, then its folder. Where the screen offers
|
||||
**Another setup or folder**, choose it first.
|
||||
|
||||
### Error: Python 3.8 or newer is required.
|
||||
@@ -162,7 +162,7 @@ Nothing ran, because something changed the file. Try another network.
|
||||
|
||||
### Cannot create ...
|
||||
|
||||
You cannot write there. Do what the message says.
|
||||
That folder cannot be written. Do what the message says.
|
||||
|
||||
### The card is full
|
||||
|
||||
@@ -174,6 +174,6 @@ See [When a game does not start](troubleshooting.md).
|
||||
|
||||
## Next steps
|
||||
|
||||
- [Get your files](../which-pack.md)
|
||||
- [Get the files](../which-pack.md)
|
||||
- [When a game does not start](troubleshooting.md)
|
||||
- Details: [Reading the installer's output, line by line](installer.md#reading-a-run)
|
||||
+7
-7
@@ -16,10 +16,10 @@ order: 60
|
||||
console.
|
||||
|
||||
**Setup**
|
||||
: What you play with: RetroArch, Batocera, EmuDeck and others.
|
||||
: What plays the games: RetroArch, Batocera, EmuDeck and others.
|
||||
|
||||
**BIOS folder**
|
||||
: The folder where your setup looks for BIOS files.
|
||||
: The folder where the setup looks for BIOS files.
|
||||
|
||||
**Pack**
|
||||
: The ZIP, sometimes in parts, with one setup's BIOS files. Made for the
|
||||
@@ -29,13 +29,13 @@ order: 60
|
||||
: A setup, as the project's data calls it.
|
||||
|
||||
**ZIP**
|
||||
: One file that holds many files. You unzip it to get them out.
|
||||
: One file that holds many files. Unzip it to get them out.
|
||||
|
||||
**Terminal**
|
||||
: A window where you type commands.
|
||||
: A window for typing commands.
|
||||
|
||||
**Installer**
|
||||
: The small program the command starts. It fills your BIOS folder.
|
||||
: The small program the command starts. It fills the BIOS folder.
|
||||
|
||||
**Hash**
|
||||
: A fingerprint of a file's contents. A different file gets a different hash.
|
||||
@@ -50,11 +50,11 @@ order: 60
|
||||
: Required: games do not start without it. Optional: games start anyway.
|
||||
|
||||
**Game data**
|
||||
: Files from your own copy of a PC game, like Doom. Not a BIOS.
|
||||
: Files from an owned copy of a PC game, like Doom. Not a BIOS.
|
||||
|
||||
## Next steps
|
||||
|
||||
- [What is a BIOS?](what-are-bios-files.md)
|
||||
- [Get your files](../which-pack.md)
|
||||
- [Get the files](../which-pack.md)
|
||||
- For contributors: [Terms of the reference pages](reference-terms.md)
|
||||
|
||||
+2
-2
@@ -7,7 +7,7 @@ order: 0
|
||||
|
||||
These pages describe how the files are checked, what the data holds and how the
|
||||
toolchain works. To set up BIOS files on a device, start with
|
||||
[Get your files](../which-pack.md).
|
||||
[Get the files](../which-pack.md).
|
||||
|
||||
## Checking files
|
||||
|
||||
@@ -51,7 +51,7 @@ at run time, so the source is the primary reference:
|
||||
- **[Release process](release-process.md)**: CI workflows, large files, manual release
|
||||
- **[Architecture](architecture.md)**: directory structure, data flow, platform inheritance, pack grouping, security, edge cases, CI workflows
|
||||
- **[Command-line tools](tools.md)**: every script, pipeline usage, scrapers
|
||||
- **[Build your own packs](advanced-usage.md)**: custom packs, region filtering, one file per slot, target filtering, truth generation, emulator verification, offline workflow
|
||||
- **[Build custom packs](advanced-usage.md)**: custom packs, region filtering, one file per slot, target filtering, truth generation, emulator verification, offline workflow
|
||||
|
||||
See [contributing](../contributing.md) for submission guidelines.
|
||||
|
||||
|
||||
+14
-14
@@ -6,20 +6,20 @@ terms: manifest, events, exit code, schema, packager, pin, reproducible
|
||||
|
||||
# All installer options
|
||||
|
||||
The one-line command finds your setup and its BIOS folder. It downloads only
|
||||
The one-line command finds the setup and its BIOS folder. It downloads only
|
||||
the files that are missing or wrong, and checks each one against its
|
||||
fingerprint before writing it. The options below are for anything else: fewer
|
||||
files (one console, one region, only the cores you have), another folder, an
|
||||
files (one console, one region, only the cores installed), another folder, an
|
||||
SD card, a check without download, or a run from a script.
|
||||
|
||||
Example: `--platform retroarch --system sony-playstation --region north-america`
|
||||
installs only the PlayStation files, and the North American version where
|
||||
there is one per region.
|
||||
|
||||
How the command protects your machine is under
|
||||
How the command protects the machine is under
|
||||
[What the bootstrap does](#what-the-bootstrap-does) and
|
||||
[Trust boundary](#trust-boundary). The BIOS folder of each setup is on
|
||||
[Get your files](../which-pack.md).
|
||||
[Get the files](../which-pack.md).
|
||||
|
||||
## Options at a glance
|
||||
|
||||
@@ -160,13 +160,13 @@ Enter checks the BIOS folder when nothing can be copied.
|
||||
## The full-screen interface { #the-full-screen-interface }
|
||||
|
||||
Run at a terminal, the installer opens a full screen that a keyboard or a
|
||||
controller drives. Three presses of A or Enter install everything your setup
|
||||
controller drives. Three presses of A or Enter install everything the setup
|
||||
reads: the setup found here, the plan, then the result. The plan screen says
|
||||
how many files are missing, how much they weigh, how many are in place and how
|
||||
much space is free, before anything is written.
|
||||
|
||||
The other choices sit one press away. **Choose systems** ticks the consoles you
|
||||
play, with the total to download under the list. A long list opens on **None**:
|
||||
The other choices sit one press away. **Choose systems** ticks the consoles to
|
||||
keep, with the total to download under the list. A long list opens on **None**:
|
||||
A or Enter there unticks every system, and A on a system then takes that one alone. A
|
||||
on a system (**Continue**) always opens the confirm screen, which counts the choice
|
||||
before **Install**: it never installs by itself. Back with nothing ticked keeps the ticks
|
||||
@@ -356,7 +356,7 @@ file list is downloaded once and handed to each run.
|
||||
(`.<ref>.archive.part`), asking with `If-Range` so that a server whose
|
||||
archive changed sends it whole. A second run into the same folder finds
|
||||
that archive in use and downloads its own copy. A file already there with other contents
|
||||
is moved aside first, see [Files you already had](#files-you-already-had).
|
||||
is moved aside first, see [Files already in the folder](#files-you-already-had).
|
||||
8. Copies into standalone emulator directories, only with `--standalone-copies`.
|
||||
|
||||
The file list names the version of the platform it was built for (Batocera
|
||||
@@ -581,7 +581,7 @@ and `--check` exits with code 3. The files the collection does not hold are
|
||||
listed after it again, as long as they are absent from the folder. A number before `wrong copies` means a file is
|
||||
in place with contents the platform does not accept. Running the install again
|
||||
replaces it and keeps the old one, see
|
||||
[Files you already had](#files-you-already-had).
|
||||
[Files already in the folder](#files-you-already-had).
|
||||
|
||||
### Why a file is refused { #why-a-file-is-refused }
|
||||
|
||||
@@ -640,7 +640,7 @@ a part that was not extracted, or one extracted into a folder of its own:
|
||||
Download it and extract into /home/me/.config/retroarch/system, beside the other parts.
|
||||
```
|
||||
|
||||
## Files you already had
|
||||
## Files already in the folder { #files-you-already-had }
|
||||
|
||||
A file in the BIOS folder whose contents differ from the expected one (another
|
||||
revision, a personal dump) is replaced, but never lost. Just before the
|
||||
@@ -724,7 +724,7 @@ member locked by a password.
|
||||
The folder is only read: each file is copied, checked against the list's
|
||||
hashes once written, and the original stays where it is. A file in place with
|
||||
other contents is kept aside first, as a download would replace it (see
|
||||
[Files you already had](#files-you-already-had)). What no folder holds is
|
||||
[Files already in the folder](#files-you-already-had)). What no folder holds is
|
||||
downloaded as usual, or taken from the pack with `--from-pack`. Several
|
||||
`--from` are read in the order given, and the end of the run says where each
|
||||
file came from. A run of a list of four files, two of them in `old`:
|
||||
@@ -826,7 +826,7 @@ answer is not asked.
|
||||
Asked only when the chosen systems have such files. Every core is kept
|
||||
until numbers name some, and the head then says how many of how many
|
||||
(`1 of 2 cores`). The full screen's **Cores** opens with every core
|
||||
ticked, as Choose systems does: untick the ones you do not use, **All**
|
||||
ticked, as Choose systems does: untick the unused ones, **All**
|
||||
and **None** tick or untick them all.
|
||||
- **Regions.** Asked only when a chosen system has one BIOS per region. The
|
||||
numbers give an order of preference: `2,1` keeps the second region where a
|
||||
@@ -1465,7 +1465,7 @@ python install.py --platform retroarch --dest /storage/emulated/0/RetroArch/syst
|
||||
|
||||
RetroBIOS also runs on the handheld itself, in the
|
||||
[full-screen interface](#the-full-screen-interface), with the controller.
|
||||
Copy the file for your system to the SD card, then start RetroBIOS from the
|
||||
Copy the file for the system to the SD card, then start RetroBIOS from the
|
||||
menu.
|
||||
|
||||
The files below ship with the next release. Until then, build them from a
|
||||
@@ -1556,7 +1556,7 @@ On a Miyoo, B, X, Y and Select are Left Ctrl, Shift, Alt and Right Ctrl:
|
||||
pressed alone, a modifier sends nothing to a terminal, so the interface goes
|
||||
back with R2 instead, and the bottom line says so.
|
||||
|
||||
**Without Wi-Fi.** On a computer, download the BIOS pack that serves your
|
||||
**Without Wi-Fi.** On a computer, download the BIOS pack that serves the
|
||||
system (every part, for a pack in parts): RetroArch's on muOS, ArkOS,
|
||||
dArkOS and JELOS, Batocera's on Batocera. Copy it next to RetroBIOS: into
|
||||
`ports/retrobios` for the PortMaster port and on Batocera, to the root of
|
||||
|
||||
+1
-1
@@ -6,7 +6,7 @@ terms: license
|
||||
|
||||
# Is it legal?
|
||||
|
||||
It depends on your country. Nothing here is legal advice.
|
||||
It depends on the country. Nothing here is legal advice.
|
||||
|
||||
- Making an emulator is legal in the US. EU law allows it under conditions.
|
||||
- Sharing BIOS files is not settled law. The strongest case is old consoles no
|
||||
|
||||
@@ -7,8 +7,8 @@ terms: measurement, proof, tested, core probe, real conditions, method
|
||||
|
||||
# How emulators are tested
|
||||
|
||||
We run an emulator only when a question needs a real answer. That is an
|
||||
issue, a fix we send to a project, or a check before a release.
|
||||
An emulator runs here only when a question needs a real answer. That is an
|
||||
issue, a fix sent to a project, or a check before a release.
|
||||
|
||||
A page that relies on a run says so in a **Proof** line. Every run is on the
|
||||
[Measurements](../measurements.md) page.
|
||||
@@ -18,7 +18,7 @@ A page that relies on a run says so in a **Proof** line. Every run is on the
|
||||
- A script runs the emulator with no window and no sound.
|
||||
- It starts a game and runs it for a set time.
|
||||
- A test that compares files runs each case at least twice.
|
||||
- It compares the screens with ones we checked by eye.
|
||||
- It compares the screens with ones checked by eye.
|
||||
- It reads the emulator's log to see which BIOS it ran.
|
||||
|
||||
## What a result says
|
||||
@@ -37,8 +37,8 @@ A page that relies on a run says so in a **Proof** line. Every run is on the
|
||||
|
||||
- It shows the first minutes of one game, not the whole game.
|
||||
- It sees the files the emulator opened on this path, not every path.
|
||||
- Some emulators run their own BIOS when yours is refused. The game still works.
|
||||
- The app you play in may change settings the test left as they were.
|
||||
- Some emulators run their own BIOS when the given one is refused. The game still works.
|
||||
- The app that runs the game may change settings the test left as they were.
|
||||
|
||||
## How a file is proven
|
||||
|
||||
|
||||
+9
-9
@@ -4,23 +4,23 @@ order: 65
|
||||
terms: privacy, cookies, analytics, tracking
|
||||
---
|
||||
|
||||
# What we count
|
||||
# What is counted
|
||||
|
||||
No cookies. No account. Nothing is stored on your device, and nothing
|
||||
No cookies. No account. Nothing is stored on the device, and nothing
|
||||
links a visit to a person.
|
||||
|
||||
## On this site
|
||||
|
||||
When a page opens, your browser sends one request to
|
||||
When a page opens, the browser sends one request to
|
||||
[GoatCounter](https://www.goatcounter.com), an open-source counter. It
|
||||
carries:
|
||||
|
||||
- the page address, without the part after `?` or `#`;
|
||||
- the site you came from, by its address without a path
|
||||
- the site the visit came from, by its address without a path
|
||||
(`https://www.google.com`).
|
||||
|
||||
GoatCounter reads the browser name and the country from that request. It does
|
||||
not keep your IP address. To tell a reload from a second visitor it keeps a
|
||||
not keep the IP address. To tell a reload from a second visitor it keeps a
|
||||
code made from the request for 8 hours, then drops it.
|
||||
|
||||
These actions are counted the same way, with the page they happened on:
|
||||
@@ -35,12 +35,12 @@ 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: your screen size, your language, a search that found results.
|
||||
Not sent: the screen size, the language, a search that found results.
|
||||
|
||||
The totals are kept two years and are public:
|
||||
[retrobios.goatcounter.com](https://retrobios.goatcounter.com).
|
||||
|
||||
If your browser sends Do Not Track or Global Privacy Control, nothing is sent,
|
||||
If the browser sends Do Not Track or Global Privacy Control, nothing is sent,
|
||||
and the "Did this page help?" question is not shown. A content blocker that
|
||||
stops GoatCounter changes nothing on the site.
|
||||
|
||||
@@ -51,6 +51,6 @@ those requests as it sees any download.
|
||||
|
||||
## Search engines
|
||||
|
||||
Google and Bing tell us which searches showed the site and how often it was
|
||||
clicked. They report totals, from their own records, never from your
|
||||
Google and Bing report which searches showed the site and how often it was
|
||||
clicked. They give totals, from their own records, never from a reader's
|
||||
browser.
|
||||
@@ -8,7 +8,7 @@ group: Checking files
|
||||
|
||||
These sections are about this repository's own tools, run from a clone.
|
||||
`scripts/verify.py` checks the collection in `bios/` against each platform, never
|
||||
your BIOS folder: for that, use the installer's `--check`
|
||||
a user's BIOS folder: for that, use the installer's `--check`
|
||||
([When a game does not start](troubleshooting.md)). How each platform checks a
|
||||
file is on [How each platform checks files](verification-modes.md).
|
||||
|
||||
@@ -43,7 +43,7 @@ version the emulator tries first, and some cores accept several versions.
|
||||
|
||||
## Pack is missing files
|
||||
|
||||
A generated pack doesn't contain all the files you expected.
|
||||
A generated pack lacks some of the expected files.
|
||||
|
||||
### Severity levels
|
||||
|
||||
@@ -69,7 +69,7 @@ Files like PS3UPDAT.PUP, PSVUPDAT.PUP, and Switch firmware are too large for the
|
||||
git repository. They are stored as GitHub release assets under the `large-files`
|
||||
release and downloaded at build time.
|
||||
|
||||
If a pack build fails to include these, check your network connection. In offline
|
||||
If a pack build fails to include these, check the network connection. In offline
|
||||
mode (`--offline`), large files are only included if already cached locally in
|
||||
`.cache/large/`.
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ The words the reference and contributor pages use, each with a real case. The
|
||||
everyday words (BIOS, emulator, core, hash) are in the [glossary](glossary.md).
|
||||
|
||||
**Frontend**
|
||||
: The menu you pick and start games from, such as EmulationStation, MinUI or
|
||||
: The menu that picks and starts games, such as EmulationStation, MinUI or
|
||||
the RetroArch menu. It starts the emulator.
|
||||
|
||||
**Pack**
|
||||
|
||||
@@ -356,7 +356,7 @@ download address. It lists the files of the pack the latest release holds,
|
||||
read from `release.json`, or gives the command when there is no pack. The
|
||||
README, the setup pages and the release notes link it, never an asset URL:
|
||||
step 6 deletes the previous tag, and with it every link to its assets. Six of
|
||||
the eight links one community wiki had to our packs answered 404 that way.
|
||||
the eight links one community wiki had to the packs answered 404 that way.
|
||||
Committing `release.json` in step 5 rebuilds these pages, so the release
|
||||
never touches them.
|
||||
|
||||
|
||||
@@ -6,10 +6,10 @@ terms: mame version, romset version, which mame
|
||||
|
||||
# Technical questions
|
||||
|
||||
Answers to "how do you know?" questions: how a file is identified, why one BIOS
|
||||
Answers to "how is this known?" questions: how a file is identified, why one BIOS
|
||||
has several fingerprints, why some files are not BIOS, and which MAME version an
|
||||
arcade set belongs to. Each answer gives a real file as its example, so you can
|
||||
check it on the system pages. Questions asked before installing are in
|
||||
arcade set belongs to. Each answer gives a real file as its example, to check on the
|
||||
system pages. Questions asked before installing are in
|
||||
[Common questions](faq.md).
|
||||
|
||||
## What's a hash/checksum?
|
||||
@@ -50,7 +50,7 @@ Two main reasons:
|
||||
1. **Regional variants.** The same filename (e.g., `IPL.bin` for GameCube) exists in different versions for USA, Europe, and Japan. Each region has a different hash.
|
||||
2. **Revision differences.** Console manufacturers released updated BIOS versions over time. A PlayStation SCPH-5501 BIOS differs from a SCPH-7001.
|
||||
|
||||
Platforms that verify by MD5 accept specific hashes. If yours doesn't match any known hash, it may be a bad dump or an uncommon revision.
|
||||
Platforms that verify by MD5 accept specific hashes. A file that matches no known hash may be a bad dump or an uncommon revision.
|
||||
|
||||
A filename is never allowed to stand in for a declared hash. When a file entry
|
||||
carries a hash, resolution matches on content and reports `hash_mismatch` if the
|
||||
@@ -114,14 +114,14 @@ cross-referenced against their DATs: files matching a catalog entry
|
||||
carry a verified dump badge on the system pages, and catalog entries
|
||||
absent from the collection are tracked as acquisition targets. When
|
||||
the two views differ, this project follows the code, because that is
|
||||
what decides whether your emulator boots.
|
||||
what decides whether the emulator boots.
|
||||
|
||||
The [dump provenance](../provenance.md) page has the current coverage
|
||||
per catalog and the full list of catalogued dumps still missing.
|
||||
|
||||
## Which MAME version do the arcade BIOS sets match?
|
||||
|
||||
Your game sets and BIOS sets must come from the same version as your arcade
|
||||
Game sets and BIOS sets must come from the same version as the arcade
|
||||
emulator.
|
||||
|
||||
<!-- generated: romsets -->
|
||||
@@ -156,10 +156,10 @@ carry their own profiles on top of those generations: `mamearcade`,
|
||||
`mamemess`, `mame2003_midway`, the three `mame4droid` drops,
|
||||
`advancemame`, `groovymame` and `hbmame`. Recalbox compiles two MAME
|
||||
versions of its own, 0.258 and 0.278, profiled as `mame0258` and
|
||||
`mame0278`. The pack ships the sets matching the core you run, and a
|
||||
`mame0278`. The pack ships the sets matching the core in use, and a
|
||||
generic unversioned arcade pack cannot do that.
|
||||
|
||||
## Why does my verification report say UNTESTED?
|
||||
## Why does a verification report say UNTESTED? { #why-does-my-verification-report-say-untested }
|
||||
|
||||
`untested` means the file exists on disk but its hash does not match the expected value. This happens on MD5 and SHA1 platforms (Batocera, Recalbox, BizHawk, ROCKNIX, MiSTer FPGA, and the rest) when the file is present but contains different data than what the platform declares.
|
||||
|
||||
|
||||
+2
-2
@@ -267,13 +267,13 @@ own verification mode ([discrepancy detection](verification-modes.md#discrepancy
|
||||
### Granular options
|
||||
|
||||
- `--system` with `--platform`: filter to specific systems within a platform pack.
|
||||
It takes our system ids (`sony-playstation`) and the platform's own names,
|
||||
It takes the collection's system ids (`sony-playstation`) and the platform's own names,
|
||||
read from `native_system` in its YAML (Batocera `psx`, Recalbox `msx1,msx2`).
|
||||
`--platform <name> --list-systems` prints both. `verify.py --platform --system`
|
||||
reports on the same narrowed pack, and the installer's `--system` reads the
|
||||
same mapping from the manifest's `system_names`. An unknown name is refused
|
||||
with the closest matches before any work. Without `--platform`, `--system`
|
||||
takes our ids only.
|
||||
takes the collection's ids only.
|
||||
- `--required-only`: exclude optional files and the data directories declared
|
||||
`required: false`, keep only required. `verify.py --required-only` reports
|
||||
on the same file set, for `--platform`, `--emulator` and `--system`
|
||||
|
||||
@@ -8,7 +8,7 @@ terms: bios not found, bios missing, firmware missing, bios error, check my bios
|
||||
|
||||
Usually a BIOS file is missing or wrong.
|
||||
|
||||
## 1. Check my BIOS folder { #checking-what-you-installed }
|
||||
## 1. Check the BIOS folder { #checking-what-you-installed }
|
||||
|
||||
<span id="game-wont-start-black-screen"></span><span id="my-setup-says-untested"></span>
|
||||
|
||||
@@ -17,7 +17,7 @@ Usually a BIOS file is missing or wrong.
|
||||
platforms/libretro/libretro.cpp:866 "OS-7 BIOS missing" (23d0ec28), RetroArch
|
||||
intl/msg_hash_us.h:32805 "One or more firmware files are missing" (5333a7c5). -->
|
||||
|
||||
Your emulator says **BIOS not found**, **BIOS missing** or **firmware
|
||||
The emulator says **BIOS not found**, **BIOS missing** or **firmware
|
||||
missing**? Run the command with `--check`. It changes nothing.
|
||||
|
||||
<!-- os-tabs -->
|
||||
@@ -42,9 +42,9 @@ Without `--check`, it adds missing files and replaces wrong ones.
|
||||
|
||||
## 3. Check the folder and the names
|
||||
|
||||
- **Right folder?** [Get your files](../which-pack.md) names it.
|
||||
- **Right folder?** [Get the files](../which-pack.md) names it.
|
||||
- **Exact name?** `scph5501.bin` and `SCPH-5501.BIN` differ.
|
||||
- **A `bios` folder inside your BIOS folder?** The installer copies those
|
||||
- **A `bios` folder inside the BIOS folder?** The installer copies those
|
||||
files up one level.
|
||||
- **BIOS setting on a subfolder, like `system/dc`?** Point it at the BIOS
|
||||
folder. Emulators add their own, like `dc/` for Flycast.
|
||||
@@ -94,5 +94,5 @@ Other messages: [When something goes wrong](installer.md#when-something-goes-wro
|
||||
|
||||
## Next steps
|
||||
|
||||
- [Get your files](../which-pack.md)
|
||||
- [Get the files](../which-pack.md)
|
||||
- [Common questions](faq.md)
|
||||
Reference in new issue
Block a user