Add-on:Artwork Downloader: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>Martijn
>Martijn
Line 165: Line 165:
''<u>All commands are case sensitive!</u>''
''<u>All commands are case sensitive!</u>''


'''Silent mode'''
 
'''Modes'''
 
These are the available mode like they where explained before
* mode=gui
* mode=custom
* silent=true
 
'''Silent mode:'''


This will run the script in background mode. It will only display the starting and finish notification dialog. Only useful when used for bulk mode.
This will run the script in background mode. It will only display the starting and finish notification dialog. Only useful when used for bulk mode.
Line 187: Line 195:


'''Medianames'''
'''Medianames'''
Available medianame usage for skins:
Available medianame usage for skins:
* Movies:
* Movies:
Line 204: Line 213:


This are the available art types that can be used in the scrip command.
This are the available art types that can be used in the scrip command.


* Movies:
* Movies:
Line 239: Line 247:
** discart ''(not yet available)''
** discart ''(not yet available)''


'''Modes'''
These are the available mode like they where explained before
* mode=gui
* mode=custom




Revision as of 18:10, 3 February 2012

Artwork Downloader
http://mirrors.xbmc.org/addons/eden-pre/script.artwork.downloader/icon.png

See this add-on on the kodi.tv showcase

Author: paddycarey, putneyj, Martijn

Type: Program
Repo:

Summary: Downloads Artwork for TV shows, Movies and Musicvideos in your library
Home icon grey.png   ▶ Add-ons ▶ Artwork Downloader

Downloads all available artwork for TV shows, Movies and Musicvideos in your library. Check the options for supported artwork

Artwork sources:
www.fanart.tv
www.thetvdb.com
www.themoviedb.org

Remark:
Check your skin to see what type of artwork is supported!
Each TV Show/Movie must have its own folder!

Skin integration:
See readme file

Installing

This add-on is installed from the Add-on browser located in Kodi as follows:

  1. Settings
  2. Add-ons
  3. Install from repository
  4. Program Add-ons
  5. Artwork Downloader
  6. Install

Summary:

This add-ons searches through your library for all your currently added Movies, TV Shows and Musicvideos and then searches for avaiable artwork. This then is downloaded to the folder location where that media is stored.

Current Features

Download artwork

  • Movies
  • TV Shows
  • Musicvideos


Limit artwork

  • Maximum extrafanart
  • Minimum rating
  • Preferred language (fall-back is always English)
  • Exclude fanart that has text (only available on thetvdb.com)
  • Minimum fanart size Movies (also for Musicvideos)
  • Minimum fanart size TV Shows


Overwrite all

  • This will overwrite all current files with the ones that fit the limiter. This option will automatic reset after a download run.

Artwork sources:

Please show your support to these sites by donating or contributing new artwork!

Filenaming conventions

Movies:

  • Poster (poster.jpg)
  • Fanart (fanart.jpg)
  • Extrafanart (<image ID from provider>.jpg)
  • Extrathumbs (thumb1.jpg to thumb4.jpg)


TV Shows:

  • Poster (poster.jpg)
  • Season Posters (season-all.jpg / seasonxx.jpg / season-specials.jpg)
  • Fanart (fanart.jpg)
  • Extrafanart (<image ID from provider>.jpg)
  • Clearart (cleart.png)
  • Characterart (character.png)
  • Logo (logo.png)
  • Banner (banner.jpg)
  • Season Banners (seasonbannerxx.jpg)


Musicvideos:

  • Poster (poster.jpg)
  • Fanart (fanart.jpg)
  • Extrafanart (<image ID from provider>.jpg)
  • Extrathumbs (thumb1.jpg to thumb4.jpg)


Limit artwork on (when available):

  • Maximum number of extrafanart
  • Rating
  • Without text
  • Language
  • Image size
  • Automaticly deleted extrafanart below the set limits (when available)

Skin integration

This add-on support different kind of skin integration methods. This allows skins to use buttons to download different kinds of artwork for a single media item or in bulk mode.

Solo mode

This downloads for a single media item depending from what section of XBMC this is gonna be used from.

Run script for single media item

This downloads all available artwork that has been enable in the add-on settings.

Script command: 

   XBMC.RunScript(script.artwork.downloader, mediatype=?, medianame=?)

Skin example: 

   <item id="8">
       <description>Get Artwork</description>
       <label>$LOCALIZE[31316]</label>
       <onclick condition="Container.Content(tvshows)">XBMC.RunScript(script.artwork.downloader, mediatype=tvshow, medianame=$INFO[ListItem.TVShowTitle])</onclick>
       <onclick condition="Container.Content(movies)">XBMC.RunScript(script.artwork.downloader, mediatype=movie, medianame=$INFO[ListItem.Title],mediapath=$INFO[ListItem.Path])</onclick>
       <onclick condition="Container.Content(musicvideos)">XBMC.RunScript(script.artwork.downloader, mediatype=musicvideos, medianame=$INFO[ListItem.Title],mediapath=$INFO[ListItem.Path])</onclick>
       <visible>[Container.Content(tvshows)|Container.Content(movies)|Container.Content(musicvideos)]+system.hasaddon(script.artwork.downloader)</visible>
   </item>


