DOCSEARCHbyAlgolia
Submit Docs

Shokofin

repository·dev·Indexed 43 days ago

https://github.com/shokoanime/shokofin

A Jellyfin plugin that integrates Jellyfin with Shoko Server to provide advanced anime metadata, library organization, and user data synchronization. Supports Jellyfin versions 10.10, 10.11, and 12.

Tokens
1.2K
Snippets
2
Records
6
Agent score
6%

What's inside Shokofin

  1. Install Shokofin via GitHub Releases (Manual)

    dev

    If you prefer manual installation:

    1. Download: Get the latest shoko_*.zip from the GitHub Releases page.
    2. Extract: Extract all .dll files and meta.json into a folder named Shoko.
    3. Deploy: Copy the Shoko folder into your Jellyfin plugins directory (located in your program data or install directory).
    4. Restart: Restart your Jellyfin server.

  2. Build Shokofin from source

    dev

    To build the plugin manually, you need the .NET SDK installed (version depends on your Jellyfin target).

    1. Clone the repository.
    2. Restore and Publish using the following commands:
    $ dotnet restore Shokofin/Shokofin.csproj
$ dotnet publish -c Release -f net10.0 Shokofin/Shokofin.csproj

    1. Framework Selection: Adjust the -f flag in the publish command based on your Jellyfin version:

      • Jellyfin 12: net10.0
      • Jellyfin 10.11: net9.0
      • Jellyfin 10.10: net8

    2. Deploy: Copy all .dll files from the bin/Release/ directory into a folder named Shoko, then place that folder in your Jellyfin plugins directory.

  3. Install Shokofin via Jellyfin Repository (Jellyfin 10.10)

    dev

    For Jellyfin 10.10 users:

    1. Access Plugin Repositories: Navigate to Dashboard -> Plugins -> Catalog -> ⚙ Gear icon.
    2. Add Repository:
      • Repository Name: Shokofin Stable
      • Repository URL: https://raw.githubusercontent.com/ShokoAnime/Shokofin/metadata/stable/manifest.json
    3. Install: Go to the plugins catalog and install Shoko from the Anime section.
    4. Restart: Restart your Jellyfin server.

  4. Prerequisites for Shokofin installation

    dev

    Before installing Shokofin, ensure the following requirements are met:

    1. Shoko Server is running: Shokofin is a plugin that integrates Jellyfin with an existing Shoko Server instance.
    2. Files are indexed: The media files you want to appear in Jellyfin must already be indexed (and optionally managed) by Shoko Server. If files are not indexed in Shoko, the plugin cannot provide metadata for them.

  5. Install Shokofin via Jellyfin Repository (Jellyfin 10.11)

    dev

    The recommended method for Jellyfin 10.11 users:

    1. Access Plugin Repositories: Navigate to Dashboard -> Plugins -> Manage Repositories -> New Repository.
    2. Add Repository:
      • Repository Name: Shokofin Stable
      • Repository URL: https://raw.githubusercontent.com/ShokoAnime/Shokofin/metadata/stable/manifest.json
    3. Install: Go to the plugins catalog, filter to All or Available, refresh the page, find Shoko (or filter by Anime), and install it.
    4. Restart: Restart your Jellyfin server.

  6. Shokofin version compatibility matrix

    dev

    Use the following table to ensure your versions of Shokofin, Jellyfin, and Shoko Server are compatible. Warning: Never run a stable Shokofin release with a Shoko Server development build.

    | Shokofin          | Jellyfin          | Shoko Server      |
|-------------------|-------------------|-------------------|
| `0.x.x`           | `10.7`            | `4.0.0` — `4.1.2` |
| `1.x.x`           | `10.7`            | `4.1.0` — `4.1.2` |
| `2.x.x`           | `10.8`            | `4.1.2`           |
| `3.x.x`           | `10.8`            | `4.2.0`           |
| `4.0.0` — `4.1.1` | `10.9`            | `4.2.2`           |
| `4.2.0` — `4.2.2` | `10.9`            | `4.2.2` — `5.0.0` |
| `5.0.0`           | `10.10`           | `5.0.0`           |
| `5.0.1` — `5.0.4` | `10.10`           | `5.0.0` — `5.1.0` |
| `5.0.5` — `5.0.6` | `10.11`           | `5.1.0`           |
| `6.0.0`           | `10.11`           | `5.2.0` — `5.2.5` |
| `6.0.1` — `6.0.3` | `10.10` — `10.11` | `5.2.0` — `5.3.0` |
| `6.0.4` — `6.0.5` | `10.10` — `10.11` | `5.2.0` — `5.3.3` |
| `dev`             | `10.10.7`+, `10.11.11`+, `12` | `5.3.3`, `dev` |