|
ArtworkScanner_TEMP
This describes the changes to the artwork scanner in an upcoming release
Artwork, Skin, Plugin, Phase-Design NOTE: This page is temporary and will be moved into Artwork when finished and released
IntroductionFor a long time the way that MovieJukebox locates the local artwork has been fairly restrictive. You must store it with the video and it must be named the same as the video with a token extension (.fanart, .banner, etc.) Changes over time have enabled some flexibility to that model, but not much. This new artwork scanner update will allow you to store your artwork anywhere, named anyway you like it or that fits with other media centres. ConfigurationThere are several new and changed configuration options available now. You should take time to read them and understand what has changed to get the most out of your set-up. By default the settings will be configured to emulate the way that YAMJ works now (upto v2.5). Artwork TypesAll of the properties listed will apply to all of the artwork types. Currently the artwork types are:
The major change from previous versions, is the ability to specify where the scanner will search for artwork and in what order. This is controled by the [ArtworkScanner_TEMP#{artworkType}.scanner.artworkPriority artworkPriority] property. PropertiesThese are the properties used: {artworkType}.scanner.searchForExistingArtworkTrue/False - Should local artwork be looked for? If a skin doesn't use a particular artwork type, it can be skipped totally. {artworkType}.scanner.artworkExtensionslist of image extensions to search for the artwork. Example: jpg, jpeg, gif, png {artworkType}.scanner.artworkTokenThe token that determines this artwork type in the filename. For example .fanart. The filename format is: {video name}{artworkToken}.{artworkFormat} {artworkType}.scanner.imageNameThis is a list of fixed filenames that the scanner should search for. It should not include the extension (use [ArtworkScanner_TEMP#{artworkType}.scanner.artworkExtensions artworkExtensions] for that). Example: if you want to search for fanart called backdrop.jpg or fanart.jpg, you should set this property to {artworkType}.scanner.imageName=backdrop,fanart {artworkType}.scanner.Validate{artworkType}.scanner.ValidateMatch{artworkType}.scanner.ValidateAspect{artworkType}.scanner.artworkDirectoryThe name of the directory that artwork is stored in. Will be checked relative to the video and to the library {artworkType}.scanner.artworkPriorityThere are five different orders that each type of artwork can be searched for. As soon as a matching piece of artwork is found, the search stops. This will change in a later release as MovieJukebox will have the ability to store and use multiple artwork images. The available priorities are:
The default configuration for each artwork type is: {artworkType}.scanner.artworkPriority=video,folder,fixed,series,directoryvideoThis will search the same directory as the video is in for artwork named the same as the video. folderThis will search for artwork named the same as the directory that the video is in. fixedThis will search for artwork with fixed names seriesThis will search for series artwork ABOVE the directory that the video resides in Only valid for TV Sets directoryThis will search for artwork in a sub-directory, firstly the location where the video is stored and then the library root. Use in conjunction with [ArtworkScanner_TEMP#{artworkType}.scanner.artworkDirectory artworkDirectory] {artworkType}.formatthe format to save the artwork in {artworkType}.movie.downloaddownload the artwork from the internet for Movies {artworkType}.tv.downloaddownload the artwork from the internet for TV Shows Artwork Sizes & QuantitiesNOTE: This is not implemented These parameters control the creation of the various artwork sizes and quantities. They allow you to download up to a specific number of each type of artwork. Artwork sizes are disabled by default, except for large which will need to be turned off (=0) if not required. Note: Only 1 original artwork will be downloaded per artwork and the width & height for that type will be ignored. Enable & QuantityThe basic format of this property is {artworkType}.{movie|tv}.size.{original|large|medium|small}=??artworkType should be one of the artwork types ArtworkScanner_TEMP#Artwork_Types Example: Get 2 Large posters for TV, 1 for Movies and 3 Small each poster.movie.size.large=1 poster.tv.size.large=2 poster.movie.size.small=3 poster.tv.size.small=3 DimensionsOnce you have defined the required sizes and quantities, you need to define the sizes (dimensions) each of those artwork will have. You only need to specify the required width and height for each of the movie/tv sizes. Defaut format: {artworkType}.{movie|tv}.{large|medium|small}.width=??
{artworkType}.{movie|tv}.{large|medium|small}.height=??Example: Define the size of the large fanart artwork for movie and tv as well as the small fanart. fanart.movie.large.width=1280 fanart.movie.large.height=720 fanart.tv.large.width=1000 fanart.tv.large.height=600 fanart.movie.small.width=640 fanart.movie.small.height=360 fanart.tv.small.width=500 fanart.tv.small.height=300 | ||||||||||||||||||||||||||||||||||||