Igir

https://igir.io/
Admin
Igir is a zero-setup ROM collection manager that sorts, filters, extracts, archives, patches, and...
Tokens:125,849
Snippets:926
Trust Score:6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example input ROMs starting with 'S'

Source: https://igir.io/output/path-options

Lists example ROM files that all start with the same first letter, used to illustrate the effect of --dir-letter-limit.

```plaintext
ROMs-Input/
├── Shaq Fu (USA) (SGB Enhanced).gb
├── Space Invaders (USA) (SGB Enhanced).gb
├── Star Wars (USA, Europe) (Rev 1).gb
├── Star Wars - The Empire Strikes Back (USA, Europe).gb
├── Street Fighter II (USA, Europe) (Rev 1) (SGB Enhanced).gb
├── Super Mario Land (World) (Rev 1).gb
└── Super Mario Land 2 - 6 Golden Coins (USA, Europe) (Rev 2).gb

```

--------------------------------

### Install Igir via Scoop

Source: https://igir.io/installation

Install Igir via Scoop on Windows. First add the bucket, then install the igir package.

```bash
scoop bucket add igir https://github.com/emmercm/igir
scoop install igir

```

--------------------------------

### Example input ROMs for letter grouping

Source: https://igir.io/output/path-options

Example list of ROMs starting with different letters, used to illustrate the grouping behavior.

```plaintext
ROMs-Input/
├── Alleyway (World).gb
├── Battletoads (USA, Europe).gb
├── Centipede (USA) (Majesco).gb
├── Donkey Kong (World) (Rev 1) (SGB Enhanced).gb
├── Earthworm Jim (USA).gb
├── Final Fantasy Adventure (USA).gb
├── Game Boy Wars Turbo (Japan) (SGB Enhanced).gb
├── Harvest Moon GB (USA) (SGB Enhanced).gb
├── James Bond 007 (USA, Europe) (SGB Enhanced).gb
├── Kirby's Dream Land (USA, Europe).gb
├── Legend of Zelda, The - Link's Awakening (USA, Europe) (Rev 2).gb
├── Mario's Picross (USA, Europe) (SGB Enhanced).gb
└── Pocket Bomberman (Europe) (SGB Enhanced).gb

```

--------------------------------

### Install Igir via Homebrew

Source: https://igir.io/installation

Install Igir via Homebrew on macOS or Linux. First trust the tap, then install the igir formula.

```bash
brew trust emmercm/igir
brew install emmercm/igir/igir

```

--------------------------------

### Run Igir Example Command

Source: https://igir.io/contributing

Example command that runs Igir with the report command, a .dat file, and input directory.

```bash
npm start -- report --dat *.dat --input ROMs

```

--------------------------------

### Unverified dump examples (with [!])

Source: https://igir.io/roms/filtering

Example ROM filenames that contain '[!]' and would be filtered out by --only-unverified.

```text
Kirby & The Amazing Mirror (U) [!]
Legend of Zelda, The - A Link To The Past with Four Swords (E) (M5) [!]
Mario & Luigi - Superstar Saga (U) [!]

```

--------------------------------

### Run Igir with npm start

Source: https://igir.io/contributing

Defines the npm start script to run Igir with command-line arguments and options.

```bash
npm start -- [commands..] [options]

```

--------------------------------

### Unverified dump examples (no [!])

Source: https://igir.io/roms/filtering

Example ROM filenames that do NOT contain '[!]' and would be filtered out by --no-unverified.

```text
Getaway, The (U)
Gex - Enter the Gecko (U) [C][b1]
Golf (W) [o1]
Grand Theft Auto (E) (M5) [C][t1]

```

--------------------------------

### Homebrew ROM name examples

Source: https://igir.io/roms/filtering

Example ROM filenames that contain '(Homebrew)' and would be affected by the --no-homebrew or --only-homebrew flags.

```text
Game Boy Camera Gallery 2022, The (World) (Aftermarket) (Homebrew)
GB-Wordyl (World) (Aftermarket) (Homebrew)

```

--------------------------------

### Bad dump examples with [c] or [x]

Source: https://igir.io/roms/filtering

Example ROM filenames that contain '[c]' or '[x]' and are not verified dumps, which are also filtered by --no-bad or --only-bad.

```text
Brian Lara Cricket 96 (E) [a1][x]
Micro Machines Military - It's a Blast! (E) [x]

```

--------------------------------

### Aftermarket ROM name examples

Source: https://igir.io/roms/filtering

