plugin.json

{
  "name": "VOD Manager",
  "version": "2.6.3",
  "description": "Curates Dispatcharr's VOD catalogue from vod-probe's measurements: keeps the versions matching your quality/language settings and prunes the rest. Optional .strm generation for Emby/Jellyfin. Needs vod-probe. Dry-run by default.",
  "author": "oxios0x00",
  "license": "MIT",
  "fields": [
    {
      "id": "dry_run",
      "label": "Dry run (log decisions, don't delete anything)",
      "type": "boolean",
      "default": true,
      "help_text": "ON: decides winners but never deletes anything. Turn OFF once a test batch looks right — pruning is a real delete, only recoverable via Dispatcharr's own next refresh."
    },
    {
      "id": "_section_settings",
      "label": "[SETTINGS]",
      "type": "info",
      "description": "Changing any setting below only affects titles processed afterward, never retroactively, and an already-pruned relation isn't recoverable from a setting change alone. For a reliable result after a change, run [MAINTENANCE] Reset Plugin State, then Scan + Process again from scratch."
    },
    {
      "id": "target_qualities",
      "label": "Qualities to keep (one winner per tier)",
      "type": "string",
      "default": "2160p,1080p",
      "help_text": "Comma-separated, best first. Empty = every tier. Falls back to the best available tier if none listed exist."
    },
    {
      "id": "exclude_unmatched_quality",
      "label": "Exclude titles with none of the target qualities",
      "type": "boolean",
      "default": false,
      "help_text": "OFF: keeps the best available tier instead. ON: drops the title entirely."
    },
    {
      "id": "keep_one_version_per_tier",
      "label": "Keep one version per quality tier",
      "type": "boolean",
      "default": false,
      "help_text": "OFF (default): keep every matching version per tier. ON: one winner per tier (old, more aggressive behaviour)."
    },
    {
      "id": "target_languages",
      "label": "Target languages (ISO 639-2, e.g. fre,eng)",
      "type": "string",
      "default": "fre,eng",
      "help_text": "Comma-separated. Empty = language is ignored."
    },
    {
      "id": "exclude_unmatched_language",
      "label": "Exclude relations matching none of the target languages",
      "type": "boolean",
      "default": false,
      "help_text": "OFF: keeps the best-bitrate relation anyway. ON: drops that tier entirely."
    },
    {
      "id": "_section_exclusions",
      "label": "[EXCLUSIONS]",
      "type": "info",
      "description": "Permanently exclude specific titles by TMDB id, regardless of the settings above."
    },
    {
      "id": "excluded_movie_tmdbids",
      "label": "Movies to exclude (one TMDB id per line)",
      "type": "text",
      "default": "",
      "help_text": "One TMDB id per line, optional free comment after it (e.g. '603 wrong match')."
    },
    {
      "id": "excluded_series_tmdbids",
      "label": "Series to exclude (one TMDB id per line)",
      "type": "text",
      "default": "",
      "help_text": "Same format, matched against the series' own TMDB id."
    },
    {
      "id": "batch_size",
      "label": "Batch size (movies per batch)",
      "type": "number",
      "default": 25,
      "min": 1,
      "help_text": "Start small (5-25) to validate before scaling up."
    },
    {
      "id": "_section_series",
      "label": "[SERIES]",
      "type": "info",
      "description": "Same select/prune pipeline as Films, per episode, using the settings above."
    },
    {
      "id": "series_batch_size",
      "label": "Batch size (series per batch)",
      "type": "number",
      "default": 5,
      "min": 1,
      "help_text": "Smaller than the Films batch size — one series can fan out into dozens of episodes."
    },
    {
      "id": "_section_title_cleanup",
      "label": "[TITLE CLEANUP]",
      "type": "info",
      "description": "Cosmetic only — strips junk prefixes from titles (e.g. 'NF - The Matrix' → 'The Matrix'). Never affects quality/language selection."
    },
    {
      "id": "title_cleanup_tags",
      "label": "Tags to strip (one per line)",
      "type": "text",
      "default": "NF -\nTOP -\n4K-FR -\nAMZ -\nFR -\nFR .\nD+ -\nD+  -\nUNV -\n4K-NF -\nPRMT -\n4K-AMZ -\n4K-D+ -\n4K-FR-HDR -\n4K-FR-\nA+ -\nA+\n4K-A+ -\n4K-MRVL -\nDWA -\n007 -\nK-FR -\nAR-SUBS -\n4M-AMZ -\n4K-",
      "help_text": "Case-insensitive prefixes, stripped from the start of the title (stacked tags are stripped repeatedly)."
    },
    {
      "id": "auto_clean_titles",
      "label": "Run title cleanup automatically with Scan + Process",
      "type": "boolean",
      "default": false,
      "help_text": "OFF (default): only runs from the Clean Titles buttons or its own scheduled action."
    },
    {
      "id": "_section_strm",
      "label": "[.STRM OUTPUT]",
      "type": "info",
      "description": "Optional: writes one .strm per kept relation, for Emby/Jellyfin multi-version playback. Run order: Scan + Process until Queue Status is empty, then Generate."
    },
    {
      "id": "strm_dispatcharr_url",
      "label": "Dispatcharr base URL (baked into every .strm)",
      "type": "string",
      "default": "",
      "placeholder": "http://192.168.1.94:9292",
      "help_text": "Must be reachable from your media server, not just from Dispatcharr — a LAN IP/hostname, not 'localhost'."
    },
    {
      "id": "strm_library_path",
      "label": "Library root path (inside this container)",
      "type": "string",
      "default": "/data/strm",
      "help_text": "Mount this same path into your media server so it can see the generated files."
    },
    {
      "id": "strm_movies_subfolder",
      "label": "Movies subfolder name",
      "type": "string",
      "default": "movies"
    },
    {
      "id": "strm_series_subfolder",
      "label": "Series subfolder name",
      "type": "string",
      "default": "series"
    },
    {
      "id": "strm_profiles",
      "label": "Language profiles (one per line)",
      "type": "text",
      "default": "",
      "placeholder": "arabe : ara : movies-ar : series-ar : exclusif\nprincipal : all : movies : series",
      "help_text": "Empty (default): one folder pair, from the two subfolder names above. Otherwise one profile per line, 'name : languages : movies folder : series folder', optionally ending in ': exclusif'. languages = ISO 639-2 codes separated by commas, or 'all'. A version goes to every profile it matches; a version matching an 'exclusif' profile goes only to the first such profile and to no other, so use it with care. When this is filled, the two subfolder names above are ignored. See docs/strm-and-emby.md."
    },
    {
      "id": "auto_generate_strm",
      "label": "Run .strm generation automatically with Scan + Process",
      "type": "boolean",
      "default": false,
      "help_text": "OFF (default): only runs from the Generate buttons or its own scheduled action."
    },
    {
      "id": "strm_include_id_tag",
      "label": "Include [tmdbid-####] / [imdbid-ttXXXXXXX] in the movie/series folder name",
      "type": "boolean",
      "default": true,
      "help_text": "ON (default): tags the folder and file names with the title's TMDB/IMDB id, for Emby/Jellyfin identification and Jellyfin's multi-version grouping. Flipping this renames the whole tagged tree on the next Generate."
    },
    {
      "id": "strm_require_id",
      "label": "Skip titles with no TMDB/IMDB id",
      "type": "boolean",
      "default": true,
      "help_text": "ON (default): no .strm for a title with neither id (some providers never expose one). OFF: it still gets one, named from the raw title text."
    },
    {
      "id": "strm_write_nfo",
      "label": "Also write a .nfo sidecar next to each .strm",
      "type": "boolean",
      "default": false,
      "help_text": "OFF (default): no companion Emby/Jellyfin plugin reads this yet, so it would just be an extra file most media servers ignore. ON: writes '<file>.strm.nfo' with vod-probe's already-measured streamdetails (video/audio codec, resolution, languages) — free, no extra probing. Flipping back to OFF deletes any already-written .nfo on the next Generate, same as an orphaned .strm."
    },
    {
      "id": "_section_schedule",
      "label": "[SCHEDULE]",
      "type": "info",
      "description": "Runs one action on its own cron. Fill in the fields below, click Apply, then restart Dispatcharr once. Leave Schedule empty until you trust the picks."
    },
    {
      "id": "schedule_cron",
      "label": "Schedule (5-field cron)",
      "type": "string",
      "default": "",
      "help_text": "'minute hour day-of-month month day-of-week'. Empty falls back to every 6 hours when Apply is clicked. Best set a few minutes after Dispatcharr's VOD refresh and vod-probe."
    },
    {
      "id": "schedule_target",
      "label": "Scheduled action",
      "type": "select",
      "default": "scan_and_process",
      "options": [
        {
          "value": "scan_and_process",
          "label": "Scan + Process Movies"
        },
        {
          "value": "scan_movies",
          "label": "Scan Movies only"
        },
        {
          "value": "clean_movie_titles",
          "label": "Clean Movie Titles only"
        },
        {
          "value": "clean_series_titles",
          "label": "Clean Series Titles only"
        },
        {
          "value": "scan_and_process_series",
          "label": "Scan + Process Series"
        },
        {
          "value": "scan_and_process_both",
          "label": "Scan + Process Movies then Series (recommended)"
        },
        {
          "value": "scan_series",
          "label": "Scan Series only"
        },
        {
          "value": "generate_movie_strm",
          "label": "Generate Movie .strm Files only"
        },
        {
          "value": "generate_series_strm",
          "label": "Generate Series .strm Files only"
        }
      ],
      "help_text": "Which action the scheduler runs on each tick."
    }
  ],
  "actions": [
    {
      "id": "scan_and_process_both",
      "label": "[MOVIES + SERIES] Scan + Process",
      "description": "Background run: Movies, then Series, back to back. Same as running both buttons below in sequence.",
      "button_label": "Run",
      "button_variant": "filled",
      "button_color": "teal"
    },
    {
      "id": "scan_and_process",
      "label": "[MOVIES] Scan + Process",
      "description": "Background run: scans, then selects and prunes until the queue is empty. Follow with Queue Status, end with Stop.",
      "button_label": "Run",
      "button_variant": "filled",
      "button_color": "green"
    },
    {
      "id": "scan_movies",
      "label": "[MOVIES] Scan",
      "description": "Enqueue movies whose M3U relations changed since last pass.",
      "button_label": "Scan",
      "button_variant": "outline",
      "button_color": "blue"
    },
    {
      "id": "queue_status",
      "label": "[MOVIES] Queue Status",
      "description": "Whether a run is in progress, pending/in-progress/done/error counts and the last batch.",
      "button_label": "Status",
      "button_variant": "outline",
      "button_color": "blue"
    },
    {
      "id": "stop_queue",
      "label": "[MOVIES] Stop",
      "description": "Stops a running movie Scan + Process after its current batch. Nothing is left blocked: run Scan + Process again to carry on.",
      "button_label": "Stop",
      "button_variant": "outline",
      "button_color": "orange"
    },
    {
      "id": "clean_movie_titles",
      "label": "[MOVIES] Clean Titles",
      "description": "Strip configured junk prefixes from movie titles (uses Dry Run).",
      "button_label": "Clean Titles",
      "button_variant": "outline",
      "button_color": "grape"
    },
    {
      "id": "generate_movie_strm",
      "label": "[MOVIES] Generate .strm Files",
      "description": "Write one .strm per kept movie relation, plus a .nfo sidecar for each if 'Also write a .nfo sidecar' is on. Refuses to run until Scan + Process is done. Runs in the background; a notification appears when finished.",
      "button_label": "Generate",
      "button_variant": "outline",
      "button_color": "cyan"
    },
    {
      "id": "scan_and_process_series",
      "label": "[SERIES] Scan + Process",
      "description": "Background run: scans, then selects and prunes until the queue is empty. Follow with Queue Status, end with Stop.",
      "button_label": "Run",
      "button_variant": "filled",
      "button_color": "green"
    },
    {
      "id": "scan_series",
      "label": "[SERIES] Scan",
      "description": "Enqueue series whose M3U relations changed since last pass.",
      "button_label": "Scan",
      "button_variant": "outline",
      "button_color": "blue"
    },
    {
      "id": "series_queue_status",
      "label": "[SERIES] Queue Status",
      "description": "Whether a run is in progress, pending/in-progress/done/error counts and the last batch, for series.",
      "button_label": "Status",
      "button_variant": "outline",
      "button_color": "blue"
    },
    {
      "id": "stop_series_queue",
      "label": "[SERIES] Stop",
      "description": "Stops a running series Scan + Process after its current batch. Nothing is left blocked: run Scan + Process again to carry on.",
      "button_label": "Stop",
      "button_variant": "outline",
      "button_color": "orange"
    },
    {
      "id": "clean_series_titles",
      "label": "[SERIES] Clean Titles",
      "description": "Strip configured junk prefixes from series titles (uses Dry Run).",
      "button_label": "Clean Titles",
      "button_variant": "outline",
      "button_color": "grape"
    },
    {
      "id": "generate_series_strm",
      "label": "[SERIES] Generate .strm Files",
      "description": "Write one .strm per kept episode relation, plus a .nfo sidecar for each if 'Also write a .nfo sidecar' is on. Refuses to run until Scan + Process is done. Runs in the background; a notification appears when finished.",
      "button_label": "Generate",
      "button_variant": "outline",
      "button_color": "cyan"
    },
    {
      "id": "catalog_stats",
      "label": "[MAINTENANCE] Catalog Stats",
      "description": "Snapshot kept movies/series by quality tier. Also runs automatically after Scan + Process.",
      "button_label": "Stats",
      "button_variant": "outline",
      "button_color": "grape"
    },
    {
      "id": "delete_strm_files",
      "label": "[MAINTENANCE] Delete .strm Files",
      "description": "Starts a background run that deletes every generated .strm and .nfo (movies and series) and clears the manifest. Real files, real delete. Uses Dry Run. Follow it with the notification centre.",
      "button_label": "Delete",
      "button_variant": "outline",
      "button_color": "red",
      "confirm": {
        "required": true,
        "title": "Delete every .strm file?",
        "message": "Removes all files under the configured Movies/Series .strm subfolders. Your media server will lose them until the next Generate. This does not touch Dispatcharr's own catalogue."
      }
    },
    {
      "id": "prune_orphaned_state",
      "label": "[MAINTENANCE] Prune Orphaned State",
      "description": "Deletes this plugin's own queue rows for titles Dispatcharr has since deleted. Uses Dry Run. Never touches Dispatcharr's data or .strm files.",
      "button_label": "Prune",
      "button_variant": "outline",
      "button_color": "orange"
    },
    {
      "id": "retry_errored_titles",
      "label": "[MAINTENANCE] Retry Errored Titles",
      "description": "Re-queues every title in 'error' status, movies and series. Follow with Scan + Process.",
      "button_label": "Retry",
      "button_variant": "outline",
      "button_color": "orange"
    },
    {
      "id": "reset_plugin_state",
      "label": "[MAINTENANCE] Reset Plugin State",
      "description": "Wipes the queues, known relations, run history and catalog stats — starts fresh on the next Scan/Process. Uses Dry Run.",
      "button_label": "Reset",
      "button_variant": "outline",
      "button_color": "red",
      "confirm": {
        "required": true,
        "title": "Reset all plugin state?",
        "message": "Clears every queue this plugin has recorded — the next Scan + Process will decide every title again. Dispatcharr's own movies/series/relations are untouched."
      }
    },
    {
      "id": "apply_schedule",
      "label": "[SCHEDULE] Apply",
      "description": "Register or update the periodic task from the [SCHEDULE] settings.",
      "button_label": "Apply",
      "button_variant": "outline",
      "button_color": "blue"
    },
    {
      "id": "remove_schedule",
      "label": "[SCHEDULE] Remove",
      "description": "Unregister the periodic task.",
      "button_label": "Remove",
      "button_variant": "outline",
      "button_color": "orange",
      "confirm": {
        "required": true,
        "title": "Remove the schedule?",
        "message": "Unregisters the periodic task. You can re-create it any time with Apply Schedule."
      }
    },
    {
      "id": "schedule_status",
      "label": "[SCHEDULE] Status",
      "description": "Whether a schedule is registered and when it last ran.",
      "button_label": "Status",
      "button_variant": "outline",
      "button_color": "blue"
    }
  ]
}