Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 3.52 KB

README.md

File metadata and controls

66 lines (46 loc) · 3.52 KB
Raw

Ani-Sync Jellyfin Plugin

About

Ani-Sync lets you synchorinze your Jellyfin Anime watch progress to popular services (currently MyAnimeList and AniList are supported, please create an issue if you have a different provider you would like to be supported).

While I may not commit to the plugin too often, I am still maintaining it. Please do not presume the project is dead, and if you still have any ideas for the plugin or find an errors please do let me know.

Installation

Automatic (recommended)

  1. Navigate to Settings > Admin Dashboard > Plugins > Repositories
  2. Add a new repository with a Repository URL of https://raw.githubusercontent.com/vosmiic/jellyfin-ani-sync/master/manifest.json. The name can be anything you like.
  3. Save, and navigate to Catalogue.
  4. Ani-Sync should be present. Click on it and install the latest version.

Manual

See the official Jellyfin documentation for install instructions.

  1. Download a version from the releases tab that matches your Jellyfin version.
  2. Copy the meta.json and jellyfin-ani-sync.dll files into plugins/ani-sync (see above official documentation on where to find the plugins folder).
  3. Restart your Jellyfin instance.
  4. Navigate to Plugins in Jellyfin (Settings > Admin Dashboard > Plugins).
  5. Adjust the settings accordingly. I would advise following the detailed instructions on the wiki page.

Build

  1. To build this plugin you will need .Net 6.x.

  2. Build plugin with following command

dotnet publish --configuration Release --output bin
  1. Place the dll-file in the plugins/ani-sync folder (you might need to create the folders) of your JF install

Services/providers

Currently supported

  1. MyAnimeList
  2. AniList
  3. (Beta) Kitsu

In-progress

  1. Your suggestion

External tools

Anime Lists

We use the XML documents in the anime lists repo to find the anime you are watching on each provider we support.

Please help the project by contributing to the lists of anime, it helps everyone!

Anime Offline Database/arm server

We use the API offered by the arm server repo which accesses the anime offline database repo that we use to fetch our providers IDs so we can update your progress.

Please also help these projects by contributing to the anime database/helping with the API server.

In progress

The current list of unsupported features (that are being worked on):

  1. Other providers/services. Any suggestions as to which providers the plugin should be extended to support is appreciated (click here to request a new provider).

Known issues

1. Anime with names longer than 60 characters seem to cause the plugin to crash. This is a high priority issue being actively worked on and will be out in the next update. Fixed in build 1.1

2. OVA's can throw an error that crashes Jellyfin entirely if the show is not found. A fix will be out on the next release. Fixed

Development

Unit tests can be found here.