Add-on settings & actions

Artwork Beef configuration and manual actions when run from “Program Add-ons”.

General

“Add artwork for new videos / music after library updates”

The main process of Artwork Beef. Runs after library updates to add extended artwork for media items newly added to the Kodi library, either from the file system or web services. Video and music are configured separately. A media item is only “new” once, after it has been scanned it is no longer “new”.

“Update artwork for old items daily”

Check old items for new artwork. “Old” in this case refers to media items that have been in the library for a while already. 4 months for newly released media that is still missing a bit of artwork, 8 months otherwise. If the options “only identify local files” is enabled then local files are checked monthly.

“Delete deselected artwork files”

Manually deselecting artwork like fanart will delete the original file. Otherwise the image will stay in the file system and Artwork Beef will add it back to the library the next time this item is scanned.

“Recycle deleted and replaced artwork files to temp/cache directory”

Recycled artwork goes to Kodi’s local temp or cache directory.

“Disable/Enable Artwork Beef context items (per skin)”

Hide the two standard context items “AB: Add missing artwork” and “AB: Select artwork …” under the “Manage” menu of the context menu of most media items.

Sorting and auto filters

“Prefer ‘fanart’ with no title”

“Preferred artwork size”

Artwork larger than this will be sorted based on rating instead of size, and the minimum size of artwork automatically added is adjusted.

“Minimum image rating”

Slider to set minimum image rating to be added automatically.

“Prefer ‘poster’ with no title”

Save ‘keyart’ (aka textless poster) to ‘poster’ if available.

Action “Show latest artwork report”

Contains details on the latest automatic and manual processing Artwork Beef performed.

TV Shows / Movies / Music videos / Music

Each media section is configurable separately, but the options are mostly the same. Music only works for Kodi 18 Leia.

“Do not automatically add artwork from web services, only identify local files”

If you manage all of you media info with an external media manager, then you probably want this. Manual artwork selection will still be able to pick artwork from web services, but only the file system will be checked during automatic processing.

“Prefer artwork from specific web service”

Artwork from the specified web service will sort first for automatic and manual processing. For artwork types that can have multiple images, automatic processing will only include images from this web service if any are available, to avoid picking duplicates from multiple sources automatically.

“Automatically add these artwork types from web services and file system”

A list of switches and number sliders for each art type for each individual media type to be automatically added to the media library from web services and the file system. Some skins can work with multiple artwork of the same type, like “fanart”, which is configured with a number slider. If you want other artwork types in the file system added to the Kodi library, include the artwork type in the box “Additional art types for … (comma separated)”.

Artwork Beef will not automatically apply these changes to existing items in the library, you will need to run “add missing artwork for …” “all videos” or music to look for newly configured artwork.

“Select series for episode ‘fanart’…”

Episode fanart must be enabled per series as they add a bundle of new API calls and just won’t be available for many series.

“Download artwork to local files”

“Artwork download configuration”

By default artwork is only downloaded by Kodi’s image (texture) caching. Switch this to “all configured above” to download everything configured in the section “Automatically add these artwork types from web services and file system”, or “specific types below” for a more detailed configuration of types to download.

Artwork types configured below will be downloaded to the local file system (generally next to the media items), rather than linked directly to the original URL. This makes it easy to share with other Kodi installations and saves a bundle of bandwidth for you and the web services. For artwork types that can have multiple images, only the base art name is needed; “fanart” will also download any “fanart1”, “fanart2”, “fanart3”, etc added to Kodi’s library.

Advanced

“TV show scraper (if source unknown)”

Kodi Jarvis (and early Krypton scrapers) didn’t identify uniqueid sources for TV shows, this setting will be used as a backup. ‘tvdb’ for TheTVDB or ‘tmdb’ for TheMovieDB.

“Include detailed per item changes in the report”

Include more details for each processed media item in the “artwork report” file.

“Progress display for automatic processing”

“full progress bar” displays a persistent progress bar like Kodi’s built in library updates can, and it includes a count of updated artwork at the end. “just warnings and errors” only shows notifications for warnings such as an error encountered accessing a web service or the add-on crashes. Finally there is “only add-on crashes”.

“Show final artwork update count notification”

Shows the final artwork update count in a notification. Overrides the count at the end of the “full progress bar”.

“Automatically preload local video / music library artwork to Kodi texture cache”

Artwork can be preloaded to the Kodi cache for faster browsing of new media. Video and music are configured separately. Only works for artwork saved locally: if you are going to download all artwork immediately for caching, then you might as well save it somewhere so you won’t have to download it again later. This requires the Kodi setting ‘Allow remote control via HTTP’ enabled.

“Clean existing artwork URLs (HTTP to HTTPS, web service URL changes)”

Fixes up remote artwork URLs. Tracks a couple of web service URL changes since Artwork Beef was released, converts HTTP to HTTPS for supported web services, and ensures artwork URLs are properly URL encoded.

“Manually select multiple images for all media types”

