Skip to content

feat(originals-to-assets): add USE_ASSET_TYPE_SUBFOLDERS option #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mjlynden wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(originals-to-assets): add USE_ASSET_TYPE_SUBFOLDERS option #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c0b1a5
Add .python-version to .gitignore
mjlynden Dec 27, 2025
428824d
Support asset type subfolders in asset folder
mjlynden Dec 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ RETAIN_TCM_OVERLAID_IMAGES=0 # keep images that have the TCM ove
USE_ASSET_NAMING=1 # should grab-all-posters name images to match Kometa's Asset Directory requirements?
USE_ASSET_FOLDERS=1 # should those Kometa-Asset-Directory names use asset folders?
USE_ASSET_SUBFOLDERS=0 # create asset folders in subfolders ["Collections", "Other", or [0-9, A-Z]] ]
USE_ASSET_TYPE_SUBFOLDERS=0 # should those Kometa-Asset-Directory names use asset type subfolders (movie, show)?
ASSETS_BY_LIBRARIES=1 # should those Kometa-Asset-Directory images be sorted into library folders?
ASSET_DIR=assets # top-level directory for those Kometa-Asset-Directory images
# if asset-directory naming is on, the next three are ignored
Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
**/*.log
**/*.pickle
**/*.sqlite
**/.python-version

Kometa/metadata-items

Expand Down
1 change: 1 addition & 0 deletions Kometa/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ KOMETA_CONFIG_DIR=/opt/kometa/config # Path to Kometa config directory

# ORIGINAL TO ASSETS
USE_ASSET_FOLDERS=1 # should those Kometa-Asset-Directory names use asset folders?
USE_ASSET_TYPE_SUBFOLDERS=0 # should those Kometa-Asset-Directory names use asset type subfolders (movie, show)?
ASSET_DIR=assets # top-level directory for those Kometa-Asset-Directory images
KOMETA_CONFIG_DIR=/kometa/is/here

26 changes: 23 additions & 3 deletions Kometa/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,17 +269,37 @@ If you don't have overlays on any episodes, this script will not put any episode
```
# ORIGINAL TO ASSETS
USE_ASSET_FOLDERS=1 # should the asset directory use asset folders?
USE_ASSET_TYPE_SUBFOLDERS=1 # optionally, should the asset directory use asset type subfolders? (e.g. 'movie', 'show')
ASSET_DIR=assets # top-level directory for those assets
```
The asset file system will be rooted at the directory in the `ASSET_DIR` setting, and `USE_ASSET_FOLDERS` controls whether the images are stored as:
The asset file system will be rooted at the directory in the `ASSET_DIR` setting, while `USE_ASSET_FOLDERS` and `USE_ASSET_TYPE_SUBFOLDERS` controls whether the images are stored as:

`USE_ASSET_FOLDERS=0`
```
Media-Scripts/Plex/assets/All That Jazz (1979) {imdb-tt0078754} {tmdb-16858}.jpg
# movie|show
Media-Scripts/Plex/assets/<ASSET_NAME>.jpg
# season
Media-Scripts/Plex/assets/<ASSET_NAME>_Season##.jpg
# episode
Media-Scripts/Plex/assets/<ASSET_NAME>_S##E##.jpg
```
or `USE_ASSET_FOLDERS=1`
```
Media-Scripts/Plex/assets/All That Jazz (1979) {imdb-tt0078754} {tmdb-16858}/poster.jpg
# movie|show
Media-Scripts/Plex/assets/<ASSET_NAME>/poster.jpg
# season
Media-Scripts/Plex/assets/<ASSET_NAME>/Season##.jpg
# episode
Media-Scripts/Plex/assets/<ASSET_NAME>/S##E##.jpg
```
with `USE_ASSET_TYPE_SUBFOLDERS=1`
```
# movie|show
Media-Scripts/Plex/assets/<movie|show>/...
# season
Media-Scripts/Plex/assets/show/...
# episode
Media-Scripts/Plex/assets/show/...
```

example output:
Expand Down
58 changes: 40 additions & 18 deletions Kometa/originals-to-assets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@
# 0.0.4 more chatty logging and bail if the original isn't found
# 0.0.5 Actually fix TV libraries
# 0.0.6 use parent directory name rather than stem
# 0.0.7 add USE_ASSET_TYPE_SUBFOLDERS option

