Skin Configuration - YAMJ/yamj-v2 GitHub Wiki
List of the options in the skin.properties files and what they do
Properties
This is a list of the current properties used in the skin.properties file.
You can specify a skin-user.properties file to over-ride the skin.properties file that is distributed with each skin. This file is not distributed with MovieJukebox and must be created by you.
You should only place the parameters in this file that you specifically want to over-ride from the default skin.properties file provided by the skin maker.
<wiki:toc max_depth="2" />
General
mjb.homePage
This is the default page displayed when the index.htm is loaded. This can point to any of the html files created in the jukebox directory, or it may be left blank. If left blank, the default page will be the first category listed in categories.xml which has at least one movie.
Default value
mjb.homePage=
Example: To point to the new page, change the value to
mjb.homePage=Other_New_1
mjb.indexFile
The name of the genrated index file. Use the default value for HD skins, but SD skins should change it to index_sd.htm inorder for the NMT to autoload it.
Default value
mjb.indexFile=index.htm
Example: To create index_sd.htm for and SD skin
mjb.indexFile=index_sd.htm
mjb.overlay.skinroot
Set relation of overlay.dir; true = skin root (mjb.skin.dir), false = YAMJ root
Default value
mjb.overlay.skinroot=true
Valid values
mjb.overlay.skinroot=false
mjb.overlay.skinroot=true
mjb.overlay.dir
Place of overlay xml files and overlay.properties. Relation depends on mjb.overlay.skinroot setting. Instead of skin(-user).properties overlay settings can be put in overlay.properties.
Default value (= /skins/skin folder)
mjb.overlay.dir=.
mjb.overlay.resources
Place of overlay xml resources (overlay images, default overlay PNGs, dummy images).
Default value (= /skins/skin/resources folder)
mjb.overlay.resources=resources
Example: overlay XMLs and images are in "/skins/eversion/resources/eskin":
mjb.skin.dir=./skins/eversion
mjb.overlay.skinroot=true
mjb.overlay.dir=./resources/eskin
mjb.overlay.resources=.
mjb.clean.skip
Regular expression for files that are part of the skin, so they should be skipped during cleaning (if -c is specified at the command line).
NOTE: This is Java REGEX and so you need to use .** to be the equivalent of ** in standard REGEX
Example: Tell YAMJ not to delete the categories.css, exportindex_item_pch.css, or exportdetails_item_popcorn.css files.
mjb.clean.skip=categories.css|exportindex_item_pch.css|exportdetails_item_popcorn.css
or, somewhat similarly
mjb.clean.skip=categories.css|export.***item*.**.css
Note the use of .* in the last item
mjb.skin.copyDirs
List of directories to copy from the skin directory to the jukebox
Default value
mjb.skin.copyDirs=html
genres.max
The maximum number of genres to display for a movie
Example: To list movies in three categories
genres.max=3
actors.max
The maximum number of actors to display for a movie
Example: To display 6 actors in the movie detail page (if supported by the skin)
actors.max=6
mjb.fullMovieInfoInIndexes
Include full movie details in the index xml files
Valid values
mjb.fullMovieInfoInIndexes=true
mjb.fullMovieInfoInIndexes=false
sorting.strip.prefixes
This is a list of articles (The, An, A, etc.) to ignore when sorting the video files.
Default Value
sorting.strip.prefixes="A ","An ","The ","Le ","Les "
indexing.character.groupEnglish
Group all English characters into a single A-Z category. This is most useful for non-English character sets such as Cyrillic or Hebrew. Note: This should only really be used by non-English users.
Valid values
indexing.character.groupEnglish=false
indexing.character.groupEnglish=true
Default value
indexing.character.groupEnglish=false
mjb.lineBreak
This property controls the replacement value for the line break that is used by the plugins and the skins.
This should not be changed unless you know what you are doing and not all skins/plugins will use this value.
Default value
mjb.lineBreak={br}
mjb.customPages
This property allows skin makers to create custom pages for their skin. The property should contain a comma separated list of one or more pages that will be transformed.
Example
mjb.customPages=setup
These values will use "setup.xsl" and it's companion file "setup.xml" in the skin folder to create a file called "setup.html" in the jukebox.
Plot Summaries
imdb.plot
Lookup for the storyline (long) or the outline (short) when grabbing the movie plot from IMDB. Valid values are short, long
Default value
imdb.plot=short
mjb.includeEpisodePlots
Lookup and include the television episode Plot in the XML file. Valid values are true, false
Default value
mjb.includeEpisodePlots=false
Fanart
fanart.movie.download
Download fanart image for movies using the IMDB id. Please note that if the skin does not use fanart, then this will have no discernible effect except to slow down the generation of your jukebox.
Valid values
fanart.movie.download=false
fanart.movie.download=true
fanart.movie.width
fanart.movie.height
These settings affect the resizing of the fanart to the values specified. The default values are for a HD TV (regardless of 1080p or 720p). Change these variables if you need the pictures to fit a SD TV
default values
fanart.movie.width=1280
fanart.movie.height=720
fanart.tv.download
Download fanart image for TV shows using the IMDB id. Please note that if the skin does not use fanart, then this will have no discernible effect except to slow down the generation of your jukebox.
Valid values
fanart.tv.download=false
fanart.tv.download=true
fanart.tv.width
fanart.tv.height
These settings affect the resizing of the fanart to the values specified. The default values are for a HD TV (regardless of 1080p or 720p). Change these variables if you need the pictures to fit a SD TV
default values
fanart.tv.width=1280
fanart.tv.height=720
fanart.scanner.fanartExtensions
This determines the extensions of the files that will be scanned for fanart.
Default value
fanart.scanner.fanartExtensions=jpg,jpeg,gif,bmp,png
mjb.scanner.fanartToken
This is the extension to the video name to scan for fanart. This should be a value that shouldn't occur in any video filenames and should occur at the end of the video filename. If no fanart is found for a video, the normal download will be run.
Example
This.Is.My.Movie.mkv
This.Is.My.Movie.Fanart.jpg
Default value
mjb.scanner.fanartToken=.Fanart
fanart.upscale
This allows you to turn on or off upscaling of the fanart background image.
Default value
fanart.upscale=true
Valid values
fanart.upscale=true
fanart.upscale=false
Thumbnails
mjb.nbThumbnailsPerPage
mjb.nbThumbnailsPerLine
These values control the thumbnail settings on the index page. nbThumbnailsPerPage controls the number of thumbnails displayed on the page, while nbThumbnailsPerLine controls the number of thumbnails on each row.
Default values
mjb.nbThumbnailsPerPage=10
mjb.nbThumbnailsPerLine=5
mjb.nbTvThumbnailsPerPage
mjb.nbTvThumbnailsPerLine
These two values overwrite the mjb.nbThumbnailsPerPage & mjb.nbThumbnailsPerLine values for the TV Show indexes. These are for use with season banners for those skins that use them as banners are a different size to normal posters
Default values If these properties are not populated then they will default to the values of mjb.nbThumbnailsPerPage & mjb.nbThumbnailsPerLine respectively.
mjb.nbSetThumbnailsPerPage
mjb.nbSetThumbnailsPerLine
The number of thumbnails per line & page for Movie sets. If these values are blank or zero (0) then the standard movie values will be used
mjb.nbTVSetThumbnailsPerPage
mjb.nbTVSetThumbnailsPerLine
The number of thumbnails per line & page for TV sets. If these values are blank or zero (0) then the standard TV values will be used
mjb.filter.genres
Reduce the number of genres
Default value
mjb.filter.genres=true
thumbnails.format
Format of the thumbnails generated
Valid values
thumbnails.format=png
thumbnails.format=jpeg
thumbnails.width
thumbnails.height
The dimensions of the thumbnails to generate for the index page.
Default values
thumbnails.width=171
thumbnails.height=243
thumbnails.normalize
This parameter controls the thumbnails resizing policy.
When true, the generated thumbnails will be exactly WIDTHxHEIGHT (=> cropped images) When false, the original poster aspect ratio is respected
Valid values
thumbnails.normalize=true
thumbnails.normalize=false
thumbnails.stretch
Image resizing policy
Example 1:
thumbnails.normalize=true
thumbnails.stretch=false
The generated image will be exactly WIDTHxHEIGHT (=> original aspect ratio but cropped images)
Example 2:
thumbnails.normalize=false
thumbnails.stretch=true
The generated image will be exactly WIDTHxHEIGHT (=> changed aspect ratio but full images)
Example 3:
thumbnails.normalize=false
thumbnails.stretch=false
The original image aspect ratio is respected but only WIDTH will be used (bigger height->bottom cropped / lower height->gap at the top)
thumbnails.reflection
Add reflection to the generated thumbnails: true or false
Valid values
thumbnails.reflection=true
thumbnails.reflection=false
thumbnails.logoHD
Add a HD logo to the thumbnail when the movie is 720p or 1080p : true or false
Valid values
thumbnails.logoHD=true
thumbnails.logoHD=false
thumbnails.logoTV
Add a TV logo to the thumbnail if the video is a TV Show: true or false
Valid values
thumbnails.logoTV=true
thumbnails.logoTV=false
thumbnails.logoSubTitle
Add a SubTitle logo to the thumbnail if the video has subtitles: true or false
Valid values
thumbnails.logoSubTitle=true
thumbnails.logoSubTitle=false
thumbnails.logoSet
Add a logo to the thumbnails of set posters to indicate that they are sets: true or false
Valid values
thumbnails.logoSet=true
thumbnails.logoSet=false
thumbnails.language
Add a language specific icon (flag) to the thumbnail : true or false
Valid values
thumbnails.language=true
thumbnails.language=false
thumbnails.perspective
Add a perspective effect to the generated thumbnails
Valid values
thumbnails.perspective=true
thumbnails.perspective=false
thumbnails.reflectionHeight
This controls how much of the poster to reflect, this is listed as a percentage of the poster height.
Default Value
thumbnails.reflectionHeight=12.5
thumbnails.reflectionStart
thumbnails.reflectionEnd
These two parameters control where the reflection gradient effect will occur on the reflection portion of the image as a percentage of the reflection height. The default values are 0% and 100%.
Default values
thumbnails.reflectionStart=0.0
thumbnails.reflectionEnd=100.0
thumbnails.opacityStart
thumbnails.opacityEnd
These two parameters control the opacity of the gradient effect. They range from 0% which is clear to 100% which is totally opaque.
Default values
thumbnails.opacityStart=30.0
thumbnails.opacityEnd=100.0
thumbnails.perspectiveTop
thumbnails.perspectiveBottom
These control the percentage that the corners dip to give the perspective view, this is listed as a percentage of the poster height.
Default Value
thumbnails.perspectiveTop=3
thumbnails.perspectiveBottom=3
thumbnails.perspectiveDirection
This controls the direction of the perspective. The Left and Right values are the side of the poster that dips away.
For the "both" parameter an additional graphic is created named "_mirror" which is equivalent to the left perspective. The standard graphic is equivalent to the right perspective.
Valid Values
thumbnails.perspectiveDirection=right
thumbnails.perspectiveDirection=left
thumbnails.perspectiveDirection=both
Default Value
thumbnails.perspectiveDirection=right
thumbnails.addText.setSize
Add the number of the set's elements to the thumbnail of set. This will be at the bottom of the thumbnail. Displays numbers from '1' to '9', and when set contains more than 9 movies - displays text '9+'.
Default value
thumbnails.addText.setSize=false
Valid values
thumbnails.addText.setSize=true
thumbnails.addText.setSize=false
You can specify the text's color, the shadow's color, the font name and a few other parameters as described below for banners - see *banners.addText.** parameters. Defaut color of text is LIGHT_GRAY, default color of shadow is DARK_GRAY.
thumbnails.roundCorners
Round the corner of the thumbnail image
Default value
thumbnails.roundCorners=false
Valid values
thumbnails.roundCorners=true
thumbnails.roundCorners=false
thumbnails.cornerRadius
The radius (size) of the rounded corner.
Default value
thumbnails.cornerRadius=25
thumbnails.cornerQuality
Improve round corners quality. Recommended values:
- image height >= 720px: 0-10
- image height < 720px: 10-20 (depends on system)
Note: The higher values the longer it takes!
Default value
thumbnails.cornerQuality=0
thumbnails.overlay
Apply an overlay to the thumbnail picture. If this property is set to true, then the file "overlay_thumbnails.png" will be applied to the thumbnail picture to create a new thumbnail.
Default value
thumbnails.overlay=false
Valid values
thumbnails.overlay=true
thumbnails.overlay=false
thumbnails.overlay.source
Change the overlay image to be used based on a pre-determined criteria. There are four options to choose from: default, videosource, container & certification.
The "default" option will use a static (single) image for all of the graphic types, for example: default_overlay_thumbnails.png
"videosource", "container" & "certification" will utilise the fields from the XML to determine what image to overlay.
There has to be a corresponding PNG file in the skin/resources folder for this option to work. The file should be named {value}*overlay*{grapictype}.png in lower case letters.
For example a videosource of BLURAY for thumbnails: bluray_overlay_thumbnails.png
Default value
thumbnails.overlay.source=default
Valid values
thumbnails.overlay.source=default
thumbnails.overlay.source=videosource
thumbnails.overlay.source=container
thumbnails.overlay.source=certification
thumbnails.overlay.offsetX
If the graphic overlay is used, this value controls how far from the left side of the overlay the thumbnail is placed.
Default value
thumbnails.overlay.offsetX=0
thumbnails.overlay.offsetY
If the graphic overlay is used, this value controls how far from the top of the overlay the thumbnail is placed.
Default value
thumbnails.overlay.offsetY=0
thumbnails.addFrame
Add a frame with a defined thickness (= frameSize) around the Image depending on resolution (SD, HD, 720p, 1080p) it can be filled with RGB color; default is White (255, 255, 255) Note: for 720p and 1080p differentiation, highdef.differentiate=true must be set.
Default value
thumbnails.addFrame=false
Valid values
thumbnails.addFrame=false
thumbnails.addFrame=true
thumbnails.xmlOverlay
Enable OverlayXML function for thumbnails.
Default value
thumbnails.xmlOverlay=false
Valid values
thumbnails.xmlOverlay=false
thumbnails.xmlOverlay=true
thumbnails.xmlOverlayFile
Choose XML file with OverlayXML settings for thumbnails.
Default value
thumbnails.xmlOverlay=overlay-default.xml
Example:
thumbnails.xmlOverlayFile=thumbnails.xml
thumbnails.frame.size
The depth of the frame around the image
Default value
thumbnails.frame.size=5
thumbnails.frame.colorSD
The color for the SD frame
Default value
thumbnails.frame.colorSD=255/255/255
thumbnails.frame.colorHD
The color for the HD frame
Default value
thumbnails.frame.colorHD=255/255/255
thumbnails.frame.color720
The color for the 720p frame
Default value
thumbnails.frame.color720=255/255/255
thumbnails.frame.color1080
The color for the 1080p frame
Default value
thumbnails.frame.color1080=255/255/255
Posters
posters.format
posters.width
posters.height
posters.normalize
posters.stretch
posters.reflection
posters.logoHD
posters.logoTV
posters.language
posters.perspective
posters.reflectionHeight
posters.reflectionStart
posters.reflectionEnd
posters.opacityStart
posters.opacityEnd
posters.perspectiveTop
posters.perspectiveBottom
posters.perspectiveDirection
posters.addText.setSize
posters.roundCorners
posters.cornerQuality
posters.cornerRadius
posters.overlay
posters.overlay.source
posters.overlay.offsetX
posters.overlay.offsetY
posters.addFrame
posters.frame.size
posters.frame.colorSD
posters.frame.colorHD
posters.frame.color720
posters.frame.color1080
posters.xmlOverlay
posters.xmlOverlayFile
All of the same properties for the thumbnail rendering can be applied to the detail Poster image
Default values
- posters.format=png
- posters.width=400
- posters.height=600
- posters.normalize=false
- posters.reflection=true
- posters.logoHD=false
- posters.logoTV=false
- posters.language=false
- posters.perspective=true
mjb.sets.createPosters
If enabled, posters will be created for set masters. Disabled by default. Valid values
- mjb.sets.createPosters=false
- mjb.sets.createPosters=true
!VideoImages
Most of the same settings for thumbnails and posters can be used for the video images if they are enabled in the skin.
Default values
videoimages.format=jpg
videoimages.width=400
videoimages.height=225
videoimages.normalize=false
videoimages.reflection=false
videoimages.reflectionHeight=12.5
videoimages.reflectionStart=0.0
videoimages.reflectionEnd=100.0
videoimages.opacityStart=30.0
videoimages.opacityEnd=100.0
videoimages.perspective=false
videoimages.perspectiveTop=3.0
videoimages.perspectiveBottom=3.0
videoimages.perspectiveDirection=right
mjb.includeVideoImages
This setting will download episode images from TheTVDB.com for each of the TV Series episodes. If there is no image associated with the video, then a dummy image is used
Valid values
mjb.includeVideoImages=false
mjb.includeVideoImages=true
Season Wide Banners
Most of the same settings for thumbnails and posters can be used for season wide banners if they are enabled in the skin.
Default values
banners.format=jpg
banners.width=400
banners.height=225
banners.normalize=false
banners.reflection=false
banners.reflectionHeight=12.5
banners.reflectionStart=0.0
banners.reflectionEnd=100.0
banners.opacityStart=30.0
banners.opacityEnd=100.0
banners.perspective=false
banners.perspectiveTop=3.0
banners.perspectiveBottom=3.0
banners.perspectiveDirection=right
mjb.includeWideBanners
This setting will download episode images from TheTVDB.com for each of the TV Series episodes. If there is no image associated with the video, then a dummy image is used
Valid values
mjb.includeWideBanners=false
mjb.includeWideBanners=true
mjb.onlySeriesBanners
Only download series banners and not specific season banners
Valid values
mjb.onlySeriesBanners=false
mjb.onlySeriesBanners=true
mjb.cylceSeriesBanners
Attempt to download different series banners for each season
This works if "mjb.seriesOnlyBanners=false" and there are no season banners and "mjb.seriesOnlyBanners=true"
Valid values
mjb.cylceSeriesBanners=true
mjb.cylceSeriesBanners=false
banners.addText.title
Add the title of the video file to the banner. This will be at the top of the banner.
Default value
banners.addText.title=false
Valid values
banners.addText.title=true
banners.addText.title=false
banners.addText.season
Add the season to the bottom of the banner. Note: using this value, MovieJukebox will attempt to download "blank" banners before any others.
Default value
banners.addText.season=false
Valid values
banners.addText.season=true
banners.addText.season=false
banners.addText.alignment
The horizontal alignment of the Title and Season text
Default value
banners.addText.alignment=left
Valid values
banners.addText.alignment=left
banners.addText.alignment=right
banners.addText.alignment=centre
banners.addText.font
The font to be used for the text. Note this should be the name of a system font.
Default value
banners.addText.font=Helvetica
banners.addText.fontSize
The size of the font to use. If you specify too large a value the text could be out of alignment.
Default value
banners.addText.fontSize=36
banners.addText.fontColor
The colour of the font.
Default value
banners.addText.fontColor=LIGHT_GRAY
Valid values || WHITE || LIGHT_GRAY || GRAY || DARK_GRAY || BLACK || || RED || PINK || ORANGE || YELLOW || GREEN || || MAGENTA || CYAN || BLUE ||
banners.addText.fontShadow
Create a drop shadow for the text in the specified colour. If this value is blank then the shadow won't be created.
Default value
banners.addText.fontShadow=DARK_GRAY
Valid values || WHITE || LIGHT_GRAY || GRAY || DARK_GRAY || BLACK || || RED || PINK || ORANGE || YELLOW || GREEN || || MAGENTA || CYAN || BLUE ||
banners.addText.offset
This is the offset of the font from the left (alignment=left) or right (alignment=right) of the border. You may need to change this value if you alter the font size.
Default value
banners.addText.offset=10
Footers
Footers show a video's mediainfo as graphical elements and are exclusively generated by OverlayXML functions. They don't contain any artwork (thumbnail, poster, etc.) and can be positioned independently from artwork (e.g. in indexes).
Most of the same settings for thumbnails and posters can be used for footers if they are enabled in the skin.
mjb.footer.count
Set total number of footer images per video.
Default value
mjb.footer.count=0
mjb.footer.{number}.enable
Enable or disable footer.{number} ({number} = 0, 1, 2,...).
Default value
mjb.footer.{number}.enable=false
Valid values
mjb.footer.{number}.enable=false
mjb.footer.{number}.enable=true
mjb.footer.{number}.name
Set footer.{number} token name ({number} = 0, 1, 2,...).
Default value
mjb.footer.{number}.name=footer.{number}
Example: for "videoname.footer_set.png"
mjb.footer.0.name=footer_set
{footerName}.xmlOverlay
Enable OverlayXML function for specified footer image. Otherwise footer image will be blank.
Default value
{footerName}.xmlOverlay=false
Valid values
{footerName}.xmlOverlay=false
{footerName}.xmlOverlay=true
{footerName}.xmlOverlayFile
Choose XML file with OverlayXML settings for specified footer image.
Default value
{footerName}.xmlOverlay=overlay-default.xml
Example: for "videoname.footer_set.png"
footer_set.xmlOverlayFile=footer_set.xml
Plugins
This is the fully qualified name of the plugin class implementing the thumbnail, poster, video images and background generator for movie posters.
You can replace this default class with your own in order to develop your customized image creator.
The class must implement interface com.moviejukebox.MovieImagePlugin. 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 THESE VALUES.
Default values
mjb.image.plugin=com.moviejukebox.plugin.DefaultImagePlugin
mjb.background.plugin=com.moviejukebox.plugin.DefaultBackgroundPlugin
High-Definition
highdef.differentiate
Differentiate between 720p and 1080p. If this property is not set or false, then the highdef.720.width will be used to determine if a video is HD
Default value
highdef.differentiate=false
Valid values
highdef.differentiate=false
highdef.differentiate=true
highdef.720.width
The width of the video to define 720p. Note this will be used if highdef.differentiate=false to calculate a high-definition video
Default value
highdef.720.width=1280
highdef.1080.width
The width of the video to define 1080p
Default value
highdef.1080.width=1920