Skip to content
This repository has been archived by the owner on Sep 25, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Moved native installation steps to a separate file
  • Loading branch information
ConfusedPolarBear committed May 21, 2022
1 parent 68b6594 commit c27087f
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 22 deletions.
28 changes: 6 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

Analyzes the audio of television episodes to detect and skip over intros. Currently in alpha.

Installing this plugin (along with a modified web interface) will result in a skip intro button displaying in the video player, like this:
Installing this plugin (along with a modified web interface and `fpcalc`) will result in a skip intro button displaying in the video player, like this:

![Skip intro button](images/skip-button.png)

The custom web interface **is required** in order to display the skip intro button inside the video player.
This plugin **will not work** until both the modified web interface and `fpcalc` are installed. The easiest way to do this is to follow the steps below.

## Introduction requirements

Expand All @@ -19,34 +19,18 @@ 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

## Container installation

## Step 1: Install the modified web interface + fpcalc
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

## Plugin installation
## Step 2: Install the plugin
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

## 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

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)
3. Follow the plugin installation steps above
## Containerless installation
If you do not run Jellyfin as a container, you will need to follow the [native installation](docs/native.md) instructions.
18 changes: 18 additions & 0 deletions docs/native.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Native installation

## Requirements

* Jellyfin 10.8.0 beta 2 (beta 3 may also work, untested)
* 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

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)
3. Follow the plugin installation steps from the readme

0 comments on commit c27087f

Please sign in to comment.