majomi/intro-skipper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README navigation using Wiki

Browse Source
This commit is contained in:
TwistedUmbrellaX 2024-09-09 14:41:25 -04:00 committed by GitHub
parent c45b2b4428
commit 362962a8ed
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
README.md
View File

@ -34,86 +34,13 @@ Ending credits will be detected if they are shorter than 4 minutes.
These parameters can be configured by opening the plugin settings These parameters can be configured by opening the plugin settings
## Installation ## [Installation](https://github.com/jumoog/intro-skipper/wiki/Installation)
### Step 1: Install the plugin ## [Troubleshooting](https://github.com/jumoog/intro-skipper/wiki/Troubleshooting)
1. Add this plugin repository to your server: `https://raw.githubusercontent.com/jumoog/intro-skipper/master/manifest.json` - #### [Scheduled tasks fail instantly](https://github.com/jumoog/intro-skipper/wiki/Troubleshooting#scheduled-tasks-fail-instantly)
2. Install the Intro Skipper plugin from the General section
3. Restart Jellyfin
### Step 2: Configure the plugin
4. OPTIONAL: Enable automatic skipping or skip button
1. Go to Dashboard -> Plugins -> Intro Skipper
2. Check "Automatically skip intros" or "Show skip intro button" and click Save
5. Go to Dashboard -> Scheduled Tasks -> Analyze Episodes and click the play button
6. 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
## Troubleshooting - #### [Skip button is not visible](https://github.com/jumoog/intro-skipper/wiki/Troubleshooting#skip-button-is-not-visible)
#### Scheduled tasks fail instantly
- Verify that Intro Skipper can detect ffmpeg with Chromaprint
- Dashboard -> Plugins -> Intro Skipper -> Support Bundle Info
- Verify that ffmpeg is installed and detected by jellyfin
- Dashboard -> Playback -> FFmpeg path
- Verify that Chromaprint is enabled in ffmpeg (`--enable-chromaprint`)
#### Skip button is not visible ## [API Documentation](https://github.com/jumoog/intro-skipper/blob/master/docs/api.md)
- Verify you have successfully completed the scheduled task at least once
- Clear your browser cache and reload the Jellyfin server webpage
- Fix any permission mismatches between the web folder and Jellyfin server
- **Official Jellyfin Docker:** The container is being run as a non-root user while having been built as a root user, causing the web files to be owned by root. To solve this, you can remove any lines like `User: 1000:1000`, etc. from the Jellyfin Docker Compose file.
- **LinuxServer Docker Container:** Set an environment variable `DOCKER_MODS=ghcr.io/jumoog/intro-skipper` to ensure the permissions are set correctly for the skip button:
```yaml
services:
jellyfin:
image: lscr.io/linuxserver/jellyfin:latest
container_name: jellyfin
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- DOCKER_MODS=ghcr.io/jumoog/intro-skipper
```
- **Hotio Docker Container:** For the Hotio Docker Container, you can find the detailed solution to permission issues in the linked GitHub discussion: [Hotio Docker Container Issue Solution](https://github.com/jumoog/intro-skipper/issues/198#issuecomment-2169737803).
- **Ubuntu/Debian:**
Run the following command to fix the permissions on `index.html`:
```sh
sudo dpkg-statoverride --update --add jellyfin root 0644 /usr/share/jellyfin/web/index.html
```
- **Windows:** Locate `index.html` in `C:\Program Files\Jellyfin\Server\jellyfin-web` and modify the permissions for your user to Full Control. After making this change, restart Jellyfin.
* <b>Install from distro repositories -</b> the jellyfin-server will execute as `jellyfin` user while the web files will be owned by `root`, `www-data`, etc. This can <i>likely</i> be fixed by adding the `jellyfin` user (or whichever user executes the jellyfin server) to the same group that owns the jellyfin-web folders. **You should only do this if they are owned by a group other than root**.
- **If the above steps do not resolve the issue,** instructions on how to use the modified web interface can be found [here](docs/web_interface.md).
- The official Android TV app do not support the skip button. For this app, you will need to use the autoskip option. Please note that there is currently an [issue](https://github.com/jumoog/intro-skipper/issues/168) with autoskip not working because the apps never receive the seek command from Jellyfin.
## Installation (MacOS)
1. Build ffmpeg with chromaprint support using brew:
- macOS 12 or newer can install the [portable jellyfin-ffmpeg](https://github.com/jellyfin/jellyfin-ffmpeg)
```
brew uninstall --force --ignore-dependencies ffmpeg
brew install chromaprint amiaopensource/amiaos/decklinksdk
brew tap homebrew-ffmpeg/ffmpeg
brew install homebrew-ffmpeg/ffmpeg/ffmpeg --with-chromaprint
brew link --overwrite ffmpeg
```
2. Open ~/.config/jellyfin/encoding.xml and add or edit the following lines
- Replace [FFMPEG_PATH] with the path returned by `whereis ffmpeg`
```
<EncoderAppPath>[FFMPEG_PATH]</EncoderAppPath>
<EncoderAppPathDisplay>[FFMPEG_PATH]</EncoderAppPathDisplay>
```
4. Follow the [general installation instructions](#installation) above
## Documentation
Documentation about how the API works can be found in [api.md](docs/api.md). Documentation about how the API works can be found in [api.md](docs/api.md).