Closed Alpha
FluxPlay is currently in Closed Alpha. This documentation is a work in progress and may be incomplete or out of date. Features, UI, and APIs are subject to change without notice. For access inquiries, please contact [email protected].
SCANNING GUIDE
Learn how FluxPlay discovers, identifies, and organizes your media files. Proper folder structure ensures accurate metadata matching.
How Scanning Works
Discovery
Finds media files in library folders
Parsing
Extracts title, year, season/episode from filename
Matching
Looks up in external databases
Enrichment
Downloads metadata, artwork, ratings
Storage
Saves to FluxPlay database
Folder Structure Examples
Movies
Movies/
├── Inception (2010)/
│ ├── Inception (2010).mkv
│ └── Inception (2010).en.srt
├── The Matrix (1999)/
│ └── The Matrix (1999).mkv
└── Blade Runner (1982)/
├── Blade Runner (1982) - Final Cut.mkv
└── Blade Runner (1982) - Theatrical.mkvEach movie in its own folder named Title (Year)
TV Shows
TV Shows/
└── Breaking Bad (2008)/
├── Season 01/
│ ├── S01E01 - Pilot.mkv
│ └── S01E02 - Cat's in the Bag.mkv
├── Season 02/
│ └── S02E01.mkv
└── Specials/
└── S00E01 - Making Of.mkvOrganize by Series → Season → Episode with S01E01 format
Music
Music/
└── Artist Name/
├── Album Name (Year)/
│ ├── 01 - Track Title.flac
│ ├── 02 - Track Title.flac
│ └── cover.jpg
└── Another Album/
└── 01 - Track.mp3Artist → Album structure. Embedded tags take priority.
Books & Comics
Comics/
└── Batman/
├── Batman v01.cbz
├── Batman v02.cbz
└── Specials/
└── Batman Annual.cbz
Books/
└── Author Name/
└── Book Title/
└── Book Title.epubVolume numbers help with ordering
Naming Conventions
| Media Type | Format | Example |
|---|---|---|
| Movie | Title (Year) | Inception (2010).mkv |
| Movie (IMDb) | Title (Year) [imdbid-xxx] | The Matrix (1999) [imdbid-tt0133093].mp4 |
| TV Episode | Show - S01E01 - Title | Breaking Bad - S01E01 - Pilot.mkv |
| TV Episode (alt) | S01E01 | S01E01.mkv |
| Multi-Episode | S01E01-E03 | Show - S01E01-E03.mkv |
| Music | Track# - Title | 01 - Song Name.flac |
| Comic/Manga | Series v## | Batman v01.cbz |
Scan Types
Only processes new and changed files
Re-processes all files in the library
Re-downloads metadata without re-scanning
Ignoring Files
Create a .ignore or .plexignore file in any folder to exclude content from scanning.
Example .ignore File
# Skip sample files *sample* *SAMPLE* # Skip specific folders Featurettes/ Extras/ # Skip by extension *.nfo *.txt *.partial
Common Patterns
*sample*Any file with "sample"*.txtAll text filesExtras/Entire Extras folder*.partialIncomplete downloadsLocal Metadata Overrides
NFO Files
XML-based metadata for Kodi/Emby compatibility
ComicInfo.xml
Series, volume, credits, and tags
OPF Files
Calibre-compatible ebook metadata