Runs script in GUI dialog mode

A menu is displayed with available artwork type. When a artwork type is selected the image list with available images will be displayed. This won't take the add-on settings into account.

The selected image will automaticly overwrite the current one when present.


Script command: 

   XBMC.RunScript(script.artwork.downloader, mode=gui, mediatype=?, medianame=?)

Skin example: 

   <item id="8">
       <description>Get Artwork</description>
       <label>$LOCALIZE[31316]</label>
       <onclick condition="Container.Content(tvshows)">XBMC.RunScript(script.artwork.downloader, mode=gui, mediatype=tvshow, medianame=$INFO[ListItem.TVShowTitle])</onclick>
       <onclick condition="Container.Content(movies)">XBMC.RunScript(script.artwork.downloader, mode=gui, mediatype=movie, medianame=$INFO[ListItem.Title],mediapath=$INFO[ListItem.Path])</onclick>
       <onclick condition="Container.Content(musicvideos)">XBMC.RunScript(script.artwork.downloader, mode=gui, mediatype=musicvideo, medianame=$INFO[ListItem.Title],mediapath=$INFO[ListItem.Path])</onclick>
       <visible>[Container.Content(tvshows)|Container.Content(movies)|Container.Content(musicvideos)]+system.hasaddon(script.artwork.downloader)</visible>
   </item>

Runs script in custom mode

In this mode you can specify an artwork type that you want to download for a specific media item. When only one image is found it will be just downloaded. When multiple images are found the image selection dialog will be shown for user selection. You can specify multiple artwork types for downloading however this won't show the image selection dialog. The image dialog is also disabled for extrathumbs and extrafanart.

This won't take the add-on settings into account except for extrafanart/extrathumbs.

Script command: 

   XBMC.runscript(script.artwork.downloader, mode=custom, mediatype=?,medianame=?, <art_type>)

   XBMC.runscript(script.artwork.downloader, mode=custom, mediatype=?,medianame=?, <art_type>, <art_type>, <art_type>)

Skin example: 

   <item id="8">
       <description>Get Artwork</description>
       <label>$LOCALIZE[31316]</label>
       <onclick condition="Container.Content(tvshows)">XBMC.RunScript(script.artwork.downloader, mode=custom, mediatype=tvshow, medianame=$INFO[ListItem.TVShowTitle], extrafanart)</onclick>
       <onclick condition="Container.Content(movies)">XBMC.RunScript(script.artwork.downloader, mode=custom, mediatype=movie, medianame=$INFO[ListItem.Title],mediapath=$INFO[ListItem.Path], extrafanart)</onclick>
       <onclick condition="Container.Content(musicvideos)">XBMC.RunScript(script.artwork.downloader, mode=custom, mediatype=musicvideo, medianame=$INFO[ListItem.Title],mediapath=$INFO[ListItem.Path], extrafanart)</onclick>
       <visible>[Container.Content(tvshows)|Container.Content(movies)|Container.Content(musicvideos)]+system.hasaddon(script.artwork.downloader)</visible>
   </item>

Bulk mode

Script options

All commands are case sensitive!


Modes

These are the available mode like they where explained before

  • mode=gui
  • mode=custom
  • silent=true

Silent mode:

This will run the script in background mode. It will only display the starting and finish notification dialog. Only useful when used for bulk mode.

Script bool: 

   silent=true

Script example: 

   XBMC.runscript(script.artwork.downloader, mode=custom, silent=true, extrafanart)

   XBMC.runscript(script.artwork.downloader, mode=custom, mediatype=movie, silent=true, extrafanart)


Mediatypes

Available media types to used in the script command:

  • mediatype=movie
  • mediatype=tvshow
  • mediatype=musicvideo


Medianames

Available medianame usage for skins:

  • Movies:
    • medianame=$INFO[ListItem.Title]
    • medianame=$INFO[ListItem.Title], mediapath=$INFO[ListItem.Path] (This prevents using the wrong library item when multiple versions are found of this movie)
    • medianame=Avatar
  • TV Shows:
    • medianame=$INFO[ListItem.TVShowTitle]
    • medianame=House
  • Musicvideos:
    • medianame=$INFO[ListItem.Title]
    • medianame=$INFO[ListItem.Title], mediapath=$INFO[ListItem.Path] (This prevents using the wrong library item when multiple versions are found of this musicvideo)
    • medianame=Adele - Live At The Royal Albert Hall (2011)


Art types

This are the available art types that can be used in the scrip command.

  • Movies:
    • poster
    • fanart
    • extrafanart
    • extrathumbs
    • clearlogo (not yet available)
    • clearart (not yet available)
    • discart (not yet available)


  • TV Show:
    • poster
    • seasonposter (not yet available)
    • fanart
    • extrafanart
    • extrathumbs
    • clearlogo
    • clearart
    • tvthumb
    • seasonthumb (not yet available)
    • banner
    • seasonbanner


  • Musicvideos:
    • poster
    • fanart
    • extrafanart
    • extrathumbs
    • clearlogo (not yet available)
    • clearart (not yet available)
    • discart (not yet available)


Retrieved from "https://kodi.wiki/index.php?title=Add-on:Artwork_Downloader&oldid=41364"