# What each platform page and pack README tell someone holding the device:
# the folder, where the command runs, what to know. Read by
# scripts/siteguides.py, which checks it on load: every platform in
# _registry.yml has a guide here, and every guide a registered platform.
#
# Values are Markdown. A folder row with no `path` is the registry's
# `extract_to` for that platform, the one place that folder is written.
# `run` names the terminals below, in the order the page shows them.
# `pack_manual` is the manual part of the README inside the pack, plain text.
# `{folders}` in it is the folder list of the page.
# `runs_on` names the hardware in the project's own words, cited beside it.
# `terminal` is how this system opens a terminal, from its own documentation.
# `card_run` names the computers that open the device's card, when not all do.
# `lead` comes before the folder table, `finish` closes the guide.
# `logo_owner` and `logo_licence` credit the logo the registry links: it is
# shown only to name the platform, with the licence of the repository the
# file was taken from when that repository states one.
#
# The registry keeps what tools read (device_group, extract_to, install);
# this file keeps what people read.

# The site serving the one-line bootstraps (scripts/sitebootstrap.py).
install_base: https://abdess.github.io/retrobios

# Is it safe: shown on the home page and under every command on a guide page.
# Where it writes follows install.py: the BIOS folder, the frontend's save
# folder for the entries a manifest files under `root: save`
# (place_save_entries), and retrobios-backup beside the folder written to.
trust_items:
- It checks each file before saving it.
- 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 save file.
- >-
  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.
# `anchor` is the section id on the device picker: two keep the ids the page
# had before it was grouped by device, which links outside the site may use.
# `also_runs` are setups that are not platforms of their own: they run one,
# and use its pack.
device_groups:
  computer:
    label: Computers (Windows, Mac, Linux) and Steam Deck
    description: An emulator app on a computer or a Steam Deck.
    anchor: computers-and-steam-deck
    also_runs:
    - setup: LaunchBox
      summary: >-
        A game library and launcher. It starts RetroArch or standalone emulators.
      uses: retroarch
      runs_on: Windows
      folder: The folder of the RetroArch it starts
  gaming-os:
    label: Raspberry Pi and mini PCs
    description: A system that starts straight into a game menu.
    anchor: game-systems
  handheld:
    label: Handhelds and TV boxes (Anbernic, Retroid, Miyoo)
    description: The system a handheld or TV box starts.
    anchor: handhelds
    also_runs:
    - setup: Android (Retroid Pocket, AYN Odin and others)
      summary: RetroArch for Android.
      uses: retroarch
      runs_on: Android
      folder: '`RetroArch/system/` on the internal storage'
    # Kinds of handheld that run a setup of their own: a tile each beside the
    # setups of the group, leading to where their folder is written.
    tiles:
    - name: Android
      # goretroid.com/products/retroid-pocket-5-handheld: "OS: Android 13".
      # ayntec.com/products/ayn-odin-3: "Android 15".
      text: Retroid, AYN Odin and other Android handhelds
      link: platforms/retroarch.md#where-the-files-go
      logo: https://raw.githubusercontent.com/simple-icons/simple-icons/7185d367013b99211c2728d5007833a922ec12c7/icons/android.svg
      logo_owner: Google
      logo_licence: Android robot, file from simple-icons, CC0-1.0
    - name: Linux handhelds
      text: ArkOS, muOS, Onion, spruceOS
      link: platforms/linux-handhelds.md
      logo: https://raw.githubusercontent.com/simple-icons/simple-icons/521c96fd04b0ea93034db8715eda5a4de27a58bb/icons/linux.svg
      logo_owner: Larry Ewing
      logo_licence: Tux, file from simple-icons, CC0-1.0
    # No terminal runs there: the files are copied in, each app its own way
    # (which-pack.md, section iPhone and iPad, each step cited).
    - name: iPhone and iPad
      text: RetroArch, Delta, Provenance
      link: which-pack.md#iphone-and-ipad
      # A phone and a tablet, no brand: Apple's guidelines allow no use of its logo.
      logo: https://raw.githubusercontent.com/lucide-icons/lucide/a1b2ce5b7b6a09da2f2f61f682b299f69effb057/icons/tablet-smartphone.svg
      logo_owner: Lucide
      logo_licence: icon from lucide-icons, ISC
  fpga:
    label: MiSTer FPGA
    description: >-
      A board that recreates old consoles in hardware, not in software.
    anchor: fpga
  server:
    label: Self-hosted game library
    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