Example ROM filenames that contain '(Aftermarket)' and would be affected by the --no-aftermarket or --only-aftermarket flags.

```text
Bub-O Escape (World) (v2.5) (Aftermarket) (Unl)
D-Fuzed (World) (v1.1.0) (GB Compatible) (Aftermarket) (Unl)

```

--------------------------------

### Bad dump name examples

Source: https://igir.io/roms/filtering

Example ROM filenames that contain '[b]' or '[b#]' and would be affected by the --no-bad or --only-bad flags.

```text
[MIA] Aprilia - DiTech Interface (Unknown) (Unl) [b]
Great Greed (U) [b1]
Gremlins 2 - The New Batch (W) [b2]

```

--------------------------------

### Example input directory structure for --dir-mirror

Source: https://igir.io/output/path-options

Shows the input directory structure used in the --dir-mirror example. The subdirectories 'gb/mario' and 'gb/pokemon' contain ROM files.

```text
ROMs-Input/
└── gb
    ├── mario
    │   ├── mario land 2.gb
    │   └── mario land.gb
    └── pokemon
        ├── pokemon blue.gb
        ├── pokemon red.gb
        └── pokemon yellow.gb

```

--------------------------------

### Example output directory structure with {region} token

Source: https://igir.io/output/tokens

Sample directory tree showing how ROMs are sorted into AUS, EUR, and USA subdirectories when using the {region} token.

```text
ROMs-Sorted/
├── AUS
│   └── Pokemon Pinball (USA, Australia) (Rumble Version) (SGB Enhanced) (GB Compatible).gbc
├── EUR
│   ├── Pokemon - Blue Version (USA, Europe) (SGB Enhanced).gb
│   ├── Pokemon - Red Version (USA, Europe) (SGB Enhanced).gb
│   └── Pokemon - Yellow Version - Special Pikachu Edition (USA, Europe) (CGB+SGB Enhanced).gb
└── USA
    ├── Pokemon - Blue Version (USA, Europe) (SGB Enhanced).gb
    ├── Pokemon - Red Version (USA, Europe) (SGB Enhanced).gb
    ├── Pokemon - Yellow Version - Special Pikachu Edition (USA, Europe) (CGB+SGB Enhanced).gb
    └── Pokemon Pinball (USA, Australia) (Rumble Version) (SGB Enhanced) (GB Compatible).gbc

```

--------------------------------

### Example sorted ROMs directory tree

Source: https://igir.io/output/tokens

Example output directory tree after sorting ROMs with the MiSTer token. Shows Gameboy, MegaDrive, and SNES folders with sample ROM filenames.

```text
ROMs-Sorted/
├── Gameboy
│   ├── Hyper Lode Runner (World) (Rev 1).gb
│   ├── Wave Race (USA, Europe).gb
├── MegaDrive
│   ├── Shinobi III - Return of the Ninja Master (USA).md
│   ├── X-Men 2 - Clone Wars (USA, Europe).md
└── SNES
    ├── F-Zero (USA).sfc
    └── Mario Paint (Japan, USA) (En).sfc

```

--------------------------------

### Glob pattern: Only process BIOS ROMs

Source: https://igir.io/input/file-scanning

Uses the glob pattern `**/\[BIOS\]*` to match files starting with '[BIOS]', as shown in the example file tree.

```bash
--input "**/\[BIOS\]*"

```

--------------------------------

### Example output directory structure after --dir-mirror

Source: https://igir.io/output/path-options

Shows the output directory structure after using --dir-mirror with a DAT. The subdirectory structure matches the input, but ROMs have standardized names.

```text
ROMs-Output/
└── gb
    ├── mario
    │   ├── Super Mario Land (World) (Rev 1).gb
    │   └── Super Mario Land 2 - 6 Golden Coins (USA, Europe) (Rev 2).gb
    └── pokemon
        ├── Pokemon - Blue Version (USA, Europe) (SGB Enhanced).gb
        ├── Pokemon - Red Version (USA, Europe) (SGB Enhanced).gb
        └── Pokemon - Yellow Version - Special Pikachu Edition (USA, Europe) (CGB+SGB Enhanced).gb

```

--------------------------------

### Trainer game name examples

Source: https://igir.io/roms/filtering

Example game names that are considered trainers.

```plaintext
Qix Adventure (J) [C][t1]
R-Type DX (U) [C][t2]

```

--------------------------------

### Example input ROMs from multiple consoles

Source: https://igir.io/output/path-options

This example shows a set of ROMs from multiple consoles combined in one input directory before processing with igir.

