File Naming - YAMJ/yamj-v2 GitHub Wiki

How to name the video files

Intro

The aim of the MovieJukebox file name parser is to extract as much information as possible from the video file names, which are commonly used. The idea is to process almost all of the usual naming conventions.

The intention is that you will not normally have to rename files.

If you find that MovieJukebox isn't recognising a video filename, then follow these guidelines and you should be able to eliminate the problem. However, in some cases, no amount of tweaking the filename will result in a correct match, in which case a NFO file should be used.

How does the file name parser work?

Dividers

To separate the different parts (called Tokens) of the filename MovieJukebox has a concept of "dividers". These are characters that are used to seperate parts of the filename so that YAMJ can process them. Characters that can be used to seperate the filename parts are:

[()
.
_
-

The Braces and brackets [](])() are conceptually used to group items together and should not be used to group dissimilar parts of the filename or MovieJukebox may not be able to understand the Token.

Example of a wrong use

Blade Runner[1982_FRENCH_DVDRip].avi

MovieJukebox will try to interpret "[1982_FRENCH_DVDRip]" as a single phrase and will fail. A better naming would be any of the following:

Examples of correct use

Blade Runner.(1982).(FRENCH).(DVDRip).avi

The "-" Character

The minus (-) character is a special character within MovieJukebox file names. It denotes the end of the scanable file name and the start of the file or episode title. Anything after the "-" will NOT be used in determining the video name or other attributes and only used as the title for the video.

Cleaning

As first step MovieJukebox "removes" all redundant parts from file name (the file is not renamed, MovieJukebox just works with name internally). The parts to be ignored are defined in the configuration file. See parameters: PropertiesConfiguration#filename.scanner.skip.keywords Skip Keywords and Version Keywords. Everything configured within these parameters is completely ignored by further processing.

All "removed" keywords are counted as a divider.

Name

Movie name should be at the first position in the file name. It can be divided by spaces, dots or underscores.

Example

Blade Runner.mkv

Year

Year must be in YYYY format (4 digits). Must be between 1919 - 2099. Must come right after movie name. Can be in square or round brackets.

Examples

Blade Runner 1982.avi     << Ok
Blade Runner (1982).mkv     << Best

Languages

Languages are used for displaying a national flag on the poster/thumbnails view of the jukebox. If more than one language is detected, then the flags will be combined to indicate this.

All languages from the file name are extracted and stored in the video XML. They are also removed from the possible video name for searching. See Filename Language for more information.

Examples

Blade Runner (1982).FR.mkv
Blade Runner [GER].mkv
Blade Runner (1982).SPANISH.mkv

Multi-Part Videos

See MultiPartVIdeos for information on how to name the videos with more than one part.

Episodes, Seasons

See Boxed Sets

Trailers and other extras

For trailers: See [Trailers#Trailers_Naming.

Examples

Blade Runner (1982) [Bonus- Title of the bonus].mkv

Movie IDs

Starting with v2.1 you can now specify an ID in the filename (so you don't have to have a NFO file.

The format is similar to sets:

filename [<moviedb> <id>](ID).avi

There MUST be a space between ID and <moviedb> and a space or '-' between that and the <id>.

For a list of the valid <moviedb> settings see the Plugins page.

Example

BR [IMDB tt0083658](ID).avi

This will correctly identify the file as Blade Runner

Excluding a Directory

If you wish to exclude a specific directory from the scan, you can create a file named ".mjbignore" in the directory. This will stop MovieJukebox from scanning this directory and all sub-directories.

For windows you will have to create the file using the following command from a DOS / CMD window

echo >.mjbignore

Examples

**File name** **Video Name** **Year**
{{{My Best Movie.avi}}} My Best Movie -
{{{My.Best.Movie.avi}}} My Best Movie -
{{{My_Best_Movie_2000.avi}}} My Best Movie 2000
{{{1984.DivX.avi}}} 1984 -
{{{2012.(2009).mkv}}} 2012 2009
⚠️ **GitHub.com Fallback** ⚠️