Setting up Nostlan

Nostlan is meant to be really easy to setup if you use the Nostlan file structure for your emulators and I recommend it! It is entirely OPTIONAL though, if you don't use it you can pick the locations of your emulators and game libraries as you use Nostlan.

Nostlan File Structure

📁 emu (root folder can have any name)
├─┬ 📁 arcade
│ ├─┬ 📁 mame
│ │ └── 🎮 mame64.exe
│ └─┬ 📁 games
│   ├── 💿 1942.zip
│   └── 💿 spang.zip
├─┬ 📁 ds
│ ├─┬ 📁 melonds
│ │ └── 🎮 melonDS.exe
│ └─┬ 📁 games
│   ├── 💿 Mario & Luigi - Partners in Time.nds
│   └── 💿 Mario & Luigi - Partners in Time.sav
├─┬ 📁 gba
│ ├─┬ 📁 mgba
│ │ └── 🎮 mGBA.exe
│ └─┬ 📁 games
│   ├── 💿 Mario & Luigi - Superstar Saga.gba
│   └── 💿 Mario & Luigi - Superstar Saga.sav
├─┬ 📁 n3ds
│ ├─┬ 📁 citra
│ │ └─┬ 📁 nightly-mingw
│ │   └── 🎮 citra-qt.exe
│ └─┬ 📁 games
│   └── 💿 Super Mario 3D Land.3ds
├─┬ 📁 nostlan
│ └── 📁 themes
├─┬ 📁 ps2
│ ├─┬ 📁 pcsx2
│ │ └── 🎮 pcsx2.exe
│ └─┬ 📁 games
│   └── 💿 Bully.iso
├─┬ 📁 ps3
│ └─┬ 📁 rpcs3
│   ├─┬ 📁 dev_hdd0
│   │ └─┬ 📁 game
│   │   ├── 💿 BLES00760/USRDIR/EBOOT.BIN
│   │   └── 💿 BLUS30591/USRDIR/EBOOT.BIN
│   └── 🎮 rpcs3.exe
├─┬ 📁 snes
│ ├─┬ 📁 bsnes
│ │ └── 🎮 bsnes.exe
│ └─┬ 📁 games
│   └── 💿 Super Mario World.sfc
├─┬ 📁 switch
│ ├── 📁 yuzu
│ └─┬ 📁 games
│ 	└── 💿 Super Mario Odyssey.xci
├─┬ 📁 wii
│ ├─┬ 📁 dolphin
│ │ ├── 📁 User
│ │ ├── 📄 portable.txt
│ │ └── 🎮 Dolphin.exe
│ └─┬ 📁 games
│   ├── 💿 Super Mario Sunshine.gcz
│   ├── 💿 Super Smash Bros Melee.iso
│   └── 💿 sm64.wad
├─┬ 📁 wiiu
│ ├─┬ 📁 cemu
│ │ └── 🎮 Cemu.exe
│ └─┬ 📁 games
│   └── 💿 Mario Kart 8/code/Turbo.rpx
└─┬ 📁 xbox360
  ├─┬ 📁 xenia
  │ └── 🎮 xenia.exe
  └─┬ 📁 games
  	├── 💿 Halo 4 (disc a).iso
  	└── 💿 Halo 4 (disc b).iso

Nostlan was designed to OPTIONALLY use this template file structure. The default game library for every system will be its games folder. As an exception, Nostlan will default to the internal game library of emulators that store games in file structures meant to mimic the system being emulated. For example, RPCS3 has an internal game library that will be located at emu/ps3/rpcs3/dev_hdd0/game.

Windows users should not store emulator apps or games in Program Files or any other folder that Nostlan will not have read/write access to. Nostlan will look for emulator executables in the emu/${sys}/${emu} folder or the default install location of that emulator (no need to move Yuzu).

On macOS, Nostlan will look for emulator apps in /Applications or emu/${sys}/${emu}. Nostlan needs read/write permission to the install folder. You can have the nostlan.app in /Applications but don't install your emulator folder emu there.

On Linux, Nostlan will look for emulator apps in their default install locations or in emu/${sys}/${emu}.