```plaintext
ROMs-Input/
├── Pokemon - Blue Version (USA, Europe) (SGB Enhanced).gb
├── Pokemon - Crystal Version (USA, Europe) (Rev 1).gbc
├── Pokemon - Emerald Version (USA, Europe).gba
├── Pokemon - Gold Version (USA, Europe) (SGB Enhanced) (GB Compatible).gbc
├── Pokemon - Red Version (USA, Europe) (SGB Enhanced).gb
├── Pokemon - Ruby Version (USA, Europe) (Rev 2).gba
├── Pokemon - Sapphire Version (USA, Europe) (Rev 2).gba
├── Pokemon - Silver Version (USA, Europe) (SGB Enhanced) (GB Compatible).gbc
└── Pokemon - Yellow Version - Special Pikachu Edition (USA, Europe) (CGB+SGB Enhanced).gb

```

--------------------------------

### Hacked game name examples

Source: https://igir.io/roms/filtering

Example game names that are considered hacks.

```plaintext
Kirby's Dream Land 2 (U) [S][h1] (Sound Test)
Pokemon - Blue Version (UE) [S][h2]
Q-bert II (UE) [h1C]

```

--------------------------------

### Pirated game name examples

Source: https://igir.io/roms/filtering

Example game names that are considered pirated.

```plaintext
Flipull (J) [p1]
Super Mario 4 (Unknown) (Ja) (Pirate)
Super Robot Taisen Final Vol.1 (Unl) [C][p2]

```

--------------------------------

### Example input ROMs directory

Source: https://igir.io/output/path-options

Shows the input directory structure with ROMs that do not all share the same first letter, used as the example for --dir-letter.

```plaintext
ROMs-Input/
├── Kirby's Dream Land (USA, Europe).gb
├── Kirby's Dream Land 2 (USA, Europe) (SGB Enhanced).gb
├── Pokemon - Blue Version (USA, Europe) (SGB Enhanced).gb
├── Pokemon - Red Version (USA, Europe) (SGB Enhanced).gb
├── Pokemon - Yellow Version - Special Pikachu Edition (USA, Europe) (CGB+SGB Enhanced).gb
├── Super Mario Land (World) (Rev 1).gb
└── Super Mario Land 2 - 6 Golden Coins (USA, Europe) (Rev 2).gb

```

--------------------------------

### Overdump game name examples

Source: https://igir.io/roms/filtering

Example game names that are considered overdumps.

```plaintext
Castlevania II - Belmont's Revenge (U) [o1]
Cave Noire (J) [o2]

```

--------------------------------

### Example output directory structure after subsequent sort

Source: https://igir.io/usage/basic

Shows the expected structure of the ROMs-Sorted directory after running the subsequent sort command. New ROMs have been added to the existing collection.

```text
ROMs-Sorted/
├── Nintendo - Game Boy
│   ├── Pokemon - Blue Version (USA, Europe) (SGB Enhanced).zip
│   ├── Pokemon - Red Version (USA, Europe) (SGB Enhanced).zip
│   └── Pokemon - Yellow Version - Special Pikachu Edition (USA, Europe) (CGB+SGB Enhanced).zip
├── Nintendo - Game Boy Advance
│   ├── Pokemon - Emerald Version (USA, Europe).zip
│   ├── Pokemon - Ruby Version (USA, Europe) (Rev 2).zip
│   └── Pokemon - Sapphire Version (USA, Europe) (Rev 2).zip
└── Nintendo - Game Boy Color
    ├── Pokemon - Crystal Version (USA, Europe) (Rev 1).zip
    └── Pokemon Pinball (USA, Australia) (Rumble Version) (SGB Enhanced) (GB Compatible).zip

```

--------------------------------

### Fixed game name examples

Source: https://igir.io/roms/filtering

Example game names that are considered fixed.

```plaintext
Black Bass - Lure Fishing (U) [C][f1]
Bugs Bunny - Crazy Castle 3 (J) [C][f2]

```

--------------------------------

### Typical RomVault directory structure

Source: https://igir.io/misc/alternatives

Reference directory layout for a typical RomVault setup, showing DatRoot, RomRoot, and ToSort folders.

