Skip to content

Configuration

InfinityPacer edited this page May 2, 2024 · 3 revisions

配置选项 config.ini

以下是 config.ini 中可用的选项列表。

位置

./config/config.ini

示例

./setup/config.ini.sample

复制并重命名样本到根文件夹,或者在首次启动时将创建默认配置

Plex.tv

键 类型 默认值 描述
username str Plex.tv 用户名
password str Plex.tv 密码(如果包含令牌则无需指定)
token str Plex.tv 令牌(如果包含密码则无需指定)
servername str Plex 服务器名称

如果你的 Plex.tv 账户使用了双因素认证,留空密码并使用令牌进行认证

服务器

仅在不使用 Plex.tv 凭证时需要设置,可能仍然需要令牌,取决于您的安全配置

键 类型 默认值 描述
address str 服务器地址,无前缀协议的 URL 或 IP 地址
ssl bool True 使用 SSL
port int 32400 Plex 服务器端口

安全

键 类型 默认值 描述
ignore-certs bool False 选项来忽略 SSL 认证,仅应用于测试

跳过

键 类型 默认值 描述
mode str skip 模式选项包括 skip 和 volume。Skip 会跳转到标记范围的末尾,volume 会在支持音量调整的播放器上调整标记范围的音量(通过 Plex setVolume api 命令支持相当有限)
tags csv intro, commercial, advertisement, credits 要跳过的标记/章节标签,除非您正在自定义视频文件的章节,否则保持默认。您可以添加前缀 c: 或 m: 来分别只应用于章节或标记
types csv movie, episode 要监控的媒体类型
ignored-libraries csv 应忽略的库,指定库名不区分大小写
last-chapter float 0.0 跳过媒体文件的最后一章(通常是片尾)的选项。0.0 禁用此功能。有效范围 0.0 - 1.0 是播放中最后一章必须落在的百分比。0.9 是确保最后一章在播放结束时的一个好起点
unwatched bool True 未观看内容自动跳过
first-episode-series custom Watched 在系列的第一集自动跳过,即 S01E01 见下方自定义选项
first-episode-season custom Always 在季节的第一集自动跳过,即 S**E01 见下方自定义选项
first-safe-tags csv 不会受到 first-episode-series 和 first-episode-season 选项影响(将被跳过)的标签。例如,在这些场景中,您仍然可以跳过片尾,同时允许片头播放,只需将“credits”添加到此选项中
last-episode-series custom Watched 在系列的最后一集自动跳过 见下方自定义选项
last-episode-season custom Always 在季节的最后一集自动跳过 见下方自定义选项
last-safe-tags csv 不会受到 last-episode-series 和 last-episode-season 选项影响(将被跳过)的标签。例如,在这些场景中,您仍然可以跳过片尾,同时允许片头播放,只需将“credits”添加到此选项中
next bool False 如果媒体已经结束或跳过目标是媒体的结尾,跳过到下一个项目以避免“接下来播放”的界面

有效的自定义值

  • Never - 永不自动跳过任何内容
  • Watched - 仅在剧集被标记为'已观看/已播放'时自动跳过
  • Always - 不论剧集的'已观看/已播放'状态如何,始终自动跳过

偏移量

可调偏移量以校准自动跳过功能

键 类型 默认值 描述
start int 2000 偏移开始时间(毫秒)。播放时“跳过开场”按钮出现后,将在此时间后自动跳过
end int 1000 偏移结束时间(毫秒)。自动跳过将提前到标记结束后加上此时间
command int 500 在执行跳过下一功能时,发送命令之间的暂停时间(毫秒)。大多数客户端需要一些延迟以便用户界面赶上
tags csv intro 应用偏移的标记标签,仅适用于标记,因此不要在此使用前缀。Plex似乎不需要像对开场那样对结尾字幕应用偏移

Binge

当你开始连续观看内容时,允许某些标签在最初几集避免自动跳过,然后恢复自动跳过。连续观看会话仅限于特定用户和播放器组合,并可选择特定的节目。不适用于非'剧集'内容。

键 类型 默认值 描述
ignore-skip-for int 0 在连续观看开始时忽略跳过标签的剧集数量,0 禁用此功能
safe-tags csv 即使在连续观看开始时也会被跳过的标签列表
same-show-only bool False 仅当剧集来自同一节目时应用连续观看
skip-next-max int 0 如果启用此功能,使用连续观看监控设置触发跳过下一条的最大数量,0 表示直到内容用尽

音量

用于 volume 模式设置

键 类型 默认值 描述
low int 0 低音量范围 0-100
high int 100 高音量范围 0-100

custom.json 的配置选项

以下是 custom.json 中可用的选项列表。这里可以看到一个通用用例示例。如果您希望保持您的自定义定义组织,您可以包含多个 custom.json 文件,config 文件夹中以 *.json 结尾的任何文件都将被扫描。

如果您希望将您的 custom.json 文件转换为 ratingKey 与 GUID 格式,您可以运行 custom_audit.py -g 转换为 GUID 和 custom_audit.py -rk 转换为 ratingKey。custom_audit.py 还包含额外的功能,使用 custom_audit.py --help 查看可用选项。

