From aff53e4aff9d3483f7f4fe7559ca076fe89cd02a Mon Sep 17 00:00:00 2001 From: Christian Emmer <10749361+emmercm@users.noreply.github.com> Date: Mon, 2 Sep 2024 15:05:36 -0700 Subject: [PATCH] Docs: update (#1336) --- docs/advanced/temp-dir.md | 6 +++--- docs/alternatives.md | 8 ++++++-- docs/dats/dir2dat.md | 4 ++-- docs/dats/fixdats.md | 4 ++-- docs/dats/processing.md | 4 ++-- docs/input/reading-archives.md | 6 +++++- docs/installation.md | 5 +++-- docs/output/cleaning.md | 8 ++++---- docs/output/path-options.md | 28 +++++++++++++------------- docs/output/reporting.md | 8 ++++---- docs/output/tokens.md | 4 ++-- docs/output/writing-archives.md | 12 +++++------ docs/usage/arcade.md | 24 +++++++++++----------- docs/usage/basic.md | 20 +++++++++--------- docs/usage/console/gamecube.md | 4 ++-- docs/usage/console/ps2.md | 4 ++-- docs/usage/desktop/retroarch.md | 12 +++++------ docs/usage/desktop/retropie.md | 4 ++-- docs/usage/desktop/romm.md | 4 ++-- docs/usage/handheld/adam.md | 8 ++++---- docs/usage/handheld/funkeyos.md | 4 ++-- docs/usage/handheld/jelos.md | 8 ++++---- docs/usage/handheld/minui.md | 4 ++-- docs/usage/handheld/miyoocfw.md | 4 ++-- docs/usage/handheld/onionos.md | 8 ++++---- docs/usage/handheld/twmenu.md | 4 ++-- docs/usage/hardware/analogue-pocket.md | 4 ++-- docs/usage/hardware/everdrive.md | 8 ++++---- docs/usage/hardware/ezflash.md | 4 ++-- docs/usage/hardware/mister.md | 4 ++-- 30 files changed, 119 insertions(+), 110 deletions(-) diff --git a/docs/advanced/temp-dir.md b/docs/advanced/temp-dir.md index 511c99934..0b60eee4c 100644 --- a/docs/advanced/temp-dir.md +++ b/docs/advanced/temp-dir.md @@ -15,14 +15,14 @@ Igir will use your operating system's temporary directory for these files by def ## RAM disks -### :simple-windowsxp: Windows +### :fontawesome-brands-windows: Windows There are no tools built-in to Windows that can create a RAM disk. The open source [ImDisk Toolkit](https://sourceforge.net/projects/imdisk-toolkit/) is a popular option. -### :simple-apple: macOS +### :fontawesome-brands-apple: macOS The built-in `diskutil` and `hdiutil` tools can be used to create and mount a RAM disk. Alex T has some instructions in a [GitHub gist](https://gist.github.com/htr3n/344f06ba2bb20b1056d7d5570fe7f596). -### :simple-linux: Linux +### :fontawesome-brands-linux: Linux `tmpfs` is a tool that comes with most Linux distributions that is used for creating RAM disks. Oracle has [a guide](https://docs.oracle.com/cd/E18752_01/html/817-5093/fscreate-99040.html) on the tool. diff --git a/docs/alternatives.md b/docs/alternatives.md index 747696fcd..9ce1d48b9 100644 --- a/docs/alternatives.md +++ b/docs/alternatives.md @@ -30,9 +30,9 @@ There are a few different popular ROM managers that have similar features: | Arcade: CHD disk inclusion | ✅ by default, can be turned off ([arcade docs](usage/arcade.md)) | ✅ by default, can be turned off | ❓ | ❓ | | Arcade: sample inclusion | ❌ | ❌ | ✅ | ❓ | | Archives: extraction formats | ✅ many formats ([reading archives docs](input/reading-archives.md)) | ⚠️ `.zip`, `.7z` (natively) | ✅ `.zip`, `.7z` (via `7z`), `.rar` (via `rar`) | ⚠️ `.zip`, `.7z` | -| Archives: `.chd` support | ⚠️ via `chdman` (bundled) | ✅ v1-5 natively | ⚠️ via `chdman` | ⚠️ v1-4 natively | +| Archives: `.chd` support | ⚠️ via `chdman`1 (bundled) | ✅ v1-5 natively | ⚠️ via `chdman`1 | ⚠️ v1-4 natively | | Archives: `.cso` & `.zso` support | ⚠️ via `maxcso` (bundled) | ❌ | ❌ | ❌ | -| Archives: `.nkit.iso` support | ⚠️ matching but no extraction [GameCube docs](usage/console/gamecube.md#nkit) | ❌ | ❌ | ❌ | +| Archives: `.nkit.iso` support | ⚠️ matching but no extraction/inflation ([GameCube docs](usage/console/gamecube.md#nkit)) | ❌ | ❌ | ❌ | | Archives: creation formats | ❌ `.zip` only by design ([writing archives docs](output/writing-archives.md)) | ⚠️ `.zip` (TorrentZip), `.7z` (RV7Z) | ✅ `.zip`, `.7z`, `.rar` | ⚠️ `.zip`, `.7z` | | Archives: contents checksums | ✅ when needed ([reading archives docs](input/reading-archives.md)) | ⚠️ requires "files only" mode | ⚠️ if DAT has forcepacking=unzip | ❓ | | Archives: automatic extension correction | ✅ | ❌ | ❌ | ❌ | @@ -45,6 +45,10 @@ There are a few different popular ROM managers that have similar features: | Output: subdirectory customization | ✅ [many options](output/path-options.md) | ⚠️ depends on DAT organization | ❌ | ❌ | | Output: create single archive for DAT | ✅ | ✅ | ❌ | ❌ | + +1 requires you to install SDL2 manually, see the [chdman-js README](https://github.com/emmercm/chdman-js#readme). + + !!! note Just like Igir, other ROM managers that are in active development are likely to release new features often. The above table is not guaranteed to be perfectly up-to-date, it is just a best effort. diff --git a/docs/dats/dir2dat.md b/docs/dats/dir2dat.md index de6e5cb0e..fdfd440e1 100644 --- a/docs/dats/dir2dat.md +++ b/docs/dats/dir2dat.md @@ -16,7 +16,7 @@ Igir uses the following rules when creating dir2dat DAT files: If multiple input paths overlap, such as: - === ":simple-windowsxp: Windows" + === ":fontawesome-brands-windows: Windows" ```batch igir dir2dat ^ @@ -24,7 +24,7 @@ Igir uses the following rules when creating dir2dat DAT files: --input "C:\ROMs\NES" ``` - === ":simple-apple: macOS" + === ":fontawesome-brands-apple: macOS" ```shell igir dir2dat \ diff --git a/docs/dats/fixdats.md b/docs/dats/fixdats.md index b8bc62554..389aca3c5 100644 --- a/docs/dats/fixdats.md +++ b/docs/dats/fixdats.md @@ -8,7 +8,7 @@ The `fixdat` command creates a [Logiqx XML](http://www.logiqx.com/DatFAQs/) DAT For example: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy zip fixdat ^ @@ -20,7 +20,7 @@ For example: --fixdat ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy zip fixdat \ diff --git a/docs/dats/processing.md b/docs/dats/processing.md index f1894427e..f7d194546 100644 --- a/docs/dats/processing.md +++ b/docs/dats/processing.md @@ -39,7 +39,7 @@ There have been a few DAT-like formats developed over the years. Igir supports t Instead of exporting the ListXML to a file yourself, you can also specify a MAME executable for the DAT path and then Igir is smart enough to parse it: - === ":simple-windowsxp: Windows" + === ":fontawesome-brands-windows: Windows" Windows is fairly easy, MAME is officially compiled for Windows and downloads can be found on many mirror sites. @@ -47,7 +47,7 @@ There have been a few DAT-like formats developed over the years. Igir supports t igir [commands..] --dat "mame0258b_64bit.exe" --input ``` - === ":simple-apple: macOS" + === ":fontawesome-brands-apple: macOS" MAME isn't officially compiled for macOS, you will have to use a third-party release such as [SDL MAME](https://sdlmame.lngn.net/). diff --git a/docs/input/reading-archives.md b/docs/input/reading-archives.md index fb4379612..80fec04b1 100644 --- a/docs/input/reading-archives.md +++ b/docs/input/reading-archives.md @@ -9,7 +9,7 @@ Igir supports most common archive formats: | Extension | Contains file CRC32s | Igir can extract without a third-party binary | Igir can checksum without temporary files | |------------------------------------------------------------------|----------------------|-----------------------------------------------|-------------------------------------------| | `.7z` | ✅ | ❌ `7za` | ❌ | -| `.chd` | ❌ SHA1 | ❌ `chdman` | ❌ | +| `.chd` | ❌ SHA1 | ❌ `chdman`1 | ❌ | | `.cso`, `.zso`, `.dax` | ❌ | ❌ `maxcso` | ⚠️ CRC32 only | | `.gz`, `.gzip` | ❌ CRC16 | ❌ `7za` | ❌ | | `.nkit.iso` ([GameCube docs](../usage/console/gamecube.md#nkit)) | ✅ | ❌ no extraction support | ✅ | @@ -21,6 +21,10 @@ Igir supports most common archive formats: | `.zip.001` | ✅ | ❌ `7za` | ❌ | | `.zipx` | ✅ | ❌ `7za` | ❌ | + +1 requires you to install SDL2 manually, see the [chdman-js README](https://github.com/emmercm/chdman-js#readme). + + **You should prefer archive formats that have CRC32 checksum information for each file.** By default, Igir uses CRC32 information to [match ROMs](../roms/matching.md) to DAT entries. If an archive already contains CRC32 information for each file, then Igir doesn't need to extract each file and compute its CRC32. This can save a lot of time on large archives. diff --git a/docs/installation.md b/docs/installation.md index cc6475a71..fed164fdf 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,6 +1,6 @@ # Installation -Igir is supported on :simple-windowsxp: Windows, :simple-apple: macOS, :simple-linux: Linux, and every other operating system that [Node.js](https://nodejs.org) supports. +Igir is supported on :fontawesome-brands-windows: Windows, :fontawesome-brands-apple: macOS,:fontawesome-brands-linux: Linux, and every other operating system that [Node.js](https://nodejs.org) supports. There are a few different installation options offered for Igir with varying levels of technical complexity. Every option will require some baseline understanding of command-line interfaces (CLIs). @@ -27,7 +27,7 @@ npx igir@latest copy extract --dat *.dat --input ROMs/ --output ROMs-Sorted/ --d You can alias the `npx` command in your macOS or Linux [dotfiles](https://missing.csail.mit.edu/2019/dotfiles/) like this: - === ":simple-apple: macOS" + === ":fontawesome-brands-apple: macOS" ```bash alias igir="npx igir@latest" @@ -69,5 +69,6 @@ brew upgrade igir ## Via downloaded executable [![GitHub: release](https://img.shields.io/github/v/release/emmercm/igir?color=%236e5494&logo=github&logoColor=white)](https://github.com/emmercm/igir/releases/latest) +![Node.js](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2Figir%2Flatest&query=volta.node&logo=node.js&logoColor=white&label=Node.js&color=66cc33) If you don't want to download Node.js, you can download executables for various OSes from the [GitHub releases](https://github.com/emmercm/igir/releases) page. diff --git a/docs/output/cleaning.md b/docs/output/cleaning.md index 7b8dafc3b..245ec1874 100644 --- a/docs/output/cleaning.md +++ b/docs/output/cleaning.md @@ -21,13 +21,13 @@ In other words, `games/{mister}` is _not_ equivalent to `games/*`. Igir will _no If you want to clean _every_ directory in `games/`, you could specify it as both the `--input ` and `--output `: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir move clean --dat "*.dat" --input "games\" --output "games\{mister}\" ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir move clean --dat "*.dat" --input "games/" --output "games/{mister}/" @@ -61,13 +61,13 @@ The `--clean-dry-run` option exists to see what paths `igir clean` would delete, Usage: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir [commands..] clean [options] --clean-dry-run -vv ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir [commands..] clean [options] --clean-dry-run -vv diff --git a/docs/output/path-options.md b/docs/output/path-options.md index d4947d84b..8ba79b23e 100644 --- a/docs/output/path-options.md +++ b/docs/output/path-options.md @@ -30,7 +30,7 @@ ROMs-Input/ When combined with a [DAT](../dats/introduction.md), the ROMs will be written with a standardized name, but the output subdirectory structure will match the input: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy ^ @@ -40,7 +40,7 @@ When combined with a [DAT](../dats/introduction.md), the ROMs will be written wi --dir-mirror ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy \ @@ -101,7 +101,7 @@ ROMs-Input/ The ROMs will be grouped by their DAT name in the output directory: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy ^ @@ -111,7 +111,7 @@ The ROMs will be grouped by their DAT name in the output directory: --dir-dat-name ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy \ @@ -159,7 +159,7 @@ ROMs-Output/ Similar to `--dir-dat-name`, this option will append the matching [DAT](../dats/introduction.md)'s description to each file. -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy ^ @@ -169,7 +169,7 @@ Similar to `--dir-dat-name`, this option will append the matching [DAT](../dats/ --dir-dat-description ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy \ @@ -218,7 +218,7 @@ ROMs-Input/ The ROMs will be grouped together by their first letter in the output directory: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy ^ @@ -227,7 +227,7 @@ The ROMs will be grouped together by their first letter in the output directory: --dir-letter ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy \ @@ -273,7 +273,7 @@ This option controls the number of leading letters to use for the `--dir-letter` For example, if we increase the number of letters used for subdirectory names from the above example, then the output would be: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy ^ @@ -283,7 +283,7 @@ For example, if we increase the number of letters used for subdirectory names fr --dir-letter-count 3 ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy \ @@ -346,7 +346,7 @@ ROMs-Input/ If we limit the number of files per letter folder, then the output would be: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy ^ @@ -356,7 +356,7 @@ If we limit the number of files per letter folder, then the output would be: --dir-letter-limit 5 ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy \ @@ -418,7 +418,7 @@ ROMs-Input/ We can group the games into letter ranges, with a max of 10 games in each subdirectory like this: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy ^ @@ -429,7 +429,7 @@ We can group the games into letter ranges, with a max of 10 games in each subdir --dir-letter-group ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy \ diff --git a/docs/output/reporting.md b/docs/output/reporting.md index dbc5d68f5..e9a554656 100644 --- a/docs/output/reporting.md +++ b/docs/output/reporting.md @@ -15,7 +15,7 @@ At least one DAT is required for the `igir report` command to work, otherwise Ig The `igir report` command can be specified on its own without any [writing command](../commands.md) (i.e. `igir copy`, `igir move`, etc.) to report on an existing collection. This causes Igir to operate in a _read-only_ mode, no files will be copied, moved, or deleted. For example: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch > igir.exe report --dat *.dat --input ROMs\ @@ -24,7 +24,7 @@ The `igir report` command can be specified on its own without any [writing comma igir_2023-03-29T18;26;00-04;00.csv ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell $ igir report --dat *.dat --input ROMs/ @@ -72,7 +72,7 @@ The report output filename supports a version of [Moment.js symbols](https://mom Here are some example usages: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch > igir.exe report --dat *.dat --input ROMs\ --report-output ".\report.csv" @@ -84,7 +84,7 @@ Here are some example usages: REM /igir/1681515048.csv ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell $ igir report --dat *.dat --input ROMs/ --report-output "./report.csv" diff --git a/docs/output/tokens.md b/docs/output/tokens.md index b178d1786..3c17ff453 100644 --- a/docs/output/tokens.md +++ b/docs/output/tokens.md @@ -6,7 +6,7 @@ See [output path tokens](./path-options.md) for other options that will further For example, if you want to group all ROMs based on their region, you would specify: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy extract ^ @@ -15,7 +15,7 @@ For example, if you want to group all ROMs based on their region, you would spec --output "ROMs-Sorted\{region}\" ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy extract \ diff --git a/docs/output/writing-archives.md b/docs/output/writing-archives.md index 570288750..5e865803e 100644 --- a/docs/output/writing-archives.md +++ b/docs/output/writing-archives.md @@ -14,13 +14,13 @@ See the [reading archives](../input/reading-archives.md) page for more informati One aspect of organizing a ROM collection is to ensure a consistent archive format. You can ensure all ROMs in a collection are in a `.zip` archive like this: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir move zip --dat "*.dat" --input "ROMs\" --output "ROMs\" ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir move zip --dat "*.dat" --input "ROMs/" --output "ROMs/" @@ -44,7 +44,7 @@ You can exclude files from being zipped with the `--zip-exclude ` option. You can exclude some disc images like this: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy zip ^ @@ -54,7 +54,7 @@ You can exclude some disc images like this: --zip-exclude "**/*.{iso,bin,cue,chd}" ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy zip \ @@ -76,7 +76,7 @@ You can exclude some disc images like this: You can exclude some BIOS files like this: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy zip ^ @@ -86,7 +86,7 @@ You can exclude some BIOS files like this: --zip-exclude "**/*[BIOS]*" ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy zip \ diff --git a/docs/usage/arcade.md b/docs/usage/arcade.md index d5f4f76b9..461d6e543 100644 --- a/docs/usage/arcade.md +++ b/docs/usage/arcade.md @@ -52,7 +52,7 @@ Here is a comparison chart: The ROM merge type can be specified with the `--merge-roms ` option: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy zip ^ @@ -62,7 +62,7 @@ The ROM merge type can be specified with the `--merge-roms ` option: --merge-roms split ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy zip \ @@ -120,7 +120,7 @@ Let's say we want to build an arcade ROM set that's compatible with the most rec After determining where we want to put our ROMs, we can build our MAME v0.258 ROM set like this: - === ":simple-windowsxp: Windows (64-bit)" + === ":fontawesome-brands-windows: Windows (64-bit)" ```batch igir copy zip ^ @@ -130,7 +130,7 @@ Let's say we want to build an arcade ROM set that's compatible with the most rec --merge-roms split ``` - === ":simple-windowsxp: Windows (32-bit)" + === ":fontawesome-brands-windows: Windows (32-bit)" ```batch igir copy zip ^ @@ -140,7 +140,7 @@ Let's say we want to build an arcade ROM set that's compatible with the most rec --merge-roms split ``` - === ":simple-apple: macOS" + === ":fontawesome-brands-apple: macOS" ```shell igir copy zip \ @@ -184,7 +184,7 @@ Taking the MAME v0.258 set we created above, let's say we want to "downgrade" it 3. **Run Igir.** - === ":simple-windowsxp: Windows (64-bit)" + === ":fontawesome-brands-windows: Windows (64-bit)" ```batch igir copy zip ^ @@ -195,7 +195,7 @@ Taking the MAME v0.258 set we created above, let's say we want to "downgrade" it --merge-roms split ``` - === ":simple-windowsxp: Windows (32-bit)" + === ":fontawesome-brands-windows: Windows (32-bit)" ```batch igir copy zip ^ @@ -206,7 +206,7 @@ Taking the MAME v0.258 set we created above, let's say we want to "downgrade" it --merge-roms split ``` - === ":simple-apple: macOS" + === ":fontawesome-brands-apple: macOS" ```shell igir copy zip \ @@ -236,7 +236,7 @@ Sometimes people have a need to build very specific sets. Here are some instruct Build a set of only BIOS files, with each in its own `.zip` file: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy zip ^ @@ -246,7 +246,7 @@ Build a set of only BIOS files, with each in its own `.zip` file: --only-bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy zip \ @@ -270,7 +270,7 @@ Build a set of only BIOS files, with each in its own `.zip` file: Build a set of only device files, with each in its own `.zip` file: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy zip ^ @@ -280,7 +280,7 @@ Build a set of only device files, with each in its own `.zip` file: --only-device ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy zip \ diff --git a/docs/usage/basic.md b/docs/usage/basic.md index e0593648d..43c8a8cd1 100644 --- a/docs/usage/basic.md +++ b/docs/usage/basic.md @@ -16,7 +16,7 @@ First, you need to download a set of [DATs](../dats/introduction.md). For these Let's say that you have a directory named `ROMs/` that contains ROMs for many different systems, and it needs some organization. To make sure we're alright with the output, we'll have Igir copy these files to a different directory rather than move them. We'll also [zip](../output/writing-archives.md) them to reduce disk space & speed up future scans. -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy zip test ^ @@ -26,7 +26,7 @@ Let's say that you have a directory named `ROMs/` that contains ROMs for many di --dir-dat-name ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy zip test \ @@ -75,7 +75,7 @@ Let's say that we've done the above first time sort and were happy with the resu We now have new ROMs that we want to newly merge into our collection, and we want to generate a [report](../output/reporting.md) of what ROMs are still missing. We also want to "[clean](../output/cleaning.md)" or delete any unknown files that may have made their way into our collection. -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir move zip test clean report ^ @@ -86,7 +86,7 @@ We now have new ROMs that we want to newly merge into our collection, and we wan --dir-dat-name ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir move zip test clean report \ @@ -141,7 +141,7 @@ Let's say we've done the above sorting we want to copy some ROMs from `ROMs-Sort We would prefer having only one copy of every game ([1G1R](../roms/filtering-preferences.md#preferences-for-1g1r)), because we have a preferred language, and so there is less to scroll through to find what game we want. Our flash cart can't read `.zip` files, so we'll need to extract our ROMs during copying. -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -157,7 +157,7 @@ We would prefer having only one copy of every game ([1G1R](../roms/filtering-pre --prefer-region USA,WORLD,EUR,JPN ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/FlashCart` drive name with whatever your SD card is named: @@ -217,7 +217,7 @@ ROM organization is very opinion-based, and your opinion may not match that of D It is possible to extract or zip your ROM files en masse without complicated Bash or Batch scripts, and you can do this without DATs because the root of the filename won't change. -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir move extract test ^ @@ -226,7 +226,7 @@ It is possible to extract or zip your ROM files en masse without complicated Bas --dir-mirror ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir move extract test \ @@ -250,7 +250,7 @@ It is possible to extract or zip your ROM files en masse without complicated Bas Igir is able to detect more than 50 ROM and archive file types and automatically correct file extensions when needed during writing. See the [writing options](../output/options.md#fixing-rom-extensions) page for more information. -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir move extract test ^ @@ -260,7 +260,7 @@ Igir is able to detect more than 50 ROM and archive file types and automatically --fix-extension always ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir move extract test \ diff --git a/docs/usage/console/gamecube.md b/docs/usage/console/gamecube.md index c2f5d3fbe..ff6ff23ec 100644 --- a/docs/usage/console/gamecube.md +++ b/docs/usage/console/gamecube.md @@ -10,7 +10,7 @@ Igir has a `--writer-threads ` option to limit the number of files being written at once. You can use the option like this: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -24,7 +24,7 @@ Igir has a `--writer-threads ` option to limit the number of files bein --writer-threads 1 ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/SD2SP2` drive name with whatever your SD card is named: diff --git a/docs/usage/console/ps2.md b/docs/usage/console/ps2.md index 66df8d3b5..def283b9f 100644 --- a/docs/usage/console/ps2.md +++ b/docs/usage/console/ps2.md @@ -10,7 +10,7 @@ Igir has a `--writer-threads ` option to limit the number of files being written at once. You can use the option like this: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your USB drive is: @@ -24,7 +24,7 @@ Igir has a `--writer-threads ` option to limit the number of files bein --writer-threads 1 ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/PS2` drive name with whatever your USB drive is named: diff --git a/docs/usage/desktop/retroarch.md b/docs/usage/desktop/retroarch.md index cdbfeb1c1..382172fd7 100644 --- a/docs/usage/desktop/retroarch.md +++ b/docs/usage/desktop/retroarch.md @@ -12,7 +12,7 @@ First, RetroArch needs a number of [BIOS files](https://docs.libretro.com/librar With Igir's support for [DAT URLs](../../dats/processing.md#scanning-for-dats) we don't even have to download the DAT! Locate your "System/BIOS" directory as configured in the RetroArch UI and use it as your output directory: -=== ":simple-windowsxp: Windows (64-bit)" +=== ":fontawesome-brands-windows: Windows (64-bit)" The root directory is based on where you installed RetroArch, but by default it is: @@ -23,7 +23,7 @@ With Igir's support for [DAT URLs](../../dats/processing.md#scanning-for-dats) w --output C:\RetroArch-Win64\system ``` -=== ":simple-windowsxp: Windows (32-bit)" +=== ":fontawesome-brands-windows: Windows (32-bit)" The root directory is based on where you installed RetroArch, but by default it is: @@ -34,7 +34,7 @@ With Igir's support for [DAT URLs](../../dats/processing.md#scanning-for-dats) w --output C:\RetroArch-Win32\system ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy extract test clean \ @@ -58,7 +58,7 @@ RetroArch is less opinionated about where your ROMs can live, you have to specif If you want to store your ROMs in the RetroArch folder, you could co-locate them near your BIOS files: -=== ":simple-windowsxp: Windows (64-bit)" +=== ":fontawesome-brands-windows: Windows (64-bit)" The root directory is based on where you installed RetroArch, but by default it is: @@ -71,7 +71,7 @@ If you want to store your ROMs in the RetroArch folder, you could co-locate them --no-bios ``` -=== ":simple-windowsxp: Windows (32-bit)" +=== ":fontawesome-brands-windows: Windows (32-bit)" The root directory is based on where you installed RetroArch, but by default it is: @@ -84,7 +84,7 @@ If you want to store your ROMs in the RetroArch folder, you could co-locate them --no-bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy zip test \ diff --git a/docs/usage/desktop/retropie.md b/docs/usage/desktop/retropie.md index 67baacef2..1565585c0 100644 --- a/docs/usage/desktop/retropie.md +++ b/docs/usage/desktop/retropie.md @@ -19,7 +19,7 @@ Because RetroPie uses RetroArch under the hood, the instructions are generally t The [RetroPie docs](https://retropie.org.uk/docs/Transferring-Roms/) recommend creating a `retropie/roms` directory at the root of a USB drive. You can then load up this USB drive with your ROMs from a different computer: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -33,7 +33,7 @@ The [RetroPie docs](https://retropie.org.uk/docs/Transferring-Roms/) recommend c --no-bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/RETROPIE` drive name with whatever your SD card is named: diff --git a/docs/usage/desktop/romm.md b/docs/usage/desktop/romm.md index 80d22fdd3..58bdd3695 100644 --- a/docs/usage/desktop/romm.md +++ b/docs/usage/desktop/romm.md @@ -63,7 +63,7 @@ docker compose up This will create all of the local directories necessary. On your host machine (not from inside the container) you can sort your ROMs into the correct directories like this: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" ```batch igir copy zip test clean ^ @@ -72,7 +72,7 @@ This will create all of the local directories necessary. On your host machine (n --output "romm\roms\{romm}" ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" ```shell igir copy zip test clean \ diff --git a/docs/usage/handheld/adam.md b/docs/usage/handheld/adam.md index 6ccd0c788..6ed0993f2 100644 --- a/docs/usage/handheld/adam.md +++ b/docs/usage/handheld/adam.md @@ -18,7 +18,7 @@ This ensures that the card already has the correct folder structures and is reco The Adam image does not come with BIOS files. Where you have to put which of your own BIOS files is [documented in the image's wiki](https://github.com/eduardofilo/RG350_adam_image/wiki/En:-3.-Content-installation#bios). Most of the BIOS files have to be stored in the `BIOS` subfolder of the second SD card (TF2) and the libretro System.dat can be used to put them there -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -29,7 +29,7 @@ The Adam image does not come with BIOS files. Where you have to put which of you --output E:\BIOS ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/JELOS` drive name with whatever your SD card is named: @@ -59,7 +59,7 @@ Adam supports many different ROM formats in subfolders of `ROMS` on the second S Please note that sorting the supported Arcade machine releases (MAME, CPS, FBA) in a single pass is not supported by Igir at this time. Try the [Arcade docs](../arcade.md) docs for help with this. -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -72,7 +72,7 @@ Adam supports many different ROM formats in subfolders of `ROMS` on the second S --no-bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/ADAM` drive name with whatever your SD card is named: diff --git a/docs/usage/handheld/funkeyos.md b/docs/usage/handheld/funkeyos.md index 12f04f321..d4bb3fc1a 100644 --- a/docs/usage/handheld/funkeyos.md +++ b/docs/usage/handheld/funkeyos.md @@ -19,7 +19,7 @@ To sum up the documentation, two files need to be copied: Funkey OS uses its own proprietary [ROM folder structure](https://github.com/FunKey-Project/FunKey-OS/tree/master/FunKey/board/funkey/rootfs-overlay/usr/games/collections) based in the root of the SD card, so Igir has a replaceable `{funkeyos}` token to sort ROMs into the right place. See the [replaceable tokens page](../../output/tokens.md) for more information. -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -32,7 +32,7 @@ Funkey OS uses its own proprietary [ROM folder structure](https://github.com/Fun --no-bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/FunKeyS` drive name with whatever your SD card is named: diff --git a/docs/usage/handheld/jelos.md b/docs/usage/handheld/jelos.md index 36fde18e2..b99afc9da 100644 --- a/docs/usage/handheld/jelos.md +++ b/docs/usage/handheld/jelos.md @@ -34,7 +34,7 @@ Please note that while `FAT32` is not case sensitive in most cases, `ext4` and m 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" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -45,7 +45,7 @@ JELOS has its BIOS folder at `roms/bios/`, and it uses the RetroArch filenames. --output E:\roms\bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/JELOS` drive name with whatever your SD card is named: @@ -71,7 +71,7 @@ JELOS has its BIOS folder at `roms/bios/`, and it uses the RetroArch filenames. 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" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -84,7 +84,7 @@ JELOS supports many many systems and ROM formats. Check sections under the `Syst --no-bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/JELOS` drive name with whatever your SD card is named: diff --git a/docs/usage/handheld/minui.md b/docs/usage/handheld/minui.md index 4cbc21db3..a3c41e522 100644 --- a/docs/usage/handheld/minui.md +++ b/docs/usage/handheld/minui.md @@ -33,7 +33,7 @@ MinUI requires multi-file releases to be grouped into subdirectories (bin/cue re More details about these features can be found [here](https://github.com/shauninman/MinUI/tree/main/skeleton/BASE) under the sections `Roms` and `Disc-based games`. -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -46,7 +46,7 @@ More details about these features can be found [here](https://github.com/shaunin --no-bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/MinUI` drive name with whatever your SD card is named: diff --git a/docs/usage/handheld/miyoocfw.md b/docs/usage/handheld/miyoocfw.md index 28fc69854..6552d69ea 100644 --- a/docs/usage/handheld/miyoocfw.md +++ b/docs/usage/handheld/miyoocfw.md @@ -27,7 +27,7 @@ MiyooCFW doesn't seem to have a centralized folder for putting BIOS files so it' MiyooCFW supports many many systems and ROM formats. Check the table on the [MiyooCFW Wiki](https://github.com/TriForceX/MiyooCFW/wiki/Emulator-Info) for more precise instructions about the indivudual systems. Most supported systems and their ROMS can be automatically sorted by Igir using the `{miyoocfw}` output token. See the [replaceable tokens page](../../output/tokens.md) for more information. -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -40,7 +40,7 @@ MiyooCFW supports many many systems and ROM formats. Check the table on the [Miy --no-bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/MiyooCFW` drive name with whatever your SD card is named: diff --git a/docs/usage/handheld/onionos.md b/docs/usage/handheld/onionos.md index 971b63e14..55d0785a3 100644 --- a/docs/usage/handheld/onionos.md +++ b/docs/usage/handheld/onionos.md @@ -10,7 +10,7 @@ OnionOS has its BIOS folder at the root of the SD card at `/BIOS/`, and it uses the [RetroArch filenames](https://onionui.github.io/docs/installation/fresh#step-3-copy-over-your-bios-and-rom-files): -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -21,7 +21,7 @@ OnionOS has its BIOS folder at the root of the SD card at `/BIOS/`, and it uses --output E:\BIOS ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/OnionOS` drive name with whatever your SD card is named: @@ -47,7 +47,7 @@ OnionOS has its BIOS folder at the root of the SD card at `/BIOS/`, and it uses OnionOS uses its own proprietary [ROM folder structure](https://github.com/OnionUI/Onion/wiki/Emulators#rom-folders---quick-reference), so Igir has a replaceable `{onion}` token to sort ROMs into the right place. See the [replaceable tokens page](../../output/tokens.md) for more information. -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -60,7 +60,7 @@ OnionOS uses its own proprietary [ROM folder structure](https://github.com/Onion --no-bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/OnionOS` drive name with whatever your SD card is named: diff --git a/docs/usage/handheld/twmenu.md b/docs/usage/handheld/twmenu.md index 5c7cdaa81..8ed13e231 100644 --- a/docs/usage/handheld/twmenu.md +++ b/docs/usage/handheld/twmenu.md @@ -14,7 +14,7 @@ TWiLightMenu++ ships with most emulators not needing BIOS files. No exceptions a TWiLightMenu uses its own proprietary [ROM folder structure](https://github.com/DS-Homebrew/TWiLightMenu/tree/master/7zfile/roms) based in the root of the SD card, so Igir has a replaceable `{twmenu}` token to sort ROMs into the right place. See the [replaceable tokens page](../../output/tokens.md) for more information. -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -27,7 +27,7 @@ TWiLightMenu uses its own proprietary [ROM folder structure](https://github.com/ --no-bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/DSCard` drive name with whatever your SD card is named: diff --git a/docs/usage/hardware/analogue-pocket.md b/docs/usage/hardware/analogue-pocket.md index 78ab43e2e..ee1ad5956 100644 --- a/docs/usage/hardware/analogue-pocket.md +++ b/docs/usage/hardware/analogue-pocket.md @@ -18,7 +18,7 @@ Igir has support for replaceable "tokens" in the `--output ` option. This This token can be used to reference each core's specific directory in the SD card's `Assets` directory. ROMs go in the `Assets/{pocket}/common` directory. -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -34,7 +34,7 @@ This token can be used to reference each core's specific directory in the SD car --no-bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/POCKET` drive name with whatever your SD card is named: diff --git a/docs/usage/hardware/everdrive.md b/docs/usage/hardware/everdrive.md index ef40babbb..0d22c7902 100644 --- a/docs/usage/hardware/everdrive.md +++ b/docs/usage/hardware/everdrive.md @@ -6,7 +6,7 @@ The [EverDrive](https://krikzz.com/) flash carts by Krikzz are some of the highe Because flash carts are specific to a specific console, you can provide specific input directories and [DATs](../../dats/introduction.md) when you run Igir. For example: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -18,7 +18,7 @@ Because flash carts are specific to a specific console, you can provide specific --no-bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/EverDrive` drive name with whatever your SD card is named: @@ -46,7 +46,7 @@ you can then add some other output options such as the [`--dir-letter` option](. Alternatively, Igir supports [Hardware Target Game Database SMDB files](https://github.com/frederic-mahe/Hardware-Target-Game-Database/tree/master/EverDrive%20Pack%20SMDBs) as [DATs](../../dats/introduction.md). Unlike typical DATs, Hardware Target Game Database SMDBs typically have an opinionated directory structure to help sort ROMs by language, category, genre, and more. Example usage: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -57,7 +57,7 @@ Alternatively, Igir supports [Hardware Target Game Database SMDB files](https:// --output E:\ ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/EverDrive` drive name with whatever your SD card is named: diff --git a/docs/usage/hardware/ezflash.md b/docs/usage/hardware/ezflash.md index cc1dea387..c1225fb40 100644 --- a/docs/usage/hardware/ezflash.md +++ b/docs/usage/hardware/ezflash.md @@ -6,7 +6,7 @@ The [EZ-FLASH](https://www.ezflash.cn/) flash carts for Nintendo handhelds are a Because flash carts are specific to a specific console, you can provide specific input directories & [DATs](../../dats/introduction.md) when you run Igir. For example: -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -18,7 +18,7 @@ Because flash carts are specific to a specific console, you can provide specific --no-bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/EZFLASH` drive name with whatever your SD card is named: diff --git a/docs/usage/hardware/mister.md b/docs/usage/hardware/mister.md index ecf18514c..16b491a1a 100644 --- a/docs/usage/hardware/mister.md +++ b/docs/usage/hardware/mister.md @@ -12,7 +12,7 @@ Igir has support for replaceable "tokens" in the `--output ` option. This This token can be used to reference each core's specific directory in the MiSTer's `games` directory. -=== ":simple-windowsxp: Windows" +=== ":fontawesome-brands-windows: Windows" Replace the `E:\` drive letter with wherever your SD card is: @@ -25,7 +25,7 @@ This token can be used to reference each core's specific directory in the MiSTer --no-bios ``` -=== ":simple-apple: macOS" +=== ":fontawesome-brands-apple: macOS" Replace the `/Volumes/MISTER` drive name with whatever your SD card is named: