search

vosmiic / jellyfin-ani-sync

Synchronize anime watch status between Jellyfin and anime tracking sites.
GNU General Public License v3.0
268 stars 22 forks source link

readme

Ani-Sync Jellyfin Plugin

About

Ani-Sync lets you synchorinze your Jellyfin Anime watch progress to popular services. Please create a discussion for new feature ideas.

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 by creating a discussion.

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.

Docker

There is a Docker script that will pull the last built Docker image and copy the DLL file to the given directory.

docker run --rm -v "/plugin/dir/Ani-Sync:/out" ghcr.io/vosmiic/jellyfin-ani-sync

Build

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

  2. Build plugin with following command

    dotnet publish --configuration Release --output bin

  3. 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
  4. (Limited support) Annict
  5. Shikimori
  6. Simkl

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.

Development

Beta releases can be installed automatically by replacing the manifest URL with https://raw.githubusercontent.com/vosmiic/jellyfin-ani-sync/master/beta-manifest.json. This will replace your version with the latest beta release (if there is a beta release more recent than the latest stable release). It will be replaced with the latest stable release when it is released, so both repos can be used at the same time. Authentication and other settings should be carried over. Use at your own risk.

Unit tests can be found here.

The docker.sh file can be used to build and automatically copy the resulting DLL to the correct place. The first argument should be either the path to the Ani-Sync folder or the plugins folder (where it will attempt to find the latest Ani-Sync plugin folder). The second optional argument can be an image, or left empty to build using the Dockerfile.