# the shell the command is written for.
terminals:
  windows:
    label: Windows
    how: >-
      Open Start. Type **PowerShell**, press Enter. Click Copy. Right-click to paste. Press
      Enter.
    shell: powershell
  macos:
    label: macOS
    how: >-
      Press Cmd+Space. Type **Terminal**, press Return. Click Copy. Press Cmd+V. Press
      Return.
    shell: sh
  linux:
    label: Linux
    how: >-
      Open a terminal, often with Ctrl+Alt+T. Click Copy. Press Ctrl+Shift+V. Press Enter.
    shell: sh
  steamdeck:
    label: Steam Deck
    how: >-
      Hold power, pick **Switch to Desktop**. Open **Konsole**. Click Copy. Press
      Ctrl+Shift+V. Press Enter.
    shell: sh
  android:
    label: Android (Termux)
    how: >-
      Install **Termux**, a terminal app. Paste the line. Press Enter. Accept the Python
      install and allow the storage access Android asks for.
    shell: sh
  device:
    label: On the device
    how: >-
      Open a terminal on the device. Or connect from a computer with SSH, a terminal over
      the network. Paste the line. Press Enter.
    shell: sh
  server:
    label: On the server
    how: >-
      Open a terminal on the machine that holds the RomM library. Put the path of its
      `bios` folder after `--dest`.
    shell: sh

