plugin.json

{
  "id": "tv-logos",
  "name": "TV Logos",
  "version": "1.0.9",
  "api_version": "1.0.0",
  "repository": "m3ue/tv-logos-plugin",
  "description": "Automatically enriches channel logos from the open-source tv-logo/tv-logos or K-yzu/Logos repositories via the jsDelivr CDN.",
  "entrypoint": "Plugin.php",
  "class": "AppLocalPlugins\\TvLogos\\Plugin",
  "capabilities": [
    "channel_processor"
  ],
  "hooks": [
    "playlist.synced"
  ],
  "permissions": [
    "db_read",
    "db_write",
    "network_egress",
    "filesystem_read",
    "filesystem_write",
    "hook_subscriptions",
    "queue_jobs"
  ],
  "schema": {
    "tables": []
  },
  "data_ownership": {
    "tables": [],
    "directories": [
      "plugin-data/tv-logos",
      "plugin-reports/tv-logos"
    ],
    "files": [],
    "default_cleanup_policy": "purge"
  },
  "settings": [
    {
      "id": "source_target",
      "type": "section",
      "label": "Source & Target",
      "description": "Logo source repository and playlist assignment.",
      "collapsible": true,
      "collapsed": false,
      "fields": [
        {
          "id": "logo_source",
          "label": "Logo Source",
          "type": "select",
          "default": "tv-logo",
          "options": {
            "tv-logo": "tv-logo/tv-logos (tv-logo)",
            "kyzu": "K-yzu/Logos (kyzu)"
          },
          "helper_text": "Which logo repository layout to match against. K-yzu/Logos covers US, CA, UK, AU and NZ channels; its regional-affiliate subfolders (e.g. TV:US2) are not indexed yet."
        },
        {
          "id": "github_repo",
          "label": "tv-logo/tv-logos GitHub Repository (owner/repo)",
          "type": "text",
          "default": "tv-logo/tv-logos",
          "helper_text": "Used when Logo Source is tv-logo/tv-logos. Change to use a fork, e.g. your-username/tv-logos."
        },
        {
          "id": "kyzu_github_repo",
          "label": "K-yzu/Logos GitHub Repository (owner/repo)",
          "type": "text",
          "default": "K-yzu/Logos",
          "helper_text": "Used when Logo Source is K-yzu/Logos. Change to use a fork."
        },
        {
          "id": "default_playlist_id",
          "label": "Default Playlist(s)",
          "type": "model_select",
          "model": "App\\Models\\Playlist",
          "label_attribute": "name",
          "scope": "owned",
          "multiple": true,
          "helper_text": "Playlists to enrich automatically after each sync. Leave empty to disable automatic enrichment.",
          "default": null
        },
        {
          "id": "country_code",
          "label": "Country Code(s)",
          "type": "select",
          "multiple": true,
          "default": [
            "us"
          ],
          "options": {
            "al": "Albania (al)",
            "dz": "Algeria (dz)",
            "ar": "Argentina (ar)",
            "au": "Australia (au)",
            "at": "Austria (at)",
            "be": "Belgium (be)",
            "ba": "Bosnia & Herzegovina (ba)",
            "br": "Brazil (br)",
            "bg": "Bulgaria (bg)",
            "ca": "Canada (ca)",
            "cn": "China (cn)",
            "hr": "Croatia (hr)",
            "cz": "Czech Republic (cz)",
            "dk": "Denmark (dk)",
            "eg": "Egypt (eg)",
            "ee": "Estonia (ee)",
            "fi": "Finland (fi)",
            "fr": "France (fr)",
            "de": "Germany (de)",
            "gr": "Greece (gr)",
            "hu": "Hungary (hu)",
            "in": "India (in)",
            "ie": "Ireland (ie)",
            "is": "Iceland (is)",
            "il": "Israel (il)",
            "it": "Italy (it)",
            "jp": "Japan (jp)",
            "xk": "Kosovo (xk)",
            "lv": "Latvia (lv)",
            "lt": "Lithuania (lt)",
            "lu": "Luxembourg (lu)",
            "mk": "North Macedonia (mk)",
            "me": "Montenegro (me)",
            "mx": "Mexico (mx)",
            "nl": "Netherlands (nl)",
            "nz": "New Zealand (nz)",
            "ng": "Nigeria (ng)",
            "no": "Norway (no)",
            "pl": "Poland (pl)",
            "pt": "Portugal (pt)",
            "ro": "Romania (ro)",
            "ru": "Russia (ru)",
            "sa": "Saudi Arabia (sa)",
            "rs": "Serbia (rs)",
            "sk": "Slovakia (sk)",
            "si": "Slovenia (si)",
            "za": "South Africa (za)",
            "kr": "South Korea (kr)",
            "es": "Spain (es)",
            "se": "Sweden (se)",
            "ch": "Switzerland (ch)",
            "tr": "Turkey (tr)",
            "ua": "Ukraine (ua)",
            "ae": "United Arab Emirates (ae)",
            "gb": "United Kingdom (gb)",
            "us": "United States (us)"
          },
          "helper_text": "Select one or more countries, tried in order per channel (first match wins). tv-logo/tv-logos supports all listed codes; K-yzu/Logos only supports us, ca, gb, au, nz - other codes are skipped when that source is active."
        }
      ]
    },
    {
      "id": "matching_behavior",
      "type": "section",
      "label": "Matching Behavior",
      "description": "Controls for overwriting, VOD handling, and cache lifetime.",
      "collapsible": true,
      "collapsed": true,
      "fields": [
        {
          "id": "overwrite_existing",
          "label": "Overwrite channels that already have a logo",
          "type": "boolean",
          "default": false
        },
        {
          "id": "skip_vod",
          "label": "Skip VOD channels",
          "type": "boolean",
          "default": true
        },
        {
          "id": "cache_ttl_days",
          "label": "Match cache TTL in days (0 = never expire)",
          "type": "number",
          "default": 7
        }
      ]
    },
    {
      "id": "name_normalization",
      "type": "section",
      "label": "Channel Name Normalization",
      "description": "Normalize channel names before matching against the logo repository.",
      "collapsible": true,
      "collapsed": true,
      "fields": [
        {
          "id": "normalize_channel_names",
          "label": "Normalize channel names before matching",
          "type": "boolean",
          "default": false,
          "helper_text": "Enable to clean up channel names before logo matching. Configure individual rules below."
        },
        {
          "id": "normalize_strip_unicode",
          "label": "Strip unicode special characters (², ³, ʀᴀᴡ, etc.)",
          "type": "boolean",
          "default": true,
          "helper_text": "Remove superscripts, subscripts, and small-caps unicode characters."
        },
        {
          "id": "normalize_strip_raw",
          "label": "Strip 'raw' from quality tags (HDraw → HD)",
          "type": "boolean",
          "default": true,
          "helper_text": "Remove 'raw' suffix from quality indicators like HDraw, FHDraw, UHDraw."
        },
        {
          "id": "normalize_strip_provider_info",
          "label": "Strip provider/transport terms from channel names",
          "type": "boolean",
          "default": true,
          "helper_text": "Remove provider or transport identifiers (e.g. Cable, IPTV) that are not part of the channel name. Configure the terms to strip in the field below."
        },
        {
          "id": "normalize_provider_terms",
          "label": "Provider/transport terms to strip (one per line)",
          "type": "textarea",
          "default": "Cable\nIPTV\nTerrestrial\nDVB-T\nDVB-T2\nDVB-C\nDVB-S\nDVB-S2",
          "helper_text": "Terms matched as whole words (case-insensitive) and removed from channel names. Add provider-specific terms for your setup, e.g. Sat, Kabel, Astra - but check first that they don't clash with actual channel names."
        },
        {
          "id": "normalize_strip_quality_extras",
          "label": "Strip extra quality descriptors (Low, High, etc.)",
          "type": "boolean",
          "default": true,
          "helper_text": "Remove Low/High when appended to a quality tag (e.g. HD Low → HD, UHD High → UHD)."
        },
        {
          "id": "normalize_custom_patterns",
          "label": "Custom normalization patterns (one regex per line)",
          "type": "textarea",
          "default": null,
          "helper_text": "Advanced: custom regex patterns to remove from channel names. One pattern per line, applied in order."
        }
      ]
    }
  ],
  "actions": [
    {
      "id": "health_check",
      "label": "Health Check",
      "dry_run": true,
      "fields": []
    },
    {
      "id": "enrich_logos",
      "label": "Enrich Logos",
      "dry_run": false,
      "fields": [
        {
          "id": "playlist_id",
          "label": "Playlist",
          "type": "model_select",
          "model": "App\\Models\\Playlist",
          "label_attribute": "name",
          "scope": "owned",
          "required": true
        },
        {
          "id": "overwrite_existing",
          "label": "Overwrite channels that already have a logo",
          "type": "boolean",
          "default": false
        },
        {
          "id": "skip_vod",
          "label": "Skip VOD channels",
          "type": "boolean",
          "default": true
        },
        {
          "id": "ignore_cache",
          "label": "Ignore cache (force fresh lookups)",
          "type": "boolean",
          "default": false
        }
      ]
    }
  ]
}