Difference between revisions of "Artwork"

From Official Kodi Wiki
Jump to: navigation, search
(Kodi- Choose Art: Additional steps)
(Flexible artwork types)
 
(26 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Artwork_Contents}}{{mininav|[[General topics]]}}
+
{{Artwork_Contents}}
 
+
{{mininav|[[Music_library|Music Library]] {{l2|[[Video_library|Video Library]]}} |[[HOW-TO:Create_Music_Library|Create Music Library]] {{l2|[[HOW-TO:Create_Video_Library|Create Video Library]]}}}}
  
 
<section begin="intro" />The use of artwork takes pride of place in Kodi. The artwork will transform your mundane media player into a showpiece to be proud of, especially when teamed up with your favourite skin. Kodi  will allow you to display Movie Posters, Fanart, Album Covers, Actor and Artist images to name a few. Install the Kodi slideshow add-on, and you will have a constant display of video or music fanart to brighten your entertainment room.<section end="intro" />
 
<section begin="intro" />The use of artwork takes pride of place in Kodi. The artwork will transform your mundane media player into a showpiece to be proud of, especially when teamed up with your favourite skin. Kodi  will allow you to display Movie Posters, Fanart, Album Covers, Actor and Artist images to name a few. Install the Kodi slideshow add-on, and you will have a constant display of video or music fanart to brighten your entertainment room.<section end="intro" />
Line 8: Line 8:
 
'''Be aware that artwork is skin dependent. Not all artwork types are used in all skins.'''
 
'''Be aware that artwork is skin dependent. Not all artwork types are used in all skins.'''
  
 +
= Flexible artwork types =
 +
 +
<gallery mode="packed" widths=350px heights=200px>
 +
File:Artwork-PosterView01.jpg
 +
File:Artwork-FanartView01.jpg
 +
File:Artwork-Banner01.jpg
 +
File:Artwork-PosterView02.jpg
 +
File:Artwork-MusicArtist01.jpg
 +
File:Artwork-ClearLogo02.jpg
 +
</gallery>
 +
 +
{{Kodi}}'s support for artwork types to represent media items is very flexible: Any number of artwork can be added to a media item with free-form names that have only a few rules.
 +
 +
To view all art types that are already assigned in your Kodi library for any particular media type, use Kodi's built-in [[Artwork#Kodi- Choose Art| Choose Art]] dialog on nearly any item in the library (movie, TV show, episode, so on), and the list of artwork types shown on this window are assigned to at least one media item of the same type.
 +
 +
== Naming rules ==
 +
 +
* artwork names must be
 +
** only alphanumeric characters
 +
** lowercase letters
 +
** keep them short - 20 characters is a bit long, though not forbidden
 +
* Named by convention so that skins and JSON-RPC consumers can find and use them reliably
 +
* Some common types of artwork are "fanart", "clearlogo", "landscape", "banner", and "poster"
 +
 +
== Artwork whitelist ==
 +
 +
Starting with Kodi 18, there is a whitelist configuration for artwork types to be added automatically. This whitelist applies to all artwork added automatically by Kodi, either when scanning in local files or scraping from online sources. This allows you to share one media file library with a full artwork selection and configure individual Kodi clients separately based on processing power, skin selection, or client-local storage space (the local artwork cache takes up the most space of all Kodi running data). It is currently configured with advancedsettings.xml '''[[Advancedsettings.xml#Extra artwork| for the video library]]''' and  '''[[Advancedsettings.xml#Extra artwork 2| for the music library]]'''.
  
 
= Obtaining Artwork =
 
= Obtaining Artwork =
[[File:Artwork-PosterView01.jpg|500px|right]]
 
[[File:Artwork-FanartView01.jpg|500px|right]]
 
[[File:Artwork-Banner01.jpg|500px|right]]
 
[[File:Artwork-PosterView02.jpg|500px|right]]
 
[[File:Artwork-FanartView03.jpg|500px|right]]
 
[[File:Artwork-MusicArtist01.jpg|500px|right]]
 
 
Movie, TV Show and Music artwork can be obtained using a variety of methods. The most common method is via the Kodi scraper.
 
Movie, TV Show and Music artwork can be obtained using a variety of methods. The most common method is via the Kodi scraper.
 
  
 
== Scrapers ==
 
== Scrapers ==
Line 26: Line 46:
 
