Git Product home page Git Product logo

jellyfin-ani-sync's Introduction

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
  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
  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.

jellyfin-ani-sync's People

Contributors

andy2244 avatar hitsounds avatar macluxhd avatar pecomare avatar pythoncoderas avatar revam avatar terrails avatar tie avatar tj09 avatar vosmiic avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.