# The guide for the handheld systems that run RetroArch, one row for each
# system the installer detects it on (_registry.yml, retroarch install.detect).
# A folder is the one seen on the card from a computer, and a device list the
# one the system's own site, wiki or README gives. Each is written only with
# the first-party page that states it (`*_source`), and left out when no such
# page states it: the row then says where RetroArch shows the folder.
# `linux_only` marks a folder on a part of the card only Linux reads.
handheld_guide:
  page: linux-handhelds
  title: Linux handhelds
  uses: retroarch
  summary: >-
    ArkOS, muOS, Onion, spruceOS and the other systems below run **RetroArch**, an app
    with a small emulator for each console. They use its BIOS files.
  systems:
  - name: ArkOS
    folder: '`bios` on the **EASYROMS** part of the card'
    folder_source: https://github.com/christianhaitian/arkos/wiki/ArkOS-Emulators-and-Ports-information
    devices: [RG353M, RG353V, RG503, RGB30, RK2023, RG351MP, RG351V, R35S, RGB10]
    devices_source: https://github.com/christianhaitian/arkos/wiki
  - name: muOS
    folder: '`MUOS/bios` on the card'
    folder_source: https://github.com/MustardOS/internal/blob/main/share/web/tools/bios-checker.html
    devices: [RG35XX H, RG35XX Plus, RG35XX SP, RG35XX 2024, RG34XX, RG40XX H, RG40XX V,
              RG28XX, RG CubeXX, TrimUI Brick, TrimUI Smart Pro]
    devices_source: https://muos.dev/devices
  - name: Onion
    folder: '`BIOS` at the root of the card'
    folder_source: https://onionui.github.io/docs/emulators
    devices: [Miyoo Mini, Miyoo Mini Plus]
    devices_source: https://github.com/OnionUI/Onion
  - name: spruceOS
    folder: '`BIOS` at the root of the card'
    folder_source: https://github.com/spruceUI/spruceOS/wiki/10.-Adding-BIOS
    devices: [Miyoo A30, Miyoo Flip, Miyoo Mini, Miyoo Mini Plus, Miyoo Mini Flip,
              TrimUI Smart Pro, TrimUI Brick, RG35XX Plus, RG40XX H, RGB30]
    devices_source: https://github.com/spruceUI/spruceOS/wiki/Supported-Devices
  - name: Allium
    folder: '`BIOS` at the root of the card'
    folder_source: https://github.com/goweiwen/Allium/tree/ee0dda979bc02649fdda48b277eaa60938273465/static/BIOS
    devices: [Miyoo Mini, Miyoo Mini Plus, Miyoo Mini Flip]
    devices_source: https://github.com/goweiwen/Allium
  - name: Anbernic stock firmware
    devices: [RG35XX Plus, RG35XX H, RG35XX SP, RG28XX]
    devices_source: https://github.com/GarlicOS/bootloader_anbernic_rg35xxplus/blob/45b489b41dc3dd1738b14486cda0f2dce66e714f/README.md
  - name: ArchR
    folder: '`/storage/roms/bios`, on a part only Linux can open'
    folder_source: https://arch-r.io/docs/roms/
    linux_only: true
    devices: [R36S, R33S, R36S Soysauce, Odroid Go Advance, Odroid Go Super, RG351V,
              RG351M, GameForce Chi, MagicX XU10, RGB10, RGB10X, K36]
    devices_source: https://github.com/archr-linux/Arch-R
  - name: CrossMix-OS
    folder: '`BIOS` at the root of the card'
    folder_source: https://github.com/cizia64/CrossMix-OS/wiki/Emulators
    devices: [TrimUI Smart Pro]
    devices_source: https://github.com/cizia64/CrossMix-OS
  - name: dArkOS
    folder: '`bios` on the **EASYROMS** part of the card'
    folder_source: https://github.com/christianhaitian/dArkOS/wiki/dArkOS-Emulators-and-Ports-information
    devices: [Odroid Go Advance, RGB10, RG351MP, G350]
    devices_source: https://github.com/christianhaitian/dArkOS/wiki
  - name: JELOS
    folder: '`roms/bios` on the games card'
    folder_source: https://github.com/JustEnoughLinuxOS/distribution/blob/7b2e116ce6996d56e642a0e2a07288c926db926b/packages/emulators/standalone/retroarch/sources/RK3566/retroarch.cfg#L716
    devices: [RG351M, RG351V, RG353M, RG353P, RG353V, RG353VS, RG503, RG552, R33S, R36S,
              GameForce Ace, GameForce Chi, Odroid Go Advance, Odroid Go Super, Odroid Go Ultra,
              MagicX XU10, RGB10, RGB10 Max 3, RGB10 Max 3 Pro, RGB20S, RGB30, RK2023, X55,
              AYANEO Air, AYANEO Air Plus, AYANEO Air Pro, AYANEO 2, AYANEO 2S, AYANEO 2021,
              AYANEO Geek, AYANEO Next, AYN Loki Max, AYN Loki Mini Pro, AYN Loki Zero]
    devices_source: https://github.com/JustEnoughLinuxOS/distribution/tree/7b2e116ce6996d56e642a0e2a07288c926db926b/packages/hardware/quirks/devices
  - name: KOLOS
    folder: '`roms/bios` on the games card'
    folder_source: https://github.com/AnonLinuxOS/KOLOS/blob/7daf5950ae79bb8775f129468164f730dbc32298/packages/emulators/standalone/retroarch/sources/RK3566/retroarch.cfg#L716
    devices: [RG353P, RG353M, RG353V, RG353VS, RG503, RK2023, RGB30, RGB10 Max 3]
    devices_source: https://github.com/AnonLinuxOS/KOLOS
  - name: Koriki
    folder: '`BIOS` at the root of the card'
    folder_source: https://github.com/Rparadise-Team/Koriki/wiki/En:-02.-Content-installation
    devices: [Miyoo Mini]
    devices_source: https://github.com/Rparadise-Team/Koriki
  - name: MiyooCFW
    folder: '`.retroarch/system`, hidden, on the **MAIN** part, which only Linux can open'
    folder_source: https://github.com/MiyooCFW/buildroot/blob/d5912eeb7b636810bafaa34eb0517fd599a0fc71/board/miyoo/rootfs/etc/main#L164-L170
    linux_only: true
    devices: [BittBoy, Pocket Go, PowKiddy Q90, PowKiddy V90, PowKiddy Q20 Mini, Sup M3, XYC Q8]
    devices_source: https://github.com/MiyooCFW/docs/blob/main/docs/index.md
  - name: plumOS
    folder: '`bios` on the **PLUMOS** part of the card'
    folder_source: https://github.com/game-de-it/plumOS-XU20V32/blob/main/docs/developer/storage-and-updates.md
    devices: [MagicX XU20 V32]
    devices_source: https://github.com/game-de-it/plumOS-XU20V32
  # RetroOZ publishes no build source. Its wiki keeps games under /roms and
  # sends BIOS questions to the ArkOS wiki, whose folder is bios in roms. The
  # 0.60 image sets system_directory "/roms/bios" (retroarch32/retroarch.cfg:3046).
  # Written as the device path: no RetroOZ page names the card's parts.
  - name: RetroOZ
    folder: '`/roms/bios`, as the device names it'
    folder_source: https://github.com/southoz/RetroOZ/wiki/Home/4ce4fafb78d647d422e9e468d5bd9cbc63dbe3ea
    devices: [Odroid Go Super, Odroid Go Advance, RGB10 Max, RGB10 Max 2]
    devices_source: https://github.com/southoz/RetroOZ/wiki
  - name: UnofficialOS
    folder: '`roms/bios` on the games card'
    folder_source: https://github.com/RetroGFX/UnofficialOS/wiki/Emulators-and-Game-Engines
    devices: [R35S, R36S, RG351M, RG351P, RG351V, RG353M, RG353P, RG353V, RG503, RG552,
              RGB30, RGB20 Pro, Odroid Go Advance, Odroid Go Super]
    devices_source: https://github.com/RetroGFX/UnofficialOS/wiki

