|
SkinConfiguration
List of the options in the skin.properties files and what they do
Phase-Deploy, Skin, properties, configuration, set, thumbnail PropertiesThis is a list of the current properties used in the skin.properties file. From v2.0 of MovieJukebox you can now 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.
Generalmjb.homePageThis 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.indexFileThe 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.skinrootSet 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.dirPlace 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.resourcesPlace 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.skipRegular 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.copyDirsList of directories to copy from the skin directory to the jukebox Default value mjb.skin.copyDirs=html genres.maxThe maximum number of genres to display for a movie Example: To list movies in three categories genres.max=3 actors.maxThe 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.fullMovieInfoInIndexesInclude full movie details in the index xml files Valid values mjb.fullMovieInfoInIndexes=true mjb.fullMovieInfoInIndexes=false sorting.strip.prefixesThis 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.groupEnglishGroup 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.lineBreakThis 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}Plot Summariesmjb.includeEpisodePlotsLookup and include the television episode Plot in the XML file. Valid values are true, false Default value mjb.includeEpisodePlots=false Fanartfanart.movie.downloadDownload 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.widthfanart.movie.heightThese 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.downloadDownload 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.widthfanart.tv.heightThese 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.fanartExtensionsThis determines the extensions of the files that will be scanned for fanart. Default value fanart.scanner.fanartExtensions=jpg,jpeg,gif,bmp,png mjb.scanner.fanartTokenThis 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.upscaleThis 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 Thumbnailsmjb.nbThumbnailsPerPagemjb.nbThumbnailsPerLineThese 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.nbTvThumbnailsPerPagemjb.nbTvThumbnailsPerLineThese 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.nbSetThumbnailsPerPagemjb.nbSetThumbnailsPerLineThe 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.nbTVSetThumbnailsPerPagemjb.nbTVSetThumbnailsPerLineThe 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.genresReduce the number of genres Default value mjb.filter.genres=true thumbnails.formatFormat of the thumbnails generated Valid values thumbnails.format=png thumbnails.format=jpeg thumbnails.widththumbnails.heightThe dimensions of the thumbnails to generate for the index page. Default values thumbnails.width=171 thumbnails.height=243 thumbnails.normalizeThis 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.stretchImage 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.reflectionAdd reflection to the generated thumbnails: true or false Valid values thumbnails.reflection=true thumbnails.reflection=false thumbnails.logoHDAdd 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.logoTVAdd 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.logoSubTitleAdd a SubTitle logo to the thumbnail if the video has subtitles: true or false Valid values thumbnails.logoSubTitle=true thumbnails.logoSubTitle=false thumbnails.logoSetAdd 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.languageAdd a language specific icon (flag) to the thumbnail : true or false Valid values thumbnails.language=true thumbnails.language=false thumbnails.perspectiveAdd a perspective effect to the generated thumbnails Valid values thumbnails.perspective=true thumbnails.perspective=false thumbnails.reflectionHeightThis 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.reflectionStartthumbnails.reflectionEndThese 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.opacityStartthumbnails.opacityEndThese 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.perspectiveTopthumbnails.perspectiveBottomThese 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.perspectiveDirectionThis 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.setSizeAdd 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.roundCornersRound the corner of the thumbnail image Default value thumbnails.roundCorners=false Valid values thumbnails.roundCorners=true thumbnails.roundCorners=false thumbnails.cornerRadiusThe radius (size) of the rounded corner. Default value thumbnails.cornerRadius=25 thumbnails.cornerQualityImprove round corners quality. Recommended values:
Note: The higher values the longer it takes! Default value thumbnails.cornerQuality=0 thumbnails.overlayApply 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.sourceChange 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.offsetXIf 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.offsetYIf 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.addFrameAdd 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.xmlOverlayEnable OverlayXML function for thumbnails. Default value thumbnails.xmlOverlay=false Valid values thumbnails.xmlOverlay=false thumbnails.xmlOverlay=true thumbnails.xmlOverlayFileChoose XML file with OverlayXML settings for thumbnails. Default value thumbnails.xmlOverlay=overlay-default.xml Example: thumbnails.xmlOverlayFile=thumbnails.xml thumbnails.frame.sizeThe depth of the frame around the image Default value thumbnails.frame.size=5 thumbnails.frame.colorSDThe color for the SD frame Default value thumbnails.frame.colorSD=255/255/255 thumbnails.frame.colorHDThe color for the HD frame Default value thumbnails.frame.colorHD=255/255/255 thumbnails.frame.color720The color for the 720p frame Default value thumbnails.frame.color720=255/255/255 thumbnails.frame.color1080The color for the 1080p frame Default value thumbnails.frame.color1080=255/255/255 Postersposters.formatposters.widthposters.heightposters.normalizeposters.stretchposters.reflectionposters.logoHDposters.logoTVposters.languageposters.perspectiveposters.reflectionHeightposters.reflectionStartposters.reflectionEndposters.opacityStartposters.opacityEndposters.perspectiveTopposters.perspectiveBottomposters.perspectiveDirectionposters.addText.setSizeposters.roundCornersposters.cornerQualityposters.cornerRadiusposters.overlayposters.overlay.sourceposters.overlay.offsetXposters.overlay.offsetYposters.addFrameposters.frame.sizeposters.frame.colorSDposters.frame.colorHDposters.frame.color720posters.frame.color1080posters.xmlOverlayposters.xmlOverlayFileAll 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.createPostersIf enabled, posters will be created for set masters. Disabled by default. Valid values * mjb.sets.createPosters=false * mjb.sets.createPosters=true VideoImagesMost 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.includeVideoImagesThis 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 BannersMost 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.includeWideBannersThis 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.onlySeriesBannersOnly download series banners and not specific season banners Valid values mjb.onlySeriesBanners=false mjb.onlySeriesBanners=true mjb.cylceSeriesBannersAttempt 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.titleAdd 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.seasonAdd 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.alignmentThe 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.fontThe 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.fontSizeThe 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.fontColorThe colour of the font. Default value banners.addText.fontColor=LIGHT_GRAY Valid values
banners.addText.fontShadowCreate 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
banners.addText.offsetThis 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 FootersFooters 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.countSet total number of footer images per video. Default value mjb.footer.count=0 mjb.footer.{number}.enableEnable or disable footer.{number} ({number} = 0, 1, 2,...). Default value mjb.footer.{number}.enable=falseValid values mjb.footer.{number}.enable=false
mjb.footer.{number}.enable=truemjb.footer.{number}.nameSet 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}.xmlOverlayEnable OverlayXML function for specified footer image. Otherwise footer image will be blank. Default value {footerName}.xmlOverlay=falseValid values {footerName}.xmlOverlay=false
{footerName}.xmlOverlay=true{footerName}.xmlOverlayFileChoose XML file with OverlayXML settings for specified footer image. Default value {footerName}.xmlOverlay=overlay-default.xmlExample: for "videoname.footer_set.png" footer_set.xmlOverlayFile=footer_set.xml PluginsThis 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-Definitionhighdef.differentiateDifferentiate 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.widthThe 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.widthThe width of the video to define 1080p Default value highdef.1080.width=1920 | ||||||||||||||||||||||||||
► Sign in to add a comment
Be aware that if you are using a PAL system, the default values for background size are wrong, resulting in cropping. Change the values of background.width , background.height from 720x480 (NTSC) to 720x576