Trakt Scrobbler 开源项目使用教程
1. 项目的目录结构及介绍
Trakt Scrobbler 项目的目录结构如下:
trakt-scrobbler/
├── .github/
│ └── workflows/
├── trakt_scrobbler/
│ ├── __init__.py
│ ├── config.py
│ ├── logger.py
│ ├── scrobbler.py
│ ├── utils.py
│ └── monitors/
│ ├── __init__.py
│ ├── base_monitor.py
│ ├── mpc_hc_monitor.py
│ ├── mpv_monitor.py
│ ├── plex_monitor.py
│ └── vlc_monitor.py
├── tests/
│ ├── __init__.py
│ ├── test_config.py
│ ├── test_logger.py
│ ├── test_scrobbler.py
│ └── test_utils.py
├── .gitignore
├── .pre-commit-config.yaml
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
└── trakt_scrobbler.py
目录结构介绍
.github/workflows/
: GitHub Actions 的工作流配置文件。trakt_scrobbler/
: 项目的主要代码目录。__init__.py
: 初始化文件。config.py
: 配置文件处理模块。logger.py
: 日志处理模块。scrobbler.py
: 核心的 scrobbler 功能模块。utils.py
: 工具函数模块。monitors/
: 不同媒体播放器的监控模块。base_monitor.py
: 基础监控模块。mpc_hc_monitor.py
: MPC-HC 播放器监控模块。mpv_monitor.py
: MPV 播放器监控模块。plex_monitor.py
: Plex 播放器监控模块。vlc_monitor.py
: VLC 播放器监控模块。
tests/
: 测试代码目录。.gitignore
: Git 忽略文件配置。.pre-commit-config.yaml
: 预提交钩子配置。CONTRIBUTING.md
: 贡献指南。LICENSE
: 项目许可证。README.md
: 项目说明文档。requirements.txt
: 项目依赖包列表。setup.py
: 项目安装脚本。trakt_scrobbler.py
: 项目启动文件。
2. 项目的启动文件介绍
项目的启动文件是 trakt_scrobbler.py
。这个文件负责启动整个 scrobbler 服务,并根据配置文件进行初始化。
启动文件主要功能
- 读取配置文件。
- 初始化日志系统。
- 启动各个媒体播放器的监控模块。
- 处理媒体播放事件(开始、暂停、停止)并进行 scrobble 操作。
3. 项目的配置文件介绍
项目的配置文件默认是 config.ini
,位于项目根目录下。这个文件包含了所有必要的配置选项,如 API 密钥、媒体播放器监控设置等。
配置文件示例
[trakt]
api_key = your_api_key
api_secret = your_api_secret
[vlc]
enabled = true
host = localhost
port = 8080
password = your_password
[plex]
enabled = true
token = your_plex_token
[mpc-hc]
enabled = true
host = localhost
port = 13579
[mpv]
enabled = true
socket_path = /tmp/mpv-socket
配置文件说明
[trakt]
: Trakt API 的认证信息。[vlc]
: VLC 播放器的监控设置。[plex]
: Plex 播放器的监控设置。[mpc-hc]
: MPC-HC 播放器的监控设置。[mpv]
: MPV 播放器的监控设置。
通过修改这个配置文件,可以启用或禁用特定的媒体播放器监控,并设置相应的连接参数。
以上是 Trakt Scrobbler 开源