My favorites | Sign in
Project Home Downloads Wiki Issues Source
Search
for
ArtworkScanner_TEMP  
This describes the changes to the artwork scanner in an upcoming release
Artwork, Skin, Plugin, Phase-Design
Updated Apr 18, 2012 by Stuart.Boston

NOTE: This page is temporary and will be moved into Artwork when finished and released

Introduction

For 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.

Configuration

There 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 Types

All of the properties listed will apply to all of the artwork types. Currently the artwork types are:

ArtworkType TV or Movie In Use
Poster (posters) Both No
Fanart (fanart) Both No
Banner (banners) TV No
VideoImage (videoimages) TV No
ClearArt TV Yes
ClearLogo TV Yes
TvThumb TV Yes
SeasonThumb TV Yes
MovieArt Movie Yes
MovieDisc Movie Yes
MovieLogo Movie Yes

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.

Properties

These are the properties used:

{artworkType}.scanner.searchForExistingArtwork

True/False - Should local artwork be looked for? If a skin doesn't use a particular artwork type, it can be skipped totally.

{artworkType}.scanner.artworkExtensions

list of image extensions to search for the artwork. Example: jpg, jpeg, gif, png

{artworkType}.scanner.artworkToken

The token that determines this artwork type in the filename. For example .fanart. The filename format is: {video name}{artworkToken}.{artworkFormat}

{artworkType}.scanner.imageName

This 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.artworkDirectory

The name of the directory that artwork is stored in. Will be checked relative to the video and to the library

{artworkType}.scanner.artworkPriority

There 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:

  • video
  • folder
  • fixed
  • series
  • directory

The default configuration for each artwork type is:

{artworkType}.scanner.artworkPriority=video,folder,fixed,series,directory

video

This will search the same directory as the video is in for artwork named the same as the video.

folder

This will search for artwork named the same as the directory that the video is in.

fixed

This will search for artwork with fixed names

series

This will search for series artwork ABOVE the directory that the video resides in Only valid for TV Sets

directory

This 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}.format

the format to save the artwork in

{artworkType}.movie.download

download the artwork from the internet for Movies

{artworkType}.tv.download

download the artwork from the internet for TV Shows

Artwork Sizes & Quantities

NOTE: 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 & Quantity

The 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

Dimensions

Once 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

Sign in to add a comment
Powered by Google Project Hosting