https://github.com/InfinityPacer/PlexAutoSkip/wiki/Sample-custom.json

位置

./config/custom.json

示例

./setup/custom.json.sample

标记 dict

在哪里找到内容标识符

将您的

主要键设置为内容的内容标识符(可以使用 GUID、ratingKey、parentRatingKey 或 grandparentRatingKey),后跟一个包含以下两个参数的字典数组

标记 dict

键 类型 描述
start int 跳过的开始时间(毫秒)。可以设置为负值,相对于媒体结束时跳过
end int 跳过的结束时间(毫秒)(将寻找到的位置)。可以为负值,相对于媒体结束时跳过,或 0 跳到结束
cascade bool 可选布尔值,声明此标记是否应在找到更好/更精确的匹配时级联。例如,您可以为整个节目定义一个标记,但如果找到个别剧集的标记,则选择让其被覆盖
mode str 可选值,指定模式,skip 或 volume 用于自定义标记,否则将默认为全局设置

ratingKey 示例

    "markers": {
        "234": [
            {
                "start": 20000,
                "end": 40000,
                "cascade": false,
                "mode": "volume"
            },
            {
                "start": -20000,
                "end": 0,
                "cascade": false,
                "mode": "skip"
            }
        ],
        "12345": []
    }

GUID 示例

    "markers": {
        "tmdb://32726": [
            {
                "start": 20000,
                "end": 40000,
                "cascade": false,
                "mode": "volume"
            },
            {
                "start": -20000,
                "end": 0,
                "cascade": false,
                "mode": "skip"
            }
        ],
        "tmdb://32726.4.21": []
    }

偏移量 dict

在哪里找到内容标识符

将您的主要键设置为内容的内容标识符(同样可以使用 GUID、ratingKey、parentRatingKey 或 grandparentRatingKey),后跟一个包含以下两个参数的字典。更具体的键将优先(例如,针对剧集的个别自定义参数将覆盖整个节目的自定义参数)

偏移量 dict

键 类型 描述
start int 自定义偏移开始时间(毫秒)。自动跳过将在“跳过片头”按钮出现后这段时间进行
end int 自定义偏移结束时间(毫秒)。自动跳过将跳到标记结束后再加上这段时间
command int 在跳过下一功能期间发送命令之间的自定义命令延迟。默认 500ms,可以根据每个播放器调整。使用播放器名称或 machineIdentifier 作为键

ratingKey 示例

    "offsets": {
        "234": {
            "start": 3000,
            "end": 20000
        }
    }

GUID 示例

    "offsets": {
        "tmdb://32726": {
            "start": 3000,
            "end": 20000
        }
    }

标签 dict

在哪里找到内容标识符

将您的主要键设置为内容的内容标识符(同样可以使用 GUID、ratingKey、parentRatingKey 或 grandparentRatingKey),后跟一个标记/章节跳过的标签数组。将覆盖 config.ini 中指定的tags,适用于指定媒体

ratingKey 示例

    "tags": {
        "234": ["intro", "outro"]
    }

GUID 示例

    "tags": {
        "tmdb://32726": ["intro", "outro"]


    }

允许 dict

在哪里找到内容标识符

留空所有选项以允许所有。设置任何允许参数将阻止所有未在列表中的内容/用户

键 类型 描述
users array 允许使用自动跳过功能的 plex.tv 用户名列表
clients array 允许使用自动跳过功能的客户端名称列表(区分大小写)
keys array 允许使用自动跳过功能的内容标识符列表,您可以包括 GUID、ratingKey、parentRatingKeys 允许一个季节,或 grandparentRatingKeys 允许整个节目
skip-next array 允许使用跳过下一功能的客户端名称列表(区分大小写)

阻止 dict

在哪里找到内容标识符

键 类型 描述
users array 阻止使用自动跳过功能的 plex.tv 用户名列表
clients array 阻止使用自动跳过功能的客户端名称列表(区分大小写)
keys array 阻止使用自动跳过功能的内容标识符列表,您可以包括 GUID、ratingKey、parentRatingKeys 阻止一个季节,或 grandparentRatingKeys 阻止整个节目
skip-next array 阻止使用跳过下一功能的客户端名称列表(区分大小写)

客户端 dict

通常您不需要覆盖客户端 IP 地址/端口,除非您在使用基于 GDM 发现的查找和回退方法也失败时遇到错误(脚本将尝试在 GDM 失败时动态回退到基于 IP 的查找);这是在此错误检测或端口由于某些原因被重新映射的边缘情况

键 值 描述
客户端名称 str 客户端地址 url 客户端名称和自定义地址的键值对。地址示例为 http://192.168.0.10:32500

示例

    "clients": {
        "SHIELD": "http://10.0.1.51:32500"
    }

模式 dict

为不同内容设置自定义模式,skip 或 volume

键 值 描述
ratingKey/GUID/名称 str 模式 str 键值对和期望的模式。键可以是 ratingKey(或 parent/grandparent)、GUID 或客户端名称,以覆盖全局模式设置为 skip 或 volume

示例

    "mode": {
        "tmdb://32726": "skip",
        "234": "volume",
        "SHIELD": "volume"
    }

Clone this wiki locally