Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
@EusthEnoptEron
EusthEnoptEron committed Jul 28, 2023
1 parent 0056942 commit a43e210
Showing 1 changed file with 22 additions and 15 deletions.
37 changes: 22 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# AnimeThemes for Jellyfin

Plugin for [Jellyfin](https://jellyfin.org/) that fetches anime themes (OPs and EDs)
from [animethemes.moe](https://animethemes.moe). This supports both audio-only, video-only, and video.
from [animethemes.moe](https://animethemes.moe). Both audio files and video files are supported.

**Since the AniDB ID is used to find the matching themes, you'll need to install the AniDB plugin.**
**An AniDB ID is used to find matching themes, so you'll need to install the AniDB plugin. All other series are ignored.**

## How to use

The plugin creates a new scheduled task that you can configure. By default, it will run every 6 hours.

Also make sure to enable theme music / videos in the display settings.
Also make sure to enable theme music / videos in your display settings.

## How to install

Expand All @@ -26,14 +25,22 @@ Also make sure to enable theme music / videos in the display settings.

## Configuration

| Configuration | Default | Description |
|-----------------------------------------|---------|------------------------------------------------------------------------------------------------------------------------------|
| Degree of parallelism | 1 | How many items should be downloaded in parallel. Default is set to 1 to go easy on the servers. |
| Ignore themes that overlap with episode | true | Some shows transition into their themes. Use this setting to filter those themes out. |
| Ignore themes with credits | false | Whether to skip themes with credits in them. Useful for video downloads. |
| Ignore OP themes | false | Use this to control whether OPs are considered. |
| Ignore ED themes | false | Use this to control whether EDs are considered. |
| (Audio) Fetch type | Single | Whether to fetch no audio, *all* themes (`theme-music/{slug}.mp3`) or just one that is picked by some factors. (`theme.mp3`) |
| (Audio) Volume | 0.5 | The volume that should be used for downloaded themes. (The volume will be baked in.) |
| (Video) Fetch type | None | Whether to fetch no video, *all* themes (`backdrops/{slug}.webm`) or just one that is picked by some factors. |
| (Video) Volume | 0 | The volume for videos. 0 will result with the audio channel being removed. |
| Configuration | Description |
|------------------------------------------|-----------------------------------------------------------------------------------------------------------|
| Degree of parallelism | How many items should be downloaded in parallel. Default is set to 1 to go easy on the servers. |
| Ignore themes that overlap with episode | Some shows transition into their themes. Use this setting to filter those themes out. |
| Ignore themes with credits | Whether to skip themes with credits in them. Useful for video downloads. |
| Ignore OP themes | Use this to control whether OPs are considered. |
| Ignore ED themes | Use this to control whether EDs are considered. |
| Fetch type | Determines if you want all distinct themes, only the best match, or none at all. |
| Volume | The desired volume, which will be baked in. For videos, 0 will result in the audio channel being removed. |

## Other notes

If you want the videos to cover the whole screen, try the following CSS:

```css
body:not(.hide-scroll) > .videoPlayerContainer > video {
object-fit: cover;
}
```

0 comments on commit a43e210

Please sign in to comment.