Skip to content

Commit

Permalink
Docs: update (#1214)
Browse files Browse the repository at this point in the history
  • Loading branch information
emmercm authored Jul 14, 2024
1 parent 8c7993d commit 777b4d9
Show file tree
Hide file tree
Showing 9 changed files with 30 additions and 24 deletions.
2 changes: 1 addition & 1 deletion docs/advanced/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ There are additional levels of verbosity that can be enabled with the `-v` flag:
- [dir2dat](../dats/dir2dat.md) files being created
- [Fixdat](../dats/fixdats.md) files being created
- Input files deleted after being moved
- Output files being [cleaned](../output/cleaning.md)
- Output files being [cleaned](../output/cleaning.md) (including files skipped due to `--clean-dry-run`)
- [Report](../output/reporting.md) files being created

Usage:
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/arcade.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This page is written to give users just enough context to build & re-build arcad

Unlike traditional console emulators that only have to emulate a small set of hardware, arcade emulators have the monumental task of emulating a wildly varying number of hardware chips, inputs, and outputs. This results in each version of an emulator having a very specific set of games it can emulate, and newer emulator versions will likely add more games to this set.

Due to arcade machines being more complicated and rarer, arcade ROM dumps are sometimes imperfect. Because of this, newer emulator versions may expect different ROM files than older versions. This makes ROM sets potentially incompatible between different emulator versions.
Due to arcade machines being more complicated and rarer than games for home consoles, arcade ROM dumps are sometimes imperfect. Because of this, newer emulator versions may expect different ROM files than older versions. This makes ROM sets potentially incompatible between different emulator versions.

Because of all of these reasons, each arcade emulator version usually comes with a companion [DAT](../dats/introduction.md#arcade-dats) that details the _exact_ set of ROM files supported by that _exact_ emulator version. Emulators such as [MAME](https://www.mamedev.org/) take this a step further and expect an _exact_ zip file name for each game.

Expand Down
2 changes: 1 addition & 1 deletion docs/usage/collection-sorting.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Now we have new ROMs that we want to merge into our collection, and we want to g
--dir-dat-name
```

Any new ROMs in `~/Downloads/` that we didn't already have in `ROMs-Sorted/` will be moved, and a report will be generated for us.
Any new ROMs in `ROMs-New/` that we didn't already have in `ROMs-Sorted/` will be moved, and a report will be generated for us.

`ROMs-Sorted/` then might look something like this, with new ROMs added:

Expand Down
9 changes: 6 additions & 3 deletions docs/usage/console/gamecube.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@
```batch
igir copy extract test clean ^
--dat "Redump*.zip" ^
--dat-name-regex '/gamecube/i' ^
--input "ISOs" ^
--output "E:\ISOs" ^
--output "E:\Games" ^
--dir-letter ^
--writer-threads 1
```
Expand All @@ -30,8 +31,9 @@
```shell
igir copy extract test clean \
--dat "Redump*.zip" \
--dat-name-regex '/gamecube/i' \
--input "ISOs/" \
--output "/Volumes/SD2SP2/ISOs/" \
--output "/Volumes/SD2SP2/Games/" \
--dir-letter \
--writer-threads 1
```
Expand All @@ -43,8 +45,9 @@
```shell
igir copy extract test clean \
--dat "Redump*.zip" \
--dat-name-regex '/gamecube/i' \
--input "ISOs/" \
--output "/media/SD2SP2/ISOs/" \
--output "/media/SD2SP2/Games/" \
--dir-letter \
--writer-threads 1
```
3 changes: 3 additions & 0 deletions docs/usage/console/ps2.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
```batch
igir copy extract test clean ^
--dat "Redump*.zip" ^
--dat-name-regex '/playstation 2/i' ^
--input "ISOs" ^
--output "E:\DVD" ^
--dir-letter ^
Expand All @@ -30,6 +31,7 @@
```shell
igir copy extract test clean \
--dat "Redump*.zip" \
--dat-name-regex '/playstation 2/i' \
--input "ISOs/" \
--output "/Volumes/PS2/DVD/" \
--dir-letter \
Expand All @@ -43,6 +45,7 @@
```shell
igir copy extract test clean \
--dat "Redump*.zip" \
--dat-name-regex '/playstation 2/i' \
--input "ISOs/" \
--output "/media/PS2/DVD/" \
--dir-letter \
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/handheld/jelos.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ We will assume the single card variant here. If you use a card just for roms, pl
| Component | single SD card (OS+ROMs) | separate SD card (ROMs only) |
|---------------|--------------------------|------------------------------|
| BIOS | `<SD>/roms/bios/` | `<SD>/bios/` |
| GameBoy ROMs | `<SD>/roms/gb` | `<SD>/gb` |
| Game Boy 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.
Expand Down
20 changes: 10 additions & 10 deletions docs/usage/handheld/minui.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ MinUI is strictly *bring your own BIOS*. You can find information on the require

Place these files under `/Bios/<PAK-name>/<Filename>`:

| Console | PAK | File | MD5 |
|:--------|:---:|:-----|:---:|
| NEC TurboGrafx-16 | PCE | `syscard3.pce` | `38179df8f4ac870017db21ebcbf53114` |
| Nintendo GameBoy | GB | `gb_bios.bin` | `32fbbd84168d3482956eb3c5051637f5` |
| Nintendo GameBoy Color | GBC | `gbc_bios.bin` | `dbfce9db9deaa2567f6a84fde55f9680` |
| Nintendo GameBoy Advance | GBA | `gba_bios.bin` | `a860e8c0b6d573d191e4ec7db1b1e4f6` |
| Nintendo GameBoy Advance | MGBA | `gba_bios.bin` | `a860e8c0b6d573d191e4ec7db1b1e4f6` |
| Nintendo Pokemon Mini | PKM | `bios.min` | `1e4fb124a3a886865acb574f388c803d` |
| Nintendo Super GameBoy | SGB | `sgb.bios` | `d574d4f9c12f305074798f54c091a8b4` |
| Sony PlayStation | PS | `scph1001.bin` | `924e392ed05558ffdb115408c263dccf` |
| Console | PAK | File | MD5 |
|:--------------------------|:---:|:-----|:---:|
| NEC TurboGrafx-16 | PCE | `syscard3.pce` | `38179df8f4ac870017db21ebcbf53114` |
| Nintendo Game Boy | GB | `gb_bios.bin` | `32fbbd84168d3482956eb3c5051637f5` |
| Nintendo Game Boy Color | GBC | `gbc_bios.bin` | `dbfce9db9deaa2567f6a84fde55f9680` |
| Nintendo Game Boy Advance | GBA | `gba_bios.bin` | `a860e8c0b6d573d191e4ec7db1b1e4f6` |
| Nintendo Game Boy Advance | MGBA | `gba_bios.bin` | `a860e8c0b6d573d191e4ec7db1b1e4f6` |
| Nintendo Pokemon Mini | PKM | `bios.min` | `1e4fb124a3a886865acb574f388c803d` |
| Nintendo Super Game Boy | SGB | `sgb.bios` | `d574d4f9c12f305074798f54c091a8b4` |
| Sony PlayStation | PS | `scph1001.bin` | `924e392ed05558ffdb115408c263dccf` |

## ROMs

Expand Down
10 changes: 5 additions & 5 deletions docs/usage/hardware/analogue-pocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,11 @@ Your SD card should look like this, likely with more cores:
│ │ ├── ROM1.sms
│ │ ├── ROM2.sms
│ │ └── ROM3.sms
── snes
└── common
├── ROM1.snes
├── ROM2.snes
└── ROM3.snes
── snes
└── common
├── ROM1.snes
├── ROM2.snes
└── ROM3.snes
├── Cores
├── Platforms
└── Presets
Expand Down
4 changes: 2 additions & 2 deletions docs/usage/hardware/everdrive.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# EverDrive

The [EverDrive](https://krikzz.com/) flash carts by Krikzz are some of the high quality, highest rate of compatability, and most often recommended flash carts available on the market today.
The [EverDrive](https://krikzz.com/) flash carts by Krikzz are some of the highest quality, highest rate of compatability, and most often recommended flash carts available on the market today.

## ROMs

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:
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"

Expand Down

0 comments on commit 777b4d9

Please sign in to comment.