diff --git a/docs/conf.py b/docs/conf.py index 3716be6a..d79ca7f4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -250,7 +250,7 @@ html_theme_options = { ("Edition Overlay", "defaults/overlays/edition"), ("Episode Info Overlay", "defaults/overlays/episode_info"), ("After Credit Overlay", "defaults/overlays/mediastinger"), - ("Ratings Overlay", "defaults/overlays/resolution"), + ("Ratings Overlay", "defaults/overlays/ratings"), ("Resolution Overlay", "defaults/overlays/resolution"), ("Ribbon Overlay", "defaults/overlays/ribbon"), ("Runtimes Overlay", "defaults/overlays/runtimes"), diff --git a/docs/defaults/images/audio_codec_ov.png b/docs/defaults/images/audio_codec_ov.png new file mode 100644 index 00000000..bef5aa7a Binary files /dev/null and b/docs/defaults/images/audio_codec_ov.png differ diff --git a/docs/defaults/images/audio_language_ov.png b/docs/defaults/images/audio_language_ov.png new file mode 100644 index 00000000..1b647273 Binary files /dev/null and b/docs/defaults/images/audio_language_ov.png differ diff --git a/docs/defaults/images/commonsense_ov.png b/docs/defaults/images/commonsense_ov.png new file mode 100644 index 00000000..1db37960 Binary files /dev/null and b/docs/defaults/images/commonsense_ov.png differ diff --git a/docs/defaults/images/direct_play_ov.png b/docs/defaults/images/direct_play_ov.png new file mode 100644 index 00000000..cfb54650 Binary files /dev/null and b/docs/defaults/images/direct_play_ov.png differ diff --git a/docs/defaults/images/episode_info_ov.png b/docs/defaults/images/episode_info_ov.png new file mode 100644 index 00000000..661600d2 Binary files /dev/null and b/docs/defaults/images/episode_info_ov.png differ diff --git a/docs/defaults/overlays/audio_codec.md b/docs/defaults/overlays/audio_codec.md new file mode 100644 index 00000000..fecc074a --- /dev/null +++ b/docs/defaults/overlays/audio_codec.md @@ -0,0 +1,50 @@ +# Audio Codec Default Overlay File + +The `- pmm: audio_codec` Overlay File is used to create an overlay based on the audio codec available on each item within your library. + + +Example Overlays Created: + +![](../images/audio_codec_ov.png) + +The below YAML in your config.yml will create the overlays: +```yaml +libraries: + Movies: + overlay_path: + - pmm: audio_codec +``` + +## Template Variables + +Template Variables can be used to manipulate the file from the default settings which are provided. + +Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. + +A key system is used to control each overlay that is created by the file. Each key refers to one overlay and is used to control multiple template variables. + +Below are the keys and what they refer to: + +| Key | Audio Codec | +|:-------------|:-----------------------| +| opus | Opus | +| mp3 | MP3 | +| digital | Dolby Digital | +| aac | AAC | +| dts | DTS | +| es | DTS-ES | +| plus | Dolby Digital+ | +| hra | DTS-HD-HRA | +| pcm | PCM | +| flac | FLAC | +| hd | DTS-HD-MA | +| truehd | Dolby TrueHD | +| plus-atmos | Dolby Digital+ / E-AC3 | +| atmos | Dolby Atmos | +| x | DTS-X | +| truehd-atmos | Dolby TrueHD Atmos | + + + +Further information on the universal template attributes and editing Overlay Files via template variables can be found [here]() + diff --git a/docs/defaults/overlays/audio_language.md b/docs/defaults/overlays/audio_language.md new file mode 100644 index 00000000..f4c1ca86 --- /dev/null +++ b/docs/defaults/overlays/audio_language.md @@ -0,0 +1,34 @@ +# Audio Language Default Overlay File + +The `- pmm: audio_language` Overlay File is used to create an overlay based on the number of audio languages available on each item within your library. + +Example Overlays Created: + +![](../images/audio_language_ov.png) + +The below YAML in your config.yml will create the overlays: +```yaml +libraries: + Movies: + overlay_path: + - pmm: audio_language +``` + +## Template Variables + +Template Variables can be used to manipulate the file from the default settings which are provided. + +Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. + +A key system is used to control each overlay that is created by the file. Each key refers to one overlay and is used to control multiple template variables. + +Below are the keys and what they refer to: + +| Key | Audio Languages | +|:------|:---------------------------------------| +| dual | Dual Audio (i.e. 2 languages) | +| multi | Multi Audio (i.e. 3 or more languages) | + +Further information on the universal template attributes and editing Overlay Files via template variables can be found [here]() + + diff --git a/docs/defaults/overlays/commonsense.md b/docs/defaults/overlays/commonsense.md new file mode 100644 index 00000000..56883aa9 --- /dev/null +++ b/docs/defaults/overlays/commonsense.md @@ -0,0 +1,35 @@ +# CommonSense Age Rating Default Overlay File + +The `- pmm: commonsense` Overlay File is used to create an overlay based on the CommonSense Age Rating on each item within your library. + +Note that this file requires the `mass_content_rating: mdb_commonsense` operation to be set against your library so that the content ratings are taken from CommonSense. + +Example Overlays Created: + +![](../images/commonsense_ov.png) + +The below YAML in your config.yml will create the overlays: +```yaml +libraries: + Movies: + overlay_path: + - pmm: commonsense +``` + +## Template Variables + +Template Variables can be used to manipulate the file from the default settings which are provided. + +Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. + +A key system is used to control the overlays that is created by the file. Each key refers to one overlay and is used to control multiple template variables. + +Below are the keys and what they refer to: + +| Key | Age Rating | +|:------|:-----------| +| nr | Not Rated | + +Further information on the universal template attributes and editing Overlay Files via template variables can be found [here]() + + diff --git a/docs/defaults/overlays/direct_play.md b/docs/defaults/overlays/direct_play.md new file mode 100644 index 00000000..309e5c85 --- /dev/null +++ b/docs/defaults/overlays/direct_play.md @@ -0,0 +1,23 @@ +# Direct Play Default Overlay File + +The `- pmm: direct_play` Overlay File is used to create an overlay to indicate items that cannot be transcoded and instead only support Direct Play (i.e. if you use Tautulli to kill 4K transcoding) + +Example Overlays Created: + +![](../images/direct_play_ov.png) + +The below YAML in your config.yml will create the overlays: +```yaml +libraries: + Movies: + overlay_path: + - pmm: direct_play +``` + +## Template Variables + +This Overlay File has no individual template variables that can be set. + +Further information on the universal template attributes and editing Overlay Files via template variables can be found [here]() + + diff --git a/docs/defaults/overlays/edition.md b/docs/defaults/overlays/edition.md new file mode 100644 index 00000000..23a39c22 --- /dev/null +++ b/docs/defaults/overlays/edition.md @@ -0,0 +1 @@ +To be updated once fixed \ No newline at end of file diff --git a/docs/defaults/overlays/episode_info.md b/docs/defaults/overlays/episode_info.md new file mode 100644 index 00000000..d2ffc075 --- /dev/null +++ b/docs/defaults/overlays/episode_info.md @@ -0,0 +1,24 @@ +# Episode Info Default Overlay File + +The `- pmm: episode_info` Overlay File is used to create an overlay based on the episode numbering within a given series in your library. + +Note that this file should only be used against show libraries and is not expected to work against movie libraries. + +Example Overlays Created: + +![](../images/episode_info_ov.png) + +The below YAML in your config.yml will create the overlays: +```yaml +libraries: + Movies: + overlay_path: + - pmm: episode_info +``` + +## Template Variables + +This Overlay File has no individual template variables that can be set. + +Further information on the universal template attributes and editing Overlay Files via template variables can be found [here]() + diff --git a/docs/defaults/overlays/flixpatrol.yml b/docs/defaults/overlays/flixpatrol.yml new file mode 100644 index 00000000..c6475b59 --- /dev/null +++ b/docs/defaults/overlays/flixpatrol.yml @@ -0,0 +1,102 @@ +queues: + flixpatrol_position: + right: + - horizontal_offset: 30 # This is the first position + horizontal_align: right + vertical_offset: 465 + vertical_align: top + - horizontal_offset: 30 # This is the second position + horizontal_align: right + vertical_offset: 670 + vertical_align: top + - horizontal_offset: 30 # This is the third position + horizontal_align: right + vertical_offset: 875 + vertical_align: top + left: + - horizontal_offset: 30 # This is the first position + horizontal_align: left + vertical_offset: 465 + vertical_align: top + - horizontal_offset: 30 # This is the second position + horizontal_align: left + vertical_offset: 670 + vertical_align: top + - horizontal_offset: 30 # This is the third position + horizontal_align: left + vertical_offset: 875 + vertical_align: top + +templates: + FlixPatrol: + optional: + - use_<> + - time_window_<> + - location_<> + default: + style: round + overlay: <> + slug: <> + horizontal_offset: 15 + horizontal_align: left + vertical_offset: 15 + vertical_align: top + font: fonts/Inter-Bold.ttf + font_size: 50 + font_color: "#FFFFFF" + back_color: "#00000099" + back_radius: 30 + back_width: 165 + back_height: 165 + back_align: center + back_padding: 15 + addon_position: top + addon_offset: 30 + time_window: last_week + time_window_<>: <> + location: united_states + location_<>: <> + limit: 10 + limit_<>: <> + weight_<>: <> + ignore_blank_results: true + allowed_library_types: <>>> + overlay: + name: text(TOP<>) + queue: flixpatrol_position + weight: <>>> + horizontal_offset: <> + horizontal_align: <> + vertical_offset: <> + vertical_align: <> + font: <> + font_size: <> + font_color: <> + back_radius: <> + back_color: <> + back_width: <> + back_height: <> + back_align: <> + back_padding: <> + pmm: logo/<