mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-09-09 17:16:19 -07:00
sudacode
9eecb7358b
- Clarify current integration, media review, and Anki behavior - Remove obsolete AI translation and configuration references - Standardize headings and prose across docs
54 lines
2.5 KiB
Markdown
54 lines
2.5 KiB
Markdown
# AniSkip integration
|
|
|
|
SubMiner looks up anime intro timings from [AniSkip](https://aniskip.com) so you can jump past the OP with one key.
|
|
|
|
Intro detection runs in the SubMiner app over the mpv IPC socket. It works whenever the overlay is connected to mpv, not only at launch, and covers every local file loaded during the session including playlist advances.
|
|
|
|
## Setup
|
|
|
|
AniSkip is enabled by default. Disable it or change the skip key in your config:
|
|
|
|
```jsonc
|
|
{
|
|
"mpv": {
|
|
"aniskipEnabled": true, // default: true
|
|
"aniskipButtonKey": "TAB",
|
|
},
|
|
}
|
|
```
|
|
|
|
Both settings hot-reload: changing them in your config takes effect immediately without restarting playback or mpv.
|
|
|
|
For best title and episode detection, install [`guessit`](https://github.com/guessit-io/guessit):
|
|
|
|
```bash
|
|
python3 -m pip install --user guessit
|
|
```
|
|
|
|
Without `guessit`, SubMiner falls back to its own filename parser. That handles the usual release naming, but unusual formats slip past it.
|
|
|
|
## How it works
|
|
|
|
On each local file load:
|
|
|
|
1. SubMiner infers the anime title, season, and episode number from the filename and path (using `guessit` if available, otherwise the built-in parser). Remote URLs are skipped entirely.
|
|
2. The title is matched against MyAnimeList to resolve a MAL id.
|
|
3. SubMiner queries the AniSkip API for an OP skip interval for that MAL id and episode.
|
|
4. If an interval is found, SubMiner adds `AniSkip Intro Start` and `AniSkip Intro End` chapter markers to the current file and binds the skip key (`mpv.aniskipButtonKey`, default `TAB`).
|
|
5. At the start of the intro, an OSD prompt appears for 3 seconds: `You can skip by pressing TAB` (reflects your configured key). Pressing the key at any point during the intro seeks to the intro end.
|
|
|
|
When a custom key (other than `TAB` or `y-k`) is configured, the legacy `y-k` chord is also bound as a fallback skip trigger.
|
|
|
|
Results are cached per file for the app session. Only a definitive "no intro found" is cached, so a failed lookup gets retried on the next load rather than sticking. If mpv reloads the same file, SubMiner re-applies the chapter markers without hitting the API again.
|
|
|
|
## Triggering from mpv
|
|
|
|
AniSkip actions are also reachable from mpv script-messages:
|
|
|
|
| Command | Effect |
|
|
| ------- | ------ |
|
|
| `script-message subminer-skip-intro` | Skip to the intro end immediately (same as pressing the key) |
|
|
| `script-message subminer-aniskip-refresh` | Force a fresh lookup for the current file, discarding any cached result |
|
|
|
|
The SubMiner app handles both over the IPC socket.
|