guides:
  retroarch:
    summary: >-
      An app that runs many consoles. It uses a different **core**, a small emulator,
      for each one.
    folders:
    - where: Windows
      path: '`system\` next to `retroarch.exe`'
    - where: macOS
      path: '`~/Documents/RetroArch/system/`'
    - where: Linux
      path: '`~/.config/retroarch/system/`'
    - where: Steam Deck and Linux Flatpak
      path: '`~/.var/app/org.libretro.RetroArch/config/retroarch/system/`'
    - where: Android
      path: '`RetroArch/system/` on the internal storage'
    - where: Nintendo Switch
      path: '`retroarch/cores/system/` on the SD card'
    more_folders:
    - where: Windows, Microsoft Store build
      path: '`%LOCALAPPDATA%\Packages\1e4cf179-f3c2-404f-b9f3-cb2070a5aad8_*\LocalState\system\`'
    - where: macOS, Steam or portable build
      path: '`~/Library/Application Support/RetroArch/system/`'
    more_folders_title: 'Other builds: Microsoft Store, Mac Steam, handhelds'
    # Adds a row for each named system the registry detects this platform on.
    more_folders_detected: true
    more_folders_note: LaunchBox and other launchers use the folder RetroArch reads.
    run: [windows, macos, linux, steamdeck, android]
    lead: >-
      **Not sure?** In RetroArch, open **Settings > Directory > System/BIOS**. It shows
      the folder.
    reference_notes:
    - >-
      RetroArch reads its BIOS folder from the `system_directory` line of `retroarch.cfg`,
      the value **Settings > Directory > System/BIOS** shows.
    - >-
      On Windows, `retroarch.cfg` is read next to `retroarch.exe` first, then from `%APPDATA%\RetroArch\`.
      A `system_directory` left at its default is the `system` folder next to `retroarch.exe`
      (`:\system` in RetroArch's `frontend/drivers/platform_win32.c`, where `:` stands
      for the folder of the program).
    pack_manual: |
      Option B: Manual (PC)
      ---------------------
      1. Find the RetroArch system directory:
         - RetroArch > Settings > Directory > System/BIOS
         - Default: retroarch/system/
      2. Extract all files from this archive directly into the system directory
      3. Overwrite if asked

      Option C: Manual (handheld / SD card)
      -------------------------------------
      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 the SD card and reboot the device

      Folders by device:
        {folders}
    logo_owner: libretro
    logo_licence: repository licence GPL-3.0
  batocera:
    summary: A system that starts straight into a game menu, on a PC, a Raspberry Pi or a handheld.
    # batocera.org/download: x86-64 desktop PC and laptop, Raspberry, Steam Deck OLED,
    # Anbernic and AYN handhelds.
    runs_on: PCs, Raspberry Pi, Steam Deck, handhelds
    # wiki.batocera.org/access_the_batocera_via_ssh: root@batocera.local, password
    # linux, SSH on by default. wiki.batocera.org (file manager): xterm in the
    # Applications menu of the F1 file manager, Xorg builds (x86_64) only.
    terminal: >-
      On a PC, press **F1** on the system list, then open **xterm** in the Applications
      menu. From a computer, open a terminal over the network with `ssh
      root@batocera.local`, password `linux`. Paste the line. Press Enter.
    folders:
    - where: On Batocera
    - where: From Windows, over the home network
      path: '`\\BATOCERA\share\bios\`'
    - 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.
    pack_manual: |
      The terminal is xterm, in the Applications menu of the F1 file
      manager (PC only), or SSH: ssh root@batocera.local, password linux.

      Option B: Manual (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
      3. Overwrite if asked

      Option C: Manual (SD card)
      --------------------------
      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 the setup asks for dc_flash.bin, same file).
    logo_owner: Batocera
    logo_licence: repository licence MIT
  recalbox:
    summary: A system that starts straight into a game menu, on a board, a PC or a handheld.
    # recalbox.com: "TV, PC or handheld?", 13 supported boards and consoles.
    runs_on: Boards, PCs, handhelds
    # wiki.recalbox.com/en/tutorials/system/access/root-access-terminal-cli: Alt+F2 with
    # 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 set when flashing. Paste the line.
      Press Enter.
    folders:
    - where: On Recalbox
    - where: From Windows, over the home network
      path: '`\\RECALBOX\share\bios\`'
    run: [device]
    download_hint: From a computer, use the network folder below.
    pack_manual: |
      Option B: Manual (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 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
    logo_owner: Recalbox
    logo_licence: file from homarr-labs/dashboard-icons, Apache-2.0
  retrobat:
    summary: >-
      A game menu for Windows. It comes with RetroArch and other emulators.
    folders:
    - where: Inside the RetroBat folder
      path: '`bios\`'
    - where: Default install
      path: '`C:\RetroBat\bios\`'
    run: [windows]
    notes:
    - The command finds RetroBat wherever it is installed.
    reference_notes:
    - >-
      RetroBat records its own folder each time it starts, and the installer reads it
      there.
    pack_manual: |
      Option B: Manual
      ----------------
      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 the bios\ folder
      4. Overwrite if asked
    logo_owner: RetroBat
    logo_licence: repository states no licence
  emudeck:
    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)
    # and functions/jsonToBashVars.sh:128-132 (biosPath "$globPath/Emulation/bios"),
    # dragoonDorise/EmuDeck dddb3022.
    - where: Steam Deck, installed on the SD card
      path: '`Emulation/bios/` on the card, under `/run/media/`'
    - where: Windows, by default
      path: '`C:\Emulation\bios\`'
    - where: macOS
    run: [steamdeck, linux, windows, macos]
    notes:
    - >-
      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: >-
      EmuDeck's **Bios files checker** shows the files too. Return to Gaming Mode and start
      a game.
    reference_notes:
    - >-
      The installer reads the Emulation folder from EmuDeck's settings (`emulationPath`
      in `~/.config/EmuDeck/settings.sh`).
    pack_manual: |
      Option B: Manual
      ----------------
      Extract all files from this archive directly into EmuDeck's bios
      folder, inside the Emulation folder chosen in EmuDeck:
        Steam Deck, Linux and macOS: ~/Emulation/bios/ by default
        Windows: C:\Emulation\bios\ by default
    logo_owner: EmuDeck
    logo_licence: repository licence GPL-3.0
  lakka:
    summary: A system that starts straight into RetroArch, on a Raspberry Pi or a small PC.
    # lakka.tv: "transforms a small computer", "a Raspberry Pi".
    runs_on: Raspberry Pi, small computers
    folders:
    - where: On Lakka
    # lakka.tv/doc/Accessing-Lakka-filesystem: Samba in Settings > Services, share System.
    - where: From Windows, over the home network
      path: '`\\LAKKA\System\`'
    run: [device]
    notes:
    - >-
      For the network folder, turn on **Samba** in Lakka's **Settings > Services**.
    # lakka.tv/doc/Accessing-Lakka-command-line-interface: SSH in Settings > Services,
    # user root, password root.
    terminal: >-
      Turn on **SSH**, a terminal over the network, in Lakka's **Settings > Services**. From
      a computer, connect with `ssh root@lakka`, password `root`. Paste the line. Press
      Enter.
    # /storage is the card's ext4 partition, the other one FAT32 (Lakka-LibreELEC
    # 4696b48f, scripts/mkimage:71-72 and 95): from a computer, only Linux opens it.
    card_run: [linux]
    reference_notes:
    - The folder is reachable over SSH and over the network share.
    pack_manual: |
      Lakka reads its BIOS files from /storage/system/.

      Option B: Via network share
      --------------------------
      1. On Lakka: Settings > Services > Samba Enable
      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
      -----------------
      1. On Lakka: Settings > Services > SSH Enable
      2. Copy the files to /storage/system/ (scp -r * root@lakka:/storage/system/)
    logo_owner: Lakka (libretro)
    logo_licence: file from libretro/retroarch-assets, CC-BY-4.0
  retrodeck:
    summary: >-
      One app with its emulators inside. Install it from Flathub or Discover.
    folders:
    - where: Steam Deck and Linux
      path: '`~/retrodeck/bios/`'
    - where: Installed on a microSD card
      path: 'for example `/run/media/mmcblk0p1/retrodeck/bios/`'
    run: [steamdeck, linux]
    pack_manual: |
      Option B: Manual
      ----------------
      1. Open Dolphin file manager
      2. Show hidden files (Ctrl+H)
      3. Navigate to ~/retrodeck/
      4. Extract all files from this archive directly into ~/retrodeck/
         (the archive already holds the bios/ and roms/ folders)

      NOTE: RetroDECK uses its own BIOS checker. After
      copying, open RetroDECK > Tools > BIOS Checker to
      verify everything is detected.
    logo_owner: RetroDECK
    logo_licence: repository licence GPL-3.0
  romm:
    summary: >-
      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'
    more_folders:
    - where: 'With `firmware: "{platform}/bios"` in `config.yml`'
      path: '`<platform>/bios/` for each platform'
    run: [server]
    notes:
    - '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
    # laid out as {platform}/roms (rommapp/romm 68f71259,
    # backend/config/config_manager.py:58,101-109,1105-1124).
    pack_manual: |
      Option B: Manual
      ----------------
      The archive holds one folder per RomM platform (psx/, gba/, ...).
      Where they go depends on filesystem.structure.firmware in RomM's
      config.yml, read relative to the library folder:

      - Not set, or "bios/{platform}" (the default): extract all files
        from this archive directly into library/bios/
      - "{platform}/bios" (the layout RomM suggests for a library kept as
        {platform}/roms): each folder goes under its platform, psx/ into
        library/psx/bios/, gba/ into library/gba/bios/, and so on.
        The installer reads config.yml and does this itself. Run from
        the host of a container, --romm-firmware "{platform}/bios" says it.

      Then restart the RomM service to detect new files.
    logo_owner: RomM
    logo_licence: GitHub organisation avatar of rommapp
  rocknix:
    summary: A system for handhelds.
    # rocknix.org: "an immutable Linux distribution for handheld gaming devices".
    runs_on: Handhelds
    folders:
    - where: On ROCKNIX
    run: [device]
    notes:
    - >-
      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: >-
      Turn on **SSH**, a terminal over the network, in **Network Settings**. From a
      computer, connect as `root`, with the password shown in **System Settings >
      Security**. Paste the line. Press Enter.
    reference_notes:
    - >-
      ROCKNIX runs on ARM and x86 handhelds, among them the RG35XX (H700) and the RG552
      (RK3399). The folder is reachable over SSH and over the network share.
    logo_owner: ROCKNIX
    logo_licence: GitHub organisation avatar of ROCKNIX
  amberelec:
    summary: A system for Anbernic handhelds.
    # amberelec.org: "optimized for the RG351P/M/V/MP and RG552".
    runs_on: Anbernic RG351 and RG552
    folders:
    - where: On AmberELEC
    # 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 the home network
      path: '`\\AmberELEC\roms\`'
    run: [device]
    # amberelec.org/guides/getting-to-know-amberelec.html: host AmberELEC, root, amberelec.
    terminal: >-
      From a computer, open a terminal over the network with `ssh root@AmberELEC`, password
      `amberelec`. Paste the line. Press Enter.
    reference_notes:
    - >-
      AmberELEC runs on the RG351P, RG351V, RG351MP, RG353, RG503 and RG552. Its list
      names files under `/storage/roms`: `bios/` for most, `neogeo/` for the rest. The
      command fills those folders.
    logo_owner: AmberELEC
    logo_licence: GitHub organisation avatar of AmberELEC
  emuelec:
    summary: A system for TV boxes and some handhelds.
    # EmuELEC wiki Supported-Devices.md: Amlogic boxes, Odroid-GO Advance and Super,
    # GameForce Chi.
    runs_on: TV boxes, Odroid Go handhelds
    folders:
    - 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 the home network
      path: '`\\EMUELEC\roms\`'
    run: [device]
    # EmuELEC wiki How-to-SSH-into-EmuELEC.md:38-44: root, password emuelec.
    terminal: >-
      From a computer, open a terminal over the network with `ssh root@emuelec`, password
      `emuelec`. Paste the line. Press Enter.
    reference_notes:
    - >-
      EmuELEC runs on Amlogic TV boxes, the Odroid Go Advance, GameForce and RK356x devices.
      Its list names files under `/storage/roms`: `bios/` for most, `neogeo/` and `ports/`
      for the rest. The command fills those folders.
    logo_owner: EmuELEC
    logo_licence: GitHub organisation avatar of EmuELEC
  knulli:
    summary: A system for handhelds and bartops, based on Batocera.
    # knulli.org: "retro gaming devices (handhelds, bartops, etc.)".
    runs_on: Handhelds, bartops
    folders:
    - 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 the home network
      path: '`\\KNULLI\share\bios\`'
    run: [device]
    notes:
    - >-
      For the network folder, turn on **SAMBA** in **System Settings > Services**
      ([KNULLI docs](https://github.com/knulli-cfw/knulli.org/blob/314b26f1822c8531bed8a9cea72028b229b4436e/docs/play/add-games/network-transfer.md?plain=1#L20-L24)).
    # knulli.org/configure/ssh: SSH in System Settings > Services, root, password linux.
    terminal: >-
      Turn on **SSH**, a terminal over the network, in **System Settings > Services**. From
      a computer, connect with `ssh root@KNULLI`, password `linux`. Paste the line. Press
      Enter.
    reference_notes:
    - >-
      KNULLI runs on handhelds among them the RG35XX family (H700) and the TrimUI Smart
      Pro.
    logo_owner: KNULLI
    logo_licence: GitHub organisation avatar of knulli-cfw
  retropie:
    summary: Installs RetroArch and other emulators on a Raspberry Pi or a PC.
    # RetroPie docs index.md (175f5b15): Raspberry Pi, PC and Odroid.
    runs_on: Raspberry Pi, PC, Odroid
    folders:
    - 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 the home network
      path: '`\\RETROPIE\bios\`'
    run: [device]
    # RetroPie docs/FAQ.md:193 (F4 in EmulationStation, its game menu), 175f5b15. The computer route
    # is the network folder above.
    terminal: >-
      Press **F4** in the game menu for a terminal. Paste the line. Press Enter.
    # The BIOS folder is on the card's Linux partition (pack_manual below):
    # from a computer, only Linux opens it.
    card_run: [linux]
    notes:
    - >-
      Install with `--platform retropie`, not RetroArch's files. The command does not run on
      RetroPie 4.8: run it on a computer there, with the network folder above after `--dest`.
    reference_notes:
    - >-
      RetroPie also installs standalone emulators (openMSX, PCSX2, XRoar, Amiberry and
      others) whose files only the RetroPie file list carries.
    pack_manual: |
      Option B: Via network share
      --------------------------
      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 the Pi: ssh pi@retropie
      2. Copy files to ~/RetroPie/BIOS/

      NOTE: the BIOS folder is on the card's Linux partition,
      which Windows and macOS cannot open: copying through the
      card works from a Linux computer only
      (<rootfs>/home/pi/RetroPie/BIOS/).
    logo_owner: RetroPie
    logo_licence: GitHub organisation avatar of RetroPie
  bizhawk:
    summary: An emulator app for many consoles, from TASVideos.
    folders:
    - where: Inside the BizHawk folder
      path: '`Firmware\`'
    - where: Default place the installer looks
      path: '`%USERPROFILE%\BizHawk\Firmware\`'
    run: [windows, linux]
    reference_notes:
    - BizHawk carries rerecording and debugging tools.
    pack_manual: |
      Option B: Manual
      ----------------
      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 the Firmware folder
      4. In BizHawk: Config > Paths > Firmware should
         point to this folder
    logo_owner: TASVideos
    logo_licence: GitHub organisation avatar of TASEmulators
  misterfpga:
    summary: >-
      A board that recreates old consoles in hardware, not in software.
    # mister-devel.github.io/MkDocs_MiSTer: "an FPGA board called the DE10-Nano".
    runs_on: Its own board
    folders:
    - where: On the MiSTer SD card
      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 the home network
      path: '`\\MiSTer\sdcard\games\`'
    run: [device]
    # mister-devel.github.io/MkDocs_MiSTer/advanced/network: F9 for a Linux terminal,
    # SSH user root, password 1.
    terminal: >-
      Press **F9** in the MiSTer menu and log in as `root`, password `1`. Or from a
      computer, open a terminal over the network as `root`. Paste the line. Press Enter.
    notes:
    - >-
      Each file goes in its console's folder, like `/media/fat/games/3DO/boot.rom`.
    - >-
      For the network folder, run **samba_on** from the MiSTer Scripts menu.
    reference_notes:
    - >-
      MiSTer runs FPGA cores on a DE10-Nano board. Only the files the MiSTer BIOS database
      lists with a download address are in the pack. The others come with the MiSTer distribution
      and install themselves.
    logo_owner: MiSTer FPGA
    logo_licence: GitHub organisation avatar of MiSTer-devel
  minui:
    summary: A simple game menu for Anbernic, Miyoo and Trimui handhelds, on the SD card.
    # shauninman/MinUI README (dbf89435) lines 3, 65-91.
    runs_on: Anbernic, Miyoo, Trimui handhelds
    folders:
    - where: On the SD card
      path: '`Bios/<TAG>/`, one folder per console'
    run: [macos, linux, windows]
    notes:
    - >-
      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.
    on_card: true
    reference_notes:
    - >-
      MinUI gives each console its own folder, named after the tag in parentheses of the
      Roms folder the game sits in. A game in `Roms/Game Boy (GB)/` runs with `Bios/GB/`
      as its BIOS folder (MinUI `workspace/all/minarch/minarch.c:2943`).
    - >-
      Without `--platform`, the installer reads the release name MinUI writes in `.system/version.txt`
      on the card. A console started by a standalone program instead of a libretro core
      (DraStic for NDS, native PICO-8) is not covered.
    logo_owner: Shaun Inman
    logo_licence: MinUI boot logo, repository states no licence
  nextui:
    summary: A game menu for TrimUI handhelds, based on MinUI, on the SD card.
    # LoveRetro/NextUI README (5291344b) lines 37, 89-94.
    runs_on: TrimUI Brick, Smart Pro
    folders:
    - where: On the SD card
      path: '`Bios/<TAG>/`, one folder per console'
    run: [macos, linux, windows]
    notes:
    - >-
      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.
    on_card: true
    reference_notes:
    - >-
      NextUI gives each console its own folder, named after the tag in parentheses of
      the Roms folder the game sits in (NextUI `workspace/all/minarch/ma_core.c:76`).
    logo_owner: LoveRetro
    logo_licence: GitHub organisation avatar of LoveRetro
  myminui:
    summary: A game menu for Anbernic and Miyoo handhelds, based on MinUI, on the SD card.
    # Turro75/MyMinUI README (72ed4f3d) lines 9-35.
    runs_on: Anbernic, Miyoo handhelds
    logo_owner: Turro75
    logo_licence: MyMinUI boot screen, repository states no licence
    folders:
    - where: On the SD card
      path: '`Bios/<TAG>/`, one folder per console'
    run: [macos, linux, windows]
    notes:
    - >-
      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.
    on_card: true
    reference_notes:
    - >-
      MyMinUI gives each console its own folder, named after the tag in parentheses of
      the Roms folder the game sits in (MyMinUI `workspace/all/minarch/minarch.c:3532`).