mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-09-25 05:16:19 -07:00

Files

T

docs: rewrite docs site pages to be shorter and easier to scan

- Pages now start with setup and usage, and reference material is in compact tables
- Configuration reference gives each config block a short explanation and a key/default table
- Internal detail removed from user pages, and docs that had drifted from current behavior fixed
- The status line shows today's date, set on the client, instead of the page's last-updated date
- Add changelog fragment

2026-09-24 16:20:42 -07:00

3.7 KiB

Raw Blame History

AniList integration

SubMiner updates your AniList watch progress when you finish an episode. The same connection supplies cover art for the stats dashboard and names for the character dictionary.

Setup

Set anilist.enabled to true:

{
  "anilist": {
    "enabled": true,
  },
}

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

Reads the title, season, and episode from the file name and folder. Install guessit for better parsing. A folder named Season 2 is a strong season hint.
Finds the matching AniList entry. For season 2 and later, it follows the show's sequels.
Sets your progress to that episode and marks the entry Watching, or Completed on the final episode.

The show must already be on your Planning or Watching list. SubMiner does not add new entries, 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.

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 page. See Configuration 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." Add the show to your Planning or Watching list, 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.

3.7 KiB Raw Blame History