Skip to content

Properties Configuration

stuart edited this page Mar 16, 2015 · 1 revision

List of the options in the moviejukebox.properties files and what they do

Properties

MovieJukebox utilises properties files to define user configurable parameters that change the default behaviour of MovieJukebox.

All of the default properties are stored in the properties/moviejukebox-default.properties file. This file should NOT be edited as it will be overwritten when you update your installation.

Instead, create a moviejukebox.properties file in your installation root folder to override the defaults. There is an example file provided in the properties folder that you can move to your installation root folder, and then you can copy the properties from the moviejukebox-default.properties file to this file.

This is a list of the current properties used in the properties files.

<wiki:toc max_depth="2" />


Movie Jukebox Main Parameters

mjb.libraryRoot

Directory or library XML file (see [of the video files to scan.

Used only if no library root is specified on the command line (see e603c22a559551a89d373640d2af69dd).

Default value

none

mjb.jukeboxRoot

Root directory in which the jukebox files are stored. This folder will contain the index.htm file and the jukebox detail folder.

Used only if no jukebox root is specified on the command line (see e603c22a559551a89d373640d2af69dd).

Default value

none

mjb.detailsDirName

Directory where the jukebox files are stored. The index.htm file is stored at the same level as this directory.

Default value

mjb.detailsDirName=Jukebox

mjb.jukeboxTempDir

Directory where the temporary jukebox files are stored. This directory is relative to the MovieJukebox directory and most NOT end in a "/" or ""

Default value

mjb.jukeboxTempDir=./temp

mjb.showMemory

Display the memory that !MovieJukebox is currently using and has allocated. This will also perform a more aggressive free memory process (garbage collection) and can help in low memory situations.

Default value

mjb.showMemory=false

Valid values

mjb.showMemory=true
mjb.showMemory=false

mjb.monitorJukeboxProperties

Monitor the jukebox property files for changes and automatically apply the appropriate !forceOverwite flags when changes are detected.

Default value

mjb.monitorJukeboxProperties=false

Valid values

mjb.monitorJukeboxProperties=false
mjb.monitorJukeboxProperties=true

If you set this property to "true" a file "jukebox_details.xml" will be created in the jukebox folder storing information about the properties listed below. On subsequent runs, this file is checked for changes with the current configuration and the appropriate Force Overwrite flags are set to force an update of the source data.

Changing the following properties will affect these Force Overwrite flags: ||Property||xml||html||thumbnail||poster||fanart||banner||videoimage||trailers|| ||userPropertiesName|| || || || || || || || || ||mjb.skin.dir|| ||Y||Y||Y|| || || || || ||fanart.movie.download|| || || || ||Y|| || || || ||fanart.tv.download|| || || || ||Y|| || || || ||mjb.includeEpisodePlots||Y|| || || || || || || || ||mjb.includeVideoImages||Y|| || || || || ||Y|| || ||mjb.includeWideBanners|| || || || || ||Y|| || || ||filename.scanner.skip.episodeTitle||Y||Y|| || || || || || || ||mjb.nbThumbnailsPerPage|| ||Y||Y|| || || || || || ||mjb.nbThumbnailsPerLine|| ||Y||Y|| || || || || || ||mjb.nbTvThumbnailsPerPage|| ||Y||Y|| || || || || || ||mjb.nbTvThumbnailsPerLine|| ||Y||Y|| || || || || || ||thumbnails.width|| ||Y||Y|| || || || || || ||thumbnails.height|| ||Y||Y|| || || || || || ||thumbnails.logoHD|| ||Y||Y|| || || || || || ||thumbnails.logoTV|| ||Y||Y|| || || || || || ||thumbnails.logoSet|| ||Y||Y|| || || || || || ||thumbnails.language|| ||Y||Y|| || || || || || ||posters.width|| ||Y|| ||Y|| || || || || ||posters.height|| ||Y|| ||Y|| || || || || ||posters.logoHD|| ||Y|| ||Y|| || || || || ||posters.logoTV|| ||Y|| ||Y|| || || || || ||posters.language|| ||Y|| ||Y|| || || || || ||trailers.rescan.days|| || || || || || || ||Y||

mjb.playerRootPath

This value is used as the default path when running from the command line (See CommanSyntax) without a library.xml file.

Default value

mjb.playerRootPath=file:///opt/sybhttpd/localhost.drives/HARD_DISK/Video/

mjb.extensions

This parameter lists the extensions that will be scanned by the !MovieJukebox. If you want to scan a new extension, then add it to this list. Conversely, if you do not want to scan an extension, then remove it from this list.

Default value

mjb.extensions=AVI DIVX MKV WMV M2TS TS RM QT ISO VOB MPG MOV MP4 M1V M2V M4V M2P TP TRP M2T MTS ASF RMP4 IMG

mjb.skin.dir

The skin to be used for the jukebox. To install a new skin, copy it to the skins directory and edit this property to point to the new skin directory.

The !MovieJukebox ships with four skins by default || Skin Name || SD/HD || Parameter || || default || HD || mjb.skin.dir=./skins/default || || sd || SD || mjb.skin.dir=./skins/sd || || gfb107 || HD || mjb.skin.dir=./skins/gfb107 || || gfb107-sd || SD || mjb.skin.dir=./skins/gfb107-sd ||

mjb.newdays.*

This property is two properties mjb.newdays.movie and mjb.newdays.tv. This is the number of days that a video file (either movie or TV Show) stays in the New category. This should be a integer only, use 0 (Zero) to disable the New category.

If you only require one category, set the other to 0 (Zero) to disable it. If both categories are enabled the master category "New" is created with both Movies and TV Shows in it. This can be disabled from the categories.xml file if desired.

Default value*

mjb.newdays.movie=7
mjb.newdays.tv=7

mjb.newcount.*

This property is two properties mjb.newcount.movie and mjb.newcount.tv. This is the number of videos to limit the New category to. This should be a integer only, use 0 (Zero) to disable the count leaving it unlimited.

This is used in conjunction with the mjb.newdays.* property.

Example 1: mjb.newdays.movie=30 mjb.newcount.movie=25 (the 25 most recent movies within the last 30 days)

Example 2: mjb.newdays.tv=30 mjb.newcount.tv=0 (all the TV shows within the last 30 days)

Note: If both these values are used, the New category will contain a superset of both Movies and TV Shows.

Default value

mjb.newcount.movie=0
mjb.newcount.tv=0

mjb.Library.hideWatched

Hide the watched videos from the new category.

Default value

mjb.Library.hideWatched=true

Valid values

mjb.Library.hideWatched=true
mjb.Library.hideWatched=false

complete.movies.enable

Enable the CompleteMovies.xml and RSS.xml output files

Default value

complete.movies.enable=true

Valid values

complete.movies.enable=true
complete.movies.enable=false

mjb.jpeg.quality

JPEG Compression Quality Values between 0 and 100 allowed - with 100 specifying minimum compression and maximum quality/filesize

Default value

mjb.jpeg.quality=75

mjb.myiHome.IP

Specify the IP address and port number of the myiHome server - not the NMT. This is inserted into the JSP playlist file. If you are not using myiHome DO NOT ENABLE this setting.

Example

mjb.myiHome.IP=http://192.168.2.100

mjb.genre.skip

List of genres to skip when scraping video information. These genres will not be saved in the video XML files

Example

mjb.genre.skip=action|adventure

mjb.xmlGenreFile

Specify the genres file used for consolidating/renaming genres, will only be used if mjb.filter.genres is true

Default value

mjb.xmlGenreFile=genres-default.xml

mjb.filter.genres

Enable or disable the genre filtering configured in the mjb.xmlGenreFile

Default value

mjb.filter.genres=false

Valid values

mjb.filter.genres=true
mjb.filter.genres=false

mjb.xmlCertificationFile

Specify the certification file used for consolidating and renaming certifications. Will only be used if mjb.filter.certification is true

Default value

mjb.xmlCertificationFile=certification-default.xml

mjb.filter.certification

Enable or disable the certification filtering configured in the mjb.xmlCertificationFile

Default value

mjb.filter.certification=false

Valid values

mjb.filter.certification=true
mjb.filter.certification=false

mjb.xmlCategoryFile

Specify the categories file used for enabling/disabling and renaming categories.

Default value

mjb.xmlCategoryFile=categories-default.xml

mjb.forceNFOEncoding

Force encoding of the XBMC XML in the NFO files, if not specified in standard way within XML. Set the parameter to AUTO or remove it to turn off the forced encoding

Example

mjb.forceNFOEncoding=ISO-8859-1

Default value

mjb.forceNFOEncoding=AUTO

mjb.sortTitle

The field that will be used to order the videos on the index pages.

Note: This will NOT overwrite any field set in the NFO file.

Valid values are: title, original, filename

  • title = The title as scraped from the internet sites (or NFO)
  • original = The original title (useful for non-English titles)
  • filename = The base filename
  • adopt_original = Same as original, but also sets original title as title in movie xml

Valid values

mjb.sortTitle=title
mjb.sortTitle=original
mjb.sortTitle=filename
mjb.sortTitle=adopt_original

Default value

mjb.sortTitle=title

mjb.excludeMultiPartBluRay

Multi part bluray is bluray disk that the main movie is spread around multiple files. Currently only 5% of the bluray disks are multi part.

The Popcorn Hour does not play these movies very well. There is a long gap between the parts that make many movies unwatchable. It is also very hard to attach subtitles to these multi part blurays.

Valid values

mjb.excludeMultiPartBluRay=false
mjb.excludeMultiPartBluRay=true

Default value

mjb.excludeMultiPartBluRay=true

mjb.playFullBluRayDisk

To play full !BluRay disk rips (for C-200) set this value to true, otherwise set it false to play the largest file on the disk

Valid values

mjb.playFullBluRayDisk=true
mjb.playFullBluRayDisk=false

mjb.nmjCompliant

Enable the NMJ compliant mode. If set to true, then NMJ ignore files will be respected

Valid values

mjb.nmjCompliant=true
mjb.nmjCompliant=false

mjb.imageRetryCount

The number of times to retry to download an image before aborting. You can set this to any integer value greater than 0.

Default value

mjb.imageRetryCount=3

mjb.playlist.IgnoreExtensions

This is a list of file extensions to ignore when generating a playlist. These should be extensions that don't work with playlists, such as full disk images (e.g. ISO & IMG)

Default value

mjb.playlist.IgnoreExtensions=ISO,IMG

mjb.playlist.generateMultiPart

Generate multipart playlists that allow the cycling of video parts. Note that this may break some skins that use this feature if it is disabled.

Valid values

mjb.playlist.generateMultiPart=true
mjb.playlist.generateMultiPart=false

mjb.Accept-Language

Tell the web server (i.e. IMDB) which language you prefer. IMDB uses this to determine in which language it should return the movie title. Google for "Accept-Language values" to see which values are allowed.

Default value

mjb.Accept-Language=

Suggested value

mjb.Accept-Language=en-US

mjb.rating.source

Where should the main rating be from?

Average will provide the average of all available ratings, or specify a source list of sites

Example

mjb.rating.source=imdb,rottentomatoes,average

This will use imdb, then rottentomatoes for a rating, if they aren't found it will use the average of any other ratings.

Use the moviedb setting from efb79b334e30bd0a993475cf4f137480

Default value

mjb.rating.source=average

mjb.rating.ignore

List of ignoring ratings to calculate average rating.

Example

mjb.rating.ignore=rottentomatoes

Default value

mjb.rating.ignore=

mjb.aspectRatioPrecision

Defines the precision that the aspect ratio is rounded to in the XML file.

Default value

mjb.aspectRatioPrecision=3

Valid values

mjb.aspectRatioPrecision=1
mjb.aspectRatioPrecision=2
mjb.aspectRatioPrecision=3

If the value is higher than 3, then 3 will be used.

mjb.language.delimiter

Delimiter to separate the languages in the XML files

Default value

mjb.language.delimiter= / 

mjb.language.audio.unknown

Use this language if no language set in audio code. If not set then UNKNOWN will be used.

Default value

mjb.language.audio.unknown=

Example

mjb.language.audio.unknown=en

Additional Movie Details

These properties control the additional details that are scraped from some sites.

mjb.scrapeAwards

Scrape information about awards the movie has recieved

Default value

mjb.scrapeAwards=false

Valid values

mjb.scrapeAwards=true
mjb.scrapeAwards=false

mjb.scrapeBusiness

Scrape information about the business details of the movie.

Default value

mjb.scrapeBusiness=false

Valid values

mjb.scrapeBusiness=true
mjb.scrapeBusiness=false

mjb.scrapeTrivia

Scrape trivia about the movie

Default value

mjb.scrapeTrivia=false

Valid values

mjb.scrapeTrivia=true
mjb.scrapeTrivia=false

Movie Settings

These properties affects each movie. This properties are mostly used to restrict the number of people or some movie value lengths.

movie.plot.maxLength

This is the maximum length of the movie plot. If the plot is longer than this value it will be truncated and the last three characters will be an ellipse (...)

Deprecated property: plugin.plot.maxlength

Default value

movie.plot.maxLength=500

movie.outline.maxLength

This is the maximum length of the movie outline. If the outline is longer than this value it will be truncated and the last three characters will be an ellipse (...)

Deprecated property: plugin.outline.maxlength

Default value

movie.outline.maxLength=300

movie.episodeplot.maxLength

This is the maximum length of an episode plot. If the episode plot is longer than this value it will be truncated and the last three characters will be an ellipse (...)

Deprecated property: plugin.plot.maxlength

Default value

movie.episodeplot.maxLength=500

movie.actor.maxCount

Count of actor per movie.

Deprecated property: plugin.people.maxCount.actor

Default value

movie.actor.maxCount=10

movie.director.maxCount

Count of director per movie.

Deprecated property: plugin.people.maxCount.director

Default value

movie.director.maxCount=2

movie.writer.maxCount

Count of writer per movie.

Deprecated property: plugin.people.maxCount.writer

Default value

movie.writer.maxCount=3

Index Sorting

These properties control the sorting of the index categories. Each index has it's own default sort method as displayed near the start of the log file.

indexing.sort.*

This property is used to identify the category to sort and what sorting algorithm to use.

The list of available categories to sort are || 3d || all || award || cast || certification || country || director || || genres || hd || library || movies || new || new-movie || new-tv || || rating || title || tvshows || unwatched || watched || writer || year ||

The list of available sorting algorithms || Sort || Description || || new || Sorting by the modified date of the files || || title || Sorting by the title of the video || || rating || Sorting by the rating of the video || || top250 || Sorting by the top250 rating of the video (movies only) || || year || Sorting by the release year of the video ||

Example Sorting the all category by the release year:

indexing.sort.all=year

indexing.sort.*.asc

This property is used to control the sorting of the algorithm in either ascending or descending format.

The same category name that is used in the indexing.sort.* property should be used here.

Default value

indexing.sort.*.asc=true

Valid values

indexing.sort.*.asc=true
indexing.sort.*.asc=false

Rotten Tomatoes

mjb.enableRottenTomatoes

Replace the ratings for movies with ones from RottenTomatoes

Default value

mjb.enableRottenTomatoes=false

Valid values

mjb.enableRottenTomatoes=true
mjb.enableRottenTomatoes=false

mjb.rottentomatoes.priority

Comma separated list of the scores/ratings to use. The first one found will be used.

mjb.rottentomatoes.priority=critics_score,audience_score,critics_rating,audience_rating

Force Overwrite

These parameters override some of the functionality in moviejukebox and allow you to control the creation of specific content. This is useful when you change something that YAMJ is not expecting.

Setting any of these parameters will cause the process to run longer.

mjb.forceXMLOverwrite

By default !MovieJukebox does not overwrite the XML files if they already exist. If this parameter is true, then the XML files will be overwritten every time that the !MovieJukebox is run.

Valid values

mjb.forceXMLOverwrite=false
mjb.forceXMLOverwrite=true

mjb.forceThumbnailsOverwrite

By default !MovieJukebox does not overwrite the generated thumbnail files if they already exist. If this parameter is true, then the tumbnails will be overwritten every time that the !MovieJukebox is run.

Valid values

mjb.forceThumbnailsOverwrite=false
mjb.forceThumbnailsOverwrite=true

mjb.forcePostersOverwrite

By default !MovieJukebox does not overwrite (download) the poster files if they already exist. If this parameter is true, then the poster files will be downloaded and overwritten every time that the !MovieJukebox is run.

Valid values

mjb.forcePostersOverwrite=false
mjb.forcePostersOverwrite=true

mjb.forceHTMLOverwrite

By default !MovieJukebox does not overwrite the html (skin) files if they already exist. If this parameter is true, then the html files will be overwritten every time that the !MovieJukebox is run. This is useful if you change skins, rather than deleting the files from the Jukebox directory.

Valid values

mjb.forceHTMLOverwrite=false
mjb.forceHTMLOverwrite=true

mjb.forceFanartOverwrite

By default !MovieJukebox does not overwrite the Fanart files if they already exist. If this parameter is true, then the files will be overwritten every time that the !MovieJukebox is run.

Valid values

mjb.forceFanartOverwrite=false
mjb.forceFanartOverwrite=true

mjb.forceTrailersOverwrite

By default !MovieJukebox does not rescan for trailers if they already exist. If this parameter is true, then the trailers will be rescan every time that the !MovieJukebox is run.

Valid values

mjb.forceTrailersOverwrite=false
mjb.forceTrailersOverwrite=true

mjb.forceVideoImagesOverwrite

By default !MovieJukebox does not overwrite the VideoImage files if they already exist. If this parameter is true, then the files will be overwritten every time that the !MovieJukebox is run.

Valid values

mjb.forceVideoImagesOverwrite=false
mjb.forceVideoImagesOverwrite=true

mjb.forceBannersOverwrite

By default !MovieJukebox does not overwrite the Banner files if they already exist. If this parameter is true, then the files will be overwritten every time that the !MovieJukebox is run.

Valid values

mjb.forceBannersOverwrite=false
mjb.forceBannersOverwrite=true

mjb.forceFooterOverwrite

By default !MovieJukebox does not overwrite the Footer files if they already exist. If this parameter is true, then the files will be overwritten every time that the !MovieJukebox is run.

Valid values

mjb.forceFooterOverwrite=false
mjb.forceFooterOverwrite=true

mjb.forceSkinOverwrite

By default !MovieJukebox does not overwrite the Skin files if they already exist. If this parameter is true, then the files will be overwritten every time that the !MovieJukebox is run.

Note: the skin files will also be overwitten if the moviejukebox.properties file is updated.

Valid values

mjb.forceSkinOverwrite=false
mjb.forceSkinOverwrite=true

Jukebox Clean-up

Properties related to the cleaning of the jukebox output folder, post run.

mjb.jukeboxClean

Remove any unused or orphaned files from the jukebox. This has no impact on how the jukebox performs, but is useful to keep the size of the jukebox directory under control.

Note: This property can also be set from the command line using the "-" parameter see CommandSyntax#Parameters) This parameter will NOT override the command line switch if set.

Default value

mjb.jukeboxClean=false

Valid values

mjb.jukeboxClean=true
mjb.jukeboxClean=false

mjb.jukeboxCleanReport

If the jukebox folder is not cleaned with the mjb.jukeboxClean parameter, then this property will display the list of orphaned files in the log file.

It is an information only display, no files are harmed in the output.

Default value

mjb.jukeboxCleanReport=false

Valid values

mjb.jukeboxCleanReport=true
mjb.jukeboxCleanReport=false

Log File

These properties affect the log file and log formatting

mjb.appendDateToLogFile

Append the run date to the log file to create a unique log file for each run

Valid values

mjb.appendDateToLogFile=false
mjb.appendDateToLogFile=true

mjb.appendLibraryToLogFile

Append the first valid library description to the log file

Valid values

mjb.appendLibraryToLogFile=false
mjb.appendLibraryToLogFile=true

mjb.logFileDirectory

Move the log file to this directory at the end of the processing.

Default value

mjb.logFileDirectory=

Multi-threading

These are the multi-thread processing parameters Only change these values if you know what you are doing. Altering these settings could get you banned from the source websites.

mjb.MaxThreadsProcess

This parameter defines the number of processing threads, it defaults to the number of CPU cores; higher value usually doesn't help, but one can set lower value to reduce CPU load.

Default value

#mjb.MaxThreadsProcess=1

mjb.MaxThreadsDownload

The number of downloading threads. Downloading threads usually do not take CPU power, so a higher value here is normal. Per host limits are also used (see MaxDownloadSlots). 0 means the same value as !MaxThreadsProcess (above).

Default value

mjb.MaxThreadsDownload=1

Recheck Properties

These properties control the rechecking (or rescanning) of the XML files to prevent them from being stale or out of date. They also check to see if certain values are UNKNOWN and attempt to rescrape them.

mjb.recheck.XML

This parameter turns on (true) or off (false) the checking routine

Valid values

mjb.recheck.XML=true
mjb.recheck.XML=false

Default value

mjb.recheck.XML=true

mjb.recheck.Max

The maximum number of XML files to rescan. Any more than this amount will be checked on the next run.

Default value

mjb.recheck.Max=50

mjb.recheck.Version

Check if the version of YAMJ has changed, e.g. v1.8 -> v1.9

Valid values

mjb.recheck.Version=true
mjb.recheck.Version=false

Default value

mjb.recheck.Version=true

mjb.recheck.Revision

The number of YAMJ revisions before forcing a rescan

Default value

mjb.recheck.Revision=10

mjb.recheck.Days

The number of days before forcing a rescan. Note: 0 (Zero) disables this check and will always rescan the files.

Default value

mjb.recheck.Days=30

mjb.recheck.Unknown

Check to see if certain values of the XML file have UNKNOWN Currently only Title, plot, year, video image and episode plots are checked

Value values

mjb.recheck.Unknown=true
mjb.recheck.Unknown=false

Default value

mjb.recheck.Unknown=true

Check limit properties

Running YAMJ on low performance machine can take a very long time with big libraries. With this properties, the maximum number of movies scanned for each run can be limited, so that YAMJ can be periodically scheduled for shorter runs.

mjb.check.Max

The maximum number of movies scanned for each YAMJ run. If more movies are added or modified, YAMJ will skip the remaining and will check them during the next run. When set to 0, no limit is applied.

Default value

mjb.check.Max=0

Filename Scanner

filename.scanner.language.detection

Turns on or off the language detection scanner for the filename.

Valid values

filename.scanner.language.detection=false
filename.scanner.language.detection=true

filename.scanner.skip.caseSensitive

Treat filename.scanner.skip.keywords as case sensitive (true) or case insensitive (false). Warning: Changing this value may remove some proper words from your video titles

Default value

filename.scanner.skip.caseSensitive=true

Valid values

filename.scanner.skip.caseSensitive=true
filename.scanner.skip.caseSensitive=false

filename.scanner.skip.episodeTitle

Ignore (skip) any episode titles that are found in the filename for TV Shows

Default value

filename.scanner.skip.episodeTitle=false

Valid values

filename.scanner.skip.episodeTitle=false
filename.scanner.skip.episodeTitle=true

filename.scanner.language.keywords

This is the list of languages to detect.

Each Language listed here must have a corresponding language flag in skin resource/languages folder and also a detection property named filename.scanner.language.<language> with a list of the CASE SENSITIVE language codes to search for.

See here: http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

Default value

filename.scanner.language.keywords=Chinese,Dual_Language,English,French,German,
Hebrew,Hindi,Hungarian,Italian,Japanese,Norwegian,Polish,Portuguese,Russian,Spanish,
Swedish,Thai,VO,Danish,Dutch,Tagalog

filename.scanner.language.*

These are the language codes that correspond to the keywords specified in the filename.scanner.language.keywords property.

The values for the language are case sensitive

Example

filename.scanner.language.English=ENG,EN,ENGLISH,eng,en,english,Eng

filename.scanner.skip.keywords

A comma separated list of case-insensitive words to ignore when scanning the video filename

Default value

filename.scanner.skip.keywords=LIMITED,DiAMOND,AXXO,PUKKA,iDHD,PROPER,REPACK,DSR,STV,UNRATED,RERIP

filename.scanner.source.default

This property will be used if no source is found in the filename

Default value

filename.scanner.source.default=UNKNOWN

filename.scanner.source.keywords

A comma-separated list of case-insensitive words to use as valid keywords for the source property.

Default value

filename.scanner.source.keywords=HDTV,PDTV,DVDRip,DVDSCR,DSRip,CAM,R5,LINE,HD2DVD,DVD,DVD5,DVD9,HRHDTV,MVCD,VCD,TS,VHSRip,BluRay,HDDVD,D-THEATER,SDTV

Also, for each keyword listed in this property, you can have another property, filename.scanner.source.keywords.xxx (change "xxx" to the keyword) which is a comma-separated, case-insensitive list of keywords which are mapped to the "xxx" keyword.

Example

filename.scanner.source.keywords.SDTV=NTSC,PAL

This causes the NTSC and PAL keywords both to be recognized, but the movie will be given a SOURCE value of SDTV.

Default values

filename.scanner.source.keywords.SDTV=TVRip,PAL,NTSC
filename.scanner.source.keywords.D-THEATER=DTH,DTHEATER
filename.scanner.source.keywords.HDDVD=HD-DVD,HDDVDRIP
filename.scanner.source.keywords.BluRay=BDRIP,BLURAYRIP,BLU-RAY
filename.scanner.source.keywords.DVDRip=DVDR

filename.scanner.useParentRegex

Set this property to enable the option to use a regex to trigger the use of the parent foldername rather than the filename

Default value

filename.scanner.useParentRegex=false

Valid values

filename.scanner.useParentRegex=false
filename.scanner.useParentRegex=true

filename.scanner.parentRegex

Use this Java regex expression to trigger the use of the parent folder name rather than the filename. If this regex is not "found" then normal filename processing is used. WARNING: Setting this value can harm your jukebox! Use with caution!

Default value

filename.scanner.parentRegex=(\\w*?)(\\.|-{0,1})(\\d{3,4})(\\.|-{0,1})(\\w*)

These links may help in creating your regex.

http://download.oracle.com/javase/1.5.0/docs/api/java/util/regex/Pattern.html

http://www.fileformat.info/tool/regex.htm

filename.extras.process

Process the extras as their own videos complete with artwork. Setting this value to false will just remove the "Extra" category, the extras will still be playable on the video page.

Default value

filename.extras.process=true

Valid values

filename.extras.process=true
filename.extras.process=false

filename.extras.keywords

List of keywords to determine if the file is an extra (e.g. Trailer, Bonus content, etc) Filename will be like: "filename title.avi"

Default values

filename.extras.keywords=trailer,bonus,extra

filename.movie.versions.keywords

These keywords will be stripped out of the filename. Currently they are not stored anywhere and are therefore discarded.

Default values

filename.movie.versions.keywords=remastered,directors cut,extended cut,final cut

NFO Files

filename.nfo.directory

Library relative directory to check for nfo files if they aren't found as part of the normal scan. Leave blank or undefined (put a # at the start of the line) to ignore this search.

Example: For the library path D:\Videos\ then this will search in D:\Videos\NFO\ for NFO files.

filename.nfo.directory=NFO

filename.nfo.extensions

This property allows you to specify other extensions that can be considered as NFO files, such as URL or NFO.TXT.

You should omit the leading full stop (.) and separate the extensions by a comma (,)

Default value

filename.nfo.extensions=NFO

filename.nfo.parentDirs

When enabled, all parent directories up to the library root are searched for NFO files. All found nfo files are merged. Values in nfo files in deeper directories override values from directories above.

Valid values

filename.nfo.parentDirs=false
filename.nfo.parentDirs=true

filename.nfo.checknewer

If the NFO file for a video file is newer than the video file that is being scanned, this parameter will force a recheck of the movie file, updating it with the new information.

Valid values

filename.nfo.checknewer=true
filename.nfo.checknewer=false

filename.nfo.acceptAllNfo

This property will select any/all NFO files in the directory as belonging to the video file Note: This is best used where ALL videos have their own folders and WILL break individual episode NFO files for TV Series

Valid values

filename.nfo.acceptAllNfo=true
filename.nfo.acceptAllNfo=false

filename.nfo.writeFiles

Generate a basic NFO file in the jukebox folder for each video.

These NFO files are NOT used by YAMJ but can be copied alongside the videos if required.

Note: The NFO files are only written out when the video is new or changed. It will not write them out every time YAMJ runs.

Valid values

filename.nfo.writeFiles=true
filename.nfo.writeFiles=false

Default value

filename.nfo.writeFiles=false

filename.nfo.writeSimpleFiles

If filename.nfo.writeFiles is true, then setting this value to true will limit the NFO files that are created to just the ID values for the movie without the additional NFO file entries.

Valid values

filename.nfo.writeSimpleFiles=true
filename.nfo.writeSimpleFiles=false

Default value

filename.nfo.writeSimpleFiles=false

filename.nfo.skipUrl

Setting this property means that the NFO scanner will skip (ignore) any image URL entries that are found in the XML NFO file.

Valid values

filename.nfo.skipUrl=true
filename.nfo.skipUrl=false

Default value

filename.nfo.skipUrl=true

filename.nfo.skipTrailer

Setting this property means that the NFO scanner will skip (ignore) any trailer URL entries that are found in the XML NFO file.

Valid values

filename.nfo.skipTrailer=true
filename.nfo.skipTrailer=false

Default value

filename.nfo.skipTrailer=false

filename.nfo.skipCast

Setting this property means that the NFO scanner will skip (ignore) any cast (actor) entries that are found in the XML NFO file.

Valid values

filename.nfo.skipCast=true
filename.nfo.skipCast=false

Default value

filename.nfo.skipCast=false

filename.nfo.skipCrew

Setting this property means that the NFO scanner will skip (ignore) any crew (director & writer) entries that are found in the XML NFO file.

Valid values

filename.nfo.skipCrew=true
filename.nfo.skipCrew=false

Default value

filename.nfo.skipCrew=false

filename.nfo.skipTVNFOFiles

Setting this property means that the NFO scanner will skip episode NFO files it will still scan !SxxE01 but none after episode 1 and it will still scan Season NFO files.

Valid values

filename.nfo.skipTVNFOFiles=true
filename.nfo.skipTVNFOFiles=false

Default value

filename.nfo.skipTVNFOFiles=false

Poster Scanner

poster.scanner.searchForExistingCoverArt

Specifies if we should look for an existing cover art file

Valid values

poster.scanner.searchForExistingCoverArt=no
poster.scanner.searchForExistingCoverArt=moviename
poster.scanner.searchForExistingCoverArt=fixedcoverartname

poster.scanner.coverArtExtensions

Specifies the valid extension for cover art files. Valid values are a coma separated list of extensions

Default value

poster.scanner.coverArtExtensions=jpg,jpeg,gif,bmp,png

poster.scanner.fixedCoverArtName

If poster.scanner.searchForExistingCoverart=fixedcoverartname then this parameter specifies the basename of the cover art file.

Example values

poster.scanner.fixedCoverArtName=folder
poster.scanner.fixedCoverArtName=cover
poster.scanner.fixedCoverArtName=poster

poster.scanner.coverArtDirectory

Specifies the subdirectory where to look for cover art. Valid values is a directory name relative to the movie file. Comment this out if the cover art is stored in the same directory as movie.

Example value

poster.scanner.coverArtDirectory=Images

poster.scanner.useFolderImage

Specifies if the poster scanner should look for and use fixed poster images (as specified in poster.scanner.imageName). Warning: if you have a folder.* in your directory then this will use this for thumbnails for ALL videos in that folder.

This is really intended for use with TV series.

Valid values

poster.scanner.useFolderImage=false
poster.scanner.useFolderImage=true

poster.scanner.imageName

A comma seperated list of base filenames to search for. For example, a setting of "poster" will search the directory for a file named "poster.jpg" and use this for the video's poster.

Default value

poster.scanner.imageName=poster,folder

poster.scanner.SearchPriority.movie

Specifies a prioritised list of movie poster searches to look for a poster. Each search is tried in turn until a valid poster URL is found.

You can remove or change the order of these searches, but there should always be at least one value set.

Default value

poster.scanner.SearchPriority.movie=themoviedb,imdb,impawards,motechnet,moviecovers,google,yahoo

Valid values

google
yahoo
motechnet
impawards
themoviedb
imdb
filmaffinity
passionxbmc
allocine
scopedk
subbaba
filmupit
filmweb
thetvdb
sratim
cdon
caratulasdecine 
comingsoon

poster.scanner.SearchPriority.tv

Specifies a prioritised list of tv poster searches to look for a poster. Each search is tried in turn until a valid poster URL is found.

You can remove or change the order of these searches, but there should always be at least one value set.

Default value

poster.scanner.SearchPriority.tv=thetvdb,cdon,filmaffinity

Valid values

thetvdb
cdon
filmaffinity
filmweb
subbaba
sratim

poster.scanner.Validate

Determines if the poster should be validated to ensure it's at least as big as the skin properties poster Width and Height, if not, the poster will be rejected.

Default value

poster.scanner.Validate=true

Valid values

poster.scanner.Validate=true
poster.scanner.Validate=false

poster.scanner.ValidateMatch

This property controls how close to the poster Width and Height should a match be consider for use in YAMJ. Note: this should be a whole percentage without the % sign E.g. 75 will match any poster that is at least 75% of the poster Width / Height So if the poster width is 400, this will match any poster greater than 300

Default value

poster.scanner.ValidateMatch=75

poster.scanner.ValidateAspect

Determines if the poster validation should also include a check for the aspect ratio. This ensures that a landscape picture isn't used for a portrait poster.

Default value

poster.scanner.ValidateAspect=true

Valid values

poster.scanner.ValidateAspect=true
poster.scanner.ValidateAspect=false

Fanart Scanner

fanart.scanner.useFolderImage

Specifies if the fanart scanner should look for and use folder fanart files if found. Warning: if you have either in your directory then this will use this for fanart for ALL videos in that folder. This is really intended for use with TV series or single movie per folder setups

Valid values

fanart.scanner.useFolderImage=false
fanart.scanner.useFolderImage=true

fanart.scanner.imageName

A comma seperated list of base filenames to search for. For example, a setting of "background" will search the directory for a file named "background.jpg" and use this for the video's fanart.

Default value

fanart.scanner.imageName=fanart,backdrop,background

Banner Scanner

banner.scanner.useFolderImage

Specifies if the banner scanner should look for and use folder banner files if found. Warning: If you have and of these in your directory then this will use this for banner artwork for ALL videos in that folder. This is really intended for use with TV series or single movie per folder setups

Valid values

fanart.scanner.useFolderImage=false
fanart.scanner.useFolderImage=true

banner.scanner.imageName

A comma seperated list of base filenames to search for. For example, a setting of "banner" will search the directory for a file named "banner.jpg" and use this for the video's banner.

Default value

banner.scanner.imageName=banner

Watched Scanner

watched.scanner.enable

Parameter to enable/disable the watched scanner.

Valid values

watched.scanner.enable=false
watched.scanner.enable=true

Default value

watched.scanner.enable=true

mjb.watched.withExtension

Should we search for the filename with the extension (true), without the extension (false) or both (both)

Valid values

mjb.watched.withExtension=true
mjb.watched.withExtension=false
mjb.watched.withExtension=both

Default value

mjb.watched.withExtension=true

Boxed Sets

mjb.singleSeriesPage

If this parameter is enabled, multiple seasons of a TV series are grouped behind a single entry point. The default behavior is not to group seasons together.

Valid values

mjb.singleSeriesPage=false
mjb.singleSeriesPage=true

mjb.sets.minSetCount

This parameter controls the minimum number of movie titles in a boxed set that must appear in a category before they are replaced with a link to the boxed set. The default value is 2, but any number 1 or larger is acceptable.

Example values

mjb.sets.minSetCount=2
mjb.sets.minSetCount=4

mjb.sets.createPosters

Set this property to true to create large set posters as well as the thumbnail posters.

Default value

mjb.sets.createPosters=false

Valid values

mjb.sets.createPosters=false
mjb.sets.createPosters=true

mjb.sets.requireAll

If this parameter is enabled, movies in a boxed set will only be replaced by the set poster when all of the movies in the set appear in a category. This parameter does not override mjb.sets.minSetCount but augments it. So if minSetCount is 4 and requireAll is enabled, a set with fewer than four movies will never be grouped.

Default value

mjb.sets.requireAll=false

Valid values

mjb.sets.requireAll=false
mjb.sets.requireAll=true

mjb.sets.specialsAtEnd

Sorts TV Show specials (Season 0) to the end of the list of seasons

Default value

mjb.sets.specialsAtEnd=false

Valid values

mjb.sets.specialsAtEnd=true
mjb.sets.specialsAtEnd=false

mjb.sets.excludeTV

If this parameter is enabled, then TV Shows will be excluded from the Set listing in the categories.xml file.

Default value

mjb.sets.excludeTV=false

Valid values

mjb.sets.excludeTV=false
mjb.sets.excludeTV=true

mjb.sets.reindex

If this parameter is enabled, then index SET xml and html files always will be recreate.

Default value

mjb.sets.reindex=true

Valid values

mjb.sets.reindex=false
mjb.sets.reindex=true

mjb.categories.indexList

Comma-separated list of indexes to generate. Valid indexes include:

  • Other
  • Genres
  • Title
  • Certification
  • Year
  • Library
  • Cast
  • Director
  • Writer
  • Country
  • Set
  • Award
  • Person
  • Ratings

Example

mjb.categories.indexList=Other,Genres,Title,Certification,Year,Library,Set

mjb.categories.displayList

Comma-separated list of indexes to display on the categories page. If blank or undefined, all categories listed in the indexList are shown.

Default value

mjb.categories.displayList=

mjb.categories.minCount

Minimum number of movies in an index before it shows on the categories page

Default value

mjb.categories.minCount=3

You can further restrict this based on the individual category by appending the category name to the end of the property to override it.

For example: If you want a minimum of 2 directors before they are indexed and 6 actors then set the following properties:

mjb.categories.minCount.Cast=6
mjb.categories.minCount.Director=2

mjb.sets.indexFanart

Create set index fanart for sets. If local set fanart is found it will be used otherwise the fanart from the first video will be used.

Valid values

mjb.sets.indexFanart=false
mjb.sets.indexFanart=true

mjb.categories.explodeSet

Comma-separated list of indexes where SETS will be replace by their containing movie.

  • Other (and its subcategories: New, HD, Sets, Top250, Rating, etc)
  • Genres
  • Title
  • Certification
  • Year
  • Library
  • Cast
  • Director
  • Writer
  • Country
  • Set
  • Award
  • Person
  • Ratings

Default value

mjb.categories.explodeSet=

Example

mjb.categories.explodeSet=Cast,Title

In this case, SETs will be displayed as SET everywhere except in Cast and Title indexes, where
they will be replaced by their containning movie.

mjb.categories.explodeSet.beforeSort

Explosion sets before sorting.

Default value

mjb.categories.explodeSet.beforeSort=false

mjb.categories.explodeSet.keepTV

Do not explode TVShow on exploded category.

Default value

mjb.categories.explodeSet.keepTV=true

mjb.categories.explodeSet.removeSet

Remove master set from category after the explosion.

Default value

mjb.categories.explodeSet.removeSet=false

mjb.categories.explodeSet.removeSet.title

Remove the sets from the category "Title". This option works without explosion set.

Default value

mjb.categories.explodeSet.removeSet.title=false

IMDb Plugin Parameters

imdb.id.search

Specifies the search engine to be search for IMDb IDs

Valid values

imdb.id.search=imdb
imdb.id.search=google
imdb.id.search=yahoo
imdb.id.search=none

imdb.id.search.match

Try to find IDs for movies and persons in IMDb in search results.

Following values are allowed:

  • first - First search result is taken as match
  • regular - name and title must match independent from each other
  • exact - concatenation of name and title must be exactly found

Default value

imdb.id.search.match=regular

imdb.id.search.variable

Try to find IDs for movies depending if movie is a TV show or a movie.

Following values are allowed:

  • true - Only search for TV show or movie depending on actual movie
  • false - Find matching ID in all search results

Default value

imdb.id.search.variable=true

imdb.site

Specifies the site, and therefore the language, that the IMDb plugin will use. See Plugins for more detail.

Default value

imdb.site=us

imdb.plot

Use the short plot or long plot description from IMDB (imdb.plot). This will be determined by the scanner you use.

Valid values

imdb.plot=short
imdb.plot=long

imdb.getCertificationFromMPAA

This property specifies that you wish to get the certification of the movie from the MPAA rather than another source. If you want to change the movie certification, set this property to false.

When this value is false, the country certification from imdb.preferredCountry is used instead.

Valid values

imdb.getCertificationFromMPAA=true
imdb.getCertificationFromMPAA=false

Default value

imdb.getCertificationFromMPAA=true

imdb.preferredCountry

Set this to the IMDB country you want YAMJ to use when extracting certifications.

Example: IMDB shows the following for certification:

{{{Italy:T | Iceland:10 | UK:12 (video rating) | UK:12A (original rating) | Malaysia:U | France:U | Brazil:14 | Argentina:Atp | Australia:M | Canada:14 (Nova Scotia) (original rating) | Canada:G (Quebec) | Canada:PG (Alberta/British Columbia/Manitoba/Ontario) | Canada:PG (Nova Scotia) (re-rating after appeal) | Chile:TE | Denmark:11 | Finland:K-11 | Germany:12 | Hong Kong:IIA | Hungary:14 | Ireland:12 | Netherlands:12 | New Zealand:M | Norway:11 | Peru:PT | Philippines:PG-13 | Portugal:M/12 | Singapore:PG | South Korea:12 | Spain:7 | Sweden:11 | Switzerland:12 (canton of Geneva) | Switzerland:12 (canton of Vaud) | Switzerland:12 (canton of the Grisons) | USA:PG-13 | Greece:K-13}}}

Here you see all the various certifications, seperated by "|". Each certification is in the form country:value. YAMJ will extract the certification with a country value that matches the property imdb.preferredCountry. If the value contains a ( YAMJ discards all text after the first (.

YAMJ will use the last value available for a country.

In the above example, if imdb.preferredCountry = UK, the certifications are:

- UK:12 (video rating)
- UK:12A (original rating)

YAMJ will use the value 12A.

Default value

imdb.preferredCountry=USA

imdb.full.info

Get all available information from the "combined" IMDB page rather than the more limited "standard" page

Default value

imdb.full.info=false

Valid values

imdb.full.info=false
imdb.full.info=true

imdb.aka.scrape.title

If there are problems with geo-localized movie titles scraped from IMDb then this parameter could be used. In enabled the AKAs of a movie will be scraped in order to find the movie name for the imdb.preferredCountry.

Default value

imdb.aka.scrape.title=false

Valid values

imdb.aka.scrape.title=false
imdb.aka.scrape.title=true

imdb.aka.fallback.countries

If the title should be scraped from the AKAs then in addition to the preferred country several fallback countries could be set if no title was found for the preferred country.

Example

imdb.aka.fallback.countries=UK,International

Default value

imdb.aka.fallback.countries=

imdb.aka.ignore.versions

If the title should be scraped from the AKAs then several movie titles for a country may exist for different version. With this parameters versions to ignore for scraping the title from AKAs can be set.

Note that the version settings are depending from the imdb.site; i.e. the naming in english and german for versions are different ('working title' vs. 'Arbeitstitel').

Default value

imdb.aka.ignore.versions=

Example

imdb.aka.ignore.versions=IMAX version,long version,working title,promotional title

!MediaInfo Scanner

mediainfo.home

The directory where the !mediaInfo executable is located.

Default value

mediainfo.home=./mediaInfo/

mediainfo.metadata.enable

Have mediainfo pull meta data tags from media files. This data, if present, will override data in the NFO file. Valid values are: true, false

Default value

mediainfo.metadata.enable=false

mediainfo.update.enable

Set this flag to true, if mediainfo should update the media infos values if the file extension has changed. Valid values are: true, false

Default value

mediainfo.update.enable=false

mediainfo.multipart.enable

Set this flag to false, if mediainfo should not scan the other parts of a multipart video; instead using only the values from first movie file.

Until now this is only relevant for the movie runtime. Valid values are: true, false

Default value

mediainfo.multipart.enable=true

mediainfo.overrallbitrate

Update the overall bitrate of a video by mediainfo Valid values are: true, false

Default value

mediainfo.overrallbitrate=false

mediainfo.readfromfile

If set to true then the mediainfo values can be read from a file instead of running mediainfo. The filename must be placed with the movie file and have the same name (except extension) as the movie file. The extension of the file must be ".mediainfo".

The file should be generated with "!MediaInfo -f filename" before.

Valid values are: true, false

Default value

mediainfo.readfromfile=false

Attachment Scanner

attachment.scanner.enable

Enable or disable the Attachment Scanner completely

Default Value

attachment.scanner.enable=false

Valid values

attachment.scanner.enable=true
attachment.scanner.enable=false

attachment.mkvtoolnix.home

The directory where the !mkvtoolnix executables are located.

Default value

attachment.mkvtoolnix.home=./mkvToolnix/

attachment.mkvtoolnix.language

The used mkvinfo language for attachment detection is en (for Windows) or en_US (for Linux). If there are problems during scan (exit value = 2) then you should try another english language setting.

For the list of supported languages see output of: mkvinfo --ui-language list

Default value

attachment.mkvtoolnix.language=

attachment.temp.directory

The temporary directory for extracted attachments. If left empty then the value of "mjb.jukeboxTempDir" + "/attachments" will be used.

Default value

attachment.temp.directory=

attachment.temp.directory

The temporary directory for extracted attachments. If left empty then the value of "mjb.jukeboxTempDir" + "/attachments" will be used.

Default value

attachment.temp.directory=

attachment.temp.cleanup

Flag to enable or disable the clean of the temporary directory for extracted attachments. Set to false if you have set attachment.temp.directory which should not be deleted.

Default value

attachment.temp.cleanup=true

attachment.recheck.enable

Disable or enable the rechecked for new/changed attachments within a movie.

Default value

attachment.recheck.enable=true

Valid values

attachment.recheck.enable=true
attachment.recheck.enable=false

Customization Properties (Plugins)

mjb.internet.plugin

This is the fully qualified name of the plugin class implementing the internet search for movies (both movies data and poster).

You can replace this default class with your own in order to develop your customized internet search.

The class must implement interface com.moviejukebox.MovieDatabasePlugin Make sure to modify the classpath accordingly in the moviejukebox startup script

If you don't know what all this is about, DO NOT CHANGE THIS VALUE.

See Plugins for settings for this property

mjb.internet.tv.plugin

This is the fully qualified name of the plugin to be used for TV series search (for both data and posters) you can continue using any of the other plugins for TV series essentially keeping prior functionality by replacing the plugin below.

Default value

mjb.internet.tv.plugin=com.moviejukebox.plugin.TheTvDBPlugin

If you don't know what all this is about, DO NOT CHANGE THIS VALUE.

See Plugins for settings for this property

mjb.internet.alternate.plugin

This is the fully qualified name of the alternate plugin class implementing the internet search for movies (both movies data and poster). If an alternate plugin is configured it should be used only on information the normal plugin failed to fetch.

If you don't know what all this is about, DO NOT CHANGE THIS VALUE.

See Plugins for settings for this property

mjb.internet.plugin.autodetect

Turn on/off the auto detection of other plugins from the NFO file. If set to true then the NFO file will be scanned for alternative plugin URLs and, if found, that plugin will be used to scan for more information on the video. Or set comma separated list of plugin then use him only.

Default value

mjb.internet.plugin.autodetect=false

Valid values

mjb.internet.plugin.autodetect=true
mjb.internet.plugin.autodetect=false
mjb.internet.plugin.autodetect=allocine,animator,comingsoon,filmaffinity,filmkatalogus,filmupit,filmweb,imdb,kinopoisk,moviemeter,ofdb,scopedk,sratim,themoviedb,thetvdb,tvrage

mjb.internet.person.plugin

This is the fully qualified name of the plugin class implementing the internet search for person (both personal data and photo).

Default value

mjb.internet.person.plugin=com.moviejukebox.plugin.ImdbPlugin

If you don't know what all this is about, DO NOT CHANGE THIS VALUE.

See Plugins for settings for this property


!TheMovieDb Plugin Parameters

themoviedb.language

Specifies the language used for searching !TheMovieDb and the language to have descriptions and text translated to.

Valid language tags are formed from the IETF language tag definition. E.g. en-US, en-CA, es-MX, fr-PF Note: en, es, de, etc. are also valid.

Default value

themoviedb.language=en-US

themoviedb.collection

If your main movie scanner is set to !TheMovieDb, using this setting will create boxed sets for your movies based on the collections that are specified on themoviedb.org for each movie.

This setting will also download poster and fanart for the collection which will be used if there is no local artwork for the collection.

Default value

themoviedb.collection=false

Valid values

themoviedb.collection=true
themoviedb.collection=false

TheTVDB Plugin Parameters

thetvdb.language

Specifies the language used for searching TheTVDB and the language to have descriptions and text translated to.

Valid languages are: da,fi,nl,de,it,es,fr,pl,hu,el,tr,ru,he,ja,pt,zh,cs,sl,en,sv,no

Default value

thetvdb.language=en

thetvdb.language.secondary

Specifies the secondary language used for searching TheTVDB - when there is no result for primary language. Designed to simplify the search for banners and posters.

Valid languages are: same as above

Default value

thetvdb.language.secondary=en

thetvdb.dvd.episodes

Specify whether to use the DVD sort or the aired date sort.

Valid values are: true, false.

true will sort by dvd episode number, false will use aired episode number.

Default value

thetvdb.dvd.episodes=false

Kinopoisk Plugin Parameters


kinopoisk.trailer.download

Specifies if found trailer should be downloaded

Default value

kinopoisk.trailer.download=false

Valid values

kinopoisk.trailer.download=false
kinopoisk.trailer.download=true

kinopoisk.title.leader

What name leader on title

Default value

kinopoisk.title.leader=english

Valid values

kinopoisk.title.leader=english
kinopoisk.title.leader=russian

kinopoisk.title.divider

Divider between english and russian names on title

Default value

kinopoisk.title.divider=" - "

kinopoisk.NFOpriority

Set priority of data from NFO file

Default value

kinopoisk.NFOpriority=false

Valid values

kinopoisk.NFOpriority=false
kinopoisk.NFOpriority=true

kinopoisk.fanart

Download fanart from kinopoisk.ru

Default value

kinopoisk.fanart=false

Valid values

kinopoisk.fanart=false
kinopoisk.fanart=true

kinopoisk.poster

Download poster from kinopoisk.ru

Default value

kinopoisk.poster=false

Valid values

kinopoisk.poster=false
kinopoisk.poster=true

kinopoisk.kard

Download videoimage instead fanart from kinopoisk.ru

Default value

kinopoisk.kard=false

Valid values

kinopoisk.kard=false
kinopoisk.kard=true

Subtitles

Properties related to subtitles

mjb.subtitles.ExcludeFilesWithoutExternal

Exclude files without external subtitles files.

Valid values

mjb.subtitles.ExcludeFilesWithoutExternal=false
mjb.subtitles.ExcludeFilesWithoutExternal=true

Default value

mjb.subtitles.ExcludeFilesWithoutExternal=false

mjb.subtitle.skip

List of subtitle languages to skip when scraping video information. These subtitles will not be saved in the video XML files

Example

mjb.subtitle.skip=hu,nor,it,jp

Default value

mjb.subtitle.skip=

mjb.subtitle.unique

Remove duplicate subtitles if this flag is set to true.

Valid values

mjb.subtitle.unique=false
mjb.subtitle.unique=true

Default value

mjb.subtitle.unique=true

!OpenSubtitles.Org

opensubtitles.enable

Enables or disables the OpenSubtitles scanning plugin

Default value

opensubtitles.enable=true

Valid values

opensubtitles.enable=true
opensubtitles.enable=false

opensubtitles.language

The language used for downloading subtitle from opensubtitles.org

Valid Values: || alb || ara || arm || ass || bos || bul || cat || chi || hrv || || cze || dan || dut || eng || est || per || fin || fre || glg || || geo || ger || ell || heb || hin || hun || ice || ind || ita || || jpn || kaz || kor || lav || lit || ltz || mac || may || nor || || oci || pol || por || pob || rum || rus || scc || slo || slv || || spa || swe || tha || tur || ukr || vie || || || ||

opensubtitles.username

opensubtitles.password

Optional Username and Password for opensubtitles.org upload user ranking


Moviejukebox Listing Plugin

Use this plugin to generate a list of the video files in your jukebox in a CSV format than can be imported into a spreadsheet program (e.g. Excel)

mjb.listing.generate

Set this parameter to enable / disable the plugin

Valid values

mjb.listing.generate=true
mjb.listing.generate=false

Default value

mjb.listing.generate=false

mjb.listing.plugin

The listing plugin to use

Valid values

mjb.listing.plugin=com.moviejukebox.plugin.MovieListingPluginCsv
mjb.listing.plugin=com.moviejukebox.plugin.MovieListingPluginCustomCsv

Default value

mjb.listing.plugin=com.moviejukebox.plugin.MovieListingPluginCsv

mjb.listing.output.filename

The filename to write the output to

Default value

mjb.listing.output.filename=MovieJukebox-listing

mjb.listing.output.destination

Where to write the output file to. Default is to leave this value unset and the output will be written to the jukebox root directory (aka mjb.jukeboxRoot).

Note: If you are using windows, you should use "\" or "/" for the path separator.

Default value

#mjb.listing.output.destination=

Example value

mjb.listing.output.destination=C:/

mjb.listing.types

Types of the video files to include

Valid values

mjb.listing.types=Movie
mjb.listing.types=Trailer
mjb.listing.types=TVShow
mjb.listing.types=All

Default value

mjb.listing.types=All

mjb.listing.GroupByType

Set to true to group by type (in order specified in mjb.listing.types)

Valid values

mjb.listing.GroupByType=true
mjb.listing.GroupByType=false

Default value

mjb.listing.GroupByType=true

mjb.listing.clear.UNKNOWN

Set to true to blank common UNKNOWN values (default: true)

Valid values

mjb.listing.clear.UNKNOWN=true
mjb.listing.clear.UNKNOWN=false

Default value

mjb.listing.clear.UNKNOWN=true

mjb.listing.csv.fields

Used by com.moviejukebox.plugin.MovieListingPluginCustomCsv

A comma separated list of field names. These names will determine the columns and the order that the fields will be written to the listing file. Leave this blank to generate all the fields that are available.

Legal field names || Type || Title || TitleSort || IMDB ID || TheTVDB ID || || Director || Company || Country || Language || Runtime || || Release Date || Year || Certification || Season # || VideoSource || || Container || File || Audio Codec || Audio Channels || Resolution || || Video Codec || Video Output || FPS || # Files || # Extras || || # Genres || # Cast || SubTitles? || Poster? || Poster Filename || || Fanart? || Fanart Filename || Rating # || Top 250 # || Library Description || || Library Path || Allocine ID || FilmUpIT ID || FilmWeb ID || || Kinopoisk ID || Sratim ID || Last Modified Date || File Size || Genres || || Cast || Plot || Outline ||

You can remove embedded spaces and trailing # and ? from the field names

Example

mjb.listing.csv.fields=TITLE,TYPE,IMDBID,DIRECTOR,COMPANY,RUNTIME,YEAR,THETVDBID,RATING,TOP250,LASTMODIFIEDDATE,FILESIZE,GENRES,CAST

Default value

mjb.listing.csv.fields=

mjb.listing.csv.delimiter

Used by com.moviejukebox.plugin.MovieListingPluginCustomCsv

Set to the character to use as delimiter in the output file

Default value

mjb.listing.csv.delimiter=,

mjb.listing.csv.secondDelimiter

Used by com.moviejukebox.plugin.MovieListingPluginCustomCsv

The fields Cast and Genres are multivalued and will us this character as delimiter (default: |)

mjb.listing.csv.dateFormat

Used by com.moviejukebox.plugin.MovieListingPluginCustomCsv

Used to control the formatting of the date in the field 'Last Modified Date'

Example

mjb.listing.csv.dateFormat==dd/MM/yyyy

Default is to use the default formatting for the current locale

mjb.listing.csv.ratingFactor

Used by com.moviejukebox.plugin.MovieListingPluginCustomCsv

Used to control the value of the number in the field 'Rating #'

The movie rating will be multiplied with this number

** Example**

mjb.listing.csv.ratingFactor=0.05

This would cause the rating to be between 0.00 and 5.00

Default value

mjb.listing.csv.ratingFactor=1.00

mjb.listing.csv.limitCast

Limit the cast field to a set number of values. Any more cast members than this will be ignored.

Default value

mjb.listing.csv.limitCast=100

mjb.listing.csv.limitGenres

Limit the genre field to a set number of values. Any more genres than this will be ignored.

Default value

mjb.listing.csv.limitGenres=100

Output File Encoding

mjb.charset.unsafeFilenameChars

Use this to control which characters are encoded in the files that YAMJ creates. By default, it is set to the characters not allowed in Windows filenames, but some filesystems or operating systems may have other restrictions. This affects the filenames in the generated jukebox only; the user interface is unaffected by this setting.

Default value

mjb.charset.unsafeFilenameChars=<>:\"/\\|?*

mjb.charset.filenameEncodingEscapeChar

Controls the escape character used in filename encoding. This character will therefore also be encoded. If this setting is blank, no encoding will be performed. If this setting contains more than one character, all characters after the first are ignored.

Default value

mjb.charset.filenameEncodingEscapeChar=$

mjb.charset.filename.translate

Some national characters can be replaced with appropriate Latins or other safe ones. This property defines mapping between national symbols and Latin replacement. For example by default following names will be generated for Russian file name три мушкетера.avi:

Tri mushketera.html - movie page.

Tri mushketera_large.png - poster image.

Tri mushketera_small.png - thumbnail image.

The list of unicode characters and their values can be found on Wikipedia HERE

Default value

mjb.charset.filename.translate=\u0430-a,\u0431-b,\u0432-v,\u0433-g,\u0434-d,\u0435-e,\u0436-zh,\u0437-z,\u0438-i,\u0439-y,\u043A-k,\u043B-l,\u043C-m,\u043D-n,\u043E-o,\u043F-p,\u0440-r,\u0441-s,\u0442-t,\u0443-u,\u0444-f,\u0445-h,\u0446-c,\u0447-ch,\u0448-sh,\u0449-sch,\u044A-*,\u044B-y,\u044C-*,\u044D-e,\u044E-yu,\u044F-ya,\u0451-yo

Sratim Plugin

sratim.subtitle

Specify whether to download movie subtitles from Sratim

Valid values

sratim.subtitle=true
sratim.subtitle=false

Default value

sratim.subtitle=false

sratim.BidiSupport

Specify whether the device supports logical Hebrew presentation - Should be set to false for A100\110 devices for correct Hebrew display.

Valid values

sratim.BidiSupport=true
sratim.BidiSupport=false

Default value

sratim.BidiSupport=true

sratim.KeepEnglishGenres

If set to 'true' the movie genre\s will be displayed and sorted using the default English genre\s retrieved from IMDB.

Valid values

sratim.KeepEnglishGenres=true
sratim.KeepEnglishGenres=false

Default value

sratim.KeepEnglishGenres=false

Comingsoon Plugin

comingsoon.id.search

Specifies the search engine to be used for ComingSoon IDs

Valid values

comingsoon.id.search=comingsoon
comingsoon.id.search=yahoo
comingsoon.id.search=google

or a comma-separated list of these values.

Default value

comingsoon.id.search=comingsoon,yahoo

comingsoon.imdb.scan

Comingsoon plugin can scan IMDB to fetch additional informations or as a fallback if no movie is found on comingsoon.it site. This property controls when IMDB should be scanned.

Valid values

comingsoon.imdb.scan=always
comingsoon.imdb.scan=fallback
comingsoon.imdb.scan=never

Default value

comingsoon.imdb.scan=always

AniDB Plugin

anidb.useHashIdentification

Setting this to true will make the anidb plugin use filehashes rather than information extracted from the filename when searching anidb.

Valid values

anidb.useHashIdentification=false
anidb.useHashIdentification=true

Default value

anidb.useHashIdentification=false

anidb.minimumCategoryWeight

This is the minimum weight what anidb calls a category must have for the plugin to consider it a genre. Any positive integer value is valid, though keep in mind that as of this writing most categories have a weight of around 5 at most.

Default value

anidb.minimumCategoryWeight=0

anidb.maxGenres

This controls the maximum number of genres an anime can be assigned by the plugin.

Default value

anidb.maxGenres=3

anidb.regex.tvshow

Allows the user to override the default regexp used to match tv shows when not using hash identification. Leave empty to disable.

Valid values

anidb.regex.tvshow=<java regexp>

Default value

anidb.regex.tvshow=(?i)(?:\\[_-](.*?\\])?+(\\w.*?)(?:[\\.)|ep)(\\d{1,3})(?:\\w)(?:.+)

anidb.regex.tvshow.index

Represents the index of the capturing groups containing the title and episode number respectively. This must be set if anidb.regex.tvshow has been set. It's expected to be a comma separated list of two values, the first being the index of the group containing the title, and the second the group containing the episode number.

Default value

anidb.regex.tvshow.index=1,2

anidb.regex.movie

Allows the user to override the default regexp used to match movies when not using hash identification. Leave empty to disable.

Valid values

anidb.regex.movie=<java regexp>

Default value

anidb.regex.movie=(?:\\[```
## `anidb.regex.movie.index`

A single value representing the index of the capturing group that matches the movie title. Must be set if anidb.regex.movie is set.

*Default value*

anidb.regex.movie.index=1

----
# Advanced Parameters

Use these parameters with caution.

## `mjb.skipIndexGeneration`

If set (you can also use the "-i" command line property), then the creation of the indexes and HTML pages will be skipped, i.e. not generated.

This parameter is intended for use by third-party applications such as NMTServer, that do their own indexing and web page creation.

You may also want to use this parameter as a way to generate just the video file information in the situations of low memory, re-enabling this option after the base information has been generated.

*Default value*

mjb.skipIndexGeneration=false



*Valid values*

mjb.skipIndexGeneration=false mjb.skipIndexGeneration=true


----

## `mjb.skipHtmlGeneration`

If set (you can also use the "-h" command line property), then the creation of the HTML pages will be skipped, i.e. not generated.

This parameter is intended for use by flash skins that don't require the HTML pages to be generated. However, leaving this enabled will NOT affect the flash skin, and could be useful if you want to run a flash jukebox and a HTML jukebox.

*Default value*

mjb.skipHtmlGeneration=false



*Valid values*

mjb.skipHtmlGeneration=false mjb.skipHtmlGeneration=true


----

## `mjb.fullMovieInfoInIndexes`

Use full or partial information in the index files.

*Default value*

mjb.fullMovieInfoInIndexes=false


*Valid values*

mjb.fullMovieInfoInIndexes=false mjb.fullMovieInfoInIndexes=true


----

## `mjb.fullCategoriesInIndexes`

This property will limit the information written in the index XML files to only the categories and index names that are current, i.e. the category and index that is being processed.


*Default value*

mjb.fullCategoriesInIndexes=true



*Valid values*

mjb.fullCategoriesInIndexes=true mjb.fullCategoriesInIndexes=false


----
# Person Scanner

These properties control the scanning person`s information.

## `mjb.people`

This parameter sets the collection of enhancement data about people (cast/directors/writers).

*Default value*

mjb.people=false



*Valid values*

mjb.people=true mjb.people=false


## `mjb.people.popularity`

Min popularity of person (count of movies where they appear) to scan personal information. If value greater 0, then use popularity method, else use per movie person count limitations.

*Default value*

mjb.people.popularity=5



## `mjb.people.maxCount`

If mjb.people.popularity equals 0 or -1, then option means count of person from per movie to scan personal details, else the total number of people to scan the method's popularity.

*Default value*

mjb.people.maxCount=10



## `plugin.biography.maxlength`

Max length of biography.

*Default value*

plugin.biography.maxlength=500


## `plugin.filmography.max`

Count of movie per person.

*Default value*

plugin.filmography.max=20


## `plugin.filmography.jobsInclude`

List of jobs included in the filmography.

*Default value*

plugin.filmography.jobsInclude=Director,Writer,Actor,Actress



## `plugin.people.skip.VG`

Skip videogame on filmography scanner.

*Default value*

plugin.people.skip.VG=true


*Valid values*

plugin.people.skip.VG=true plugin.people.skip.VG=false


## `plugin.people.skip.TV`

Skip television on filmography scanner.

*Default value*

plugin.people.skip.TV=false


*Valid values*

plugin.people.skip.TV=true plugin.people.skip.TV=false


## `plugin.people.skip.V`

Skip video on filmography scanner.

*Default value*

plugin.people.skip.V=false


*Valid values*

plugin.people.skip.V=true plugin.people.skip.V=false


## `mjb.includePhoto`

Downloading personal photos from the Internet.

*Default value*

mjb.includePhoto=false


*Valid values*

mjb.includePhoto=true mjb.includePhoto=false



## `photo.scanner.photoExtensions`

Personal photo image extensions.

*Default value*

photo.scanner.photoExtensions=jpg,jpeg,gif,bmp,png


## `mjb.forcePhotoOverwrite`

Enabled personal photo image overwrite.

*Default value*

mjb.forcePhotoOverwrite=false


*Valid values*

mjb.forcePhotoOverwrite=true mjb.forcePhotoOverwrite=false


## `mjb.view.personList`

?omma-separated list of xsl files for multiview functional.

*Default value*

mjb.view.personList=people.xsl



## `indexing.completePerson`

Indexing only people with complete personal information.

*Default value*

indexing.completePerson=true


*Valid values*

indexing.completePerson=true indexing.completePerson=false


## `mjb.people.folder`

Folder name in the Jukebox to store personal information (xml/html/photo files).

*Default value*

mjb.people.folder=


Default personal information store to root Jukebox.


## `plugin.filmography.sort.asc`

Sort the filmography for a person in year order.
By default this is done from newest to oldest (false).

*Default value*

plugin.filmography.sort.asc=false


*Default value*

plugin.filmography.sort.asc=false plugin.filmography.sort.asc=true



----

# Trailer Scanner

## `trailers.scanner.enable`

Specifies if the trailers scanner plugin is enabled or disable.

*Valid values*

trailers.scanner.enable=false trailers.scanner.enable=true


*Default value*

trailers.scanner.enable=true



## `trailers.download`

Specifies if the trailers should be downloaded or not.

*Default value*

trailers.download=false


*Valid values*

trailers.download=false trailers.download=true



## `trailers.scanner`

Specifies trailers scanner plugin priority. Possible to use several plug-ins to search

*Valid values*

trailers.scanner=apple trailers.scanner=comingsoon trailers.scanner=kinopoisk trailers.scanner=youtube (Note: This is for streaming in Flash skins only)


*Default value*

trailers.scanner=apple


## `trailers.path.scaner`

Specifies the absolute path to download trailers.

*Default value*

trailers.path.scaner=

Default trailers store near the movie.

*Example*

trailers.path.scaner=/media/sda1/trailers


## `trailers.path.player`

Specifies the absolute path to play trailers. Parameter is related with trailers.path.scaner.

*Default value*

trailers.path.player=


*Example*

trailers.path.scaner=/tmp/mounted/trailers


## `trailers.rescan.days`

Specifies the number of days before forcing a rescan if a movie has no trailer(s).
Note: a value of -1 disable the rescan

*Default value*

trailers.rescan.days=15


## `trailers.safeFilename`

Make safe the filename or otherwise the same as the name of the movie.

*Valid values*

trailers.safeFilename=false trailers.safeFilename=true


*Default value*

trailers.safeFilename=false



----
# Apple Movie Trailers

## `appletrailers.resolution`

The desired resolution of trailers from apple trailers site 
Leave this blank or commented out to disable this feature

*Valid values*

appletrailers.resolution=1080p appletrailers.resolution=720p appletrailers.resolution=480p appletrailers.resolution=640



## `appletrailers.download`

Determines if the trailers found are downloaded and stored locally or a link is generated for the movie and then streamed as required.

*Valid values*

appletrailers.download=false appletrailers.download=true


*Default value*

appletrailers.download=false



## `appletrailers.typesinclude`

This parameter controls whether the trailer types listed in appletrailers.trailertypes are include (true) or excluded (false) by the plugin

If this is set to true, then the trailer is selected only if it contains one of the types. If this is set to false then the trailer is selected only if it *does not* contain one of the types.

*Valid values*

appletrailers.typesinclude=true appletrailers.typesinclude=false



## `appletrailers.trailertypes`

Comma separated list of trailer types to include or exclude (based on appletrailers.typesinclude parameter)

*Default value*

appletrailers.trailertypes=tlr,tsr



## `appletrailers.replaceurl`

This is the Url to replace all the apple websites (See list below) with to enable downloading. 

Urls to be replaced: 
  - www.apple.com
  - movies.apple.com
  - images.apple.com

*Default value*

appletrailers.replaceurl=www.apple.com


----
# Coming Soon Trailers

## `comingsoontrailers.maxResolution`

Movie trailer can be donwloaded, provided that a QuickTime or Windows Media trailer exists for a given movie. Trailer can be found on comingsoon in 480p, 720p or 1080p resolution. This property controls which resolution shall be chosen. If the specified resolution cannot be found, a lower one will be used. 

*Valid values*

comingsoontrailers.maxResolution=480p comingsoontrailers.maxResolution=720p comingsoontrailers.maxResolution=1080p


*Default value*

comingsoontrailers.maxResolution=1080p


## `comingsoontrailers.preferredFormat`

HD trailers are usually available in MOV format from comingsoon.it. WMV is found sometimes. This property specifies the preferred format order. 

*Valid values*

comingsoontrailers.preferredFormat=wmv comingsoontrailers.preferredFormat=mov comingsoontrailers.preferredFormat=wmv,mov comingsoontrailers.preferredFormat=mov,wmv


*Default value*

comingsoontrailers.preferredFormat=wmv,mov



## `comingsoontrailers.label`

For downloaded trailers, this property will set a label that will be added in the filename. 

*Default value*

comingsoontrailers.label=ita


This leads to file name MOVIE_FILENAME.[TRAILER-ita](.*?\\])?+([\\w-]+)(?:\\[\\w{8}\\])?+(?:.*)).avi


----
# Trailersland Trailers

## `trailersland.max`

Maximum number of trailers to be downloaded or linked

**Default value**

trailersland.max=3



## `trailersland.maxResolution`

The desired resolution of trailers. Valid resolutions are: 1080p 720p sd. Choose only one of these values, if a trailer is not found at that resolution then a lower quality one will be looked for.

**Valid values**

trailersland.maxResolution=sd trailersland.maxResolution=720p trailersland.maxResolution=1080p


**Default value**

trailersland.maxResolution=1080p


## `trailersland.allowedFormats`

Comma-separated list of file extension to be downloaded.
# Valid file extension, separated by commas

**Default value**

trailersland.allowedFormats=wmv,mov,mp4,avi,mkv,mpg


## `trailersland.preferredLanguages`

Ordered list of desired languages (in prefernce order). Valid items are ita, sub-ita, en, fr. 
When more than one trailer is found, these are ordered firstly by language preference, then by trailer type.

**Valid values**

trailersland.preferredLanguages=ita trailersland.preferredLanguages=sub-ita trailersland.preferredLanguages=en trailersland.preferredLanguages=fr trailersland.preferredLanguages=ita,sub-ita,en,fr


**Default value**

trailersland.preferredLanguages=ita,sub-ita,en


## `trailersland.preferredTypes`

Ordered list of desired trailer type. Valid items are trailer and teaser.
When more than one trailer is found, these are ordered firstly by language preference, then by trailer type.

**Valid values**

trailersland.preferredTypes=trailer trailersland.preferredTypes=teaser trailersland.preferredTypes=trailer,teaser


**Default value**

trailersland.preferredTypes=trailer,teaser

Clone this wiki locally