Music- [http://www.theaudiodb.com/ The AudioDB]<br />
 
Music- [http://www.theaudiodb.com/ The AudioDB]<br />
 
<br />
 
<br />
There are many other scraper informationsources, but most are specialist listings for foreign language movies or Disney movies, for example.
+
There are many other scraper information sources, but most are specialist listings for foreign language movies or Disney movies, for example.
  
 
The Video scraping process is reliant on your local directory and file names being named in accordance with the title listed at the scraper site. To ensure correct naming, simply visit the website, search for your title, and copy the title from the site and paste into your directory/filename.  
 
The Video scraping process is reliant on your local directory and file names being named in accordance with the title listed at the scraper site. To ensure correct naming, simply visit the website, search for your title, and copy the title from the site and paste into your directory/filename.  
Line 35: Line 55:
  
 
If you subsequently locate artwork that is preferable, it is possible to replace the Kodi selected artwork. Refer to [[Artwork#Kodi-_Choose_Art|paragraph 2.1]] below.
 
If you subsequently locate artwork that is preferable, it is possible to replace the Kodi selected artwork. Refer to [[Artwork#Kodi-_Choose_Art|paragraph 2.1]] below.
; {{see also|How_To_use_Scrapers}}
+
; {{see also|Naming video files}}
; {{see also|Naming_video_files}}
+
; {{see also|Add-on:The Movie Database}}
; {{see also|Add-on:The_MovieDB}}
+
; {{see also|Add-on:The TVDB}}
; {{see also|Add-on:The_TVDB}}
+
; {{see also|Add-on:Universal Album Scraper}}
; {{see also|Add-on:Universal_Album_Scraper}}
+
; {{see also|Add-on:Universal Artist Scraper}}
; {{see also|Add-on:Universal_Artist_Scraper}}
 
 
 
 
 
  
 
== Media Managers ==
 
== Media Managers ==
There is a range of software that can create nfo files and download artwork and save them to the correct location and correct naming. They perform the same process and function as the Kodi Scraping operation does natively, but they do not add any entries into the Kodi library. Instead they create what is known as a '''[[nfo]]''' file. This file holds all the metadata for that particular movie, tv show or music. The software will also download associated artwork from the scraper site. Kodi can then read this file and scrape it into the library along with the artwork.
+
There is a range of software that can create nfo files and download artwork and save them to the correct location and correct naming. They perform the same process and function as the Kodi Scraping operation does natively, but they do not add any entries into the Kodi library. Instead they create what is known as '''[[NFO_files|NFO files]]'''. This file holds all the metadata for that particular movie, tv show or music. The software will also download associated artwork from the scraper site. Kodi can then read this file and scrape it into the library along with the artwork.
  
 
Although these programs are quick and easy to use, they are more suited for use where a movie or tv show is not listed at the scraper site. You are then able to create the metadata from scratch. You would normally use this for, say, home movies, sporting events or other items that are not listed at the scraper site.  
 
Although these programs are quick and easy to use, they are more suited for use where a movie or tv show is not listed at the scraper site. You are then able to create the metadata from scratch. You would normally use this for, say, home movies, sporting events or other items that are not listed at the scraper site.  
  
 
It is always best to use Kodi for the normal mainstream scrapes and the Media Managers for the non-listed movie, tv show and music scrapes.
 
It is always best to use Kodi for the normal mainstream scrapes and the Media Managers for the non-listed movie, tv show and music scrapes.
; {{see also|nfo}}
+
; {{see also|NFO_files}}
 
 
 
 
  
 
== Web Search ==
 
== Web Search ==
Line 58: Line 73:
  
 
Once downloaded, they must be named and saved correctly for the artwork to be visible to Kodi.
 
Once downloaded, they must be named and saved correctly for the artwork to be visible to Kodi.
 
 
  
 
== Create Your Own ==
 
== Create Your Own ==
Line 76: Line 89:
 
:; ''see : [http://theaudiodb.com/forum/viewtopic.php?f=2&t=1<nowiki>TheAudioDB- Image Creation Guide</nowiki>]''
 
:; ''see : [http://theaudiodb.com/forum/viewtopic.php?f=2&t=1<nowiki>TheAudioDB- Image Creation Guide</nowiki>]''
  
 +
= Importing-Scanning Artwork =
 +
{{anchor|Importing-Scraping Artwork}}
  
 
= Importing/Scraping Artwork =
 
 
This section does not apply to the Kodi scraper or any other add-on scraping process. It only applies to artwork you have manually sourced and saved.
 
This section does not apply to the Kodi scraper or any other add-on scraping process. It only applies to artwork you have manually sourced and saved.
  
Line 85: Line 98:
 
'''It is important to note that once a movie, tv show, artist or album has been scraped into the library, Kodi will ignore them on subsequent scans.''' If you have made changes to either artwork and/or metadata (in the form of a nfo file), you must instruct Kodi to update using one of the following methods...
 
'''It is important to note that once a movie, tv show, artist or album has been scraped into the library, Kodi will ignore them on subsequent scans.''' If you have made changes to either artwork and/or metadata (in the form of a nfo file), you must instruct Kodi to update using one of the following methods...
 
#If the Library has not yet been created, or the source has not yet been added
 
#If the Library has not yet been created, or the source has not yet been added
#*Ensure your artwork is named and saved correctly. Add the [[Sources]] to Kodi and allow to update. Artwork will be cached
+
#*Ensure your artwork is named and saved correctly. Add the [[Media sources]] to Kodi and allow to update. Artwork will be cached
 
#This Movie/TV Show/Album/Artist is new and has not been added to the library yet
 
#This Movie/TV Show/Album/Artist is new and has not been added to the library yet
 
#*An Update Library will scrape and cache the artwork, or
 
#*An Update Library will scrape and cache the artwork, or
Line 96: Line 109:
 
#*Update each Movie/TV Show/Music manually using instructions in the previous option, or
 
#*Update each Movie/TV Show/Music manually using instructions in the previous option, or
 
#*Remove the Source and clean library. Re-add the source and allow the Update Library
 
#*Remove the Source and clean library. Re-add the source and allow the Update Library
 +
:'''''See also: [[Updating_or_removing_videos|Update Video Library]]'''''
  
 +
== "Available" artwork ==
  
 +
Scrapers and NFO files can include multiple images for a single type of artwork. The first image will be assigned to the media item for skins and other interfaces to access for display, and the full list will be saved for the "Choose art" dialog, where you can select a new image for any art type.
  
=== Kodi- Choose Art ===
+
== Kodi- Choose Art ==
 
From within Kodi, you have the ability to manually change the artwork at any time by following these directions.  
 
From within Kodi, you have the ability to manually change the artwork at any time by following these directions.  
To change music artwork- ''see [[Music_artwork]]''
 
  
#Highlight the Movie, TV Show, Season or Episode whose artwork you want to change.  
+
#Highlight the media item whose artwork you want to change.  
 
#Call up the ''Information'' page, (Image 1)
 
#Call up the ''Information'' page, (Image 1)
 +
#* For seasons and movie sets the "Choose Art" option is in the [[Context menu]].
 
#Select ''Choose Art''. (Image 1)
 
#Select ''Choose Art''. (Image 1)
 
#From within this page, you will be given the option to select which type of artwork you would like to change. (Image 2)
 
#From within this page, you will be given the option to select which type of artwork you would like to change. (Image 2)
#Once selected, you will then be provided with a list of available artworks at the scraper site, or you can navigate to a local or network location. (Image 3)
+
#* This dialog is filled with artwork already assigned to similar media items in the library. If your type of artwork is not listed, then use the '''Add art''' button. An onscreen keyboard will be displayed. Enter the new type of artwork and select '''Ok'''.
#Once you select the desired image, it will be immediately cached and replace the existing image. You will be returned to the screen displayed in Image 2
+
#* Examples of artwork type are those listed in the following pages- eg clearlogo, clearart, banner etc...
 +
#Once selected, you will then be provided with a list of available artwork at the scraper site, or you can navigate to a local or network location. (Image 3)
 +
#Once you select the desired image, it will replace the existing image. You will be returned to the screen displayed in Image 2
 
#If you do not intend to change any other artwork types, simply Esc or Back out of the screen
 
#If you do not intend to change any other artwork types, simply Esc or Back out of the screen
  
Line 123: Line 141:
 
#*To scrape online artwork and metadata - Select '''Yes'''
 
#*To scrape online artwork and metadata - Select '''Yes'''
  
= Managing Artwork =
+
= Artwork details for media sections =
[[File:Skin.rapier fullscreen music.jpg|500px|right]]
 
[[File:Artwork-MusicBanner01.jpg|500px|right]]
 
[[File:Artwork-FanartView02.jpg|500px|right]]
 
[[File:Rapier new tvshows.jpg|500px|right]]
 
[[File:Artwork-ListView01.jpg|500px|right]]
 
There are a number of ways to maintain and improve Kodi's handling of the artwork.
 
  
 +
<gallery mode="packed" widths=350px heights=200px>
 +
File:Skin.rapier fullscreen music.jpg
 +
File:Artwork-MusicBanner01.jpg
 +
File:Artwork-FanartView02.jpg
 +
File:Rapier new tvshows.jpg
 +
File:Artwork-Animated01.gif
 +
File:Artwork-musiclandscape-EstuaryATF.jpg
 +
</gallery>
  
== Cache ==
+
== Movie Artwork ==
Kodi maintains a local '''texture''' cache for all artwork that is scraped either from online or local sources. During this caching process, artwork size is '''modified''' to default sizes. This allows faster access and loading times of the artwork which is especially noticeable on low powered equipment. These default sizes can be modified in the ''advancedsettings.xml''- Refer [[Artwork#Advanced_Settings|paragraph 3.3]]<br />
+
{{#lst:Movie_artwork|intro}}
<section begin="CacheMaxResolution" />{{red|'''Note:''' The maximum resolution currently available for cached artwork is 1920x1080, regardless of any ''advancedsettings.xml'' entries. The only known workaround requires you to manually locate the existing cached artwork, delete it and replace it with the higher resolution image, ensuring the new image is named exactly as the former image was.}}<section end="CacheMaxResolution" />
+
{{see|Movie artwork}}
  
When Kodi performs an online scrape to download the metadata of your videos or music, it also downloads the associated artwork. The URL link to the original online artwork location is stored in the video or music databases. The downloaded artwork is then saved in the Cache located in ''\userdata\thumbnails '' directory. An entry in the ''texturesxx.db'' is recorded that connects each image to the appropriate video or music library entry.
+
== TV Show Artwork ==
 +
{{#lst:TV-Show_artwork|intro}}
 +
{{see|TV-Show artwork}}
  
If you have stored local artwork with your video or music file, Kodi will scrape these as described above. Once scraped, these original local images are no longer accessed by Kodi. Note that Extrafanart and Extrathumbs are a skin function, and these are not cached, but accessed directly by the skin.
+
== Music Artwork ==
; {{see also|Artwork/Cache}}
+
{{#lst:Music_artwork|intro}}
 +
{{see|Music artwork}}
  
== Recovering Disk Space ==
+
== Music Videos Artwork ==
After years of use, it is expected that your system will gather some clutter- that being either orphaned artwork files or corrupted artwork which will not display.
+
{{#lst:Music_Video_artwork|intro}}
There are two methods available to maintain a healthy cache and database:
+
{{see|Music Video artwork}}
; {{see also|HOW-TO:Reduce_disk_space_usage}}
 
  
=== Texture Cache Maintenance ===
+
== Live TV Artwork ==
{{#lst:Texture_Cache_Maintenance_utility|intro}}
+
{{#lst:Live_TV_Artwork|intro}}
; {{see also|Texture_Cache_Maintenance_utility}}
+
{{see|Live TV Artwork}}
  
=== Delete textures13.db ===
+
== Pictures Artwork ==
One sure way to repair any caching problem is to delete the ''textures13.db'' database. This procedure does not affect the entries in the Video and Music libraries. It affects the artwork database only.
+
There is no user definable artwork for the Pictures section of Kodi.<br />
 +
:'''''See: [[Pictures]]
  
Be aware that this should be a last resort procedure. Deleting this database file will remove all cache entries and links, requiring your artwork be re-scraped.
+
All images added to Pictures are cached as follows:
 +
#Embedded EXIF previews are scanned and cached. If none available then
 +
#Preview images are created and cached
 +
:'''''See: [[Artwork#Cache|Artwork Cache]]'''''<br />
  
You will need to perform the following for a clean start with respect to Artwork.
+
To add an image to the folder icon:
*Exit Kodi
+
:'''''See: [[Movie_artwork#Source Folder Artwork|Folder Image]]'''''
*Delete ''texturesxx.db'' located in the ''\userdata\database\'' folder.
 
*Delete the ''Thumbnails'' directory located at ''\userdata\'' which stores all the cached images,
 
Once the above steps are performed
 
*Restart Kodi
 
*Kodi will automatically  rebuild the Textures database from Local Artwork saved alongside your media file. If there is no local artwork, Kodi will download from the scraper sites for Movies, TV Shows and Music.
 
  
 +
= Add-ons to display artwork =
 +
The following add-ons allow you to display your movie, TV show and music artwork.
  
 +
=== Screensavers ===
  
== Advanced Settings ==
+
Want to do more with all that wonderful fanart? Install this Kodi screensaver. Just like a screensaver on computers from yesteryear, the Kodi screensaver will produce a slideshow of your Movie and TV Show fanart, or set it to display your Music Fanart. Don't like either of those? Then setup a directory with your own pictures and it can produce a screensaver from your selection of photos.
There are a number of ''advancedsettings.xml'' tags which can be used to modify the caching of artwork. The following preset defaults are used unless modified
+
; {{see also|Add-on:Picture Slideshow Screensaver}}
*Fanart will be cached to a maximum of 1920x1080. Larger fanart is reduced to this size.  
 
*Smaller fanart and all other artwork types are cached to a maximum of (*)x720 height.
 
  
If you are experiencing slow loading images or lagging GUI navigation on low powered equipment and/or you have minimal storage available, these defaults can be modified to further reduce the size of artwork.
+
= Managing Artwork =
 +
There are a number of ways to maintain and improve Kodi's handling of the artwork.  
  
For higher powered equipment the settings can be increased to maintain the original artwork size. (eg 3840x2160 fanart)
+
== Cache ==
 
+
{{#lst:Artwork/Cache|intro}}
An easily understandable explanation of the effects of some of these settings can be located in the [https://forum.kodi.tv/showthread.php?tid=315806&pid=2599318#pid2599318 forum here.]
+
; {{see also|Artwork/Cache}}
 
 
; {{see also|Advancedsettings.xml#Library_artwork}}
 
  
 +
== Recovering Disk Space ==
 +
After years of use, it is expected that your system will gather some clutter- that being either orphaned artwork files or corrupted artwork which will not display.
 +
; {{see also|HOW-TO:Reduce disk space usage}}
 +
; {{see also|Artwork/Cache}}
  
 +
=== Texture Cache Maintenance ===
 +
{{#lst:Texture_Cache_Maintenance_utility|intro}}
 +
; {{see also|Texture Cache Maintenance utility}}
  
 
== Import/Export ==
 
== Import/Export ==
 
{{#lst:import-export_library|intro}}
 
{{#lst:import-export_library|intro}}
; {{see also|Import-Export_library}}
+
; {{see also|Import-export library}}
  
 +
= Troubleshooting =
 +
There are certain scenarios where attempting to replace existing artwork with new artwork, '''you may experience {{kodi}} refusing to load the new artwork'''. This occurs when replacing one artwork with another artwork having the same name. eg replacing ''poster.jpg'' with a new ''poster.jpg''.
  
 +
Rest assured that the new image has been accepted, but due to the same filename, {{kodi}} may take upto 24 hrs to check the image hash, realise the image is different and clear out the cached image and replace it with the new one. This is intended behaviour. Further reading available in the following link
  
== Add-ons ==
+
; {{see also|Artwork/Cache}}
The following add-ons allow you to display your movie, tv show and music artwork
 
 
 
=== Screensavers ===
 
 
 
Want to do more with all that wonderful fanart? Install the Kodi screensaver. Just like a screensaver on computers from yesteryear, the Kodi screensaver will produce a slideshow of your Movie and TV Show fanart, or set it to display your Music Fanart. Don't like either of those? Then setup a directory with your own pictures and it can produce a screensaver from your selection of photos.
 
; {{see also|Add-on:Picture_Slideshow_Screensaver}}
 
 
 
  
 +
= Animated artwork - experimental =
  
= Movie Artwork =
+
Kodi has basic support for displaying animated artwork, and two artwork types have a decent collection of animated options: posters and fanart for movies. The most comprehensive support for animated artwork is Skin Helper Service, which has taken to naming these as "animatedposter" and "animatedfanart".
{{#lst:Movie_artwork|intro}}
 
{{see|Movie_artwork}}
 
  
 +
New animated movie posters (and textless posters / keyart which could be named "animatedkeyart") are often posted to [https://forum.kodi.tv/showthread.php?tid=215727 this forum thread].
  
= TV Show Artwork =
+
== Limitations of animated artwork ==
{{#lst:TV-Show_artwork|intro}}
 
{{see|TV-Show_artwork}}
 
  
 +
Kodi's support for displaying animated artwork is basic, and does have some limitations.
  
= Music Artwork =
+
Number one is a hard limit on the number of pixels in a single animated artwork. The size of animated artwork is limited to roughly 12 frames of 1920x1080. This limit is defined as fully decoded pixels. The trend for animated posters is for smaller images with more frames (a recent "animatedposter" is 500x713 with 60 frames). Kodi will discard any remaining frames after it has reached this limit, which will probably hitch unpleasantly, so obeying this limit is important.
{{#lst:Music_artwork|intro}}
+
* Technically this limit is 11 frames but Kodi will decode full frames until it has decoded MORE than this, so the calculation is
{{see|Music_artwork}}
+
** 1920 × 1080 = 2,073,600 * 11 =
 
+
*** 22,809,600 pixels '''plus''' one more frame
 
 
 
 
= Music Videos Artwork =
 
{{#lst:Music_Video_artwork|intro}}
 
{{see|Music_Video_artwork}}
 
 
 
 
 
 
 
= TV Artwork =
 
There is no user definable artwork for the TV section of Kodi
 
 
 
 
 
 
 
= Pictures Artwork =
 
There is no user definable artwork for the Pictures section of Kodi.<br />
 
:'''''See: [[Pictures]]
 
 
 
All images added to Pictures are cached as follows:
 
#Embedded EXIF previews are scanned and cached. If none available then
 
#Preview images are created and cached
 
:'''''See: [[Artwork#Cache|Artwork Cache]]'''''<br />
 
 
 
To add an image to the folder icon:
 
:'''''See: [[Movie_artwork#Source_Folder_Artwork|Folder Image]]'''''
 
 
 
  
 +
Number two is that Kodi doesn't save animated artwork to the texture cache and will not play them (only displaying the first frame) unless they are stored on a client-local file system.
  
 +
= Accessing with skins and JSON-RPC =
 +
{{#lst:Artwork/Accessing with skins and JSON-RPC|intro}}
 +
; {{see also|Artwork/Accessing with skins and JSON-RPC}}
  
 
{{Top}}
 
{{Top}}
  
 
+
{{updated|18}}
{{updated|17}}
 
 
[[Category:FAQ]]
 
[[Category:FAQ]]
 
[[Category:Index]]
 
[[Category:Index]]
 
[[Category:Guides]]
 
[[Category:Guides]]
 
[[Category:Manual]]
 
[[Category:Manual]]
 +
[[Category:Karellen]]
 
[[Category:Video library]]
 
[[Category:Video library]]
[[Category:Music library|*]]
+
[[Category:Music library]]
 
[[Category:Advanced topics]]
 
[[Category:Advanced topics]]
 
[[Category:First time user]]
 
[[Category:First time user]]
 
[[Category:Quick Start Guide]]
 
[[Category:Quick Start Guide]]

Latest revision as of 20:35, 17 February 2019

Artwork contents

Report Artwork corrections:
here in the forum

Home icon grey.png   ▶ Music Library
▶ Video Library
▶ Create Music Library
▶ Create Video Library
▶ Artwork

The use of artwork takes pride of place in Kodi. The artwork will transform your mundane media player into a showpiece to be proud of, especially when teamed up with your favourite skin. Kodi will allow you to display Movie Posters, Fanart, Album Covers, Actor and Artist images to name a few. Install the Kodi slideshow add-on, and you will have a constant display of video or music fanart to brighten your entertainment room.

As the topic covering artwork is comprehensive, it has been broken down into smaller and more manageable pages for ease of reading. Choose the subject that interests you to obtain further information. Information common to all categories is located on this page. Specific category details are located on linked pages.

Be aware that artwork is skin dependent. Not all artwork types are used in all skins.

1 Flexible artwork types

Kodi's support for artwork types to represent media items is very flexible: Any number of artwork can be added to a media item with free-form names that have only a few rules.

To view all art types that are already assigned in your Kodi library for any particular media type, use Kodi's built-in Choose Art dialog on nearly any item in the library (movie, TV show, episode, so on), and the list of artwork types shown on this window are assigned to at least one media item of the same type.

1.1 Naming rules

  • artwork names must be
    • only alphanumeric characters
    • lowercase letters
    • keep them short - 20 characters is a bit long, though not forbidden
  • Named by convention so that skins and JSON-RPC consumers can find and use them reliably
  • Some common types of artwork are "fanart", "clearlogo", "landscape", "banner", and "poster"

1.2 Artwork whitelist

Starting with Kodi 18, there is a whitelist configuration for artwork types to be added automatically. This whitelist applies to all artwork added automatically by Kodi, either when scanning in local files or scraping from online sources. This allows you to share one media file library with a full artwork selection and configure individual Kodi clients separately based on processing power, skin selection, or client-local storage space (the local artwork cache takes up the most space of all Kodi running data). It is currently configured with advancedsettings.xml for the video library and for the music library.

2 Obtaining Artwork

Movie, TV Show and Music artwork can be obtained using a variety of methods. The most common method is via the Kodi scraper.

2.1 Scrapers

A scraper is a Kodi core function which, in combination with the relevant metadata API add-on, will preform an automatic online search for movie, tv show and music information and then retrieve all relevant metadata and artwork and import the data into the Kodi Library and the artwork into the cache. The default sources for information are:

Movies- The MovieDB
TV Shows- The TVDB
Music- The AudioDB

There are many other scraper information sources, but most are specialist listings for foreign language movies or Disney movies, for example.

The Video scraping process is reliant on your local directory and file names being named in accordance with the title listed at the scraper site. To ensure correct naming, simply visit the website, search for your title, and copy the title from the site and paste into your directory/filename.

The Music scraping process is reliant on correct file naming and music tags.

Kodi will then match the video or music and download all relevant metadata and artwork. It is important to note that if you already have correctly named artwork in the video and music folder, then Kodi will scrape the local artwork and ignore the online source. Metadata will still be downloaded though.

If you subsequently locate artwork that is preferable, it is possible to replace the Kodi selected artwork. Refer to paragraph 2.1 below.

2.2 Media Managers

There is a range of software that can create nfo files and download artwork and save them to the correct location and correct naming. They perform the same process and function as the Kodi Scraping operation does natively, but they do not add any entries into the Kodi library. Instead they create what is known as NFO files. This file holds all the metadata for that particular movie, tv show or music. The software will also download associated artwork from the scraper site. Kodi can then read this file and scrape it into the library along with the artwork.

Although these programs are quick and easy to use, they are more suited for use where a movie or tv show is not listed at the scraper site. You are then able to create the metadata from scratch. You would normally use this for, say, home movies, sporting events or other items that are not listed at the scraper site.

It is always best to use Kodi for the normal mainstream scrapes and the Media Managers for the non-listed movie, tv show and music scrapes.

2.3 Web Search

Using an online search engine can help you discover individual artworks, or additional sites where artwork is hosted. When downloading, check that the resolution is of an acceptable standard. Also pay respect to any copyright notices that are attached to the artwork.

Once downloaded, they must be named and saved correctly for the artwork to be visible to Kodi.

2.4 Create Your Own

So you are not happy with the artwork the scraper downloaded? And you just can't find that perfect artwork by manually searching the internet. Then, you will just have to create your own. For those who are artistically minded and can easily navigate around image editing software, then you should be able to easily create your very own user-defined artwork on your computer. Only your imagination is the limit, but be mindful that the artwork needs to remain true to the movie or tv show it represents.

If you are unsure where to start, the following links may prove useful. Especially if you plan to share your masterpieces. If this is the case, it is best to stick to the posted guidelines.

  • Fanart.TV- The premier repository for all things artwork. They have an in-depth guide for artwork requirements
see : Fanart.tv- Image Creation Guide
  • The MovieDB- The go to movie scraper site for Kodi. In addition to metadata, they also hold a large repository of artwork that are created and uploaded to the site by people just like you. Read their easy to understand artwork creation guide.
see : themoviedb- Image Creation Guide
  • The TVDB- The go to TV Show scraper site for Kodi. In addition to metadata, they also hold a large repository of artwork devoted to TV Shows. Read their easy to understand artwork creation guide.
see : theTVDB- Image Creation Guide
  • IMDB- A comprehensive listing of ensuring artwork is appropriate and suitable.
see : IMDB- Image Submission Guide
  • TheAudioDB- The go to scraper site for all things music. They hold metadata on Artists, Albums and Songs with a large collection of music artwork.
see : TheAudioDB- Image Creation Guide

3 Importing-Scanning Artwork

This section does not apply to the Kodi scraper or any other add-on scraping process. It only applies to artwork you have manually sourced and saved.

When performing an Update Library or Scrape, Kodi will always use Local Artwork first if it exists. If there is no local artwork, Kodi will obtain the artwork from online sources.

It is important to note that once a movie, tv show, artist or album has been scraped into the library, Kodi will ignore them on subsequent scans. If you have made changes to either artwork and/or metadata (in the form of a nfo file), you must instruct Kodi to update using one of the following methods...

  1. If the Library has not yet been created, or the source has not yet been added
    • Ensure your artwork is named and saved correctly. Add the Media sources to Kodi and allow to update. Artwork will be cached
  2. This Movie/TV Show/Album/Artist is new and has not been added to the library yet
    • An Update Library will scrape and cache the artwork, or
    • For Videos, navigate Videos>Files, navigate to the item and call up the Information page. This will start an automatic scrape for that single item
    • For Music, navigate Music>Files, locate and highlight the new artist or album. From the context menu select Scan item to library
  3. I added new artwork for Movie/TV Show/Album/Artist already in the library
    • For videos follow instructions for Kodi- Choose Art below
    • For music follow instructions in Music_artwork
  4. I added new artwork for a lot of Movies/TV Shows/Music already in the library
    • Update each Movie/TV Show/Music manually using instructions in the previous option, or
    • Remove the Source and clean library. Re-add the source and allow the Update Library
See also: Update Video Library

3.1 "Available" artwork

Scrapers and NFO files can include multiple images for a single type of artwork. The first image will be assigned to the media item for skins and other interfaces to access for display, and the full list will be saved for the "Choose art" dialog, where you can select a new image for any art type.

3.2 Kodi- Choose Art

From within Kodi, you have the ability to manually change the artwork at any time by following these directions.

  1. Highlight the media item whose artwork you want to change.
  2. Call up the Information page, (Image 1)
    • For seasons and movie sets the "Choose Art" option is in the Context menu.
  3. Select Choose Art. (Image 1)
  4. From within this page, you will be given the option to select which type of artwork you would like to change. (Image 2)
    • This dialog is filled with artwork already assigned to similar media items in the library. If your type of artwork is not listed, then use the Add art button. An onscreen keyboard will be displayed. Enter the new type of artwork and select Ok.
    • Examples of artwork type are those listed in the following pages- eg clearlogo, clearart, banner etc...
  5. Once selected, you will then be provided with a list of available artwork at the scraper site, or you can navigate to a local or network location. (Image 3)
  6. Once you select the desired image, it will replace the existing image. You will be returned to the screen displayed in Image 2
  7. If you do not intend to change any other artwork types, simply Esc or Back out of the screen

An alternative method:

  1. Choose Refresh as seen in Image 1.
  2. You will then be asked Locally stored information found. Ignore and refresh from Internet? (Image 4)
    • To scrape local artwork and metadata - Select No note- If you have no local nfo file, Kodi will scrape metadata from the online scraper site
    • To scrape online artwork and metadata - Select Yes

4 Artwork details for media sections

4.1 Movie Artwork

Movie artwork are images directly related to a movie or movie collection / set, preferably of high quality, that are displayed when viewing the movie or collection entry in the library. The artwork support in Kodi's video library is very flexible and able to display many types of artwork, but this page will describe the types of artwork readily available for the Movie library of Kodi.

See: Movie artwork

4.2 TV Show Artwork

TV Show artwork are images directly related to a TV Show, preferably of high quality, that are displayed when viewing the entry in the library. The artwork support in Kodi's video library is very flexible and able to display many types of artwork, but this page will describe the types of artwork readily available for the TV show library of Kodi.

See: TV-Show artwork

4.3 Music Artwork

Music artwork are images directly related to an artist or an album, preferably of high quality, that are displayed when viewing the album or artist entry in the library. They may also be used as visualizations while playing music. The artwork support in Kodi's music library is very flexible and able to display many types of artwork, but this page will describe the types of artwork readily available for the Music library of Kodi.

See: Music artwork

4.4 Music Videos Artwork

Music Video artwork are images directly related to an Artist or an Album. The images are, preferably, of high quality, that are displayed when viewing the Album or Artist entry in the library. The Music Video section in Kodi is able to display four types of artwork. This page will describe the different types of artwork available in the Music Video category of Kodi.

See: Music Video artwork

4.5 Live TV Artwork

Kodi provides the ability to insert the Logo of your TV Stations which then becomes visible in the program guide, on-screen displays and all channel listings, making it easy to distinguish each channel.

See: Live TV Artwork

4.6 Pictures Artwork

There is no user definable artwork for the Pictures section of Kodi.

See: Pictures

All images added to Pictures are cached as follows:

  1. Embedded EXIF previews are scanned and cached. If none available then
  2. Preview images are created and cached
See: Artwork Cache

To add an image to the folder icon:

See: Folder Image

5 Add-ons to display artwork

The following add-ons allow you to display your movie, TV show and music artwork.

5.1 Screensavers

Want to do more with all that wonderful fanart? Install this Kodi screensaver. Just like a screensaver on computers from yesteryear, the Kodi screensaver will produce a slideshow of your Movie and TV Show fanart, or set it to display your Music Fanart. Don't like either of those? Then setup a directory with your own pictures and it can produce a screensaver from your selection of photos.

6 Managing Artwork

There are a number of ways to maintain and improve Kodi's handling of the artwork.

6.1 Cache

Kodi maintains a texture cache on local device storage for all artwork displayed in the GUI, whether from an online source or the local file system. These textures are optimized and stored locally for faster loading.

When artwork is added to the library, Kodi initially only has a URL or path to the artwork. The artwork itself is only downloaded (if from an online source) and then cached when the image is displayed in the GUI or other interface such as the Chorus web interface.

6.2 Recovering Disk Space

After years of use, it is expected that your system will gather some clutter- that being either orphaned artwork files or corrupted artwork which will not display.

6.2.1 Texture Cache Maintenance

Texture Cache Maintenance utility is a python script created by MillhouseVH, that can do a number of artwork related maintenance on the Kodi library. The script can be used to pre-generate thumbnails, clean up old thumbnail files, find corrupted files, and much more. The script can work on any OS that can run Python 2.6 or higher.

6.3 Import/Export

Kodi offers the ability to import and export metadata and artwork manually into/from the Media Library, as well as importing media info automatically from .nfo files.

7 Troubleshooting

There are certain scenarios where attempting to replace existing artwork with new artwork, you may experience Kodi refusing to load the new artwork. This occurs when replacing one artwork with another artwork having the same name. eg replacing poster.jpg with a new poster.jpg.

Rest assured that the new image has been accepted, but due to the same filename, Kodi may take upto 24 hrs to check the image hash, realise the image is different and clear out the cached image and replace it with the new one. This is intended behaviour. Further reading available in the following link

8 Animated artwork - experimental

Kodi has basic support for displaying animated artwork, and two artwork types have a decent collection of animated options: posters and fanart for movies. The most comprehensive support for animated artwork is Skin Helper Service, which has taken to naming these as "animatedposter" and "animatedfanart".

New animated movie posters (and textless posters / keyart which could be named "animatedkeyart") are often posted to this forum thread.

8.1 Limitations of animated artwork

Kodi's support for displaying animated artwork is basic, and does have some limitations.

Number one is a hard limit on the number of pixels in a single animated artwork. The size of animated artwork is limited to roughly 12 frames of 1920x1080. This limit is defined as fully decoded pixels. The trend for animated posters is for smaller images with more frames (a recent "animatedposter" is 500x713 with 60 frames). Kodi will discard any remaining frames after it has reached this limit, which will probably hitch unpleasantly, so obeying this limit is important.

  • Technically this limit is 11 frames but Kodi will decode full frames until it has decoded MORE than this, so the calculation is
    • 1920 × 1080 = 2,073,600 * 11 =
      • 22,809,600 pixels plus one more frame

Number two is that Kodi doesn't save animated artwork to the texture cache and will not play them (only displaying the first frame) unless they are stored on a client-local file system.

9 Accessing with skins and JSON-RPC

The primary usage of artwork is to be displayed, and to that end, they can be accessed by name in skins and over JSON-RPC.

Return to top