```text
ROMVault_V3.7.4/
├── DatRoot
│   ├── No-Intro Love Pack (PC) (2025-05-09)
│   │   ├── No-Intro
│   │   │   ├── Sega - Game Gear (Parent-Clone) (20241203-185356).dat
│   │   │   ├── Sega - Master System - Mark III (Parent-Clone) (20241225-050512).dat
│   │   │   ├── Sega - Mega Drive - Genesis (Parent-Clone) (20250210-102212).dat
│   │   │   └── ...
│   │   └── Non-Redump
│   │       ├── Non-Redump - Nintendo - Nintendo GameCube (Parent-Clone) (20250118-063947).dat
│   │       ├── Non-Redump - Nintendo - Wii (Parent-Clone) (20241203-105832).dat
│   │       ├── Non-Redump - Nintendo - Wii U (Parent-Clone) (20231229-065143).dat
│   │       └── ...
│   └── Redump (2025-05-09)
│       ├── Sony - PlayStation - Datfile (10853) (2025-05-09 17-16-34).dat
│       ├── Sony - PlayStation 2 - Datfile (11623) (2025-05-09 15-01-56).dat
│       ├── Sony - PlayStation - Datfile (10853) (2025-05-09 17-16-34).dat
│       └── ...
├── RomRoot
│   ├── No-Intro Love Pack (PC) (2025-05-09)
│   │   ├── No-Intro
│   │   │   └── ...
│   │   └── Non-Redump
│   │       └── ...
│   └── Redump (2025-05-09)
│       └── ...
├── ROMVault37.exe
└── ToSort
    └── ...

```

--------------------------------

### Cracked game name examples

Source: https://igir.io/roms/filtering

Example game names that are considered cracked.

```plaintext
Jet Set Willy (1984)(Software Projects)[cr]
Buck Rogers - Countdown to Doomsday v1.0 (1991)(SS1)(Disk 1 of 3)[cr2][FD installed]
Dungeon Master (1987)(FTL)[cr 42-Crew]

```

--------------------------------

### Alpha game name examples

Source: https://igir.io/roms/filtering

Example game names that are considered alphas.

```plaintext
Isle Quest (World) (v0.1c) (Alpha) (Aftermarket) (Homebrew)
Sword (Alpha) (PD) [C]

```

--------------------------------

### Common npm Commands

Source: https://igir.io/contributing

Shows three npm commands for running, testing, and packaging. `npm start` runs Igir, `npm test` runs tests, `npm pack` creates a tarball.

```bash
npm start -- [arguments..]
npm test
npm pack

```

--------------------------------

### Unlicensed game name examples

Source: https://igir.io/roms/filtering

Example game names that are considered unlicensed.

```plaintext
4 in 1 (Europe) (4B-002, Sachen) (Unl)
Caihong Zhanshi - Rainbow Prince (Taiwan) (Unl)

```

--------------------------------

### Example file tree for glob patterns

Source: https://igir.io/input/file-scanning

A sample directory structure used to illustrate glob pattern examples. It shows a typical ROM collection with gb, gba, and gbc subdirectories.

```text
.
├── gb
│   ├── Bomberman GB (USA, Europe) (SGB Enhanced).gb
│   └── [BIOS] Nintendo Game Boy Boot ROM (World) (Rev 1).gb
├── gba
│   └── misc
│       ├── Dragon Ball Z - The Legacy of Goku II International (Japan).gba
│       └── [BIOS] Game Boy Advance (World).gba
└── gbc
    ├── Legend of Zelda, The - Link's Awakening DX (USA, Europe) (Rev 2) (SGB Enhanced) (GB Compatible).gbc
    └── [BIOS] Nintendo Game Boy Color Boot ROM (World) (Rev 1).gbc

```

--------------------------------

### Install npm Dependencies

Source: https://igir.io/contributing

Installs third-party dependencies using npm package manager.

```bash
npm install

```

--------------------------------

### BIOS game name examples

Source: https://igir.io/roms/filtering

Example game names that are considered BIOS files.

```plaintext
[BIOS] Nintendo Game Boy Boot ROM (World) (Rev 1)
[BIOS] Nintendo Game Boy Color Boot ROM (World) (Rev 1)

```

--------------------------------

### GNU GPL notice for new programs

Source: https://igir.io/license

Use this notice to apply the GNU General Public License to a new program. Attach it to the start of each source file, including the copyright line and a pointer to the full notice. The text includes the warranty disclaimer and a link to the license.

```text
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year>  <name of author>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
```

--------------------------------

### Run Igir with a No-Intro DAT zip using --dat

Source: https://igir.io/dats/introduction

Use this command to run Igir with a downloaded No-Intro DAT zip file. The --dat option accepts a path, glob, or URL, and the --input option specifies the ROM input directory. This is the recommended setup for organizing ROMs with Igir.

```shell
igir [commands..] --dat "No-Intro*.zip" --input <input>

```

