Plugin Setup

This guide details the process for integrating an emulation collection into Jellyfin for metadata management and direct playback.

---

1. Plugin Configuration

Before adding your media, you should configure the plugin to communicate with external game databases.

• Navigate to Dashboard and select JellyEmu.
• Locate and select the Settings tab.
• Input your IGDB API Key (Client ID and Client Secret).
• Input your RAWG API Key.
• Input your SteamDBGrid API Key.
• Save your changes. This ensures the metadata providers are authenticated and ready to fetch game data.

---

2. Library Creation

With the plugin configured, you can now create the library to house your ROMs.

• Go to Dashboard and select Libraries.
• Click Add Media Library.
• Select Books as the Content Type. Note: This specific type is required for the plugin to map game data correctly within the Jellyfin database.
• Assign a name such as Video Games and add the folder path where your ROMs are stored.
• Under the Metadata Downloaders section, ensure that IGDB and RAWG are checked/enabled.
• Finalize the library creation by clicking OK.

---

3. Folder Structure

With your library created, this is where you create your accepted folder structure for your roms using the structure below matched to supported platforms.

Target Platform	Accepted Folder Names
Nintendo Entertainment System (NES)	nes, famicom, nintendo entertainment system
Super Nintendo (SNES)	snes, super nintendo, super famicom, super nintendo entertainment system
Nintendo 64	n64, nintendo 64
Game Boy / Color	gb, game boy, gameboy, gbc, game boy color, gameboy color
Game Boy Advance	gba, game boy advance, gameboy advance
Nintendo DS	nds, nintendo ds, ds
Virtual Boy	vb, virtual boy
Sega Master System	sms, master system, sega master system
Sega Genesis / Mega Drive	genesis, sega genesis, mega drive, sega mega drive, md
Sega Game Gear	gg, game gear, sega game gear
Sega Saturn	ss, sega saturn
Sega CD	sega cd, segacd, mega cd, sega-cd
Sega 32X	32x, sega 32x
PlayStation 1	psx, ps1, playstation, playstation 1, ps one
Atari 2600	atari 2600, 2600
Atari 7800	atari 7800, 7800
Atari Lynx	lynx, atari lynx
Atari Jaguar	jaguar, atari jaguar
WonderSwan	ws, wonderswan, wonder swan
TurboGrafx-16 / PC Engine	pce, turbografx, turbografx-16, turbografx 16, pc engine
ColecoVision	coleco, colecovision
NeoGeo Pocket / Color	ngp, neogeo pocket, neo geo pocket, ngpc
Pico-8	pico-8, pico, pico8

Example:

/ROMs/
 ├── /SNES/
 │    └── Super Mario World.sfc          (Platform: SNES)
 ├── /PlayStation/
 │    ├── /Final Fantasy VII/
 │    │    └── Disc 1.chd                (Platform: PlayStation)
 └── /Sega Genesis/
      └── Sonic The Hedgehog.md          (Platform: Sega Genesis)

---

4. Adding Roms

With the folder structure setup, this is the one of the last steps, adding roms to your folders created in step 3, be sure to follow the supported platforms and extensions list below.

Platform	Common Extensions
Nintendo (NES)	.nes
Super Nintendo (SNES)	.sfc, .smc
Game Boy (GB)	.gb
Game Boy Color (GBC)	.gbc
Game Boy Advance (GBA)	.gba
Virtual Boy (VB)	.vb
Nintendo DS (NDS)	.nds
Nintendo 64 (N64)	.n64, .z64
PlayStation (PSX)	.iso, .bin, .cue, .chd
PlayStation Portable (PSP)	.iso, .cso
Sega Genesis / Mega Drive	.md, .gen, .bin
Sega CD	.iso, .bin, .cue, .chd
Sega Game Gear	.gg
Sega Saturn	.iso, .bin, .cue
Sega 32X	.32x
Sega Master System	.sms
Atari 2600	.a26, .bin
Atari 5200	.a52, .bin
Atari 7800	.a78, .bin
Atari Jaguar	.j64, .jag
Atari Lynx	.lnx
MAME / Arcade / CPS	.zip, .7z
3DO	.iso, .bin, .cue
Commodore 64	.d64, .g64, .t64
Commodore 128	.d64, .d81
Commodore PET	.d64, .t64
Commodore Plus/4	.d64
Commodore VIC-20	.d64
Amiga	.adf, .ipf, .lha
ColecoVision	.col, .rom
PC Engine / TurboGrafx-16	.pce, .bin, .cue
PC-FX	.bin, .cue
Neo Geo Pocket	.ngp, .ngc
WonderSwan	.ws, .wsc
DOS	.exe, .com, .conf, .zip
Pico-8	.p8, .p8.png, .zip

---

5. Scan

This is the final step, you need to go to your Dashboard, and click "Scan All Libraries".