Documentation

Organising your library

How to name and arrange your films, television, music, music videos and home videos so Home Stream recognises every one of them.

The short version

A scan never moves, renames or changes your files. It only reads them. If a file goes missing, for example because a drive didn't mount, the server notes it and keeps its entry until the file comes back. The few things that do change files are listed at the bottom of this page, and you start every one of them yourself.

Films

Home Stream finds a video at any depth inside your films folder. A film can sit loose beside others or in a folder of its own, and both can be mixed in one library.

Films/
  Big Buck Bunny (2008).mp4
  Sintel (2010).mkv
  Harbour Lights (2019)/
    Harbour Lights (2019).mkv
    The Lighthouse-deleted.mkv
    Featurettes/
      Building the Pier.mkv

Years

Put the year in round or square brackets after the title, for example Sintel (2010).mkv. Dots and underscores count as spaces. A film without a year still appears, but it's harder to match, because the year is what tells a remake from the original.

Loose, or in a folder of its own

A loose film is fine until you want more than one special feature of the same kind. A folder of its own allows as many as you like. To count as the film's own folder, the folder must have exactly the same name as the film's file, minus the extension, like Harbour Lights (2019)/Harbour Lights (2019).mkv.

Films matched before

If a file or folder name already contains a TMDb id, like {tmdb-603}, the server uses it to match exactly. It also uses an .nfo or .plexmatch file beside the film. Without any of these, it searches by the title and year in the name.

The title you see comes from the match, not from the file name. When you correct a match, the file is renamed to agree. See the bottom of this page.

Television

Give each series a folder of its own, and inside it a folder for each season.

Television/
  The Lighthouse Keepers/
    Season 1/
      The Lighthouse Keepers - S01E01 - Arrival.mkv
      The Lighthouse Keepers - S01E02 - The Storm.mkv
    Season 2/
      The Lighthouse Keepers - S02E01 - Return.mkv
    Specials/
      The Lighthouse Keepers - S00E01 - Christmas.mkv

Season folders

Episode numbers

S01E01, in capitals or small letters, is the most reliable form. E01, Episode 1 and a leading 01 - also work. A file with no number at all is numbered by its place in the folder, so it's worth avoiding. Episode titles come from the match, so the title in a file name only matters until then.

Two episodes in one file

Files named like S01E01-E02, S01E01E02 or S01E01-02 are recorded as the first episode only. The scan result and the library problems banner both say so. The fix is to split the file in two. Each half then gets its own title, resume position and watched mark.

Music

Music is two folders deep: the artist, then the album, with the tracks directly inside the album folder.

Music/
  The Harbour Band/
    Low Tide/
      01 - Low Tide.flac
      02 - Fog Horn.flac
  Various Artists/
    Songs of the Sea/
      01 - Shanty.mp3

Tags come first

A track's title, number and disc come from the tags inside the file. The file name is only used when a tag is missing. The artist and album come from the folder names, and a tag never overrides them. When a track's own artist differs from the album's, as on a compilation, the track's artist comes from its tags. Home Stream never writes to your tags.

Tags are read when a file is first found. To re-read them across music already in your library, use Settings → Library Maintenance → Re-read Music Tags. Nothing on the drive changes.

Albums on more than one disc

Music videos

Music videos can go in a folder of their own, or beside the songs in an album folder.

Music Videos/
  The Harbour Band/
    Low Tide (2019)-video.mp4
    Live at the Pier (2021)-concert.mkv
    Low Tide/
      Fog Horn (2019)-lyrics.mp4
    Interviews/
      Talking Tides.mp4
  The Harbour Band - Sea Shanty.mp4

Music/
  The Harbour Band/
    Low Tide/
      01 - Low Tide.flac
      Low Tide-video.mp4

The kind

The kind goes at the end of the name, after a hyphen: -video, -live, -lyrics, -concert, -interview, -behindthescenes or -documentary. Spaces around the hyphen are fine (Low Tide - live.mp4). -featurette is read as behind the scenes, and -clip and -short as videos. A name that gives no kind is a video.

A folder can give the kind instead: Videos, Clips, Concerts, Interviews, Behind The Scenes, Featurettes or Documentaries. Live and Lyrics aren't read as kinds, because both are ordinary album names.

Year, title and artist

Special features

Trailers, deleted scenes, featurettes and the like are attached to the film or series they belong to. They don't show up as titles of their own. You can mark one with a suffix on its name or by putting it in a named folder. Capitals and spaces don't matter.

For films

For television

Stick to the names above. A folder called Extras, for example, isn't one of them. Inside a series it's read as a season, and a video in an unrecognised folder inside your films folder is read as a film.

Trailers you keep as files

If a film's own trailer is in your library (Film (Year)-trailer.mkv, or in a Trailers folder in the film's folder), the Trailer button plays it instead of an online trailer. If there are several, the longest plays. The trailer settings only control online trailers. A trailer you keep is treated like any other special feature, and anyone allowed to watch the film can watch it.

Editions

A director's cut, a colourised print or a version with a commentary can sit beside the film it belongs to and appear as one title with a choice of version. Mark each version with an {edition-…} tag at the end of its name.

Films/
  Harbour Lights (2019).mkv
  Harbour Lights (2019) {edition-Director's Cut}.mkv
  Harbour Lights (2019) {edition-Black and White}.mkv

Only the tag makes a version. Two copies of a film side by side without a tag, such as a 1080p and a 4K copy, appear as two separate films.

What plays

Home Stream doesn't convert anything. Each device plays the file exactly as it is, so a file that device can't open won't play on it.

Some formats can't be opened by the browser or by the iPhone and iPad apps. The server marks those files as unable to play and says why:

The fix is to convert the file to MP4, with H.264 video. When the video inside is already H.264, repackaging it as MP4 is enough and nothing needs re-encoding.

Disc images (.iso) aren't read. After each scan, the server tells you how many files it skipped because it doesn't read their format, and which formats they were.

Only formats that fail everywhere are marked. A file that plays on one device but not another isn't marked.

Coming from Plex or Jellyfin

A library laid out for either works as it is:

Some folders belong to other programs and are skipped, including Plex's optimised Plex Versions, the bookkeeping folders a NAS writes and the system's recycle bins. Hidden files and folders, whose names start with a dot, are skipped too.

Three things aren't read:

Home videos

Home videos are switched off until you turn them on in Settings → Server → Home Videos. Then the administrator adds a home videos folder in Settings → Library Folders → Add a Folder. Home videos are kept apart from everything else, and child accounts can't see them.

Home Videos/
  1994/
    1994-12-25 Christmas morning.mp4
  2024/
    2024-08-10 Road trip.mp4
  Undated/
    Grandad's garden.mp4

When Home Stream does change your files

Each of these is something you do on purpose. None of them ever replaces a file that's already there. If the new name is taken, the file is left as it was.

All documentation · Next: Matching and metadata