Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/varoop/shinkro

An application to sync Plex watch status to myanimelist.
https://github.com/varoop/shinkro

automation golang myanimelist myanimelist-api plex plex-webhook-scrobbler webhook

Last synced: 2 months ago
JSON representation

An application to sync Plex watch status to myanimelist.

Host: GitHub
URL: https://github.com/varoop/shinkro
Owner: varoOP
License: mit
Created: 2023-02-18T23:24:32.000Z (almost 2 years ago)
Default Branch: develop
Last Pushed: 2024-10-10T00:29:17.000Z (3 months ago)
Last Synced: 2024-10-14T09:50:56.204Z (3 months ago)
Topics: automation, golang, myanimelist, myanimelist-api, plex, plex-webhook-scrobbler, webhook
Language: Go
Homepage: https://docs.shinkro.com
Size: 1.51 MB
Stars: 40
Watchers: 4
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

shinkro

An application to sync Plex watch status to myanimelist.

## Documentation

Installation guide and documentation can be found at https://docs.shinkro.com

## Key features

- Support for multiple metadata agents, including default Plex agent, HAMA, and MyAnimeList.bundle.
- Live updates to myanimelist as soon as you watch or rate in Plex.
- Powerful anime-id mapping support, make custom maps or use the community mapping.
- Built on Go making shinkro lightweight and perfect for supporting multiple platforms (Linux, FreeBSD,
Windows, macOS) on different architectures. (e.g. x86, ARM)
- Discord Notifications.
- Base path / Subfolder (and subdomain) support for convenient reverse-proxy support.

Available methods to use shinkro

- Official Plex Webhook (Requires Plex Pass) (recommended)
- Tautulli (Limitation: cannot sync ratings)

## What is shinkro?

If you use both Plex and Myanimelist to watch and track your anime, you know how mundande and boring it is to have to update your myanimelist manually after watching an anime on your Plex server.

shinkro enables you to sync your Plex ratings and watch status for anime to myanimelist.net.

## Installation

Full installation guide and documentation can be found at https://docs.shinkro.com/installation

### Quickstart via Docker:

Before your first launch, ensure you've set these environment variables:
- SHINKRO_USERNAME
- SHINKRO_PASSWORD
- PLEX_USERNAME
- ANIME_LIBRARIES

After shinkro is initialized, configurations are primarily managed through the `config.toml` file. The environment variables above won't override the settings in this config file.

```
docker run \
--name shinkro \
-v /path/to/shinkro/config:/config \
-e TZ=US/Pacific \
-e SHINKRO_USERNAME=shinkro \
-e SHINKRO_PASSWORD=shinkro \
-e PLEX_USERNAME=shinkro \
-e ANIME_LIBRARIES=Library1,Library2,Library3 \
-p 7011:7011 \
--restart unless-stopped \
ghcr.io/varoop/shinkro:latest
```

## Custom Mapping

While shinkro maps most malids to tvdbids in it's database it only works well for season 1 of anime. Multiseason anime mapping is too complicated to automate at this point in time. For malid to tmdbids, a lot of movies are properly mapped in shinkro's database but not all of them. The ones which aren't are listed in [shinkro-mapping](https://github.com/varoOP/shinkro-mapping) ready for manual mapping.

By default, shinkro will use the community mapping hosted in the [shinkro-mapping](https://github.com/varoOP/shinkro-mapping) repository. It is encouraged for the user base to use the community mapping - if it does not contain a mapping you need, consider contributing or creating an issue.

Of course, you do have the option to specify your own custom maps. Simply place `tvdb-mal.yaml` for MAL-TVDB mappings or `tmdb-mal.yaml` for MAL-TMDB mappings in shinkro's configuration directory (where config.toml and shinkro.db files are located). shinkro will automatically detect the change and start using your custom mapping(s). The structure of both yaml files can be viewed at the [shinkro-mapping](https://github.com/varoOP/shinkro-mapping) repository.

## Community

Come join us on [Discord](https://discord.gg/ZkYdfNgbAT)!

## License