/desktop-skipper-for-plex

桌面端 Plex 自动跳过片头尾工具 - Automatic Intro and Credits Skipping Tool for Plex Desktop

Primary LanguagePythonMIT LicenseMIT

Desktop Skipper for Plex

Switch to English

Plex 在 2023 年 10 月为部分播放端增加了自动跳过片头、自动跳过片尾及自定义播放下一个倒计时时长等功能，遗憾的是桌面端的 Plex for Windows/Mac 至今依然没有增加这些功能，你依然需要手动点击跳过按钮，并且需要等待 10 秒的倒计时才会自动播放下一个项目。

由于 Plex for Windows/Mac 的远程控制功能在很久之前就被移除了，所以我们也无法通过 API 或其他方式来远程控制这些播放器。我没有找到任何支持 Plex for Windows 或 Plex for Mac 的自动化工具，于是自己编写了这个脚本。

当你在 Plex for Windows/Mac 上观看视频时，使用 Desktop Skipper for Plex（下文简称 DSP）可以通过模拟键盘操作的方式，在播放进度到达片头标记（若存在）、片尾标记（若存在）或播放下一个倒计时后，通过模拟按下 回车 或 空格 键来实现自动跳过片头、自动跳过片尾和自动播放下一个（支持自定义播放下一个倒计时时长）功能。

运行说明

  • DSP 仅对指定服务器上的视频播放生效。
  • DSP 仅对运行 DSP 的设备上的视频播放生效。
  • DSP 仅在 Plex for Windows/Mac 窗口处于活动状态时生效（包括全屏状态）。
  • DSP 仅对 Plex for Windows/Mac 生效。

配置说明

在使用 DSP 前，请先参考以下提示（示例）对 /config/config.ini 进行配置。

[server]
# Plex 服务器的地址，格式为 http://服务器 IP 地址:32400 或 http(s)://域名:端口号
address = http://127.0.0.1:32400
# Plex 服务器的 token，用于身份验证
token = xxxxxxxxxxxxxxxxxxxx
# 语言设置，zh 代表中文，en 代表英文
language = zh

[preferences]
# 是否自动跳过片头，true 代表是，false 代表否
skip_intro = true
# 是否自动跳过片尾，true 代表是，false 代表否
skip_credits = true
# 是否自动播放下一个项目，true 代表是，false 代表否
auto_play = true
# 设置播放下一个倒计时的时长，范围为 1 到 8 秒，支持小数
countdown_seconds = 1.5
# 设置 DSP 对哪些用户的播放生效，格式为用户名1；用户名2；用户名3，如果希望 DSP 对所有用户生效，可以留空
users = 用户甲；用户乙；用户丙

DSP 在连接到你的服务器后，会实时监控服务器上的所有播放活动，并筛选出 Plex for Windows/Mac 上的播放活动，然后跟踪这些播放。当播放进度到达片头、片尾标记时（若存在），会模拟键盘按下 回车 键来实现自动跳过标记；当视频播放结束后，会根据你设置的倒计时时长，等待对应的秒数后模拟键盘按下 空格 键来实现自动播放下一个项目。

由于网络连接情况的差异，模拟按键的操作在某些情况下可能发生延迟。目前没有找到更好的方案来判断播放是否来自本机，若希望 DSP 工作的更加精准，建议在 preferences 里设置本机 Plex for Windows/Mac 的常用用户（在 users 处填写常用用户的用户名），这样，就只有这些常用用户的播放活动会被监控，DSP 将仅对这些指定的用户生效。

自动跳过片头、自动跳过片尾和自动播放下一个功能默认都是开启的，如果你不需要其中的某个功能，在配置文件中将对应的参数设置为 false 即可（重启脚本后生效）。要完全禁用自动播放下一个功能还需要你在 Plex 内取消勾选 开启自动播放。

运行条件

  • 安装了 Python 3.6 或更高版本。
  • 使用命令 pip3 install -r requirements.txt 安装了必要的第三方库。

