updates 5.1.0

2026-07-15 18:10:04 +02:00 · 2026-06-04 13:12:55 +01:00
parent 74782f0f3f
commit 7e10493609
82 changed files with 13340 additions and 2370 deletions
@@ -0,0 +1,287 @@
+# Output & Naming Configuration
+
+This document covers output file organization and naming configuration options.
+
+## filenames (dict)
+
+Override the default filenames used across envied.
+The filenames use various variables that are replaced during runtime.
+
+The following filenames are available and may be overridden:
+
+- `log` - Log filenames. Uses `{name}` and `{time}` variables.
+- `debug_log` - Debug log filenames. Uses `{service}` and `{time}` variables.
+- `config` - Service configuration filenames.
+- `root_config` - Root configuration filename.
+- `chapters` - Chapter export filenames. Uses `{title}` and `{random}` variables.
+- `subtitle` - Subtitle export filenames. Uses `{id}` and `{language}` variables.
+
+For example,
+
+```yaml
+filenames:
+  log: "envied_{name}_{time}.log"
+  debug_log: "envied_debug_{service}_{time}.jsonl"
+  config: "config.yaml"
+  root_config: "envied.yaml"
+  chapters: "Chapters_{title}_{random}.txt"
+  subtitle: "Subtitle_{id}_{language}.srt"
+```
+
+---
+
+## output_template (dict)
+
+Configure custom output filename templates for movies, series, and songs.
+This is **required** in your `envied.yaml` — a warning is shown if not configured.
+
+Available variables: `{title}`, `{year}`, `{season}`, `{episode}`, `{season_episode}`, `{episode_name}`,
+`{quality}`, `{resolution}`, `{source}`, `{audio}`, `{audio_channels}`, `{audio_full}`,
+`{video}`, `{hdr}`, `{hfr}`, `{atmos}`, `{dual}`, `{multi}`, `{tag}`, `{edition}`, `{repack}`,
+`{lang_tag}`, `{track_number}`, `{artist}`, `{album}`, `{disc}`
+
+Add `?` suffix to make a variable conditional (omitted when empty): `{year?}`, `{hdr?}`, `{repack?}`
+
+```yaml
+output_template:
+  # Scene-style (dot-separated)
+  movies: '{title}.{year}.{repack?}.{edition?}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{audio_full}.{atmos?}.{hdr?}.{hfr?}.{video}-{tag}'
+  series: '{title}.{year?}.{season_episode}.{episode_name?}.{repack?}.{edition?}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{audio_full}.{atmos?}.{hdr?}.{hfr?}.{video}-{tag}'
+  songs: '{track_number}.{title}.{repack?}.{edition?}.{source?}.WEB-DL.{audio_full}.{atmos?}-{tag}'
+
+  # Plex-friendly (space-separated)
+  # movies: '{title} ({year}) {quality}'
+  # series: '{title} {season_episode} {episode_name?}'
+  # songs: '{track_number}. {title}'
+```
+
+Example outputs:
+- Scene movies: `Example.Movie.2024.1080p.EXAMPLE.WEB-DL.DDP5.1.H.264-TAG`
+- Scene movies (REPACK): `Example.Movie.2024.REPACK.2160p.EXAMPLE.WEB-DL.DDP5.1.H.265-TAG`
+- Scene series: `Example.Show.2024.S01E01.Pilot.1080p.EXAMPLE.WEB-DL.DDP5.1.H.264-TAG`
+- Plex movies: `Example Movie (2024) 1080p`
+
+### folder (optional)
+
+Controls the folder name for downloaded content. Uses the same template variables as the file templates above.
+
+If not configured, the default folder naming is used:
+- Movies: `Title (Year)`
+- Series: Derived from the `series` template with episode-specific variables removed
+- Songs: `Artist - Album (Year)`
+
+`folder` accepts either a single string (applies to all title kinds) or a mapping with per-kind
+templates keyed by `movies`, `series`, and/or `songs`. Unknown keys are warned about and ignored.
+
+```yaml
+output_template:
+  movies: '{title}.{year}.{repack?}.{edition?}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{audio_full}.{atmos?}.{hdr?}.{hfr?}.{video}-{tag}'
+  series: '{title}.{year?}.{season_episode}.{episode_name?}.{repack?}.{edition?}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{audio_full}.{atmos?}.{hdr?}.{hfr?}.{video}-{tag}'
+  songs: '{track_number}.{title}.{repack?}.{edition?}.{source?}.WEB-DL.{audio_full}.{atmos?}-{tag}'
+
+  # Scene-style folder (single template, applies to all kinds)
+  folder: '{title}.{year?}.{repack?}.{edition?}.{lang_tag?}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{audio_full}.{atmos?}.{hdr?}.{hfr?}.{video}-{tag}'
+
+  # Plex-friendly folder
+  # folder: '{title} ({year?})'
+
+  # Per-kind folder templates
+  # folder:
+  #   movies: '{title} ({year})'
+  #   series: '{title} ({year?})'
+  #   songs: '{artist} - {album} ({year?})'
+```
+
+Example outputs:
+- Scene folder: `Example.Show.2024.S01.1080p.EXAMPLE.WEB-DL.DDP5.1.H.264-TAG/`
+- Plex folder: `Example Show (2024)/`
+
+---
+
+---
+
+## language_tags (dict)
+
+Automatically adds language-based identifiers (e.g., `DANiSH`, `NORDiC`, `DKsubs`) to output filenames
+based on audio and subtitle track languages. Use `{lang_tag?}` in your `output_template` to place the tag.
+
+Rules are evaluated in order; the first matching rule wins. All conditions within a single rule
+must match (AND logic). If no rules match, `{lang_tag?}` is cleanly removed from the filename.
+
+### Conditions
+
+| Condition | Type | Description |
+|-----------|------|-------------|
+| `audio` | string | Matches if any selected audio track has this language |
+| `subs_contain` | string | Matches if any selected subtitle has this language |
+| `subs_contain_all` | list | Matches if subtitles include ALL listed languages |
+
+Language matching uses fuzzy matching (e.g., `en` matches `en-US`, `en-GB`).
+
+### Example: Nordic tagging
+
+```yaml
+language_tags:
+  rules:
+    - audio: da
+      tag: DANiSH
+    - audio: sv
+      tag: SWEDiSH
+    - audio: nb
+      tag: NORWEGiAN
+    - audio: en
+      subs_contain_all: [da, sv, nb]
+      tag: NORDiC
+    - audio: en
+      subs_contain: da
+      tag: DKsubs
+
+output_template:
+  movies: '{title}.{year?}.{lang_tag?}.{quality}.{source}.WEB-DL.{audio_full}.{video}-{tag}'
+```
+
+Example outputs:
+- Danish audio: `Example.Show.S01E01.DANiSH.1080p.EXAMPLE.WEB-DL.DDP5.1.H.264-TAG`
+- English audio + multiple Nordic subs: `Example.Show.S01E01.NORDiC.1080p.EXAMPLE.WEB-DL.DDP5.1.H.264-TAG`
+- English audio + Danish subs only: `Example.Show.S01E01.DKsubs.1080p.EXAMPLE.WEB-DL.DDP5.1.H.264-TAG`
+- No matching languages: `Example.Show.S01E01.1080p.EXAMPLE.WEB-DL.DDP5.1.H.264-TAG`
+
+### Example: Other regional tags
+
+```yaml
+language_tags:
+  rules:
+    - audio: nl
+      tag: DUTCH
+    - audio: de
+      tag: GERMAN
+    - audio: fr
+      subs_contain: en
+      tag: ENGFR
+    - audio: fr
+      tag: FRENCH
+```
+
+---
+
+## unicode_filenames (bool)
+
+Allow Unicode characters in output filenames. When `false`, Unicode characters are transliterated
+to ASCII equivalents. Default: `false`.
+
+---
+
+## tag (str)
+
+Group or Username to postfix to the end of download filenames following a dash.
+Use `{tag}` in your output template to include it.
+For example, `tag: "J0HN"` will have `-J0HN` at the end of all download filenames.
+
+---
+
+## tag_group_name (bool)
+
+Enable/disable tagging downloads with your group name when `tag` is set. Default: `true`.
+
+---
+
+## tag_imdb_tmdb (bool)
+
+Enable/disable tagging downloaded files with IMDB/TMDB/TVDB identifiers (when available). Default: `true`.
+
+---
+
+## muxing (dict)
+
+- `set_title`
+  Set the container title to `Show SXXEXX Episode Name` or `Movie (Year)`. Default: `true`
+- `merge_audio`
+  Merge all audio tracks into each output file. Default: `true`
+  - `true`: All selected audio tracks are muxed into one MKV per quality.
+  - `false`: Separate MKV per (quality, audio_codec) combination.
+    For example: `Title.1080p.AAC.mkv`, `Title.1080p.EC3.mkv`.
+
+  Note: The `--split-audio` CLI flag overrides this setting. When `--split-audio` is passed,
+  `merge_audio` is effectively set to `false` for that run.
+
+- `default_language` (dict)
+  Override which track is flagged as the default in the muxed MKV, regardless
+  of the title's original language. Useful when you always want your player to
+  open on a specific language (e.g. always default to Polish audio even on
+  English originals). Only affects the MKV `--default-track` flag — track
+  selection (`-l`, `--alang`, etc.) is unchanged. All keys are optional; each
+  track type falls back to its previous default rule when the configured
+  language isn't present in the manifest.
+
+  - `audio`: BCP-47 tag (e.g. `pl`, `en`, `pt-BR`). Wins over `is_original_lang`.
+    The `--original-flag` continues to mark the true original-audio track.
+  - `video`: BCP-47 tag. Wins over the title-language / first-track rule.
+  - `subtitle`: BCP-47 tag. Wins over the "forced sub matching audio" rule.
+
+  Languages are matched with the same close-match logic used elsewhere
+  (`pt` matches `pt-BR`, etc.). Supports per-service overrides like the rest
+  of `muxing`.
+
+  ```yaml
+  muxing:
+    default_language:
+      audio: pl
+      video: pl
+      subtitle: pl
+  ```
+
+---
+
+## chapter_fallback_name (str)
+
+The Chapter Name to use when exporting a Chapter without a Name.
+The default is no fallback name at all and no Chapter name will be set.
+
+The fallback name can use the following variables in f-string style:
+
+- `{i}`: The Chapter number starting at 1.
+  E.g., `"Chapter {i}"`: "Chapter 1", "Intro", "Chapter 3".
+- `{j}`: A number starting at 1 that increments any time a Chapter has no title.
+  E.g., `"Chapter {j}"`: "Chapter 1", "Intro", "Chapter 2".
+
+These are formatted with f-strings, directives are supported.
+For example, `"Chapter {i:02}"` will result in `"Chapter 01"`.
+
+---
+
+## directories (dict)
+
+Override the default directories used across envied.
+The directories are set to common values by default.
+
+The following directories are available and may be overridden,
+
+- `commands` - CLI Command Classes.
+- `services` - Service Classes.
+- `vaults` - Vault Classes.
+- `fonts` - Font files (ttf or otf).
+- `downloads` - Downloads.
+- `temp` - Temporary files or conversions during download.
+- `cache` - Expiring data like Authorization tokens, or other misc data.
+- `cookies` - Expiring Cookie data.
+- `logs` - Logs.
+- `exports` - JSON sidecar exports written when `--export` is used on `dl`.
+- `wvds` - Widevine Devices.
+- `prds` - PlayReady Devices.
+- `dcsl` - Device Certificate Status List.
+
+Notes:
+
+- `services` accepts either a single directory or a list of directories to search for service modules.
+
+For example,
+
+```yaml
+directories:
+  downloads: "D:/Downloads/envied"
+  temp: "D:/Temp/envied"
+```
+
+There are directories not listed that cannot be modified as they are crucial to the operation of envied.
+
+---