diff --git a/tests/test_doc_surfaces.py b/tests/test_doc_surfaces.py index 21cfd770..690d3390 100644 --- a/tests/test_doc_surfaces.py +++ b/tests/test_doc_surfaces.py @@ -217,7 +217,7 @@ class EndUsersCheckTheirOwnFolder(unittest.TestCase): files points at the installer's --check, which hashes their folder.""" USER_SECTIONS = ( - ("wiki/troubleshooting.md", "## 1. Check your BIOS folder { #checking-what-you-installed }"), + ("wiki/troubleshooting.md", "## 1. Check my 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?"), diff --git a/wiki/troubleshooting.md b/wiki/troubleshooting.md index eb72017c..14f4ff73 100644 --- a/wiki/troubleshooting.md +++ b/wiki/troubleshooting.md @@ -5,11 +5,11 @@ order: 40 # When a game does not start -Usually a BIOS file is missing or the wrong version. Three checks find it. +Most often a BIOS file is missing or wrong. -## 1. Check your BIOS folder { #checking-what-you-installed } +## 1. Check my BIOS folder { #checking-what-you-installed } - + Run the command with `--check`. It changes nothing. @@ -24,50 +24,51 @@ Read the count line: 1/109 present (0 verified, 1 wrong hash) ``` -- **`wrong hash`**: wrong contents: another region, model, or damaged. -- **Fewer present than the total**: some files are missing. -- **A line under a file**, like `still zipped`: it says what to fix. -- **`0 wrong hash` and all present**: your files are fine. Go to step 3. +- **`wrong hash`**: another region, model, or damaged. Batocera says + `UNTESTED`. +- **Fewer present than the total**: files are missing. +- **A line under a file**, like `still zipped`, says what to fix. +- **`0 wrong hash`, all present**: go to step 3. ## 2. Fix the files -Run the same command without `--check`. It adds missing files and replaces -wrong ones, keeping the old ones. +Run it again without `--check`. It adds missing files and replaces wrong ones. ## 3. Check the folder and the names -- **Right folder?** Your emulator must read the folder the command used. - [Your setup's page](../which-pack.md) names it. -- **Is the name exact?** `scph5501.bin` and `SCPH-5501.BIN` are two different - names. On Linux, capital letters count too. -- **A `bios` folder inside your BIOS folder?** That ZIP holds its own top - folder. Move its files up one level. -- **Unzipped by hand on Linux?** Run the command once. It adds the names that - differ only by capital letters, which some ZIPs leave out. -- **A ZIP in parts, like `Pack.part1of2.zip`?** Unzip every part into the - same folder. `--check` names a part you missed. +- **Right folder?** [Get your files](../which-pack.md) names the one your setup + reads. +- **Exact name?** `scph5501.bin` and `SCPH-5501.BIN` differ. On Linux, + capitals count too. +- **A `bios` folder inside your BIOS folder?** Move its files up one level. +- **Unzipped by hand on Linux?** Run the command once. It adds names that + differ by capitals only. +- **A ZIP in parts, like `Pack.part1of2.zip`?** Unzip every part into one + folder. -## One console only +## An arcade game does not start -Add `--system` and its name: +It needs its BIOS set, like `neogeo.zip`, and a game set for the same emulator +version. - -```sh -curl -fsSL https://raw.githubusercontent.com/Abdess/retrobios/main/install.sh | sh -s -- --check --system sony-playstation --verbose -``` +- Keep `neogeo.zip` zipped. +- A game set for another MAME version often fails. + Details: [the version of each emulator](../emulators/index.md). +- Run the command once. It installs the BIOS sets your emulators read. -`--verbose` names each missing or wrong file. `--list-systems` lists the names. +## The BIOS is fine, the game still fails -## My setup says UNTESTED - -Batocera shows `UNTESTED` for a file with unexpected contents. Run the command -without `--check` to replace it. +- **Another emulator?** Each one reads its own files. Its page lists them. +- **A BIOS setting?** Some emulators can skip the BIOS. In PCSX ReARMed, set + **BIOS Selection** to **Auto**. +- **A disc game in several files?** Open its `.cue` or `.m3u` file, not a + `.bin`. ## If the command fails { #installation-script-fails } -- **Network error:** check that github.com opens, then try again. +- **Network error:** try again once github.com opens. - **Permission denied:** do what the message says. It names what to run. -- **No setup found:** pick it from the list. Or name it and its folder: +- **No setup found:** name it and its folder: ```sh @@ -76,9 +77,9 @@ curl -fsSL https://raw.githubusercontent.com/Abdess/retrobios/main/install.sh | Other messages: [When something goes wrong](installer.md#when-something-goes-wrong). - + ## Next steps -- [Your setup's page](../which-pack.md): its folder and how it checks files +- [Get your files](../which-pack.md) - [Common questions](faq.md)