使用方法

  1. 通过 Releases 下载最新版本的压缩包并解压到本地目录中。
  2. 用记事本或文本编辑打开目录中的 /config/config.ini 文件，填写你的 Plex 服务器地址（address）和 X-Plex-Token（token），按照需要选填其他配置选项。
  3. 双击 dsp.bat (Win) 或 dsp.command (Mac) 即可启动 DSP。
  4. DSP 将在启动后持续监控服务器上的所有播放活动，并在满足条件时通过模拟键盘按键的方式实现自动跳过片头、自动跳过片尾和自动播放下一个功能。同时也会在控制台显示对应播放活动的信息和处理结果。

自动运行

为了便于使用，你也可以通过 Launchd 服务或其他任务工具，将 DSP 设置为开机启动任务，实现开机自动运行。Mac 用户可参考以下步骤进行设置：

  1. 用文本编辑打开 dsp.plist 文件，把 /path/to/dsp.command 替换为脚本的实际路径，保存更改并关闭文件。
  2. 把 dsp.plist 文件移动到 ~/Library/LaunchAgents 目录下。
  3. 打开终端，输入命令 chmod 644 ~/Library/LaunchAgents/dsp.plist && launchctl load ~/Library/LaunchAgents/dsp.plist 按 回车。

这样我们就将 DSP 设置为了 Mac 的开机启动任务，脚本会在后台自动运行。若要取消开机启动任务（并退出 DSP），在终端输入命令 launchctl unload ~/Library/LaunchAgents/dsp.plist 按 回车 即可；使用命令 launchctl load ~/Library/LaunchAgents/dsp.plist 可以重新将 DSP 设置为开机启动任务（并启动 DSP）。

若设置为开机启动任务后脚本运行失败，你可能需要将 command 脚本中的 python3 替换为 python3 的实际路径。你可以在 Mac 终端内通过命令 which python3 找到 python3 的实际路径。

注意事项

  • 请确保你提供了正确的 Plex 服务器地址和正确的 X-Plex-Token。
  • 请确保你提供了正确的用户名，并按要求进行了填写。
  • 如果无法连接到 Plex 服务器，请检查你的网络连接，并确保服务器可以访问。
  • 修改配置文件后，需要重启脚本，新的配置信息才会生效。
  • 在同一次播放中，每个标记只会被自动跳过一次。
  • 自动跳过片头和自动跳过片尾功能仅在项目存在标记时生效。
  • Windows 用户运行脚本后，若没有任何反应，请将启动脚本中的 python3 替换为 python 再运行。

赞赏

如果你觉得这个项目对你有用，可以请我喝杯咖啡。如果你喜欢这个项目，可以给我一个⭐️。谢谢你的支持！

赞赏

回到顶部


Desktop Skipper for Plex

切换至中文

In October 2023, Plex added features such as automatic intro skipping, automatic credits skipping, and customizable auto play countdown time to some of its playback clients. Unfortunately, Plex for Windows/Mac still lacks these features. You still need to manually click the skip button and wait for the 10-second countdown to auto-play the next item.

Since the remote control (Advertise as Player) feature for Plex for Windows/Mac was removed a long time ago, we cannot remotely control these players via API or other means. I couldn’t find any automation tool supporting Plex for Windows or Plex for Mac, so I wrote this script myself.

When watching videos on Plex for Windows/Mac, you can use Desktop Skipper for Plex (hereinafter referred to as DSP) to simulate keyboard actions. When the playback reaches the intro marker (if present), the credits marker (if present), or the auto play countdown, DSP simulates pressing the Enter or Space key to automatically skip the intro, skip the credits, and auto-play the next item (with customizable auto play countdown times).

Instructions

  • DSP only works for video playback on the specified server.
  • DSP only works for video playback on the device running DSP.
  • DSP only works when the Plex for Windows/Mac window is active (including fullscreen mode).
  • DSP only works for Plex for Windows/Mac.

Configuration

Before using DSP, please configure the /config/config.ini file according to the following tips (example).

