mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-11-10 04:46:07 -08:00
e59b78dca0
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Ivan Melck <ivan@spec-kitty.ai>
69 lines
4.1 KiB
Markdown
69 lines
4.1 KiB
Markdown
# AniList integration
|
|
|
|
SubMiner updates your [AniList](https://anilist.co) watch progress when you finish an episode. The same connection supplies cover art for the stats dashboard and names for the [character dictionary](/character-dictionary).
|
|
|
|
## Setup
|
|
|
|
1. Set `anilist.enabled` to `true`:
|
|
|
|
```jsonc
|
|
{
|
|
"anilist": {
|
|
"enabled": true,
|
|
},
|
|
}
|
|
```
|
|
|
|
2. Restart SubMiner. With no token stored, it opens the AniList setup window. You can also open it from the tray (**Configure AniList**) or with `subminer app --anilist-setup`.
|
|
3. Approve access on the AniList page. SubMiner receives the token through a `subminer://` link and stores it encrypted.
|
|
|
|
If the setup window does not render, SubMiner opens the authorization page in your browser instead. To skip the flow entirely, paste a token into `anilist.accessToken`.
|
|
|
|
On Linux, the token is stored with `gnome-libsecret` by default. If your keyring is unavailable, start it (gnome-keyring or KWallet) or launch SubMiner with `--password-store=basic_text`.
|
|
|
|
## How updates work
|
|
|
|
An episode counts as watched after 85% of its length and at least 10 minutes of playback. SubMiner then:
|
|
|
|
1. Reads the title, season, and episode from the file name and folder. Install [guessit](https://github.com/guessit-io/guessit) for better parsing. A folder named `Season 2` is a strong season hint.
|
|
2. Finds the matching AniList entry. For season 2 and later, it follows the show's sequels.
|
|
3. Sets your progress to that episode and marks the entry Watching, or Completed on the final episode.
|
|
|
|
If the show is not on your list yet, SubMiner adds it as Watching, but only when the file title exactly matches an AniList title or you pinned the entry with the character dictionary's AniList override. For a looser match, add the show to Planning or Watching yourself. SubMiner never changes entries marked Completed, Paused, Dropped, or Rewatching, and it never lowers your progress.
|
|
|
|
Failed updates are saved and retried in the background, up to 8 times with growing delays. The queue survives restarts.
|
|
|
|
## Fixing a wrong match
|
|
|
|
If a cover or title in the stats Library is wrong, open the title and use **Change AniList Entry**.
|
|
|
|
If SubMiner cannot find a later season, it skips the update rather than writing progress to season 1. Pin the right entry with the character dictionary's AniList override. See [Character dictionary](/character-dictionary).
|
|
|
|
## Commands
|
|
|
|
| Command | What it does |
|
|
| ------------------------------------ | --------------------------------------- |
|
|
| `subminer app --anilist-setup` | Open the AniList setup window |
|
|
| `subminer app --anilist-status` | Show token state and retry queue counts |
|
|
| `subminer app --anilist-logout` | Remove the stored token |
|
|
| `subminer app --anilist-retry-queue` | Retry one queued update now |
|
|
|
|
## Options
|
|
|
|
| Key | What it does |
|
|
| --------------------- | ------------------------------------------------------------- |
|
|
| `anilist.enabled` | Turns on progress updates. |
|
|
| `anilist.accessToken` | Token override. Leave empty to use the token stored by setup. |
|
|
|
|
Character dictionary settings live under `anilist.characterDictionary` and are covered on the [Character dictionary](/character-dictionary) page. See [Configuration](/configuration#anilist) for defaults.
|
|
|
|
## Troubleshooting
|
|
|
|
**No update after an episode.** Check that `anilist.enabled` is `true` and that you watched at least 85% of the episode.
|
|
|
|
**"AniList update not possible."** The show is marked Completed, Paused, Dropped, or Rewatching, or it is not on your list and the title match was not exact. Add the show to your Planning or Watching list, or pin it with the character dictionary's AniList override, then mark the episode watched again.
|
|
|
|
**Wrong show or episode.** Install guessit and make sure it is on your `PATH`. Unusual file names parse poorly without it.
|
|
|
|
**Token errors.** Run `subminer app --anilist-status`. If the token is invalid, run `--anilist-logout`, then `--anilist-setup`.
|