Docs: JELOS output token (#805)

Co-authored-by: Julia Mono Brunenberg <[email protected]>

docs/output/tokens.md

@@ -71,11 +71,12 @@ You can use some information about the input and output file's name & location:
 
 To help sort ROMs into unique file structures for popular frontends & hardware, `igir` offers a few specific tokens:
 
-- `{pocket}` the [Analogue Pocket](../usage/hardware/analogue-pocket.md) core's directory for the ROM
-- `{mister}` the [MiSTer FPGA](../usage/hardware/mister.md) core's directory for the ROM
-- `{onion}` the [OnionOS / GarlicOS](../usage/handheld/onionos.md) emulator's directory for the ROM
 - `{batocera}` the [Batocera](../usage/desktop/batocera.md) emulator's directory for the ROM
 - `{funkeyos}` the [FunKey OS](../usage/handheld/funkeyos.md) emulator's directory for the ROM
+- `{jelos}` the [JELOS](../usage/handheld/jelos.md) emulator's directory for the ROM
+- `{mister}` the [MiSTer FPGA](../usage/hardware/mister.md) core's directory for the ROM
+- `{onion}` the [OnionOS / GarlicOS](../usage/handheld/onionos.md) emulator's directory for the ROM
+- `{pocket}` the [Analogue Pocket](../usage/hardware/analogue-pocket.md) core's directory for the ROM
 
 !!! tip
 

docs/usage/handheld/jelos.md

@@ -0,0 +1,111 @@
+# JELOS
+
+!!! info
+
+    [JELOS](https://jelos.org) is based on [RetroArch](https://www.retroarch.com/) and [EmulationStation](https://emulationstation.org/). If the instructions on this page don't lead to success on your device, you might want to try your luck with their documentation.
+
+[JELOS](https://jelos.org) (or **J**ust **E**nough **L**inux **OS**) is a slim open source operating system for many devices by Anbernic, Powkiddy, Hardkernel etc. While it supports many devices as an aftermarket operating system choice, vendors have started shipping their devices with JELOS, too. With powerful features like custom collections and online scraping, it can make good use of huge and well managed ROM collections.
+
+## Different card setups
+
+### OS card, ROM card
+
+JELOS can be installed on single SD card devices as well as devices using a secondary SD card for games. In normal operation, the external SD card will be mounted under `/roms`. Please keep that in mind and adapt accordingly when following these instructions.
+
+We will assume the single card variant here. If you use a card just for roms, please remove the `roms/` path component when writing to your SD card as follows:
+
+| Component     | single SD card (OS+ROMs) | separate SD card (ROMs only) |
+|---------------|--------------------------|------------------------------|
+| BIOS          | `<SD>/roms/bios/`        | `<SD>/bios/`                 |
+| GameBoy ROMs  | `<SD>/roms/gb`           | `<SD>/gb`                    |
+| ...           |                          |                              |
+
+The OS can also be installed on other media than SD cards. Still we will call them OS SD card and ROM SD card.
+
+### Filesystems
+
+JELOS, being a Linux distribution, runs from a Linux filesystem. most Linux filesystems can not be read from or written to natively using Windows or macOS. When using a single SD card setup, you might need to access partitions of the card using a Linux filesystem (probably `ext4`). This is easiest using the Network functions of JELOS via Wifi, another system running the Linux operating system or special software.
+
+When using a separate card for ROMs and OS, the ROMs are most likely stored in a `FAT32` filesystem which can be accessed using either Windows, macOS or Linux natively.
+
+Please note that while `FAT32` is not case sensitive in most cases, `ext4` and many other filesystems are. Keep that in mind while copying.
+
+## BIOS
+
+JELOS has its BIOS folder at `roms/bios/`, and it uses the RetroArch filenames. Most of the BIOS files should be found using the following guides. Check the many sections under the `Systems` menu in the [JELOS Wiki](https://jelos.org/) for more precise instructions when you run into trouble.
+
+=== ":simple-windowsxp: Windows"
+
+    Replace the `E:\` drive letter with wherever your SD card is:
+
+    ```batch
+    igir copy extract test clean ^
+      --dat "https://raw.githubusercontent.com/libretro/libretro-database/master/dat/System.dat" ^
+      --input BIOS\ ^
+      --output E:\roms\bios
+    ```
+
+=== ":simple-apple: macOS"
+
+    Replace the `/Volumes/JELOS` drive name with whatever your SD card is named:
+
+    ```shell
+    igir copy extract test clean \
+      --dat "https://raw.githubusercontent.com/libretro/libretro-database/master/dat/System.dat" \
+      --input BIOS/ \
+      --output /Volumes/JELOS/roms/bios
+    ```
+
+=== ":simple-linux: Linux"
+
+    Replace the `/media/JELOS` path with wherever your SD card is mounted:
+
+    ```shell
+    igir copy extract test clean \
+      --dat "https://raw.githubusercontent.com/libretro/libretro-database/master/dat/System.dat" \
+      --input BIOS/ \
+      --output /media/JELOS/roms/bios
+    ```
+
+## ROMs
+
+JELOS supports many many systems and ROM formats. Check sections under the `Systems` menu in the [JELOS Wiki](https://jelos.org/) for more precise instructions about the indivudual systems. Most supported systems and their ROMS can be automatically sorted by `igir` using the `{jelos}` output token. See the [replaceable tokens page](../../output/tokens.md) for more information.
+
+=== ":simple-windowsxp: Windows"
+
+    Replace the `E:\` drive letter with wherever your SD card is:
+
+    ```batch
+    igir copy extract test clean ^
+      --dat "No-Intro*.zip" ^
+      --input ROMs\ ^
+      --output "E:\roms\{jelos}" ^
+      --dir-letter ^
+      --no-bios
+    ```
+
+=== ":simple-apple: macOS"
+
+    Replace the `/Volumes/JELOS` drive name with whatever your SD card is named:
+
+    ```shell
+    igir copy extract test clean \
+      --dat "No-Intro*.zip" \
+      --input ROMs/ \
+      --output "/Volumes/JELOS/roms/{jelos}" \
+      --dir-letter \
+      --no-bios
+    ```
+
+=== ":simple-linux: Linux"
+
+    Replace the `/media/JELOS` path with wherever your SD card is mounted:
+
+    ```shell
+    igir copy extract test clean \
+      --dat "No-Intro*.zip" \
+      --input ROMs/ \
+      --output "/media/JELOS/roms/{jelos}" \
+      --dir-letter \
+      --no-bios
+    ```

mkdocs.yml

@@ -53,6 +53,8 @@ nav:
             - usage/desktop/batocera.md
             - usage/desktop/emuelec.md
             - usage/desktop/emulationstation.md
+            - usage/handheld/funkeyos.md
+            - usage/handheld/jelos.md
             - usage/desktop/lakka.md
             - usage/desktop/launchbox.md
             - usage/handheld/onionos.md