[server]
# Address of the Plex server, formatted as http://server IP address:32400 or http(s)://domain:port
address = http://127.0.0.1:32400
# Token of the Plex server for authentication
token = xxxxxxxxxxxxxxxxxxxx
# Language setting, zh for Chinese, en for English
language = en

[preferences]
# Automatically skip intro, true for yes, false for no
skip_intro = true
# Automatically skip credits, true for yes, false for no
skip_credits = true
# Automatically play the next item, true for yes, false for no
auto_play = true
# Set the duration of the auto play countdown time, range from 1 to 8 seconds, supports decimals
countdown_seconds = 1.5
# Set which users’ playback DSP applies to, format as Username1;Username2;Username3. Leave blank to apply to all users
users = UserA;UserB;UserC

After connecting to your server, DSP will monitor all playback sessions on the server in real-time and filter out playback sessions on Plex for Windows/Mac. When the playback reaches the intro or credits markers (if present), DSP simulates pressing the Enter key to skip the markers. After the video ends, DSP waits for the set countdown duration and simulates pressing the Space key to auto-play the next item.

Due to differences in network conditions, simulated keystrokes might be delayed in some cases. Currently, there is no better way to determine if playback originates from the local machine. To make DSP more accurate, it is recommended to set the usual users of Plex for Windows/Mac in the preferences section (fill in the usual usernames under users). This way, only playback sessions of these specified users will be monitored, and DSP will only apply to these users.

The features to automatically skip intro, skip credits, and play the next item are enabled by default. If you don't need any of these features, you can set the corresponding parameter to false in the configuration file (this change will take effect after restarting the script). To completely disable the auto-play next feature, you also need to uncheck AUTO PLAY ON in Plex.

Requirements

  • Python 3.6 or higher installed.
  • Necessary third-party libraries installed using the command pip3 install -r requirements.txt.

Usage

  1. Download the latest release package from Releases and extract it to a local directory.
  2. Open the /config/config.ini file in the directory with a text editor, fill in your Plex server address (address) and X-Plex-Token (token), and fill in other configuration options as needed.
  3. Double-click dsp.bat (Win) or dsp.command (Mac) to start DSP.
  4. Once started, DSP will continuously monitor all playback sessions on the server and simulate keystrokes to auto-skip intros, auto-skip credits, and auto-play the next item when conditions are met. Corresponding playback session information and results will also be displayed in the console.

Auto-Run Setup

For convenience, you can set DSP to run automatically at startup by using the Launchd service or other task tools. Mac users can follow these steps:

  1. Open the dsp.plist file with a text editor, replace /path/to/dsp.command with the actual path to your script, save the changes, and close the file.
  2. Move the dsp.plist file to the ~/Library/LaunchAgents directory.
  3. Open the terminal and enter the command chmod 644 ~/Library/LaunchAgents/dsp.plist && launchctl load ~/Library/LaunchAgents/dsp.plist, then press Enter.

This sets DSP as a startup task on your Mac, and the script will run automatically in the background. To cancel the startup task (and exit DSP), enter the command launchctl unload ~/Library/LaunchAgents/dsp.plist in the terminal and press Enter. To set DSP as a startup task again (and start DSP), use the command launchctl load ~/Library/LaunchAgents/dsp.plist.

If the script fails to run after being set as a startup task, you may need to replace python3 in the command script with the actual path of python3. You can find the actual path of python3 in the Mac terminal by using the command which python3.

Notes

  • Ensure you provide the correct Plex server address and the correct X-Plex-Token.
  • Ensure you provide the correct usernames and fill them in as required.
  • If you cannot connect to the Plex server, check your network connection and ensure the server is accessible.
  • After modifying the configuration file, restart the script for the new settings to take effect.
  • During the same playback session, each marker will only be skipped automatically once.
  • The automatic intro skipping and automatic credits skipping functions only take effect when there are markers present in the item.
  • If Windows users see no response after running the script, try replacing python3 with python in the startup script.

Support

If you found this helpful, consider buying me a coffee or giving it a ⭐️. Thanks for your support!

Support

Back to Top