From e7a64d6a082f6639f506f376d6ad20d676330152 Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Fri, 23 Oct 2026 20:46:37 +0200 Subject: [PATCH] docs: install from a zipped pack or an old card The FAQ said to unzip a pack before --from-pack, which reads the ZIP, its parts or their folder as they are. A lost or wiped card now has its answer, --from, linked to Copy from an old card. Can I play without the BIOS goes, Do I need BIOS files answers it. --- tests/test_site_r4_merge.py | 27 +++++++++++++++++++++++++++ wiki/faq.md | 22 +++++++++++----------- 2 files changed, 38 insertions(+), 11 deletions(-) diff --git a/tests/test_site_r4_merge.py b/tests/test_site_r4_merge.py index 6cb0f53b..f77e2a4f 100644 --- a/tests/test_site_r4_merge.py +++ b/tests/test_site_r4_merge.py @@ -150,6 +150,33 @@ class OptionsGlanceFromTheParser(unittest.TestCase): sitediagrams.expand_glance(f"# x\n\n{sitediagrams.GLANCE_HEADING}\n\n- a\n\n## y\n") +class FaqInstallsFromWhatYouHold(unittest.TestCase): + """--from-pack reads the ZIP itself, and a wiped card had no answer.""" + + def setUp(self): + self.faq = (REPO_ROOT / "wiki" / "faq.md").read_text(encoding="utf-8") + + def _section(self, heading: str) -> str: + return self.faq.split(f"## {heading}\n", 1)[1].split("\n## ", 1)[0] + + 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, still zipped", 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", + (REPO_ROOT / "wiki" / "installer.md").read_text(encoding="utf-8")) + self.assertIn('"--from-pack"', install) + + def test_a_wiped_card_links_the_copy(self): + section = self._section("Lost or wiped card?") + self.assertIn("`--from`", section) + self.assertIn("(installer.md#copy-from-an-old-card)", section) + installer = (REPO_ROOT / "wiki" / "installer.md").read_text(encoding="utf-8") + self.assertIn("## Copy from an old card { #copy-from-an-old-card }", installer) + self.assertIn('"--from"', (REPO_ROOT / "install.py").read_text(encoding="utf-8")) + + @unittest.skipUnless((DIST / "systems" / "arcade-acclaim-zn-1" / "index.html").is_file(), "site not built") class BuiltCrumbs(unittest.TestCase): diff --git a/wiki/faq.md b/wiki/faq.md index 2244e4d5..590e5319 100644 --- a/wiki/faq.md +++ b/wiki/faq.md @@ -29,7 +29,7 @@ No. To keep only your region's BIOS, add it, like `--region us`. ## Does the BIOS set the game's language? -Rarely. It comes from the game. Some games follow the console's setting, like Flycast's **Language** +Rarely. It comes from the game. Some follow the console's setting, like Flycast's **Language** option. ## Zip or unzip? { #zip-or-unzip } @@ -53,18 +53,13 @@ Game sets must match the emulator's version: emulator's menu. - **Keys** unlock encrypted games, like `prod.keys` for Switch. -## Can I play without the BIOS? - -Sometimes, with an emulator's stand-in, but some games fail. - ## Is the command safe? { #is-piping-the-installer-into-a-shell-safe } - It stops if the installer does not match its expected fingerprint, and checks each file. -- It writes in your BIOS folder, and for some emulators your save folder. -- It never touches a game or a save. -- It keeps each file it replaces in `retrobios-backup`. `--restore` puts it - back. +- It writes in your BIOS folder, and some emulators' save folder. +- It never touches a game or save. +- It keeps each file it replaces in `retrobios-backup`, for `--restore`. Read them first: [install.sh](https://github.com/Abdess/retrobios/blob/main/install.sh), [install.ps1](https://github.com/Abdess/retrobios/blob/main/install.ps1), @@ -92,8 +87,13 @@ curl -fsSL https://raw.githubusercontent.com/Abdess/retrobios/main/install.sh \ ## No internet on the device? -Fill its folder from a computer, as above, or unzip your ZIP and check it with -`--from-pack`: [Without a network](installer.md#without-a-network-offline-install). +Fill its folder from a computer, as above, or point `--from-pack` at +your ZIP, still zipped: [Without a network](installer.md#without-a-network-offline-install). + +## Lost or wiped card? + +`--from` copies BIOS files from an old card or a backup: +[Copy from an old card](installer.md#copy-from-an-old-card). ## My setup is not in the list