From c27087f6af133d6a4bed4aeb649bbb818605fa5c Mon Sep 17 00:00:00 2001 From: ConfusedPolarBear <33811686+ConfusedPolarBear@users.noreply.github.com> Date: Sat, 21 May 2022 14:47:00 -0500 Subject: [PATCH] Update README.md Moved native installation steps to a separate file --- README.md | 28 ++++++---------------------- docs/native.md | 18 ++++++++++++++++++ 2 files changed, 24 insertions(+), 22 deletions(-) create mode 100644 docs/native.md diff --git a/README.md b/README.md index 425318c..b4daf51 100644 --- a/README.md +++ b/README.md @@ -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 @@ -19,13 +19,12 @@ 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 @@ -33,20 +32,5 @@ Show introductions will only be detected if they are: 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. diff --git a/docs/native.md b/docs/native.md new file mode 100644 index 0000000..ae09f4b --- /dev/null +++ b/docs/native.md @@ -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