VERSION = "0.0.6"
VERSION = "0.0.7"

env_file_path = Path(".env")

Expand Down Expand Up @@ -87,6 +88,7 @@ def superchat(msg, level, logfile):
ASSET_PATH = Path(ASSET_DIR)

USE_ASSET_FOLDERS = booler(os.getenv("USE_ASSET_FOLDERS"))
USE_ASSET_TYPE_SUBFOLDERS = booler(os.getenv("USE_ASSET_TYPE_SUBFOLDERS"))

if ASSET_DIR is None:
ASSET_DIR = "assets"
Expand Down Expand Up @@ -191,27 +193,47 @@ def target_asset(item):
superchat(f"Episode asset name: {asset_name}", "info", "a")

if USE_ASSET_FOLDERS:
# Movie/Show poster <path_to_assets>/ASSET_NAME/poster.ext
target_file = Path(ASSET_PATH, asset_name, "poster.jpg")
# Season poster <path_to_assets>/ASSET_NAME/Season##.ext
if USE_ASSET_TYPE_SUBFOLDERS:
# If using type subfolders, then assets go in a subfolder for their type (movie or show):
# Movie/Show poster: -> <ASSET_PATH>/<movie|show>/<ASSET_NAME>
# Season/Episode poster: -> <ASSET_PATH>/show/<ASSET_NAME>
type_subfolder = "movie" if item.TYPE == "movie" else "show"
base_path = Path(ASSET_PATH, type_subfolder, asset_name)
else:
# Flat asset structure: all assets go directly in an ASSET_PATH/<ASSET_NAME> folder
base_path = Path(ASSET_PATH, asset_name)

if item.TYPE == "season":
target_file = Path(
ASSET_PATH, asset_name, f"Season{str(item_season).zfill(2)}.jpg"
)
# Episode poster <path_to_assets>/ASSET_NAME/S##E##.ext
if item.TYPE == "episode":
target_file = Path(ASSET_PATH, asset_name, f"{item_se_str}.jpg")
# Season poster: <base_path>/Season##.jpg
target_file = base_path / f"Season{str(item_season).zfill(2)}.jpg"
elif item.TYPE == "episode":
# Episode poster: <base_path>/S##E##.jpg
target_file = base_path / f"{item_se_str}.jpg"
else:
# Movie/Show poster: <base_path>/poster.jpg
target_file = base_path / "poster.jpg"
else:
# Movie/Show poster <path_to_assets>/ASSET_NAME.ext
target_file = Path(ASSET_PATH, f"{asset_name}.jpg")
# Season poster <path_to_assets>/ASSET_NAME_Season##.ext
if USE_ASSET_TYPE_SUBFOLDERS:
# If using type subfolders, then assets go in a subfolder for their type (movie or show):
# Movie/Show poster: -> <ASSET_PATH>/<movie|show>
# Season/Episode poster: -> <ASSET_PATH>/show
type_subfolder = "movie" if item.TYPE == "movie" else "show"
base_path = Path(ASSET_PATH, type_subfolder)
else:
# Flat asset structure: all assets go directly in the ASSET_PATH
base_path = ASSET_PATH

if item.TYPE == "season":
target_file = Path(
ASSET_PATH, f"{asset_name}_Season{str(item_season).zfill(2)}.jpg"
target_file = (
base_path
/ f"{asset_name}_Season{str(item_season).zfill(2)}.jpg" # <ASSET_NAME>_Season##.jpg
)
elif item.TYPE == "episode":
target_file = (
base_path / f"{asset_name}_{item_se_str}.jpg" # <ASSET_NAME>_S##E##.jpg
)
# Episode poster <path_to_assets>/ASSET_NAME_S##E##.ext
if item.TYPE == "episode":
target_file = Path(ASSET_PATH, f"{asset_name}_{item_se_str}.jpg")
else:
target_file = base_path / f"{asset_name}.jpg" # <ASSET_NAME>.jpg

superchat(f"Target file: {target_file}", "info", "a")

Expand Down