diff --git a/docs/source/config_reference/plugins.rst b/docs/source/config_reference/plugins.rst index c3161a27..86f69a12 100644 --- a/docs/source/config_reference/plugins.rst +++ b/docs/source/config_reference/plugins.rst @@ -615,6 +615,79 @@ Usage: Comedy Drama +---------------------------------------------------------------------------------------------------- + +season_nfo_tags +------------------------- +Adds a single NFO file in the season directory. An NFO file is simply an XML file with a +``.nfo`` extension. It uses the last entry's source variables which can change per download +invocation. Be cautious of which variables you use. + +Usage: + +.. code-block:: yaml + + presets: + my_example_preset: + season_nfo_tags: + # required + nfo_name: "Season 01/season.nfo" + nfo_root: "season" + tags: + title: "My custom season name!" + # optional + kodi_safe: False + +``enable`` + +:expected type: Optional[OverridesFormatter] +:description: + Can typically be left undefined to always default to enable. For preset convenience, + this field can be set using an override variable to easily toggle whether this plugin + is enabled or not via Boolean. + + +``kodi_safe`` + +:expected type: Optional[Boolean] +:description: + Defaults to False. Kodi does not support > 3-byte unicode characters, which include + emojis and some foreign language characters. Setting this to True will replace those + characters with '□'. + + +``nfo_name`` + +:expected type: EntryFormatter +:description: + The NFO file name. + + +``nfo_root`` + +:expected type: EntryFormatter +:description: + The root tag of the NFO's XML. In the usage above, it would look like + + .. code-block:: xml + + + + + + +``tags`` + +:expected type: NfoTags +:description: + Tags within the nfo_root tag. In the usage above, it would look like + + .. code-block:: xml + + + + My custom season name! + ---------------------------------------------------------------------------------------------------- diff --git a/src/ytdl_sub/__init__.py b/src/ytdl_sub/__init__.py index abab4d89..d319f563 100644 --- a/src/ytdl_sub/__init__.py +++ b/src/ytdl_sub/__init__.py @@ -1,2 +1,2 @@ -__pypi_version__ = "2025.01.09" -__local_version__ = "2025.01.09+57c5d3c" +__pypi_version__ = "2025.01.09.post1" +__local_version__ = "2025.01.09+52a1be3"