--------------------------------

### Igir region parsing examples

Source: https://igir.io/roms/filtering-preferences

Example game names that Igir can parse regions from, including games with multiple regions. The list shows USA, Japan, Europe, and Spain examples with their region codes.

```text
USA:
  10-Pin Bowling (USA)
  Addams Family, The - Pugsley's Scavenger Hunt (USA, Europe)
  Castelian (U) [!]

Japan:
  Dragon Quest I & II (J) [C][!]
  Taikyoku Renju (Japan) (En,Ja)

Europe:
  Adventures of Lolo (Europe) (SGB Enhanced)
  Castlevania Adventure, The (E) [!]
  Soccer (Europe, Australia) (En,Fr,De) (SGB Enhanced)

Spain:
  Dragon Ball Z - Guerreros de Leyenda (S) [C][!]
  Star Trek - The Next Generation (Spain)
```

--------------------------------

### Example DAT directory structure

Source: https://igir.io/output/path-options

Example of a DAT directory structure with two subdirectories containing DAT files. ROMs matched to these DATs will use the relative dirname in the output.

```text
DATs/
├── No-Intro Love Pack (PC) (2025-05-09)
│   └── No-Intro
│      ├── Sega - Game Gear (Parent-Clone) (20241203-185356).dat
│      ├── Sega - Master System - Mark III (Parent-Clone) (20241225-050512).dat
│      ├── Sega - Mega Drive - Genesis (Parent-Clone) (20250210-102212).dat
│      └── ...
└── Redump (2025-05-09)
    ├── Sony - PlayStation - Datfile (10853) (2025-05-09 17-16-34).dat
    ├── Sony - PlayStation 2 - Datfile (11623) (2025-05-09 15-01-56).dat
    ├── Sony - PlayStation - Datfile (10853) (2025-05-09 17-16-34).dat
    └── ...

```

--------------------------------

### Igir language parsing examples

Source: https://igir.io/roms/filtering-preferences

Example game names that Igir can parse languages from, including games with multiple languages. The list shows English, Japanese, and Spanish examples with their language codes in parentheses.

```text
English:
  Donkey Kong (Japan, USA) (En) (SGB Enhanced)
  Dr. Franken (USA)
  Dragon's Lair - The Legend (Europe)
  Gear Works (U) [!]

Japanese:
  Final Reverse (Japan)
  Makai Toushi Sa-Ga (World) (Ja) (Rev 1) (Collection of SaGa)
  Ohasuta Dance Dance Revolution GB (J) [C][!]

Spanish:
  Humans, The (Europe) (En,Fr,De,Es,It)
  Pokemon - Edicion Azul (Spain) (SGB Enhanced)
  Rugrats en Paris - La Pelicula (S) (M2) [C][!]
```

--------------------------------

### Example output directory structure after first-time sort

Source: https://igir.io/usage/basic

Shows the expected structure of the ROMs-Sorted directory after running the first-time sort command. ROMs are organized into system-specific subdirectories and named according to the No-Intro DATs.

```text
ROMs-Sorted/
├── Nintendo - Game Boy
│   ├── Pokemon - Blue Version (USA, Europe) (SGB Enhanced).zip
│   └── Pokemon - Yellow Version - Special Pikachu Edition (USA, Europe) (CGB+SGB Enhanced).zip
├── Nintendo - Game Boy Advance
│   ├── Pokemon - Emerald Version (USA, Europe).zip
│   └── Pokemon - Sapphire Version (USA, Europe) (Rev 2).zip
└── Nintendo - Game Boy Color
    ├── Pokemon - Crystal Version (USA, Europe) (Rev 1).zip
    └── Pokemon Pinball (USA, Australia) (Rumble Version) (SGB Enhanced) (GB Compatible).zip

```

--------------------------------

### Unofficial translation game name examples

Source: https://igir.io/roms/filtering

Example game names that are considered unofficial translations.

```plaintext
Duck Tales (E) [T-Ger]
Final Fantasy Legend II (U) [T+Fre]

```

--------------------------------

### --dir-game-subdir <mode> option syntax

Source: https://igir.io/output/path-options

Shows the command-line option syntax for --dir-game-subdir. The mode can be 'never', 'multiple' (default), or 'always'.

```text
--dir-game-subdir <mode>
```

--------------------------------

### Pending dump game name example

Source: https://igir.io/roms/filtering

Example game name that is considered a pending dump.

```plaintext
Cheetah Men II (Active Enterprises) [!p]

```
Tokens:
Raw