Skip to content

Latest commit

 

History

History
182 lines (163 loc) · 7.95 KB

Image-Asset-Directory.md

File metadata and controls

182 lines (163 loc) · 7.95 KB
Raw

The Image Asset Directories can be used to update the posters and backgrounds of collections, movies, shows, seasons, and episodes.

To use multiple Image Asset Directories you have to use a list. Comma-separated values will not work. By default, the program will look in the same folder as you config.yml for a folder called assets.

There are two different options when it comes to how the program looks at the files inside you Asset Directories. These can be toggled between by using asset_folders.

Image Type Image Path With Folders
asset_folders: true		 Image Path Without Folder
asset_folders: false
Collection/Movie/Show poster assets/ASSET_NAME/poster.ext assets/ASSET_NAME.ext
Collection/Movie/Show background assets/ASSET_NAME/background.ext assets/ASSET_NAME_background.ext
Season poster assets/ASSET_NAME/Season##.ext assets/ASSET_NAME_Season##.ext
Season background assets/ASSET_NAME/Season##_background.ext assets/ASSET_NAME_Season##_background.ext
Episode poster assets/ASSET_NAME/S##E##.ext assets/ASSET_NAME_S##E##.ext

  • For Collections replace ASSET_NAME with the mapping name used with the collection unless system_name is specified, which you would then use what's specified in system_name.

  • For Movies replace ASSET_NAME with the exact name of the folder the video file is stored in.

  • For Shows, Seasons, and Episodes replace ASSET_NAME with the exact name of the folder for the show as a whole.

  • For Seasons replace ## with the zero padded season number (00 for specials)

  • For Episodes replacing the first ## with the zero padded season number (00 for specials), the second ## with the zero padded episode number

  • Replace .ext with the image extension

By default, the program will only look inside the Image Asset Directories for Images when it runs a collection from a Metadata File. When it does this by default it will only look for the collection images, but you can have it look for images of every item in the collection if you add item_assets: true to the collection config.

If you're using asset_folders set to true you can also nest movie/show folders inside an Image Assets Collection Folder that contains that movie/show.

You can set assets_for_all to true to have the program, after your run, check the Image Asset Directories for Images of every item in your library.

Here's an example config folder structure with an assets directory with asset_folders set to true and false.

asset_folders: true without nesting

config
├── config.yml
├── Movies.yml
├── TV Shows.yml
├── assets
│   ├── The Lord of the Rings
│       ├── poster.png
│       ├── background.png
│   ├── The Lord of the Rings The Fellowship of the Ring (2001)
│       ├── poster.png
│       ├── background.png
│   ├── The Lord of the Rings The Two Towers (2002)
│       ├── poster.png
│       ├── background.png
│   ├── The Lord of the Rings The Return of the King (2003)
│       ├── poster.png
│       ├── background.png
│   ├── Star Wars (Animated)
│       ├── poster.png
│       ├── background.png
│   ├── Star Wars The Clone Wars
│       ├── poster.png
│       ├── background.png
│       ├── Season00.png
│       ├── Season01.png
│       ├── Season02.png
│       ├── Season03.png
│       ├── Season04.png
│       ├── Season05.png
│       ├── Season06.png
│       ├── Season07.png
│       ├── S07E01.png
│       ├── S07E02.png
│       ├── S07E03.png
│       ├── S07E04.png
│       ├── S07E05.png
│   ├── Star Wars Rebels
│       ├── poster.png
│       ├── background.png
│       ├── Season01.png
│       ├── Season01_background.png
│       ├── Season02.png
│       ├── Season02_background.png
│       ├── Season03.png
│       ├── Season03_background.png
│       ├── Season04.png
│       ├── Season04_background.png

asset_folders: true with nesting

config
├── config.yml
├── Movies.yml
├── TV Shows.yml
├── assets
│   ├── The Lord of the Rings
│       ├── poster.png
│       ├── background.png
│       ├── The Lord of the Rings The Fellowship of the Ring (2001)
│           ├── poster.png
│           ├── background.png
│       ├── The Lord of the Rings The Two Towers (2002)
│           ├── poster.png
│           ├── background.png
│       ├── The Lord of the Rings The Return of the King (2003)
│           ├── poster.png
│           ├── background.png
│   ├── Star Wars (Animated)
│       ├── poster.png
│       ├── background.png
│       ├── Star Wars The Clone Wars
│           ├── poster.png
│           ├── background.png
│           ├── Season00.png
│           ├── Season01.png
│           ├── Season02.png
│           ├── Season03.png
│           ├── Season04.png
│           ├── Season05.png
│           ├── Season06.png
│           ├── Season07.png
│           ├── S07E01.png
│           ├── S07E02.png
│           ├── S07E03.png
│           ├── S07E04.png
│           ├── S07E05.png
│       ├── Star Wars Rebels
│           ├── poster.png
│           ├── background.png
│           ├── Season01.png
│           ├── Season01_background.png
│           ├── Season02.png
│           ├── Season02_background.png
│           ├── Season03.png
│           ├── Season03_background.png
│           ├── Season04.png
│           ├── Season04_background.png

asset_folders: false

config
├── config.yml
├── Movies.yml
├── TV Shows.yml
├── assets
│   ├── The Lord of the Rings.png
│   ├── The Lord of the Rings_background.png
│   ├── The Lord of the Rings The Fellowship of the Ring (2001).png
│   ├── The Lord of the Rings The Fellowship of the Ring (2001)_background.png
│   ├── The Lord of the Rings The Two Towers (2002).png
│   ├── The Lord of the Rings The Two Towers (2002)_background.png
│   ├── The Lord of the Rings The Return of the King (2003).png
│   ├── The Lord of the Rings The Return of the King (2003)_background.png
│   ├── Star Wars (Animated).png
│   ├── Star Wars (Animated)_background.png
│   ├── Star Wars The Clone Wars.png
│   ├── Star Wars The Clone Wars_background.png
│   ├── Star Wars The Clone Wars_Season00.png
│   ├── Star Wars The Clone Wars_Season01.png
│   ├── Star Wars The Clone Wars_Season02.png
│   ├── Star Wars The Clone Wars_Season03.png
│   ├── Star Wars The Clone Wars_Season04.png
│   ├── Star Wars The Clone Wars_Season05.png
│   ├── Star Wars The Clone Wars_Season06.png
│   ├── Star Wars The Clone Wars_Season07.png
│   ├── Star Wars The Clone Wars_S07E01.png
│   ├── Star Wars The Clone Wars_S07E02.png
│   ├── Star Wars The Clone Wars_S07E03.png
│   ├── Star Wars The Clone Wars_S07E04.png
│   ├── Star Wars The Clone Wars_S07E05.png
│   ├── Star Wars Rebels.png
│   ├── Star Wars Rebels_background.png
│   ├── Star Wars Rebels_Season01.png
│   ├── Star Wars Rebels_Season01_background.png
│   ├── Star Wars Rebels_Season02.png
│   ├── Star Wars Rebels_Season02_background.png
│   ├── Star Wars Rebels_Season03.png
│   ├── Star Wars Rebels_Season03_background.png
│   ├── Star Wars Rebels_Season04.png
│   ├── Star Wars Rebels_Season04_background.png