intro-skipper/README.md

47 lines
2.1 KiB
Markdown
Raw Normal View History

2022-06-09 14:07:40 -05:00
# Intro Skipper (beta)
2022-05-18 15:45:25 -05:00
<div align="center">
<p>
<img alt="Plugin Banner" src="https://raw.githubusercontent.com/jumoog/intro-skipper/master/images/logo.png" />
</p>
<p>
Analyzes the audio of television episodes to detect and skip over intros.
</p>
2022-05-18 15:45:25 -05:00
</div>
2022-06-22 18:52:47 -05:00
## System requirements
2022-10-01 18:13:28 -05:00
* Jellyfin 10.8.4 (or newer)
* Jellyfin's [fork](https://github.com/jellyfin/jellyfin-ffmpeg) of `ffmpeg` must be installed, version `5.0.1-5` or newer
* `jellyfin/jellyfin` 10.8.z container: preinstalled
* `linuxserver/jellyfin` 10.8.z container: preinstalled
* Debian Linux based native installs: provided by the `jellyfin-ffmpeg5` package
2023-05-27 22:21:33 -05:00
* MacOS native installs: build ffmpeg with chromaprint support ([instructions](#installation-instructions-for-macos))
2022-06-10 22:52:44 -05:00
## Detection parameters
2019-02-21 00:36:01 -08:00
2024-03-04 08:20:46 -05:00
Show introductions will be detected if they are:
2022-05-10 18:24:16 -05:00
2024-03-04 08:20:46 -05:00
* Located within the first 25% of an episode or the first 10 minutes, whichever is smaller
2022-09-03 01:28:35 -05:00
* Between 15 seconds and 2 minutes long
2022-07-08 00:57:12 -05:00
2024-03-04 08:20:46 -05:00
Ending credits will be detected if they are shorter than 4 minutes.
2022-10-31 01:00:39 -05:00
These parameters can be configured by opening the plugin settings
2020-03-09 21:17:32 +01:00
`https://raw.githubusercontent.com/jumoog/intro-skipper/10.8/manifest.json`
2024-09-10 16:44:01 -04:00
## [Installation](https://github.com/jumoog/intro-skipper/wiki/Installation)
- #### [Install the plugin](https://github.com/jumoog/intro-skipper/wiki/Installation#step-1-install-the-plugin)
- #### [Configure the plugin](https://github.com/jumoog/intro-skipper/wiki/Installation#step-2-configure-the-plugin)
- #### [Custom FFMPEG (MacOS)](https://github.com/jumoog/intro-skipper/wiki/Custom-FFMPEG-(MacOS))
2022-10-01 18:13:28 -05:00
2024-09-10 16:44:01 -04:00
## [Troubleshooting](https://github.com/jumoog/intro-skipper/wiki/Troubleshooting)
- #### [Scheduled tasks fail instantly](https://github.com/jumoog/intro-skipper/wiki/Troubleshooting#scheduled-tasks-fail-instantly)
2022-05-10 16:09:27 -05:00
2024-09-10 16:44:01 -04:00
- #### [Skip button is not visible](https://github.com/jumoog/intro-skipper/wiki/Troubleshooting#skip-button-is-not-visible)
2024-09-10 16:44:01 -04:00
## [API Documentation](https://github.com/jumoog/intro-skipper/blob/master/docs/api.md)
2022-06-13 16:16:15 -05:00
Documentation about how the API works can be found in [api.md](docs/api.md).
2024-09-10 16:44:01 -04:00