Allows manual selection of multiple images for all artwork. Mostly for skin designers or developers to tinker with, it requires a skin or other interface or add-on to support multiple in some way.

“Disable/Enable Artwork Beef debug context items (per skin)”

Show the two debug context items “AB: Remove all artwork” and “AB: Log debug info” under the “Manage” menu of the context menu of most media items. Disabled by default.

Web services

Enable Fanart.tv / The Movie DB / TheTVDB / The Audio DB / KyraDB

Enable web services individually. These switches also hide service-specific configuration when disabled.

“fanart.tv personal API key”

Set the optional personal API for fanart.tv, which reduces the delay for new artwork results from fanart.tv. This is the API key that individual users of Artwork Beef (and other apps like it) should register for. Artwork Beef cannot tell you if this is entered incorrectly, so please double check it.

“Add ‘keyart’ from TheMovieDB”

TheMovieDB defaults to “No Language” for all new images, so there will always be a number of posters with text that show up as “keyart”. Disabled by default.

KyraDB API key / User key

These keys are required if you want to use artwork from KyraDB. You can get these by signing up for a free account on the website.

Image languages for automatic filter

Controls which image languages will be accepted by Artwork Beef’s automatic process. By default Artwork Beef uses Kodi’s user interface language and if not found it falls back to English, but you can disable either of those options and set a “Priority language selection” that is preferred before either.

Files

“Replace episode / movie / music video ‘thumb’ with Kodi generated thumb”

Episode ‘thumb’ from web services are usually not great, and for movies it’s not “extrathumbs” but at least there is one. Separate config for each media type.

“Process movie set artwork in a central directory”

Save movie collection artwork to a central directory. Details on the Image files page.

“central information directory”

Directory the movie set artwork is stored in.

“save new artwork to subdirectories per movie set”

Enabled by default, separates movie set artwork into subdirectories named for the movie set. When disabled Artwork Beef saves all artwork in the central directory.

“Grab movie set artwork from movie parent directory”

Mutually exclusive with “movie set central directory”, but probably shouldn’t be.

“Save movie / music video artwork with movie base file name”

Save movie artwork to “[movie file name]-fanart.jpg” rather than “fanart.jpg”. Movies and music videos are configured separately.

“Save additional movie and TV show fanart to ‘extrafanart’ directory instead”

By default Artwork Beef saves extra fanart as “fanart1.jpg”, “fanart2.jpg”, and so on next to the regular fanart. This instead saves them to the classic “extrafanart” directory.

“Save additional music video fanart to ‘extrafanart’ directory instead”

“Identify alternative Artwork Downloader and MSAA artwork files”

Like “logo.png” to “clearlogo”. This is generally safe to leave enabled, it’s an option in case you really do want the artwork saved to the Kodi library as “logo”, which is rare at this point.

“In case of emergency”

These are project API keys for the individual web services. You do not need them unless the built-in keys are disabled by the web services after being ripped off. These are unneeded otherwise.

Actions

When run from “Program Add-ons”, Artwork Beef can perform a number of actions.

  • “add missing artwork for …”
    • new videos / music
      • New media in the respective library. This is the same process that is run automatically after a Kodi library update.
    • old videos / music
      • Old media items in the library, as defined above. This is the same process that is run automatically after a Kodi library update but always includes old items.
    • all videos / music
      • All media items in the library. Don’t run this very often, but it is here if you need it.
  • scan for new local files for video library
    • Looks for new local artwork only, avoids hitting web services like the standard processing.
    • Always runs through all media items rather than just new and old.
  • “identify unmatched movie sets with TMDb …”
    • Movie sets have to be matched by name rather than an exact ID like most other media types, so sometimes it needs a little help. This will display a list of all movie sets that have not yet been matched, and select one to enter a new name to search for.
  • “identify unmatched music videos with TheAudioDB …”
    • Just like movie sets, but match on “Artist Name - Song title”.
  • “Remove artwork for media type …”
    • Remove a specific type of art for one specific type of media in the library. Doesn’t touch local files.
    • Can also remove all artwork types that don’t match the add-on configuration.
  • “Download existing remote images in the video library”
    • Downloads existing images in the video library that aren’t already saved locally.
    • Only works for the video library.
  • “Preload local video / music library artwork to texture cache”
    • Preload local artwork to Kodi’s device-local texture cache. Browsing the media library is faster with artwork cached.
    • Only works for local artwork. If you are going to download all artwork immediately for caching, then you might as well save it somewhere so you won’t have to download it again later. Run “Download existing remote images in the video library” to set that up.
  • “Save configured art types to advancesettings.xml whitelist”
    • Kodi 18 can add extended artwork from local files itself with some settings in advancedsettings.xml. This action copies the Artwork Beef configuration to Kodi’s AS.xml.
    • This whitelist also applies to artwork added from scrapers, NFO files, and single file library exports.
    • Running this action will back up the current advancedsettings.xml to “advancedsettings.xml.beef.bak”, and a new action “Restore original advancesettings.xml backed up by Artwork Beef” will be added to this list to restore the original.