intro-skipper/README.md

49 lines
2.3 KiB
Markdown
Raw Normal View History

2022-05-10 03:10:37 -05:00
# Intro Skipper (ALPHA)
2020-01-21 13:03:21 +09:00
2022-05-10 03:10:37 -05:00
Analyzes the audio of television episodes to detect and skip over intros. Currently in alpha.
2019-02-21 00:36:01 -08:00
2022-05-10 18:53:05 -05:00
Installing this plugin (along with a modified web interface) will result in a skip intro button displaying in the video player, like this:
2022-05-18 02:00:42 -05:00
![Skip intro button](images/skip-button.png)
2022-05-10 18:53:05 -05:00
2022-05-10 18:24:16 -05:00
The custom web interface **is required** in order to display the skip intro button inside the video player.
2022-05-10 03:10:37 -05:00
## Introduction requirements
2019-02-21 00:36:01 -08:00
2022-05-10 18:24:16 -05:00
Show introductions will only be detected if they are:
* Located within the first 25% of an episode, or the first 10 minutes, whichever is smaller
* At least 20 seconds long
2020-03-09 21:17:32 +01:00
2022-05-10 18:24:16 -05:00
## Container installation
2019-02-21 00:36:01 -08:00
2022-05-10 18:24:16 -05:00
1. Run the `ghcr.io/confusedpolarbear/jellyfin-intro-skipper` container just as you would any other Jellyfin container
1. If you reuse the configuration data from another container, **make sure to create a backup first**.
2. Follow the plugin installation steps below
2022-05-10 16:09:27 -05:00
2022-05-10 18:24:16 -05:00
## Plugin installation
1. Add this plugin repository to your server: `https://raw.githubusercontent.com/ConfusedPolarBear/intro-skipper/master/manifest.json`
2. Install the Intro Skipper plugin from the General section
3. Restart Jellyfin
4. Go to Dashboard -> Scheduled Tasks -> Analyze Episodes and click the play button
5. After a season has completed analyzing, play some episodes from it and observe the results
1. Status updates are logged before analyzing each season of a show
2022-05-10 16:09:27 -05:00
2022-05-10 18:24:16 -05:00
## Native installation
### Requirements
* Jellyfin 10.8.0 beta 2 (or later)
* Compiled [jellyfin-web](https://github.com/ConfusedPolarBear/jellyfin-web/tree/intros) interface with intro skip button
* [chromaprint](https://github.com/acoustid/chromaprint) (only versions 1.4.3 and later have been verified to work)
### Instructions
2019-02-21 00:36:01 -08:00
2022-05-10 03:10:37 -05:00
1. Install the `fpcalc` program
1. On Debian based distributions, this is provided by the `libchromaprint-tools` package
2. Compiled binaries can also be downloaded from the [GitHub repository](https://github.com/acoustid/chromaprint/releases/tag/v1.5.1)
2. Download the latest modified web interface from the releases tab and either:
1. Serve the web interface directly from your Jellyfin server, or
2. Serve the web interface using an external web server
3. The corresponding source code can be found in this [fork](https://github.com/ConfusedPolarBear/jellyfin-web/tree/intros)
2022-05-10 18:24:16 -05:00
3. Follow the plugin installation steps above