diff --git a/docs-site/README.md b/docs-site/README.md index 16d10ef4..687452cb 100644 --- a/docs-site/README.md +++ b/docs-site/README.md @@ -1,4 +1,4 @@ -# SubMiner Docs +# SubMiner docs In-repo VitePress documentation source for SubMiner. diff --git a/docs-site/anilist-integration.md b/docs-site/anilist-integration.md index 4852f46c..a5a490b2 100644 --- a/docs-site/anilist-integration.md +++ b/docs-site/anilist-integration.md @@ -1,10 +1,10 @@ -# AniList Integration +# AniList integration -SubMiner can sync your watch progress to [AniList](https://anilist.co) automatically. When you finish an episode, SubMiner detects the title and episode number from the filename, finds the matching AniList entry, and updates your progress via the GraphQL API. Failed updates are retried with exponential backoff in the background. +SubMiner syncs your watch progress to [AniList](https://anilist.co). Finish an episode and it reads the title and episode number off the filename, finds the matching AniList entry, and updates your progress through the GraphQL API. A failed update retries in the background with exponential backoff. -AniList data also powers two additional features: [cover art](#cover-art) for the stats dashboard and the [Character Dictionary](/character-dictionary) for in-overlay name lookup. +The same AniList data feeds [cover art](#cover-art) in the stats dashboard and the [Character Dictionary](/character-dictionary) for in-overlay name lookup. -[AniList](https://anilist.co) is a free website for tracking which anime you have watched. An **access token** is a private key SubMiner stores so it can update your list on your behalf - you approve it once during setup, and you never paste a password into SubMiner. +[AniList](https://anilist.co) is a free anime tracking site. The **access token** is a private key SubMiner keeps so it can update your list for you. You approve it once during setup, and your AniList password never touches SubMiner. ## Setup @@ -32,18 +32,18 @@ If the embedded auth UI fails to render, SubMiner opens the authorize URL in you You can also set `anilist.accessToken` directly in config to skip the setup flow entirely. When blank, SubMiner uses the locally stored encrypted token. ::: -## How Tracking Works +## How tracking works -SubMiner monitors playback and triggers an AniList progress update when an episode is considered "watched" -- at least 85% of the episode duration viewed and a minimum of 10 minutes watched. +SubMiner watches playback and pushes an AniList progress update once an episode counts as watched. That means at least 85% of its duration, and at least 10 minutes either way. The update flow: -1. **Title detection** -- SubMiner extracts the anime title, season, and episode number from the media filename and path. Season folders such as `Season 2` are treated as a strong season signal. SubMiner tries [`guessit`](https://github.com/guessit-io/guessit) first for accurate parsing, then falls back to an internal filename parser if guessit is unavailable. -2. **AniList search** -- The base title (with any `Season N` / `SN` marker stripped) is searched against the AniList GraphQL API, and SubMiner picks the best match by comparing titles (romaji, English, native, synonyms) and filtering by episode count. AniList has no notion of numbered seasons -- sequels are separate entries with their own titles (`Zoku`, `Kan`, `2nd Season`), so searching ` Season 3` finds nothing. For season 2 and later, SubMiner instead walks `SEQUEL` relations from the season 1 entry, preferring the TV line, and falls back to ordering the franchise's TV entries by air date when the relation chain is incomplete. If neither locates the season, SubMiner **skips the update** rather than writing progress to the season 1 entry, and tells you to pin the right entry with a [character dictionary override](/character-dictionary#correcting-anilist-matches). -3. **Progress check** -- SubMiner fetches your current list entry for the matched media. The media must already be in Planning or Watching; otherwise SubMiner shows an MPV message explaining that the update is not possible. If your recorded progress already meets or exceeds the detected episode, the update is skipped. -4. **Mutation** -- A `SaveMediaListEntry` mutation sets the new progress and marks the entry as `CURRENT`, or `COMPLETED` when the watched episode is the final episode of the season (the "already at this progress" skip is bypassed for the final episode so completion still lands). +1. **Title detection** - SubMiner extracts the anime title, season, and episode number from the media filename and path. Season folders such as `Season 2` are treated as a strong season signal. SubMiner tries [`guessit`](https://github.com/guessit-io/guessit) first for accurate parsing, then falls back to an internal filename parser if guessit is unavailable. +2. **AniList search** - The base title (with any `Season N` / `SN` marker stripped) is searched against the AniList GraphQL API, and SubMiner picks the best match by comparing titles (romaji, English, native, synonyms) and filtering by episode count. AniList has no notion of numbered seasons - sequels are separate entries with their own titles (`Zoku`, `Kan`, `2nd Season`), so searching `<title> Season 3` finds nothing. For season 2 and later, SubMiner instead walks `SEQUEL` relations from the season 1 entry, preferring the TV line, and falls back to ordering the franchise's TV entries by air date when the relation chain is incomplete. If neither locates the season, SubMiner **skips the update** rather than writing progress to the season 1 entry, and tells you to pin the right entry with a [character dictionary override](/character-dictionary#correcting-anilist-matches). +3. **Progress check** - SubMiner fetches your current list entry for the matched media. The media must already be in Planning or Watching; otherwise SubMiner shows an MPV message explaining that the update is not possible. If your recorded progress already meets or exceeds the detected episode, the update is skipped. +4. **Mutation** - A `SaveMediaListEntry` mutation sets the new progress and marks the entry as `CURRENT`, or `COMPLETED` when the watched episode is the final episode of the season (the "already at this progress" skip is bypassed for the final episode so completion still lands). -## Update Queue and Retry +## Update queue and retry Failed AniList updates are persisted to a retry queue on disk and retried with exponential backoff. @@ -58,7 +58,7 @@ After 8 failed attempts, the update is moved to a dead-letter queue and no longe Use `--anilist-retry-queue` to manually process one ready item from the queue. -## Cover Art +## Cover art SubMiner fetches cover art from AniList for display in the stats dashboard. When a new video starts playing, the cover art fetcher: @@ -71,11 +71,11 @@ A no-match result is cached for 5 minutes before SubMiner retries, preventing re If the automatic match is wrong, use **Change AniList Entry** on a title in the stats Library. Relinking rewrites the cached art for every episode of that title, and both the detail view and the Library grid pick up the new cover right away: the grid refetches after a relink, and cover responses carry an ETag and are revalidated on each request instead of being cached for a day. -## Rate Limiting +## Rate limiting All AniList API calls go through a shared rate limiter that enforces a sliding window of 20 requests per minute. The limiter also reads AniList's `X-RateLimit-Remaining` and `Retry-After` response headers and pauses requests when the server signals throttling. This applies to both episode tracking and cover art fetching. -## Configuration Reference +## Configuration reference ```jsonc { @@ -107,7 +107,7 @@ All AniList API calls go through a shared rate limiter that enforces a sliding w There is no `characterDictionary.enabled` key: character dictionary sync is enabled by `subtitleStyle.nameMatchEnabled`. See the [Character Dictionary](/character-dictionary) page for full details on the character dictionary feature, including name generation, matching, auto-sync lifecycle, and dictionary entry format. -## CLI Commands +## CLI commands | Command | Description | | ----------------------- | ------------------------------------------------------------- | @@ -124,10 +124,10 @@ There is no `characterDictionary.enabled` key: character dictionary sync is enab - **Token issues:** Run `--anilist-status` to check token state. If the token is invalid or expired, run `--anilist-setup` or `--anilist-logout` and re-authenticate. - **Updates failing repeatedly:** Run `--anilist-status` to see retry queue counters. Items that fail 8 times are moved to the dead-letter queue. Check network connectivity and AniList API status. - **Cover art missing:** Cover art is fetched on a best-effort basis using title matching. If the filename is hard to parse, the search may return no results. The fetcher retries after 5 minutes. -- **Encryption unavailable on Linux:** If you see warnings about safeStorage, try `--password-store=basic_text` as a workaround, or ensure your desktop keyring (gnome-keyring, KWallet) is running. +- **Encryption unavailable on Linux:** If you see warnings about safeStorage, try `--password-store=basic_text` as a workaround, or start your desktop keyring (gnome-keyring, KWallet). ## Related -- [Character Dictionary](/character-dictionary) -- AniList-powered character name dictionary for Yomitan -- [Configuration Reference](/configuration) -- full config options -- [Jellyfin Integration](/jellyfin-integration) -- media server integration +- [Character Dictionary](/character-dictionary) - AniList-powered character name dictionary for Yomitan +- [Configuration Reference](/configuration) - full config options +- [Jellyfin Integration](/jellyfin-integration) - media server integration diff --git a/docs-site/aniskip-integration.md b/docs-site/aniskip-integration.md index fc9bc230..ee5ff5dd 100644 --- a/docs-site/aniskip-integration.md +++ b/docs-site/aniskip-integration.md @@ -1,8 +1,8 @@ -# AniSkip Integration +# AniSkip integration -SubMiner integrates with [AniSkip](https://aniskip.com) to automatically detect anime intro intervals and let you skip them with a single key press. +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 is available whenever the overlay is connected to mpv - not just at launch - and covers every local file loaded during an mpv session, including playlist advances. +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 @@ -25,9 +25,9 @@ For best title and episode detection, install [`guessit`](https://github.com/gue python3 -m pip install --user guessit ``` -Without `guessit`, SubMiner falls back to an internal filename parser which handles most common naming conventions but may miss unusual formats. +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 +## How it works On each local file load: @@ -39,15 +39,15 @@ On each local file load: 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 definitive "no intro found" results are cached, so transient lookup failures are retried on the next file load. Reload detection is also handled: if mpv reloads the same file, SubMiner re-applies the chapter markers without a new API lookup. +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 -You can trigger AniSkip actions from mpv script-messages: +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 | -These are handled by the SubMiner app over the IPC socket. +The SubMiner app handles both over the IPC socket. diff --git a/docs-site/anki-integration.md b/docs-site/anki-integration.md index 9c0a4acf..3a0814c3 100644 --- a/docs-site/anki-integration.md +++ b/docs-site/anki-integration.md @@ -1,4 +1,4 @@ -# Anki Integration +# Anki integration SubMiner uses the [AnkiConnect](https://ankiweb.net/shared/info/2055492159) add-on to create and update Anki cards with sentence context, audio, and screenshots. This project is built primarily for [Kiku](https://kiku.youyoumu.my.id/) and [Lapis](https://github.com/donkuri/lapis) note types, including sentence-card and field-grouping behavior. @@ -19,28 +19,27 @@ This project is built primarily for [Kiku](https://kiku.youyoumu.my.id/) and [La AnkiConnect listens on `http://127.0.0.1:8765` by default. If you changed the port in AnkiConnect's settings, update `ankiConnect.url` in your SubMiner config. -## Auto-Enrichment Transport +## Auto-enrichment transport -When you add a word via Yomitan, SubMiner detects the new card and fills in the sentence, audio, image, and translation fields automatically. Two detection methods are available: +When you add a word via Yomitan, SubMiner detects the new card and fills in the sentence, audio, and image fields automatically. Two detection methods are available: -**Proxy mode** (default) - SubMiner runs a local _proxy_: a small middleman server that sits between Yomitan and Anki. Yomitan sends new cards to SubMiner, SubMiner enriches them, then passes them along to Anki. This makes enrichment instant. +**Proxy mode** (default) - SubMiner runs a small local server between Yomitan and Anki. Yomitan sends the new card to SubMiner, SubMiner fills in the media fields, and the finished card goes on to Anki. There is no polling delay. -**Polling mode** (fallback, when the proxy is disabled) - SubMiner asks AnkiConnect every few seconds whether any new cards were added, then enriches them. Simpler setup, but with a short delay (~3 seconds). +**Polling mode** (fallback, when the proxy is disabled) - SubMiner asks AnkiConnect every few seconds whether new cards showed up, then fills them in. Less to configure, at the cost of roughly a 3 second delay. -Use proxy mode if you want immediate enrichment. Use polling mode if your Yomitan instance is external (browser-based) or you prefer minimal configuration. +Use proxy mode unless your Yomitan runs in a browser rather than the bundled instance, in which case polling is the simpler path. In both modes, the enrichment workflow is the same: 1. Checks if a duplicate expression already exists (for field grouping). 2. Updates the sentence field with the current subtitle. 3. Generates and uploads audio and image media. -4. Fills the translation field from the secondary subtitle or AI. -5. Writes metadata to the miscInfo field. +4. Writes metadata to the miscInfo field. Polling mode uses the query `"deck:<ankiConnect.deck>" added:1` to find recently added cards. If no deck is configured, it searches all decks (`added:1`). In Settings, the AnkiConnect deck dropdown auto-fills and persists Yomitan's current mining deck when available, then falls back to the decks reported by AnkiConnect; stats-dashboard mining also falls back to Yomitan's mining deck when `ankiConnect.deck` is empty. Known-word sync scope is controlled by `ankiConnect.knownWords.decks`. -### Proxy Mode Setup (Yomitan / Texthooker) +### Proxy mode setup (Yomitan / texthooker) ```jsonc "ankiConnect": { @@ -83,7 +82,7 @@ In Yomitan, go to Settings → Profile and: This is only for non-bundled, external/browser Yomitan or other clients. The bundled profile auto-update logic only targets the active profile when its server is blank or still default. -### Proxy Troubleshooting (quick checks) +### Proxy troubleshooting (quick checks) If auto-enrichment appears to do nothing: @@ -107,7 +106,7 @@ curl -sS http://127.0.0.1:8766 \ - Launcher log: `launcher-YYYY-MM-DD.log` - mpv log: `mpv-YYYY-MM-DD.log` -4. Ensure config JSONC is valid and logging shape is correct: +4. Check that the config JSONC parses and the logging shape is right: ```jsonc "logging": { @@ -117,30 +116,31 @@ curl -sS http://127.0.0.1:8766 \ `"logging": "debug"` is invalid for current schema and can break reload/start behavior. -## Field Mapping +## Field mapping SubMiner maps its data to your Anki note fields. Configure these under `ankiConnect.fields`: ```jsonc "ankiConnect": { "fields": { - "word": "Expression", // mined word / expression text - "audio": "ExpressionAudio", // audio clip from the video - "image": "Picture", // screenshot or animated clip - "sentence": "Sentence", // subtitle text - "miscInfo": "MiscInfo", // metadata (filename, timestamp) - "translation": "SelectionText" // secondary sub or AI translation + "word": "Expression", // mined word / expression text + "audio": "SentenceAudio", // sentence audio clip cut from the video + "image": "Picture", // screenshot or animated clip + "sentence": "Sentence", // subtitle text + "miscInfo": "MiscInfo" // metadata (filename, timestamp) } } ``` +`fields.audio` receives the **sentence** audio SubMiner cuts from the video, not word audio. Yomitan writes its own dictionary audio when you mine, so point this at a separate field such as `SentenceAudio` to keep the two apart. The built-in default is still `ExpressionAudio`, which collides with Yomitan on note types that use that field for word audio. + Field names are matched against your Anki note type case-insensitively (an exact match wins, then a lowercase comparison). If a configured field does not exist on the note type, SubMiner skips it without error. These mappings always control normal word-card enrichment, including Yomitan proxy/polling updates and manual clipboard updates. Enabling Lapis or Kiku does not replace the configured word-card sentence and audio fields with `Sentence` and `SentenceAudio`. The dedicated sentence-card and audio-card shortcuts still use those Lapis/Kiku field names. Two related options live alongside `fields`: `ankiConnect.deck` (target deck; empty falls back as described above) and `ankiConnect.tags` (tags added to mined cards, default `["SubMiner"]`; set `[]` to disable tagging). The `miscInfo` content is controlled by `ankiConnect.metadata.pattern` (default `[SubMiner] %f (%t)`; tokens: `%f` filename, `%F` filename with extension, `%t` timestamp, `%T` timestamp with milliseconds, `<br>` newline). -### Minimal Config +### Minimal config If you only want sentence and audio on your cards: @@ -149,14 +149,14 @@ If you only want sentence and audio on your cards: "enabled": true, "fields": { "sentence": "Sentence", - "audio": "ExpressionAudio" + "audio": "SentenceAudio" } } ``` -## Media Generation +## Media generation -SubMiner uses FFmpeg to generate audio and image media from the video. FFmpeg must be installed and on `PATH`. +SubMiner shells out to FFmpeg for audio clips and screenshots, so FFmpeg has to be installed and on `PATH`. For remote streams such as Jellyfin playback, SubMiner downloads the clip's time window once into a temporary Matroska file (a stream copy, no re-encoding) and reads the timing review waveform, audio preview, audio, and image from that file instead of fetching the stream again for each step. The window covers the clip plus padding, plus the visible timeline in timing review, and grows when you reveal more of the timeline. It is deleted when a different window replaces it, after ten minutes without use, or when SubMiner exits. If the download fails, media generation reads the remote stream directly as before. @@ -183,13 +183,27 @@ Output format: MP3 at 44100 Hz. If the video has multiple audio streams, SubMine The audio is uploaded to Anki's media folder and inserted as `[sound:audio_<timestamp>.mp3]`. -Set `media.reviewTiming` to `true` to pause playback and review each word, sentence, or audio card before its media is generated. The review opens with the subtitle range plus configured audio padding. Subtitles usually linger past the dialogue, so once the waveform loads an untouched clip end moves back to just after the line's last speech (plus the configured padding); the Line end rail keeps marking the subtitle timing, Reset restores it, and a line whose speech runs through its end is left alone. Drag either edge of the clip to trim it, drag the middle to slide it without changing its length, or press anywhere else on the waveform to snap the nearer edge there. A focused edge also moves with the arrow keys, by 100 ms alone or 500 ms with Shift, and the 100 ms buttons do the same. Space previews the selection with a playhead that sweeps the clip; the preview ends when the hidden player has actually played the last sample, so output latency such as Bluetooth headphones does not cut the clip short. Enter confirms, and Escape cancels. The Earlier and Later buttons reveal another two seconds of available timeline without moving the selected clip. A speech-weighted waveform shows the mined subtitle as a tinted band with labeled line-start and line-end rails, making adjacent dialogue easier to distinguish. SubMiner uses a center channel when one carries dialogue, then falls back to a mono mix, keeps only the 250 to 3500 Hz speech band, and draws each slice's loudness relative to the clip's own noise floor, so steady background music or ambience reads as a flat line while dialogue stands out. Waveform analysis failure leaves the timing controls available. The confirmed range is exact: SubMiner does not apply audio padding a second time. Static screenshots use its midpoint, and animated AVIF clips use the full confirmed range. +Set `media.reviewTiming` to `true` to pause playback and check the clip before its media is generated. It applies to word, sentence, and audio cards. -The review can also pull adjacent subtitle lines onto the card. Press `P` or `N` (or use the Prev and Next steppers above the sentence preview) to add the previous or next line, as many times as lines are available; Shift+`P` and Shift+`N` remove them again. The sentence preview lists every included line with the mined line highlighted, so the card's sentence field is always visible before you confirm, and the clip start or end, along with the line-start and line-end rails on the waveform, follows the outermost added line, keeping the review's audio padding. Confirming writes the combined lines to the sentence field; the Reset button drops the added lines along with any timing changes. Adjacent lines come from the parsed subtitle track when one is loaded; otherwise only lines that already played are offered, and a clip capped by `media.maxMediaDuration` keeps the full combined sentence even when the audio cannot cover every added line. +The review opens on the subtitle range plus your configured audio padding. Subtitles usually hang around after the dialogue has stopped, so once the waveform loads, an untouched clip end pulls back to just after the last speech in the line. The Line end rail still marks the original subtitle timing, Reset puts it back, and a line whose speech runs right through its end is left alone. -Canceling the review lets you keep editing, finish with the original timing, keep or create the card without audio or an image, or discard the card. Discard deletes an existing Yomitan or audio card and skips creation for a direct sentence card. Clipboard updates and stats-dashboard mining do not open timing review. Audio preview failure does not block confirmation or card creation. The option is disabled by default and hot-reloads. You can also toggle **Review Media Timing** for the current session from the runtime options palette (`Ctrl/Cmd+Shift+O`). +**Adjusting the clip.** Drag either edge to trim, drag the middle to slide the whole clip without changing its length, or click anywhere on the waveform to snap the nearer edge there. A focused edge also moves with the arrow keys: 100 ms per press, or 500 ms with Shift. The 100 ms buttons do the same thing. Earlier and Later each reveal two more seconds of timeline without moving the selection. -### Screenshots (Static) +**Keys.** Space previews the selection with a playhead sweeping the clip. The preview ends when the hidden player has actually played the last sample, so Bluetooth output latency does not clip the tail. Enter confirms and Escape cancels. + +**The waveform.** SubMiner reads a center channel when one carries dialogue and falls back to a mono mix otherwise, keeps only the 250 to 3500 Hz speech band, and draws each slice's loudness against the clip's own noise floor. Steady background music flattens out and dialogue stands up, which makes it much easier to tell adjacent lines apart. The mined subtitle appears as a tinted band with labeled line-start and line-end rails. If waveform analysis fails, the timing controls still work. + +The range you confirm is used exactly as-is; SubMiner does not add audio padding a second time. Static screenshots take its midpoint, and animated AVIF clips cover the whole range. + +**Pulling in adjacent lines.** Press `P` or `N`, or use the Prev and Next steppers above the sentence preview, to add the previous or next subtitle line. Repeat for as many lines as exist. Shift+`P` and Shift+`N` remove them again. The sentence preview lists every included line with the mined one highlighted, so you always see the sentence field before confirming. The clip bounds and the waveform rails follow the outermost added line, keeping the review's audio padding. + +Confirming writes the combined lines to the sentence field. Reset drops the added lines along with any timing changes. Adjacent lines come from the parsed subtitle track when one is loaded; otherwise you only get lines that already played. A clip capped by `media.maxMediaDuration` still keeps the full combined sentence even when the audio cannot stretch to cover every added line. + +**Canceling.** You can go back to editing, finish with the original timing, create the card without audio or an image, or discard it. Discard deletes an existing Yomitan or audio card, and skips creation entirely for a direct sentence card. A failed audio preview does not block confirmation or card creation. + +Clipboard updates and stats-dashboard mining never open timing review. The option is off by default and hot-reloads. **Review Media Timing** in the runtime options palette (`Ctrl/Cmd+Shift+O`) toggles it for the current session. + +### Screenshots (static) A single frame is captured at the current playback position. @@ -206,9 +220,9 @@ A single frame is captured at the current playback position. } ``` -### Animated Clips (AVIF) +### Animated clips (AVIF) -Instead of a static screenshot, SubMiner can generate an animated AVIF covering the subtitle duration. +SubMiner can produce an animated AVIF spanning the subtitle duration instead of a still frame. ```jsonc "ankiConnect": { @@ -225,7 +239,7 @@ Instead of a static screenshot, SubMiner can generate an animated AVIF covering Animated AVIF requires an AV1 encoder (`libaom-av1`, `libsvtav1`, or `librav1e`) in your FFmpeg build. Generation timeout is 60 seconds. `media.syncAnimatedImageToWordAudio` (default `true`) prepends a frozen first frame matching the existing word-audio duration, so the motion starts together with the sentence audio. -### Behavior Options +### Behavior options ```jsonc "ankiConnect": { @@ -246,40 +260,7 @@ When media is available, mined-card overlay and system notifications include the `overwriteAudio` applies to automatic card updates and duplicate-card enrichment. Manual clipboard subtitle updates (`Ctrl/Cmd+C`, then `Ctrl/Cmd+V`) always replace generated sentence audio in `ankiConnect.fields.audio`, even when `overwriteAudio` is disabled. -## AI Translation - -SubMiner can auto-translate the mined sentence and fill the translation field. -Secondary subtitle text still wins when present. AI translation is only attempted when `ankiConnect.ai.enabled` is `true` and no secondary subtitle exists. - -```jsonc -"ai": { - "enabled": true, - "apiKey": "sk-...", - "apiKeyCommand": "", - "baseUrl": "https://openrouter.ai/api", - "requestTimeoutMs": 15000 -}, -"ankiConnect": { - "ai": { - "enabled": true, - "model": "openai/gpt-4o-mini", - "systemPrompt": "Translate mined sentence text only." - } -} -``` - -`ankiConnect.ai` controls feature-local enablement plus optional `model` / `systemPrompt` overrides. -Provider credentials and request transport settings live in top-level `ai`. - -Translation priority: - -1. If a secondary subtitle is available, use it as the translation. -2. If `ankiConnect.ai.enabled` is `true` and top-level `ai.enabled` is `true`, call the shared AI provider. -3. If AI translation fails and no secondary subtitle exists, fall back to the original sentence text. - -The built-in translation request asks for English output by default. Customize that behavior through `ankiConnect.ai.systemPrompt`. - -## Sentence Cards (Lapis) +## Sentence cards (Lapis) SubMiner can create standalone sentence cards (without a word/expression) using a separate note type. This is designed for use with [Lapis](https://github.com/donkuri/Lapis) and similar sentence-focused note types. @@ -302,7 +283,7 @@ The dedicated sentence-card and audio-card shortcuts use the Lapis/Kiku-compatib To mine multiple subtitle lines as one sentence card, use `Ctrl/Cmd+Shift+S` followed by a digit (1–9) to select how many recent lines to combine. -## Word Card Type (Kiku/Lapis) +## Word card type (Kiku/Lapis) Word cards get a card-type flag when SubMiner fills their sentence, whether that comes from Yomitan auto-enrichment, a manual clipboard update, or stats-dashboard word mining. By default the flag is `IsWordAndSentenceCard`; pick a different one with `ankiConnect.lapisKiku.wordCardKind`. @@ -317,7 +298,7 @@ Word cards get a card-type flag when SubMiner fills their sentence, whether that `click` marks `IsClickCard`, `sentence` marks `IsSentenceCard`, `audio` marks `IsAudioCard`, and `none` leaves the flags untouched for templates that manage them elsewhere. Whichever flag is chosen, the other card-type flags are cleared so the note never claims two card types. The setting is only read when `isKiku` or `isLapis` is enabled, and cards mined with Mine Sentence or Mine Audio keep their own flag. -## Field Grouping (Kiku/Senren) +## Field grouping (Kiku/Senren) When you mine the same word multiple times, SubMiner can merge the cards instead of creating duplicates. This is designed for note types that support grouped fields: [Kiku](https://github.com/youyoumu/kiku) and [Senren](https://github.com/BrenoAqua/Senren) (which calls the feature scene switching). @@ -351,7 +332,7 @@ For Senren note types, enable `isSenren` instead. Kiku and Senren write incompat **Manual** (`"manual"`): A modal appears in the overlay showing both cards. You choose which card to keep, preview the merge result, then confirm. The modal has a 90-second timeout, after which it cancels automatically. -### What Gets Merged +### What gets merged | Field | Merge behavior | | -------- | ----------------------------------------------- | @@ -364,7 +345,7 @@ Identical values from both cards are kept as separate grouped entries; the merge The merge markup depends on the note type. Kiku entries are wrapped in `<span data-group-id="...">` spans ordered newest first. Senren entries follow the [scene switching](https://github.com/BrenoAqua/Senren/blob/main/docs/scene_switching.md) format: sentence, sentenceFurigana, and miscInfo entries use `group` spans when ordinal order is sufficient and numbered `groupN` spans when they need an absolute scene target. Audio and pictures are appended positionally, and the number of sentenceAudio entries drives Senren's scene count. Ungrouped legacy content is wrapped into a group span on first merge, and source `groupN` spans are rebased after the kept note's existing audio scenes. -### Keyboard Shortcuts in the Modal +### Keyboard shortcuts in the modal | Key | Action | | ----------- | ---------------------------------- | @@ -373,7 +354,7 @@ The merge markup depends on the note type. Kiku entries are wrapped in `<span da | `Backspace` | Go back from the merge preview | | `Esc` | Cancel (keep both cards unchanged) | -## Full Config Example +## Full config example ```jsonc { @@ -391,11 +372,10 @@ The merge markup depends on the note type. Kiku entries are wrapped in `<span da }, "fields": { "word": "Expression", - "audio": "ExpressionAudio", + "audio": "SentenceAudio", "image": "Picture", "sentence": "Sentence", "miscInfo": "MiscInfo", - "translation": "SelectionText", }, "media": { "generateAudio": true, @@ -418,11 +398,6 @@ The merge markup depends on the note type. Kiku entries are wrapped in `<span da "metadata": { "pattern": "[SubMiner] %f (%t)", }, - "ai": { - "enabled": false, - "model": "", // e.g. "openai/gpt-4o-mini" - "systemPrompt": "", - }, "isKiku": { "enabled": false, "fieldGrouping": "disabled", @@ -433,12 +408,5 @@ The merge markup depends on the note type. Kiku entries are wrapped in `<span da "sentenceCardModel": "Lapis", }, }, - "ai": { - "enabled": false, - "apiKey": "", - "apiKeyCommand": "", - "baseUrl": "https://openrouter.ai/api", - "requestTimeoutMs": 15000, - }, } ``` diff --git a/docs-site/architecture.md b/docs-site/architecture.md index a88ad7bf..0aa87cc3 100644 --- a/docs-site/architecture.md +++ b/docs-site/architecture.md @@ -20,7 +20,7 @@ Within the desktop app, `src/main.ts` is a composition root that wires small run - services compose through explicit inputs/outputs - orchestration is separate from implementation -## Project Structure +## Project structure ```text launcher/ # Standalone CLI launcher wrapper and mpv helpers @@ -33,7 +33,6 @@ plugin/ # state · messages · hover · ui · options · environment · log # binary · session_bindings · version) src/ - ai/ # AI translation provider utilities (client, config) main-entry.ts # Background-mode bootstrap wrapper before loading main.js main.ts # Entry point - delegates to runtime composers/domain modules preload.ts # Electron preload bridge @@ -86,7 +85,7 @@ src/ anki-integration/ # AnkiConnect proxy server + note-update enrichment workflow ``` -### Service Layer (`src/core/services/`) +### Service layer (`src/core/services/`) - **Overlay/window runtime:** `overlay-manager.ts`, `overlay-window.ts`, `overlay-visibility.ts`, `overlay-bridge.ts`, `overlay-runtime-init.ts`, `overlay-content-measurement.ts` - **Shortcuts/input:** `shortcut.ts`, `overlay-shortcut.ts`, `overlay-shortcut-handler.ts`, `shortcut-fallback.ts`, `numeric-shortcut.ts` @@ -98,7 +97,7 @@ src/ - **Config/runtime controls:** `config-hot-reload.ts`, `runtime-options-ipc.ts`, `cli-command.ts`, `startup.ts` - **Domain submodules:** `anilist/*` (token/update queue/updater), `immersion-tracker/*` (storage/session/metadata/query/reducer) -### Renderer Layer (`src/renderer/`) +### Renderer layer (`src/renderer/`) The renderer keeps `renderer.ts` focused on orchestration. UI behavior is delegated to per-concern modules. @@ -136,12 +135,12 @@ src/renderer/ platform.ts # Layer/platform capability detection ``` -### Launcher + Plugin Runtimes +### Launcher + plugin runtimes - `launcher/main.ts` dispatches commands through `launcher/commands/*` and shared config readers in `launcher/config/*`. It handles mpv startup, app passthrough, Jellyfin helper commands, and playback handoff. - `plugin/subminer/main.lua` is the mpv entrypoint: it sets up the module path and loads `init.lua`, a thin shim that boots the modular Lua files: `bootstrap.lua` (startup), `lifecycle.lua` (connect/disconnect), `process.lua` (process management), `state.lua` (shared state), `messages.lua` (IPC), `hover.lua` (hover-token highlight rendering), `ui.lua` (OSD rendering), `options.lua` (config), `environment.lua` (detection), `log.lua` (logging), `binary.lua` (path resolution), `session_bindings.lua` (configurable session keybindings), `version.lua` (version metadata). AniSkip intro detection lives in the SubMiner app (`src/main/runtime/aniskip-runtime.ts`), which drives mpv chapters and the skip key over the IPC socket. -## Flow Diagram +## Flow diagram The main process orchestrates a single primary overlay window plus modal surfaces: `main.ts` delegates to composition modules that wire together domain services. Subtitle layers (primary + secondary bar) are rendered in the same overlay renderer process, connected through `preload.ts`. External runtimes (launcher CLI and mpv plugin) operate independently and communicate via IPC socket or CLI passthrough. @@ -224,7 +223,7 @@ flowchart TB style ExtRt fill:#363a4f,stroke:#494d64,color:#cad3f5 ``` -## Composition Pattern +## Composition pattern Most runtime code follows a dependency-injection pattern: @@ -261,14 +260,14 @@ Additional conventions in the current code: - Domain barrels in `src/main/runtime/domains/*` re-export runtime handlers + main-deps builders, while composers in `src/main/runtime/composers/*` assemble larger runtime clusters. - Many runtime handlers accept `*MainDeps` objects generated by `createBuild*MainDepsHandler` builders to isolate side effects and keep units testable. -### IPC Contract + Validation Boundary +### IPC contract + validation boundary - Central channel constants live in `src/shared/ipc/contracts.ts` and are consumed by both main (`ipcMain`) and renderer preload (`ipcRenderer`) wiring. - Runtime payload parsers/type guards live in `src/shared/ipc/validators.ts`. - Rule: renderer-supplied payloads must be validated at IPC entry points (`src/core/services/ipc.ts`, `src/core/services/anki-jimaku-ipc.ts`) before calling domain handlers. - Malformed invoke payloads return explicit structured errors (for example `{ ok: false, error: ... }`) and malformed fire-and-forget payloads are ignored safely. -### Runtime State Ownership (Migrated Domains) +### Runtime state ownership (migrated domains) For domains migrated to reducer-style transitions (for example AniList token/queue/media-guess runtime state), follow these rules: @@ -278,7 +277,7 @@ For domains migrated to reducer-style transitions (for example AniList token/que - Reducer boundary: when a domain has transition helpers in `src/main/state.ts`, new callsites should route updates through those helpers instead of ad-hoc object mutation in `main.ts` or composers. - Tests for migrated domains should assert both the intended field changes and non-targeted field invariants. -## Playback Startup Flow +## Playback startup flow Before the app boots, something has to launch mpv, inject the plugin, and bring the overlay up. SubMiner-managed launches own this step - the `subminer` launcher, the app's own playback, and the packaged Windows shortcut all follow the same path. The launcher reads `config.jsonc`, spawns mpv with the IPC socket and the bundled plugin, and passes runtime settings as `--script-opts`. The plugin never reads a config file: the shipped `subminer.conf` is intentionally empty so command-line opts always win. @@ -315,7 +314,7 @@ flowchart TB The runtime sockets in this flow are detailed in [IPC + Runtime Contracts](./ipc-contracts#runtime-sockets). -## Program Lifecycle +## Program lifecycle - **Module-level init:** Before `app.ready`, the composition root registers protocols, sets platform flags, constructs all services, and wires dependency injection. `runAndApplyStartupState()` parses CLI args and detects the compositor backend. - **Startup:** If `--generate-config` is passed, it writes the template and exits. Otherwise `app-lifecycle.ts` acquires the single-instance lock and registers Electron lifecycle hooks. @@ -387,7 +386,7 @@ flowchart TB style Loop fill:#363a4f,stroke:#494d64,color:#cad3f5 ``` -## Subtitle Prefetch Pipeline +## Subtitle prefetch pipeline SubMiner can pre-tokenize upcoming subtitle lines before they appear on screen. When an external subtitle file (SRT, VTT, or ASS) is detected on the active track, the `SubtitlePrefetchService` parses all cues via the subtitle cue parser (`subtitle-cue-parser.ts`), identifies a priority window of upcoming lines based on the current playback position, and tokenizes them in the background through the same pipeline used for live subtitles. Results are stored directly into the `SubtitleProcessingController` cache, so when a subtitle actually appears during playback, it hits a warm cache and renders in ~30-50ms instead of ~200-320ms. @@ -417,7 +416,7 @@ flowchart TB style Render stroke-width:2px ``` -## Why This Design +## Why this design - **Smaller blast radius:** changing one feature usually touches one service. - **Better testability:** most behavior can be tested without Electron windows/mpv. @@ -428,7 +427,7 @@ flowchart TB - **Split MPV service layers:** MPV internals are separated into transport (`mpv-transport.ts`), protocol (`mpv-protocol.ts`), and properties/render metrics modules for maintainability. - **Config by domain:** defaults, option registries, and resolution are split by domain under `src/config/definitions/*` and `src/config/resolve/*`, keeping config evolution localized. -## Extension Rules +## Extension rules - Add behavior to an existing service in `src/core/services/*` or create a focused runtime module under `src/main/runtime/*`; avoid ad-hoc logic in `main.ts`. - Add new cross-process channels in `src/shared/ipc/contracts.ts` first, validate payloads in `src/shared/ipc/validators.ts`, then wire handlers in IPC runtime modules. diff --git a/docs-site/character-dictionary.md b/docs-site/character-dictionary.md index c6eca7ea..55b01bf0 100644 --- a/docs-site/character-dictionary.md +++ b/docs-site/character-dictionary.md @@ -1,12 +1,12 @@ -# Character Dictionary +# Character dictionary -SubMiner can build a Yomitan-compatible character dictionary from [AniList](https://anilist.co) metadata so that character names in subtitles are recognized, highlighted, and enrichable with context - portraits, roles, voice actors, and biographical detail - without leaving the overlay. (AniList is an online anime/manga database; SubMiner pulls each show's character list from it.) +SubMiner builds a Yomitan-compatible dictionary of a show's characters from [AniList](https://anilist.co), the online anime and manga database. Once it is loaded, character names in subtitles get recognized and highlighted, and hovering one shows the portrait, role, voice actor, and biography without leaving the overlay. -This is helpful because proper names rarely appear in normal dictionaries, so character names would otherwise be flagged as "unknown" words and clutter your mining. Recognizing them keeps your N+1 highlighting focused on real vocabulary. +Proper names rarely appear in ordinary dictionaries, so without this every character name reads as an unknown word. That wrecks N+1 highlighting, since a line naming two characters looks like a line with two unknowns. Recognizing them keeps the highlighting pointed at real vocabulary. The dictionary is generated per-media, merged across your recently-watched titles, and auto-imported into Yomitan. When a character name appears in a subtitle line, it gets highlighted and becomes available for hover-driven Yomitan profile lookup. -## How It Works +## How it works The feature has three stages: **snapshot**, **merge**, and **match**. @@ -16,12 +16,12 @@ The feature has three stages: **snapshot**, **merge**, and **match**. 3. **Match** - During subtitle rendering, Yomitan scans subtitle text against all loaded dictionaries including the character dictionary. SubMiner only accepts character entries for the current AniList media when that media ID is known, then flags matching tokens with `isNameMatch` and highlights them in the overlay with a distinct color. -## Enabling the Feature +## Enabling the feature Character dictionary sync is disabled by default. To turn it on: 1. Enable **Name Match** in Settings → Subtitle Style, or set `subtitleStyle.nameMatchEnabled: true` in your config. -2. Start watching - SubMiner queries AniList's public GraphQL API (no authentication required) and imports the merged dictionary into Yomitan automatically. +2. Start watching. SubMiner queries AniList's public GraphQL API, which needs no authentication, and imports the merged dictionary into Yomitan. 3. Optionally enable **Name Match Images** (Settings → Subtitle Style) to show inline circular character portraits next to matched names in subtitles. ```jsonc @@ -45,7 +45,7 @@ AniList character data is fetched via public GraphQL queries - no account or acc If `yomitan.externalProfilePath` is set, SubMiner switches to read-only external-profile mode. In that mode SubMiner can reuse another app's installed Yomitan dictionaries/settings, but SubMiner's own character-dictionary features are fully disabled. ::: -## Name Generation +## Name generation A single character produces many searchable terms so that names are recognized regardless of how they appear in dialogue. SubMiner generates variants for: @@ -56,7 +56,7 @@ A single character produces many searchable terms so that names are recognized r - Family name alone: 須々木 - Given name alone: 心一 -Unspaced native names (AniList often stores 渡辺真奈美 without a separator) are split into family/given parts with MeCab when it is available: person-name POS tags (姓/名) decide the boundary, validated against AniList's romanized first/last name readings. Without MeCab, a length heuristic based on the romanized readings guesses the boundary — and because that guess can be ambiguous (東紫乃 could be 東+紫乃 or 東紫+乃), terms are generated for the top two candidate boundaries so the real surname still matches. Snapshots built without MeCab are regenerated automatically once MeCab becomes available, upgrading them to the exact splits. +Unspaced native names (AniList often stores 渡辺真奈美 without a separator) are split into family/given parts with MeCab when it is available: person-name POS tags (姓/名) decide the boundary, validated against AniList's romanized first/last name readings. Without MeCab, a length heuristic based on the romanized readings guesses the boundary. That guess can be ambiguous, since 東紫乃 could be 東+紫乃 or 東紫+乃, so SubMiner generates terms for the top two candidate boundaries and the real surname still matches. Snapshots built without MeCab are regenerated automatically once MeCab becomes available, upgrading them to the exact splits. **Middle-dot removal** (common in katakana foreign names): @@ -86,7 +86,7 @@ Unspaced native names (AniList often stores 渡辺真奈美 without a separator) This means a character like "太郎" generates entries for 太郎, 太郎さん, 太郎先生, 太郎君, 太郎ちゃん, and so on - all with correct readings. -## Name Matching +## Name matching Name matching runs inside Yomitan's scanning pipeline during subtitle tokenization. @@ -109,7 +109,7 @@ Name matches are visually distinct from [N+1 targeting, frequency highlighting, | `subtitleStyle.nameMatchImagesEnabled` | `false` | Show small AniList portraits beside names | | `subtitleStyle.nameMatchColor` | `#f5bde6` | Highlight color for matched names | -## Inline Character Portraits +## Inline character portraits When `subtitleStyle.nameMatchImagesEnabled` is enabled, SubMiner injects a small circular portrait image directly into the subtitle line next to each matched character name. @@ -128,7 +128,7 @@ The portrait size is controlled by the surrounding subtitle font size and render Inline portraits help you quickly associate names with faces while building vocabulary - especially useful for shows with large casts where you're still learning who's who. ::: -## Dictionary Entries +## Dictionary entries Each character entry in the Yomitan dictionary includes structured content: @@ -156,7 +156,7 @@ The three collapsible sections can be configured to start open or closed: } ``` -## Auto-Sync Lifecycle +## Auto-sync lifecycle When `subtitleStyle.nameMatchEnabled` is `true`, SubMiner runs an auto-sync routine whenever the active media changes. @@ -185,7 +185,7 @@ These phases are emitted through the configured notification surface. Some phase The `maxLoaded` setting (default: 3) controls how many media snapshots stay in the active set. When you start a 4th title, the oldest is evicted and the merged dictionary is rebuilt without it. -## Manual Generation +## Manual generation You can generate a character dictionary from the command line without auto-sync: @@ -199,7 +199,7 @@ SubMiner.AppImage --dictionary This creates a standalone dictionary ZIP for the target media and saves it alongside the snapshots. -## Correcting AniList Matches +## Correcting AniList matches SubMiner uses `guessit` to infer the anime title from the active filename before searching AniList. Some filenames can still resolve to the wrong title. For example, `Re - ZERO, Starting Life in Another World (2016)` can be misread as a different `Re...` series. @@ -223,11 +223,11 @@ SubMiner.AppImage --dictionary-select --dictionary-anilist-id 21355 --dictionary subminer app --session-action '{"actionId":"openCharacterDictionaryManager"}' ``` -SubMiner stores manual selections in `character-dictionaries/anilist-overrides.json`. The episode's parent directory **and detected season** define the override scope, so later episodes in the same season keep the selected AniList ID even if their filename guesses differ, while a different season never inherits the override -- including when every season sits in one flat folder. When you replace a wrong match, SubMiner removes that stale media ID from the merged dictionary's active set and rebuilds/imports the merged character dictionary. +SubMiner stores manual selections in `character-dictionaries/anilist-overrides.json`. The episode's parent directory **and detected season** define the override scope, so later episodes in the same season keep the selected AniList ID even if their filename guesses differ, while a different season never inherits the override - including when every season sits in one flat folder. When you replace a wrong match, SubMiner removes that stale media ID from the merged dictionary's active set and rebuilds/imports the merged character dictionary. An override also pins the entry used for [AniList watch progress](/anilist-integration), so correcting a wrong match once fixes both the character dictionary and progress tracking. -## Managing Loaded Entries +## Managing loaded entries Open the manager with `Ctrl/Cmd+D` (`shortcuts.openCharacterDictionaryManager`). The manager shows the merged dictionary's active MRU entries, marks the current anime, and lets you adjust eviction priority for the other loaded entries. @@ -237,7 +237,7 @@ Open the manager with `Ctrl/Cmd+D` (`shortcuts.openCharacterDictionaryManager`). The current anime cannot be removed while you are watching it; it stays loaded until playback changes. -## File Structure +## File structure All character dictionary data lives under `{userData}/character-dictionaries/`: @@ -267,7 +267,7 @@ merged.zip img/ # Embedded character and VA portraits ``` -## Configuration Reference +## Configuration reference | Option | Default | Description | | ---------------------------------------------------------------------- | --------- | --------------------------------------------------------------- | @@ -280,11 +280,11 @@ merged.zip | `subtitleStyle.nameMatchImagesEnabled` | `false` | Show small AniList portraits beside matched names | | `subtitleStyle.nameMatchColor` | `#f5bde6` | Highlight color for character-name matches | -## Reference Implementation +## Reference implementation SubMiner's character dictionary builder is inspired by the [Japanese Character Name Dictionary](https://github.com/bee-san/Japanese_Character_Name_Dictionary) project - a standalone Rust web service that generates Yomitan character dictionaries from AniList and VNDB data. -The reference implementation covers similar ground - name variant generation, honorific expansion, structured Yomitan content, portrait embedding - and additionally supports VNDB as a data source for visual novel characters. Key differences: +The reference implementation covers the same ground: name variant generation, honorific expansion, structured Yomitan content, and portrait embedding. It also reads VNDB as a source for visual novel characters. Key differences: | | SubMiner | Reference Implementation | | ---------------------- | -------------------------------------------- | ------------------------------------- | diff --git a/docs-site/configuration.md b/docs-site/configuration.md index d19c4b47..32d685b0 100644 --- a/docs-site/configuration.md +++ b/docs-site/configuration.md @@ -8,11 +8,13 @@ outline: [2, 3] import { withBase } from 'vitepress'; </script> -SubMiner is configured through a single file (`config.jsonc`). Most settings are also editable from the in-app **Settings** window - you rarely need to edit the file by hand. This page is the full reference: it explains the Settings window, where the config file lives, and documents every option grouped by topic. New to SubMiner? The Quick Start below plus the [Settings window](#settings) cover everything most users need. +One file, `config.jsonc`, holds everything. Most of it is also editable from the in-app **Settings** window, so hand-editing is rarely necessary. -## Quick Start +This page is the full reference. It covers the Settings window, where the config file lives, and every option grouped by topic. If you are just starting out, the Quick Start below and the [Settings window](#settings) are enough. -For most users, start with this minimal configuration: +## Quick start + +Start here: ```json { @@ -35,11 +37,11 @@ For most users, start with this minimal configuration: Use the known-word deck map to choose which Anki decks and note fields feed the known-word cache. -Then customize as needed using the sections below. +Everything else is optional; the sections below cover it. ## Settings -SubMiner includes a dedicated **Settings** window accessible from the tray menu, the app `--settings` flag, or launcher commands such as `subminer --settings` and `subminer settings`. It is the primary way to configure SubMiner - all changes are written directly to `config.jsonc`, so manual file editing is not required for most users. +Open the **Settings** window from the tray menu, the app's `--settings` flag, or `subminer settings`. It writes straight to `config.jsonc`, so anything you change there is a normal config edit you can inspect afterward. The Settings window groups options by workflow instead of mirroring the raw config-file shape: @@ -57,11 +59,11 @@ Each field still writes to its current `config.jsonc` path. For example, subtitl The Settings window preserves existing JSONC comments, trailing commas, and unrelated keys. Resetting a field removes the explicit config path so the built-in default applies. -Secret fields do not display stored values. They show whether a value is configured; entering a new value writes it, and reset clears the explicit path. Prefer command-based secret options such as `ai.apiKeyCommand` when available. +Secret fields do not display stored values. They show whether a value is configured; entering a new value writes it, and reset clears the explicit path. Prefer command-based secret options such as `jimaku.apiKeyCommand` when available. Saving validates the candidate config before writing. Live-reloadable changes are applied immediately; other changes return a restart-required banner in the window. -## Configuration File +## Configuration file The Settings window writes to `config.jsonc` directly, so most users do not need to edit the file by hand. The config file and the option reference below are provided for advanced use, scripting, or cases where you prefer editing config directly. @@ -95,7 +97,7 @@ For valid JSON/JSONC with invalid option values, SubMiner uses warn-and-fallback On macOS, these validation warnings also open a native dialog with full details (desktop notification banners can truncate long messages). -### Hot-Reload Behavior +### Hot-reload behavior SubMiner watches the active config file (`config.jsonc` or `config.json`) while running and applies supported updates automatically. @@ -103,7 +105,7 @@ Hot-reloadable settings include subtitle appearance, sidebar controls, keybindin shortcuts, notifications, logging level, selected source-language preferences, Jimaku/Subsync settings, AniSkip settings (`mpv.aniskipEnabled`, `mpv.aniskipButtonKey`), stats keys (`stats.toggleKey`, `stats.markWatchedKey`), the secondary-subtitle default -mode, and the Anki deck, known-word, N+1, field, sentence-card, AI, and Kiku options +mode, and the Anki deck, known-word, N+1, field, sentence-card, and Kiku options listed in the reference tables below. When these values change, SubMiner applies them live. Invalid config edits are rejected and the previous valid runtime config remains active. @@ -111,11 +113,10 @@ When these values change, SubMiner applies them live. Invalid config edits are r Restart-required changes: - Any other config sections still require restart. -- Shared top-level `ai` provider settings still require restart. - AnkiConnect transport/proxy/media/tag fields still require restart unless listed above. - SubMiner shows an on-screen/system notification listing restart-required sections when they change. -### Configuration Options Overview +### Configuration options Overview The configuration file includes several main sections: @@ -146,7 +147,6 @@ The configuration file includes several main sections: **Anki Integration** -- [**Shared AI Provider**](#shared-ai-provider) - Canonical OpenAI-compatible provider config shared by Anki and YouTube subtitle fixing - [**AnkiConnect**](#ankiconnect) - Automatic Anki card creation with media - [**Kiku/Lapis Integration**](#kiku-lapis-integration) - Sentence cards and duplicate handling for Kiku/Lapis/Senren note types - [**N+1 Word Highlighting**](#n-1-word-highlighting) - Known-word cache and single-target highlighting @@ -168,7 +168,7 @@ The configuration file includes several main sections: - [**Updates**](#updates) - Automatic update checks, notifications, and prerelease testing - [**Notifications**](#notifications) - Overlay notification placement -## Core Settings +## Core settings ### Logging @@ -243,13 +243,13 @@ Configure where overlay notification cards appear: #### Notification history panel -Every overlay notification shown during a session is also recorded in a notification history panel. Press `Ctrl/Cmd+N` (configurable via [`shortcuts.toggleNotificationHistory`](#shortcuts-configuration)) to toggle the panel; the binding works whether the overlay or mpv has focus. The panel slides in from the same edge the notifications use — left when `overlayPosition` is `"top-left"`, and right for `"top-right"` or `"top"` (centered). Character dictionary sync uses one live card but records each distinct phase in history. Each entry can be removed individually, or use **Clear** to empty the history. History is session-only and is not persisted across restarts. +Every overlay notification shown during a session is also recorded in a notification history panel. Press `Ctrl/Cmd+N` (configurable via [`shortcuts.toggleNotificationHistory`](#shortcuts-configuration)) to toggle the panel; the binding works whether the overlay or mpv has focus. The panel slides in from the same edge the notifications use, so left when `overlayPosition` is `"top-left"` and right for `"top-right"` or `"top"` (centered). Character dictionary sync uses one live card but records each distinct phase in history. Each entry can be removed individually, or use **Clear** to empty the history. History is session-only and is not persisted across restarts. Startup tokenization, subtitle annotation, and character dictionary status follow the configured notification surface. When the surface is `"overlay"` or `"both"`, SubMiner queues those startup notifications until the overlay renderer is ready instead of falling back to mpv OSD. If loading and ready states both finish before the overlay can paint, the loading card is delivered first and then updates to ready shortly after. With `"both"`, character dictionary checking/building/importing/ready status also goes to system notifications; building and importing are only emitted when that work is actually needed. The bundled mpv plugin only shows its startup OSD messages when `ankiConnect.behavior.notificationType` is set to `"osd"` or `"osd-system"` in `config.jsonc`; AniSkip prompts and skip result messages are playback feedback and still route to overlay notifications when configured. The equivalent direct CLI command is `--playback-feedback <text>` (`playbackFeedback` internally). It sends that one non-empty feedback string through the same route controlled by `ankiConnect.behavior.notificationType`; it does not change the saved config. -### Auto-Start Overlay +### Auto-start overlay Control whether the overlay automatically becomes visible when it connects to mpv: @@ -267,7 +267,7 @@ When you launch through the SubMiner app or the `subminer` wrapper, the launcher On Windows, packaged plugin installs also rewrite the plugin socket path to `\\.\pipe\subminer-socket`. -### Startup Warmups +### Startup warmups Control which startup warmups run in the background versus deferring to first real usage: @@ -293,7 +293,7 @@ Control which startup warmups run in the background versus deferring to first re Defaults warm local tokenizer/dictionary work (`true` for `mecab`, `yomitanExtension`, and `subtitleDictionaries`) with `lowPowerMode: false`; Jellyfin remote session warmup is opt-in (`false` by default). Setting a warmup toggle to `false` defers that work until first usage. -### WebSocket Server +### WebSocket server The overlay includes a built-in WebSocket server that broadcasts plain subtitle text to connected clients for external processing. @@ -357,9 +357,9 @@ See `config.example.jsonc` for detailed configuration options. | `launchAtStartup` | `true`, `false` | Start texthooker automatically with SubMiner startup (default: `false`) | | `openBrowser` | `true`, `false` | Open browser tab when texthooker starts (default: `false`) | -## Subtitle Display +## Subtitle display -### Subtitle Style +### Subtitle style Customize the appearance of primary and secondary subtitles: @@ -457,7 +457,7 @@ Secondary subtitle styling lives in the secondary subtitle CSS object. Any CSS p **See `config.example.jsonc`** for the complete list of subtitle style configuration options. -### Subtitle Sidebar +### Subtitle sidebar Configure the parsed-subtitle sidebar modal. @@ -519,7 +519,7 @@ For full details on layout modes, behavior, and the keyboard shortcut, see the [ | `N4` | `#8bd5ca` | JLPT N4 underline color | | `N5` | `#8aadf4` | JLPT N5 underline color | -### Subtitle Position +### Subtitle position Set the initial vertical subtitle position (measured from the bottom of the screen): @@ -537,7 +537,7 @@ Set the initial vertical subtitle position (measured from the bottom of the scre In the overlay, you can fine-tune subtitle position at runtime with `Right-click + drag` on subtitle text. -### Secondary Subtitles +### Secondary subtitles Display a second subtitle track (e.g., English alongside Japanese) in the overlay: @@ -563,8 +563,6 @@ Secondary subtitles do **not** auto-load by default. To turn them on for local a These two settings apply to local and Jellyfin playback only. YouTube secondary selection is fixed to English and ignores them; see [YouTube Integration](/youtube-integration#secondary-subtitle-languages). `defaultMode` still controls how the loaded secondary bar is displayed in every case. -Because the mined-card translation field is filled from the secondary subtitle when one is present, leaving `autoLoadSecondarySub` off means local-file cards fall back to AI translation (when configured) or the original sentence text. - The secondary-subtitle language list also acts as the fallback secondary-language priority for managed startup subtitle selection on local playback and YouTube playback. **Display modes:** @@ -575,7 +573,7 @@ The secondary-subtitle language list also acts as the fallback secondary-languag **See `config.example.jsonc`** for additional secondary subtitle configuration options. -## Keyboard & Controls +## Keyboard and controls ### Keybindings @@ -641,7 +639,7 @@ Subtitle delay commands (`sub-delay`, `sub-step`) show a native mpv OSD notifica **See `config.example.jsonc`** for more keybinding examples and configuration options. -### Shortcuts Configuration +### Shortcuts configuration Customize or disable the overlay keyboard shortcuts: @@ -702,7 +700,7 @@ Set any shortcut to `null` to disable it. Feature-dependent shortcuts/keybindings only run when their related integration is enabled. For example, Anki/Kiku shortcuts require `ankiConnect.enabled` (and Kiku-specific behavior where applicable), and Jellyfin remote startup behavior requires Jellyfin to be enabled. -### Controller Support +### Controller support SubMiner can read controllers through the Chrome Gamepad API and map them onto the existing keyboard-only overlay workflow. @@ -818,7 +816,7 @@ If you update this controller documentation or the generated controller examples Tune `scrollPixelsPerSecond`, `horizontalJumpPixels`, deadzones, repeat timing, and profile `buttonIndices` to match your controller. See [config.example.jsonc](/config.example.jsonc) for the full generated comments for every controller field. -### Manual Card Update Shortcuts +### Manual card update shortcuts When automatic card updates are disabled, new cards are detected but not automatically updated. Use these keyboard shortcuts for manual control: @@ -845,7 +843,7 @@ When automatic card updates are disabled, new cards are detected but not automat These shortcuts are only active when the overlay window is visible and automatically disabled when hidden. -### Session Help Modal +### Session help modal The session help modal opens from the overlay with `Ctrl/Cmd+/` by default. The mpv plugin also exposes it through the `y-h` chord. It shows the current session keybindings and color legend. @@ -869,7 +867,7 @@ The list is generated at runtime from: When config hot-reload updates shortcut/keybinding/style values, close and reopen the help modal to refresh the displayed entries. -### Runtime Option Palette +### Runtime option palette Use the runtime options palette to toggle settings live while SubMiner is running. These changes are session-only and reset on restart. @@ -889,39 +887,7 @@ Palette controls: - `Enter`: apply selected value - `Esc`: close -## Anki Integration - -### Shared AI Provider - -This is the single, shared connection to an OpenAI-compatible LLM endpoint. Configure it **once** here at the top level, and SubMiner reuses it wherever AI is needed (Anki translation/enrichment and YouTube subtitle fixing). Per-feature toggles and prompt/model tweaks live in their own sections (for example `ankiConnect.ai` and `youtubeSubgen.ai`) and inherit this transport. - -```json -{ - "ai": { - "enabled": false, - "apiKey": "", - "apiKeyCommand": "", - "model": "openai/gpt-4o-mini", - "baseUrl": "https://openrouter.ai/api", - "requestTimeoutMs": 15000 - } -} -``` - -| Option | Values | Description | -| ------------------ | -------------------- | ------------------------------------------------------------------------------------ | -| `ai.enabled` | `true`, `false` | Enable shared AI provider features (default: `false`) | -| `apiKey` | string | Static API key for the shared provider | -| `apiKeyCommand` | string | Shell command used to resolve the API key (preferred over a plaintext `apiKey`) | -| `model` | string | Default model identifier requested from the provider (default: `openai/gpt-4o-mini`) | -| `baseUrl` | string (URL) | OpenAI-compatible base URL (default: `https://openrouter.ai/api`) | -| `systemPrompt` | string | Default system prompt sent with requests (default: a translation-engine prompt) | -| `requestTimeoutMs` | integer milliseconds | Shared request timeout (default: `15000`) | - -SubMiner uses the shared provider for: - -- Anki translation/enrichment when Anki AI is enabled -- YouTube generated-subtitle fixing when `youtubeSubgen.fixWithAi` is enabled (with optional `youtubeSubgen.ai.model` / `systemPrompt` overrides) +## Anki integration ### AnkiConnect @@ -943,16 +909,10 @@ Enable automatic Anki card creation and updates with media generation: "deck": "Learning::Japanese", "fields": { "word": "Expression", - "audio": "ExpressionAudio", + "audio": "SentenceAudio", "image": "Picture", "sentence": "Sentence", - "miscInfo": "MiscInfo", - "translation": "SelectionText" - }, - "ai": { - "enabled": false, - "model": "", - "systemPrompt": "" + "miscInfo": "MiscInfo" }, "media": { "generateAudio": true, @@ -1010,14 +970,10 @@ This example is intentionally compact. The option table below documents availabl | `tags` | array of strings | Tags automatically added to cards mined/updated by SubMiner (default: `['SubMiner']`; set `[]` to disable automatic tagging). | | `ankiConnect.deck` | string | Restrict duplicate detection and card enrichment to this Anki deck. Leave empty to use the Yomitan mining deck when available. In Settings, this dropdown auto-fills and persists Yomitan's current mining deck when available. | | `fields.word` | string | Card field for mined word / expression text (default: `Expression`) | -| `fields.audio` | string | Card field for audio files (default: `ExpressionAudio`) | +| `fields.audio` | string | Card field for the generated sentence audio clip (default: `ExpressionAudio`). Set this to a dedicated field such as `SentenceAudio` so it does not collide with the word audio Yomitan writes. | | `fields.image` | string | Card field for images (default: `Picture`) | | `fields.sentence` | string | Card field for sentences (default: `Sentence`) | | `fields.miscInfo` | string | Card field for metadata (default: `"MiscInfo"`, set to `null` to disable) | -| `fields.translation` | string | Card field for sentence-card translation/back text (default: `SelectionText`) | -| `ankiConnect.ai.enabled` | `true`, `false` | Use AI translation for sentence cards. Also auto-attempted when secondary subtitle is missing. | -| `ankiConnect.ai.model` | string | Optional model override for Anki AI translation/enrichment flows. | -| `ankiConnect.ai.systemPrompt` | string | Optional system prompt override for Anki AI translation/enrichment flows. | | `media.generateAudio` | `true`, `false` | Generate audio clips from video (default: `true`) | | `media.normalizeAudio` | `true`, `false` | Normalize generated sentence-audio loudness during media extraction (default: `true`). Set to `false` to keep raw source loudness. Changes apply live. | | `media.mirrorMpvVolume` | `true`, `false` | Apply mpv's cubic software-volume curve to each generated sentence-audio clip (default: `true`). This ignores mpv's separate mute state, falls back to unity scaling if volume cannot be read, and applies changes live. | @@ -1056,10 +1012,7 @@ This example is intentionally compact. The option table below documents availabl | `isKiku` | object | Kiku-only config: `{ enabled, fieldGrouping, deleteDuplicateInAuto }` (shared sentence/audio/model settings are inherited from `isLapis`) | | `isSenren` | object | Senren-only config: `{ enabled, fieldGrouping, deleteDuplicateInAuto }`. Merges duplicates using Senren's scene-switching markup. Mutually exclusive with `isKiku.enabled`. | -`ankiConnect.ai` only controls feature-local enablement plus optional `model` / `systemPrompt` overrides. -API key resolution, base URL, and timeout live under the shared top-level [`ai`](#shared-ai-provider) config. - -### Kiku/Lapis Integration +### Kiku/Lapis integration SubMiner is intentionally built for [Kiku](https://kiku.youyoumu.my.id/) and [Lapis](https://github.com/donkuri/lapis) workflows, with note-type-specific behavior built into Anki settings. @@ -1087,7 +1040,7 @@ SubMiner is intentionally built for [Kiku](https://kiku.youyoumu.my.id/) and [La - For [Senren](https://github.com/BrenoAqua/Senren) note types, enable `isSenren` instead of `isKiku`. Duplicate merges then use Senren's scene-switching markup (including grouped `miscInfo` entries), and `isSenren.fieldGrouping` supports the same three modes (default: `auto`). Kiku and Senren are mutually exclusive; if both are enabled, Kiku wins and Senren is turned off with a config warning. - `lapisKiku.wordCardKind` picks the card-type flag set on word cards; see [Word Card Type](#word-card-type). It is read only while `isLapis` or `isKiku` is enabled. -### Word Card Type +### Word card type When SubMiner fills the sentence on a mined word card - from Yomitan auto-enrichment, a manual clipboard update, or stats-dashboard word mining - it marks which card that note should generate. `ankiConnect.lapisKiku.wordCardKind` chooses the flag: @@ -1101,7 +1054,7 @@ When SubMiner fills the sentence on a mined word card - from Yomitan auto-enrich The other card-type flags are cleared so a note never claims two card types at once. Notes are skipped when the note type has no field for the chosen flag, and when the note was already mined as a sentence or audio card. Cards created by Mine Sentence and Mine Audio keep their own flag regardless of this setting. -### N+1 Word Highlighting +### N+1 word highlighting When known-word highlighting is enabled, SubMiner builds a local cache of known words from Anki to highlight already learned tokens in subtitle rendering. @@ -1138,7 +1091,7 @@ To refresh roughly once per day, set: } ``` -### Field Grouping Modes +### Field grouping modes | Mode | Behavior | | ---------- | -------------------------------------------------------------------------------------------------------------------------- | @@ -1157,7 +1110,7 @@ When the manual merge popup opens, SubMiner pauses playback and closes any open <a :href="withBase('/assets/kiku-integration.webm')" target="_blank" rel="noreferrer">Open demo in a new tab</a> -## External Integrations +## External integrations ### Jimaku @@ -1199,7 +1152,7 @@ The keyboard shortcut lives under `shortcuts.openTsukihime` (default `Ctrl+Shift See [TsukiHime Integration](/tsukihime-integration) for the modal workflow, language tabs, and troubleshooting. -### Subtitle Sync +### Subtitle sync Sync a subtitle track from the overlay picker using `alass` or `ffsubsync`. The picker lets you choose which track gets retimed (the active primary track by default) and, for alass, which reference it is aligned against (the secondary subtitle track by default). Both are **optional external tools** that must be installed separately and available on your `PATH` (or configured via the path options below). @@ -1224,8 +1177,6 @@ Sync a subtitle track from the overlay picker using `alass` or `ffsubsync`. The | `ffmpeg_path` | string path | Path to `ffmpeg` (used for internal subtitle extraction). Empty or `null` falls back to `/usr/bin/ffmpeg`. | | `replace` | `true`, `false` | When `true` (default), overwrite the active subtitle file on successful sync. When `false`, write `<name>_retimed.<ext>`. | -Stats dashboard sentence mining also uses `alass_path` when available to align a local English sidecar against the local Japanese sidecar before filling the card translation field. This stats-only retime writes a temporary cached copy and never edits the original subtitle files. - Default trigger is `Ctrl+Alt+S` via `shortcuts.triggerSubsync`. Customize it there, or set it to `null` to disable. @@ -1389,7 +1340,7 @@ Jellyfin playback auto-launched through SubMiner loads the mpv plugin the same w When Jellyfin is enabled with a server URL and SubMiner is running, the tray menu also shows a `Jellyfin Discovery` checkbox. It starts or stops discovery for the current runtime session only and does not write config. Starting discovery still requires a valid stored or environment-provided Jellyfin auth session. -### Discord Rich Presence +### Discord rich presence Discord Rich Presence is enabled by default. SubMiner publishes a polished activity card that reflects current media title, playback state, and session timer unless you turn it off. @@ -1436,7 +1387,7 @@ Troubleshooting: - If images do not render, confirm asset keys exactly match uploaded Discord asset names. - If Discord is closed/not installed/disconnects, SubMiner continues running and quietly skips presence updates. -### Immersion Tracking +### Immersion tracking Enable or disable local immersion analytics stored in SQLite for mined subtitles and media sessions. This data also powers the stats dashboard: @@ -1510,7 +1461,7 @@ Set `dbPath` only if you want to relocate the database (for backup, syncing, or See [Immersion Tracking Storage](/immersion-tracking) for schema details, query templates, dashboard access, retention/rollup behavior, backend portability notes, and the dedicated SQLite verification command. -### Stats Dashboard +### Stats dashboard Configure the local stats UI served from SubMiner and the in-app stats overlay toggle: @@ -1541,7 +1492,7 @@ Usage notes: - The dashboard reads from the same immersion-tracking database, so keep `immersionTracking.enabled` on if you want data to appear. - The UI includes Overview, Library, Trends, Vocabulary, Search, and Sessions tabs. -### MPV Launcher +### MPV launcher Configure the mpv executable, profile, and window state for SubMiner-managed mpv launches (launcher playback, Windows `--launch-mpv`, and Jellyfin idle mpv startup): @@ -1583,7 +1534,7 @@ Launch mode behavior: - **`maximized`** - mpv starts maximized via `--window-maximized=yes`, keeping taskbar access. - **`fullscreen`** - mpv starts in true fullscreen via `--fullscreen`. -### YouTube Playback Settings +### YouTube playback settings Set defaults used by managed subtitle auto-selection and the `subminer` launcher YouTube flow: @@ -1627,6 +1578,6 @@ Track selection: These settings come from `config.jsonc` (or built-in defaults); there are no CLI flags or environment variables for subtitle language selection. -#### YouTube Subtitle Generation (`youtubeSubgen`) +#### YouTube subtitle generation (`youtubeSubgen`) -An advanced, template-hidden section for Whisper-based YouTube subtitle generation: `whisperBin`, `whisperModel`, `whisperVadModel`, `whisperThreads` (default `4`), and `fixWithAi` (default `false`), which post-processes generated subtitles through the [Shared AI Provider](#shared-ai-provider) with optional `youtubeSubgen.ai.model` / `systemPrompt` overrides. These keys are accepted in `config.jsonc` but intentionally omitted from the generated template. +An advanced, template-hidden section for Whisper-based YouTube subtitle generation: `whisperBin`, `whisperModel`, `whisperVadModel`, and `whisperThreads` (default `4`). These keys are accepted in `config.jsonc` but the generated template omits them. diff --git a/docs-site/demos.md b/docs-site/demos.md index e0097d4e..c947fb40 100644 --- a/docs-site/demos.md +++ b/docs-site/demos.md @@ -1,6 +1,8 @@ -# Feature Demos +# Feature demos -Short recordings of SubMiner's key features and integrations from real playback sessions. A few terms you'll see below: _Yomitan_ is the pop-up dictionary used for word lookups, _Jimaku_ is a community subtitle database, _alass_ and _ffsubsync_ are tools that retime subtitles to match the audio, _Jellyfin_ is a self-hosted media server, and a _texthooker_ is a web page that mirrors the current subtitle as selectable text for browser-based tools. +Short recordings from real playback sessions. + +Some vocabulary for what follows. _Yomitan_ is the pop-up dictionary. _Jimaku_ is a community subtitle database. _alass_ and _ffsubsync_ retime subtitles against the audio. _Jellyfin_ is a self-hosted media server. A _texthooker_ is a web page that mirrors the current subtitle as selectable text so browser tools can read it. <script setup> import { withBase } from 'vitepress'; @@ -8,9 +10,9 @@ import { withBase } from 'vitepress'; const v = '20260819-1'; </script> -## Anki Card Mining & Enrichment +## Anki card mining and enrichment -Mine vocabulary cards from Yomitan or directly from subtitle lines. SubMiner automatically attaches the sentence, a timing-accurate audio clip, a screenshot, and a translation. +Mine a card from Yomitan or straight from a subtitle line. SubMiner attaches the sentence, an audio clip cut to the line timing, and a screenshot. <video controls playsinline preload="metadata" :poster="withBase(`/assets/minecard-poster.jpg?v=${v}`)"> <source :src="withBase(`/assets/minecard.webm?v=${v}`)" type="video/webm" /> @@ -20,9 +22,9 @@ Mine vocabulary cards from Yomitan or directly from subtitle lines. SubMiner aut </a> </video> -## Subtitle Download & Sync +## Subtitle download and sync -Search and download subtitles from Jimaku, then retime them with alass or ffsubsync - all from within SubMiner. +Search Jimaku, download a track, then retime it with alass or ffsubsync without leaving SubMiner. <!-- <video controls playsinline preload="metadata" :poster="withBase(`/assets/demos/subtitle-sync-poster.jpg?v=${v}`)"> <source :src="withBase(`/assets/demos/subtitle-sync.webm?v=${v}`)" type="video/webm" /> @@ -32,9 +34,9 @@ Search and download subtitles from Jimaku, then retime them with alass or ffsubs ::: info VIDEO COMING SOON ::: -## Jellyfin Integration +## Jellyfin integration -Browse your Jellyfin library, cast to devices, and launch playback directly from SubMiner. Watch progress syncs back to your Jellyfin server. +Browse your Jellyfin library, cast to a device, and start playback from SubMiner. Watch progress goes back to the Jellyfin server. <!-- <video controls playsinline preload="metadata" :poster="withBase(`/assets/demos/jellyfin-poster.jpg?v=${v}`)"> <source :src="withBase(`/assets/demos/jellyfin.webm?v=${v}`)" type="video/webm" /> @@ -46,7 +48,7 @@ Browse your Jellyfin library, cast to devices, and launch playback directly from ## Texthooker -Open subtitles in an external texthooker page for use with browser-based tools and extensions alongside the overlay. +Mirror subtitles to an external texthooker page so browser extensions can read them while the overlay runs. <!-- <video controls playsinline preload="metadata" :poster="withBase(`/assets/demos/texthooker-poster.jpg?v=${v}`)"> <source :src="withBase(`/assets/demos/texthooker.webm?v=${v}`)" type="video/webm" /> diff --git a/docs-site/development.md b/docs-site/development.md index d64e929d..f03f8f92 100644 --- a/docs-site/development.md +++ b/docs-site/development.md @@ -1,6 +1,6 @@ -# Building & Testing +# Building and testing -For internal architecture/workflow guidance, use `docs/README.md` at the repo root. This page stays focused on contributor-facing build and test commands. +Architecture and workflow guidance lives in `docs/README.md` at the repo root. This page covers build and test commands only. ## Prerequisites @@ -37,7 +37,7 @@ make build-launcher `bun run build` includes the Yomitan build step. It builds the bundled Chrome extension directly from the `vendor/subminer-yomitan` submodule into `build/yomitan` using Bun. -## Launcher Artifact Workflow +## Launcher artifact workflow - Source of truth: `launcher/*.ts` - Generated output: `dist/launcher/subminer` @@ -53,7 +53,7 @@ dist/launcher/subminer --help >/dev/null bash scripts/verify-generated-launcher.sh ``` -## Running Locally +## Running locally ```bash bun run dev # builds + launches with --start --dev @@ -169,7 +169,7 @@ bun run format:check:src - `bun run format:check:src` checks the same scoped set without writing changes. - `bun run format` remains the broad repo-wide Prettier command; use it intentionally. -## Config Generation +## Config generation ```bash # Generate default config to ~/.config/SubMiner/config.jsonc (or %APPDATA%\SubMiner\config.jsonc on Windows) @@ -184,7 +184,7 @@ Convenience wrappers still exist: - `make generate-config` - `make generate-example-config` -## Documentation Site +## Documentation site The docs site now lives in `docs-site/` inside the main repo. @@ -200,7 +200,7 @@ bun run docs:test # Docs regression tests Deployment: production docs are built with `bun run docs:build:versioned` and uploaded directly to Cloudflare Pages by the `docs-pages` GitHub Actions workflow using Wrangler (from `.tmp/docs-versioned-site`). Cloudflare's automatic Git-integration deployments are intentionally disabled - see `docs-site/README.md` for the deployment contract. Do not re-enable Pages build settings in the Cloudflare dashboard. -## Makefile Reference +## Makefile reference Run `make help` for a full list of targets. Key ones: @@ -216,7 +216,7 @@ Run `make help` for a full list of targets. Key ones: | `make build-macos` | Convenience wrapper for signed macOS packaging | | `make build-macos-unsigned` | Convenience wrapper for unsigned macOS packaging | -## Contributor Notes +## Contributor notes - To add/change a config default, edit the matching domain file in `src/config/definitions/defaults-*.ts`. - To add/change config option metadata, edit the matching domain file in `src/config/definitions/options-*.ts`. @@ -228,7 +228,7 @@ Run `make help` for a full list of targets. Key ones: - Prefer direct inline deps objects in `src/main/` modules for simple pass-through wiring. - Add a helper/adapter service only when it performs meaningful adaptation, validation, or reuse (not identity mapping). -## Environment Variables +## Environment variables | Variable | Description | | ---------------------------------- | ------------------------------------------------------------------------------ | diff --git a/docs-site/docs-sync.test.ts b/docs-site/docs-sync.test.ts index 35cf7ba9..35e8e2a1 100644 --- a/docs-site/docs-sync.test.ts +++ b/docs-site/docs-sync.test.ts @@ -57,7 +57,19 @@ test('docs reflect current launcher and release surfaces', () => { expect(configurationContents).not.toContain('youtubeSubgen": {\n "mode"'); expect(configurationContents).not.toContain('youtubeSubgen.primarySubLanguages'); expect(configurationContents).toContain('youtube.primarySubLanguages'); - expect(configurationContents).toContain('### Shared AI Provider'); + // The AI provider still exists in src/ai and ankiConnect.ai, but it is not + // exposed in the Settings window and is not documented for users. Keep the + // user-facing docs free of it so nobody configures a hidden surface. + expect(configurationContents).not.toContain('Shared AI Provider'); + expect(configurationContents).not.toContain('ankiConnect.ai'); + expect(ankiIntegrationContents).not.toContain('AI Translation'); + // ankiConnect.fields.translation is a LEGACY_HIDDEN_CONFIG_PATHS key, so it + // must not be documented as a current setting. + expect(configurationContents).not.toContain('fields.translation'); + expect(ankiIntegrationContents).not.toContain('SelectionText'); + // fields.audio holds SubMiner's generated sentence audio; examples should not + // point it at the field Yomitan uses for word audio. + expect(ankiIntegrationContents).not.toContain('"audio": "ExpressionAudio"'); expect(changelogContents).toContain('v0.5.1 (2026-03-09)'); }); diff --git a/docs-site/immersion-tracking.md b/docs-site/immersion-tracking.md index 1735a2b7..2202c887 100644 --- a/docs-site/immersion-tracking.md +++ b/docs-site/immersion-tracking.md @@ -1,13 +1,13 @@ -# Immersion Tracking +# Immersion tracking -SubMiner can log your watching and mining activity to a local SQLite database, then surface it in the built-in stats dashboard. Tracking is enabled by default and can be turned off if you do not want local analytics. +SubMiner logs your watching and mining activity to a local SQLite database and shows it in the built-in stats dashboard. Tracking is on by default; turn it off if you would rather not keep the data. -"Immersion" here means time spent watching and reading native Japanese content. **All data stays on your computer** - nothing is uploaded anywhere. (SQLite is just a single-file database; you do not need to install or manage anything.) +"Immersion" here means time spent watching and reading native Japanese content. **All of it stays on your machine.** Nothing is uploaded anywhere. SQLite is a single file on disk, so there is no database server to install or run. -When enabled, SubMiner records per-session statistics (watch time, subtitle lines seen, words encountered, cards mined) and maintains exact lifetime summary tables plus daily/monthly rollups. You can view that data in SubMiner's stats UI or query the database directly with any SQLite tool. +Each session records watch time, subtitle lines seen, words encountered, and cards mined. SubMiner also keeps exact lifetime summary tables and daily and monthly rollups. Read it through the stats UI, or point any SQLite tool at the file. ::: tip For most users -Just leave tracking on and use the built-in [Stats Dashboard](#stats-dashboard). The retention, performance, SQL, and schema sections further down are reference material for advanced users who want to inspect or tune the database - you can safely skip them. +Leave tracking on and use the [Stats Dashboard](#stats-dashboard). The retention, performance, SQL, and schema sections below are reference material for querying or tuning the database yourself. Skip them. ::: Episode completion for local `watched` state uses the shared `DEFAULT_MIN_WATCH_RATIO` (`85%`) value from `src/shared/watch-threshold.ts`. @@ -25,9 +25,9 @@ Episode completion for local `watched` state uses the shared `DEFAULT_MIN_WATCH_ - Leave `dbPath` empty to use the default location (`immersion.sqlite` in SubMiner's app-data directory). - Set an explicit path to move the database (useful for backups, cloud syncing, or external tools). -- To share stats and watch history between two machines, use [`subminer sync <host>`](/launcher-script#sync-between-machines) instead of file-level cloud sync — it merges both databases without one side overwriting the other. +- To share stats and watch history between two machines, use [`subminer sync <host>`](/launcher-script#sync-between-machines) instead of file-level cloud sync. It merges both databases instead of letting one side overwrite the other. -## Stats Dashboard +## Stats dashboard The same immersion data powers the stats dashboard. @@ -37,7 +37,7 @@ The same immersion data powers the stats dashboard. - Maintenance commands: run `subminer stats cleanup` or `subminer stats cleanup -v` to backfill/repair vocabulary metadata (`headword`, `reading`, POS) and purge stale or excluded rows from `imm_words` on demand; `subminer stats cleanup -l` repairs lifetime summary tables non-destructively (recomputed from per-episode history, so lifetime totals older than the session retention window are kept); `subminer stats cleanup --duplicate-lines` collapses repeated lines left behind by typeset subtitles (see [Repeated Line Cleanup](#repeated-line-cleanup)). `subminer stats rebuild` and `subminer stats backfill` rebuild or backfill rollup data. - Browser page: open `http://127.0.0.1:6969` directly if the local stats server is already running. -### Dashboard Tabs +### Dashboard tabs #### Overview @@ -70,7 +70,7 @@ Open a title and use **Delete Entry** in its header to remove a mistakenly track #### Trends -Grouped into Activity (per-day/month watch time, cards, words, sessions), Cumulative Totals (running totals incl. new words seen and episodes), Efficiency (words/min, cards/hour, lookups per 100 words), Patterns (watch time by day of week and hour), and per-anime Library charts — all with configurable date ranges and grouping. +Grouped into Activity (per-day/month watch time, cards, words, sessions), Cumulative Totals (running totals incl. new words seen and episodes), Efficiency (words/min, cards/hour, lookups per 100 words), Patterns (watch time by day of week and hour), and per-anime Library charts. Every chart takes a configurable date range and grouping. ![Stats Trends](/screenshots/stats-trends.png) @@ -108,7 +108,7 @@ Stats server config lives under `stats`: - `markWatchedKey` toggles the watched state of the highlighted entry inside the stats dashboard. - `serverPort` controls the localhost dashboard URL. - `autoStartServer` starts the local stats HTTP server on launch once immersion tracking is active, or reuses the dedicated background stats server when one is already running. Background app launches (`subminer app`) start the stats server immediately, registering it so later launches reuse it instead of starting another one. -- `autoOpenBrowser` controls whether `subminer stats` launches the dashboard URL in your browser after ensuring the server is running. +- `autoOpenBrowser` decides whether `subminer stats` opens the dashboard URL in your browser once the server is up. - `subminer stats` forces the dashboard server to start even when `autoStartServer` is `false`. - `subminer stats -b` starts or reuses the dedicated background stats daemon and exits after startup acknowledgement. - The background stats daemon is separate from the normal SubMiner overlay app, so you can leave it running and still launch SubMiner later to watch or mine from video. @@ -116,7 +116,7 @@ Stats server config lives under `stats`: - `subminer stats` fails with an error when `immersionTracking.enabled` is `false`. - `subminer stats cleanup` defaults to vocabulary cleanup, repairs stale `headword`, `reading`, and `part_of_speech` values, attempts best-effort MeCab backfill for legacy rows, and removes rows that still fail vocab filtering. -## Mining Cards from the Stats Page +## Mining cards from the stats page The Search tab and the Vocabulary tab's word detail panel both mine from subtitle lines in your viewing history. Search matches sentence text and media titles, and **Search by headword** is enabled by default so dictionary-form searches such as `知らない` can find tracked subtitle lines with inflected variants. Turn that toggle off for exact text/title matching only. Each line with a valid source file offers sentence-card mining; word/audio mining is available when the selected word or searched word appears in the sentence: @@ -126,13 +126,13 @@ The Search tab and the Vocabulary tab's word detail panel both mine from subtitl All three modes respect your `ankiConnect` config: deck, model, field mappings, media settings (static vs AVIF, quality, dimensions), audio padding, metadata pattern, and tags. Media generation runs in parallel for faster card creation. -Secondary subtitle text (typically English translations) is stored alongside primary subtitles during playback and can be used as the translation field when mining sentence cards from Search or vocabulary occurrences. The Search tab does not use that text for display or matching. +Secondary subtitle text is stored alongside primary subtitles during playback, but the Search tab does not use it for display or matching. -### Word Exclusion List +### Word exclusion list The Vocabulary tab toolbar includes an **Exclusions** button for hiding words from all vocabulary views. Excluded words are stored in the immersion database, with older browser localStorage exclusions imported on first load after upgrade. They can be managed (restored or cleared) from the exclusion modal. Exclusions affect stat cards, charts, the frequency rank table, and the word list. -### Repeated Line Cleanup +### Repeated line cleanup Karaoke openings and animated signs are authored as one subtitle event per animation frame, all carrying the same text. Playback reports every one of those frames, so a single OP lyric could be recorded hundreds of times and dominate "Top Repeated Words". @@ -162,7 +162,7 @@ The cleanup chains runs per line of text, so interleaved dual-line karaoke colla Runs never cross a session boundary, so rewatching an episode keeps both watches. Session telemetry (watch time, lines seen, tokens seen) and the rollups derived from it are left as recorded: they are cumulative samples taken during playback, and cannot be recomputed for sessions whose raw rows have since been pruned. -## Retention Defaults +## Retention defaults By default, SubMiner keeps all retention tables and raw data (`0` means keep all) while continuing daily/monthly rollup maintenance: @@ -184,9 +184,9 @@ In practice: - Vocabulary and kanji totals are cumulative and not bounded by the raw session retention knobs. - New-word charts use their own permanent lexical daily rollups, which are not pruned by activity-rollup retention. -## Storage / Performance Model +## Storage / performance model -The tracker is optimized for "keep everything" defaults: +The defaults keep everything, and the schema is shaped around that: - Exact all-time totals live in dedicated lifetime summary tables (`imm_lifetime_global`, `imm_lifetime_anime`, `imm_lifetime_media`). - Ended-session totals are persisted onto `imm_sessions`, so most dashboard reads do not need to rescan raw telemetry. @@ -195,7 +195,7 @@ The tracker is optimized for "keep everything" defaults: - Cover-art binaries are deduplicated through a shared blob store so episodes in the same series do not each carry duplicate image bytes. - Hot tables have dedicated indexes for session time ranges, telemetry sample windows, frequency-ranked vocabulary, and cover-art lookup keys. -## Configurable Knobs +## Configurable knobs All policy options live under `immersionTracking` in your config: @@ -218,7 +218,7 @@ All policy options live under `immersionTracking` in your config: | `lifetimeSummaries.anime` | Maintain per-anime lifetime totals | | `lifetimeSummaries.media` | Maintain per-media lifetime totals | -## Query Templates +## Query templates ### Session timeline @@ -316,7 +316,7 @@ ORDER BY rollup_month DESC, video_id DESC LIMIT ?; ``` -## Technical Details +## Technical details - Write path is asynchronous and queue-backed. Hot paths (subtitle parsing, render, token flows) enqueue telemetry and never await SQLite writes. - Queue overflow policy: drop oldest queued writes, keep newest. @@ -327,7 +327,7 @@ LIMIT ?; - Large-table reads are index-backed for `sample_ms`, session time windows, frequency-ranked words/kanji, and cover-art identity lookups. - Workload-dependent tuning knobs remain at defaults unless you change them: `cache_size`, `mmap_size`, `temp_store`, `auto_vacuum`. -### Schema (v18) +### Schema (v23) The exact schema version lives in `SCHEMA_VERSION` (`src/core/services/immersion-tracker/types.ts`) and is recorded in the `imm_schema_version` table. @@ -335,6 +335,8 @@ Core tables: - `imm_videos` - video key/title/source metadata - `imm_anime` - anime/series metadata referenced by videos and lifetime tables +- `imm_anime_title_aliases` - alternate titles that resolve to the same anime row +- `imm_anime_merge_recommendations` - candidate duplicate-series merges surfaced in the dashboard - `imm_sessions` - session UUID, video reference, timing/status, final denormalized totals - `imm_session_telemetry` - high-frequency session aggregates over time - `imm_session_events` - event stream with compact numeric event types diff --git a/docs-site/index.md b/docs-site/index.md index 1a3b2d19..8279e3dc 100644 --- a/docs-site/index.md +++ b/docs-site/index.md @@ -7,7 +7,7 @@ titleTemplate: Immersion Mining Workflow for MPV hero: name: SubMiner text: Immersion Mining for MPV - tagline: Watch media, mine vocabulary, and craft anki cards without leaving the scene. + tagline: Watch, look up a word, and get an Anki card with audio and a screenshot. Without pausing your show. image: src: /assets/SubMiner.png alt: SubMiner logo @@ -24,63 +24,63 @@ features: src: /assets/mpv.svg alt: mpv icon title: Built for mpv - details: Tracks subtitles via mpv IPC in real time. Launch with the wrapper script or the mpv plugin - no external bridge needed. + details: Reads subtitle state over mpv's IPC socket. Launch with the wrapper script or the mpv plugin. There is no separate bridge process to run. link: /usage linkText: How it works - icon: src: /assets/yomitan-icon.svg alt: Yomitan logo title: Bundled Yomitan - details: Ships with a built-in Yomitan instance for instant word lookups and context-aware card creation directly from subtitle text. + details: A Yomitan instance is bundled and preconfigured. Hover a word in the subtitle overlay to look it up and mine it. link: /mining-workflow linkText: Mining workflow - icon: src: /assets/anki-card.svg alt: Anki card icon - title: Anki Card Enrichment - details: Auto-fills card fields with sentence, audio clip, screenshot, and translation so you can focus on learning. + title: Anki card enrichment + details: New cards get the subtitle line, an audio clip cut to the line timing, and a screenshot from that moment. link: /anki-integration linkText: Anki integration - icon: src: /assets/highlight.svg alt: Highlight icon - title: Reading Annotations - details: N+1 targeting, character-name matching, frequency highlighting, and JLPT tagging - all layered on subtitle text in real time. + title: Reading annotations + details: N+1 targeting, character-name matching, frequency highlighting, and JLPT tagging, drawn onto the subtitle line as it plays. link: /subtitle-annotations linkText: Annotation details - icon: src: /assets/video.svg alt: Video playback icon - title: YouTube Playback - details: Play YouTube URLs or ytsearch targets directly - SubMiner automatically selects and loads subtitles for the video. + title: YouTube playback + details: Pass a YouTube URL or a ytsearch target. SubMiner picks a subtitle track for the video and loads it. link: /usage#youtube-playback linkText: YouTube playback - icon: src: /assets/jellyfin.svg alt: Jellyfin icon - title: Jellyfin Integration - details: Browse your Jellyfin library, pick media interactively, and play through mpv with full subtitle and mining support. + title: Jellyfin integration + details: Browse your Jellyfin library from the overlay and play a title through mpv. Subtitles and mining work the same as with local files. link: /jellyfin-integration linkText: Jellyfin setup - icon: src: /assets/subtitle-download.svg alt: Subtitle download icon - title: Subtitle Download & Sync - details: Search and pull subtitles from Jimaku, then retime subtitles with alass or ffsubsync - all from the overlay. + title: Subtitle download and sync + details: Search Jimaku or TsukiHime and download a track, then retime it with alass or ffsubsync. Both run from the overlay. link: /jimaku-integration linkText: Jimaku integration - icon: src: /assets/tokenization.svg alt: Tracking chart icon - title: Stats Dashboard - details: Browse session history, streak calendars, vocabulary frequency, and per-series progress in a local dashboard - then mine cards straight from your viewing history. + title: Stats dashboard + details: A local dashboard with session history, streak calendars, word frequency, and per-series progress. You can mine cards from lines you already watched. link: /immersion-tracking linkText: Dashboard & tracking - icon: src: /assets/cross-platform.svg alt: Cross-platform icon - title: Cross-Platform - details: Runs on Linux (Hyprland, Sway, X11), macOS, and Windows with compositor-aware window positioning and platform-native integration. + title: Cross-platform + details: Runs on Linux (Hyprland, Sway, X11), macOS, and Windows. Overlay positioning is handled per compositor rather than assuming one window manager. link: /installation linkText: Platform setup --- @@ -98,38 +98,38 @@ const demoAssetVersion = '20260819-1'; <div class="workflow-step" style="animation-delay: 0ms"> <div class="step-number">01</div> <div class="step-title">Start</div> - <div class="step-desc">Launch with the wrapper or existing mpv setup and keep subtitles in sync.</div> + <div class="step-desc">Launch through the wrapper, or from an mpv setup you already have.</div> </div> <div class="workflow-connector" aria-hidden="true"></div> <div class="workflow-step" style="animation-delay: 60ms"> <div class="step-number">02</div> <div class="step-title">Lookup</div> - <div class="step-desc">Hover a token in the interactive overlay, then trigger Yomitan lookup to open context.</div> + <div class="step-desc">Hover a token in the overlay to open the Yomitan popup for that word.</div> </div> <div class="workflow-connector" aria-hidden="true"></div> <div class="workflow-step" style="animation-delay: 120ms"> <div class="step-number">03</div> <div class="step-title">Mine</div> - <div class="step-desc">Create cards from Yomitan or mine sentence cards directly from subtitle lines.</div> + <div class="step-desc">Add the word from Yomitan, or mine the whole line as a sentence card.</div> </div> <div class="workflow-connector" aria-hidden="true"></div> <div class="workflow-step" style="animation-delay: 180ms"> <div class="step-number">04</div> <div class="step-title">Enrich</div> - <div class="step-desc">Automatically attach timing-accurate audio, sentence text, and visual evidence.</div> + <div class="step-desc">SubMiner fills in the audio clip, the sentence, and a screenshot from that moment.</div> </div> <div class="workflow-connector" aria-hidden="true"></div> <div class="workflow-step" style="animation-delay: 240ms"> <div class="step-number">05</div> <div class="step-title">Track</div> - <div class="step-desc">Open the stats dashboard to review sessions, vocabulary trends, and mine cards from past viewing history.</div> + <div class="step-desc">Review past sessions and word trends, and mine anything you missed the first time.</div> </div> </div> </section> <section class="demo-section"> <h2>See it in action</h2> - <p>Subtitles, lookup flow, and card enrichment from a real playback session.</p> + <p>Recorded from an actual playback session: subtitle hover, lookup, and the card that comes out the other end.</p> <div class="demo-window"> <div class="demo-window__bar"> <span class="demo-window__dot"></span> diff --git a/docs-site/installation.md b/docs-site/installation.md index 2ab66030..6495fb47 100644 --- a/docs-site/installation.md +++ b/docs-site/installation.md @@ -1,6 +1,8 @@ # Installation -SubMiner is a desktop app that draws an interactive layer - an **overlay** - on top of the [mpv](https://mpv.io) video player. As you watch native Japanese media, you can click or hover any word in the subtitles to look it up, then turn it into an Anki flashcard without pausing to switch apps. Building flashcards from real content you're watching is called **sentence mining**, and it's what SubMiner is built for. It bundles its own copy of **Yomitan** (a pop-up dictionary) and talks to **AnkiConnect** (an add-on that lets other programs add cards to Anki) so cards get filled in automatically. +SubMiner draws an interactive overlay on top of the [mpv](https://mpv.io) video player. While you watch Japanese media, hover any word in the subtitles to look it up, then turn it into an Anki card without switching apps. + +Building cards from the content you are actually watching is called **sentence mining**, and it is the whole point of SubMiner. It bundles its own copy of **Yomitan** (a pop-up dictionary) and talks to **AnkiConnect** (the add-on that lets other programs write cards into Anki), so the sentence, audio, and screenshot fields get filled in for you. Three steps to get started: @@ -8,11 +10,11 @@ Three steps to get started: 2. **Install SubMiner** - from the AUR, or download from GitHub Releases 3. **Launch the app** - first-run setup walks you through dictionaries, the launcher, and everything else -## 1. Install Requirements +## 1. Install requirements -Only **mpv** is strictly required to run SubMiner. Everything else enhances the experience but is optional. +Only **mpv** is strictly required. Everything else is optional, though you will want ffmpeg unless you are fine with cards that have no audio or screenshot. -Several entries below exist only for the `subminer` command-line launcher, which is Linux and macOS only. On Windows you launch playback with the **SubMiner mpv** shortcut instead, so you can ignore those rows. +Some rows below matter only for the `subminer` command-line launcher, which is Linux and macOS only. On Windows you launch playback with the **SubMiner mpv** shortcut, so skip those. | Dependency | Status | Platforms | What it does | | -------------------- | ----------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -39,7 +41,7 @@ Several entries below exist only for the `subminer` command-line launcher, which - **X11 / Xwayland** - for X11 sessions or any other Wayland compositor (uses `xdotool` and `xwininfo`) ::: warning Wayland support is compositor-specific -Wayland has no universal API for window positioning - each compositor exposes its own IPC, so SubMiner needs a dedicated backend per compositor. Only Hyprland and Sway have native Wayland backends. If you run a different Wayland compositor (GNOME, KDE Plasma, river, etc.), both mpv **and** SubMiner must run under X11 or Xwayland. The `subminer` launcher handles this automatically when `--backend x11` is set or the X11 backend is auto-detected. +Wayland has no universal API for window positioning. Each compositor exposes its own IPC, so SubMiner needs a backend per compositor. Only Hyprland and Sway have native Wayland backends. If you run a different Wayland compositor (GNOME, KDE Plasma, river, etc.), both mpv **and** SubMiner must run under X11 or Xwayland. The `subminer` launcher handles this automatically when `--backend x11` is set or the X11 backend is auto-detected. ::: <details> @@ -260,7 +262,7 @@ First-run setup can install [Bun](https://bun.sh) and the `subminer` command-lin If you prefer to install it manually, see [manual launcher install](#manual-launcher-install-macos). ::: -### Windows (Installer) {#windows-installer} +### Windows (installer) {#windows-installer} Download the latest installer from [GitHub Releases](https://github.com/ksyasuda/SubMiner/releases/latest): @@ -269,7 +271,7 @@ Download the latest installer from [GitHub Releases](https://github.com/ksyasuda Make sure `mpv.exe` is on your `PATH`, or set `mpv.executablePath` in the config during first-run setup. -### From Source +### From source <details> <summary><b>Linux</b></summary> @@ -321,9 +323,9 @@ bun run build:win </details> -## 3. Launch & First-Run Setup +## 3. Launch and first-run setup -Launch SubMiner and the setup wizard will open automatically: +Launch SubMiner and the setup wizard opens on its own: ```bash # Linux (AUR install) @@ -350,7 +352,7 @@ The `Finish setup` button requires a config file and at least one Yomitan dictio > [!TIP] > You can re-open the setup wizard at any time with `subminer app --setup` or `SubMiner.AppImage --setup`. -### Play a Video +### Play a video Once setup is complete: @@ -358,13 +360,13 @@ Once setup is complete: subminer video.mkv ``` -You should see the overlay appear over mpv. If subtitles are loaded, they will appear as interactive text in the overlay. +The overlay appears over mpv. If a subtitle track loaded, its text shows up in the overlay as hoverable words. On **Windows**, the recommended way to play video is with the **SubMiner mpv** shortcut created during setup - double-click it, or drag a video file onto it. -### Verify Setup +### Verify setup -Run the built-in diagnostic to confirm everything is working: +Run the built-in diagnostic: ```bash subminer doctor @@ -372,7 +374,7 @@ subminer doctor This checks for the app binary, mpv, ffmpeg, yt-dlp, fzf, rofi, your config file, and the mpv socket path. Only the app binary and mpv are hard failures; the rest are reported as optional. Fix any hard failures before continuing. -## Anki Setup (Recommended) +## Anki setup (recommended) If you plan to mine Anki cards: @@ -398,15 +400,15 @@ The tray "Check for Updates" entry installs the new app automatically on Linux, `subminer -u` also performs the AppImage, launcher, and managed support-asset updates directly from the launcher process, which is useful when SubMiner is not currently running. -## How It All Fits Together +## How it all fits together -SubMiner is an overlay that sits on top of mpv. It connects to mpv through an IPC socket, renders subtitles as interactive text using a bundled Yomitan dictionary engine, and optionally creates Anki flashcards via AnkiConnect. +SubMiner is an overlay window that sits on top of mpv. It talks to mpv over an IPC socket, renders each subtitle line as interactive text backed by the bundled Yomitan dictionary engine, and writes Anki cards through AnkiConnect when you ask it to. The `subminer` launcher handles mpv IPC socket setup automatically. If you launch mpv yourself or from another tool, you must pass `--input-ipc-server=/tmp/subminer-socket` (or `\\.\pipe\subminer-socket` on Windows) - without it the overlay starts but subtitles won't appear. -The bundled mpv plugin is injected at runtime automatically - you don't need to install it separately. On Linux, the `subminer` launcher checks for its managed runtime plugin copy, rofi theme, and scoped thumbnailer registration before every mpv-managed launch and installs those support assets from the bundled app automatically if one is missing. For a rofi picker launch, this check runs before the picker opens. It provides in-player keybindings (the `y` chord) for controlling the overlay from within mpv. See [MPV Plugin](/mpv-plugin) for the full keybinding and configuration reference. +SubMiner injects the bundled mpv plugin at runtime, so there is nothing to install separately. On Linux, the `subminer` launcher checks for its managed runtime plugin copy, rofi theme, and scoped thumbnailer registration before every mpv-managed launch and installs those support assets from the bundled app automatically if one is missing. For a rofi picker launch, this check runs before the picker opens. The plugin adds in-player keybindings (the `y` chord) for driving the overlay from mpv. See [MPV Plugin](/mpv-plugin) for the full keybinding and configuration reference. -## Platform Notes +## Platform notes ### macOS @@ -415,9 +417,9 @@ The bundled mpv plugin is injected at runtime automatically - you don't need to - Apple Silicon (M1/M2): `/opt/homebrew/bin/mecab` - Intel: `/usr/local/bin/mecab` -Ensure `mecab` is available on your PATH when launching SubMiner. +`mecab` has to be on your PATH when SubMiner launches. -**Fullscreen:** The overlay should appear correctly in fullscreen. If you encounter issues, check that accessibility permissions are granted. +**Fullscreen:** The overlay follows mpv into fullscreen. If it does not, accessibility permission is the usual cause. ### Windows @@ -426,7 +428,7 @@ Ensure `mecab` is available on your PATH when launching SubMiner. - IPC socket on Windows is `\\.\pipe\subminer-socket` - do not use `/tmp/subminer-socket`. - Config is stored at `%APPDATA%\SubMiner\config.jsonc`. -## Manual Launcher Install +## Manual launcher install The `subminer` launcher uses a [Bun](https://bun.sh) shebang, so Bun must be installed. First-run setup can handle this automatically, but if you prefer to do it yourself: @@ -452,9 +454,9 @@ sudo curl -fSL https://github.com/ksyasuda/SubMiner/releases/latest/download/sub sudo chmod +x /usr/local/bin/subminer ``` -## Optional Extras +## Optional extras -### Linux Support Assets +### Linux support assets SubMiner ships the Linux rofi theme, scoped Matroska thumbnailer registration, and launcher-managed runtime plugin copy in `subminer-assets.tar.gz`: diff --git a/docs-site/ipc-contracts.md b/docs-site/ipc-contracts.md index 44ce3a62..71770631 100644 --- a/docs-site/ipc-contracts.md +++ b/docs-site/ipc-contracts.md @@ -1,10 +1,10 @@ -# IPC + Runtime Contracts +# IPC + runtime contracts -SubMiner's Electron app runs two isolated processes - main and renderer - that can only communicate through IPC channels. This boundary is intentional: the renderer is an untrusted surface (it loads Yomitan, renders user-controlled subtitle text, and runs in a Chromium sandbox), so every message crossing the bridge passes through a validation layer before it can reach domain logic. +SubMiner's Electron app runs two isolated processes, main and renderer, and IPC channels are the only way they talk. That boundary is deliberate. The renderer is an untrusted surface: it loads Yomitan, renders subtitle text SubMiner did not write, and runs in a Chromium sandbox. Every message crossing the bridge goes through a validator before any domain code sees it. -The contract system enforces this by making channel names, payload shapes, and validators co-located and co-evolved. A change to any IPC surface touches the contract, the validator, the preload bridge, and the handler in the same commit - drift between any of those layers is treated as a bug. +Channel names, payload shapes, and validators all live together, so they change together. Touching an IPC surface means updating the contract, the validator, the preload bridge, and the handler in one commit. Drift between those four layers is a bug, not a style preference. -## Message Flow +## Message flow Renderer-initiated calls (`invoke`) pass through four boundaries before reaching a service. Fire-and-forget messages (`send`) follow the same path but skip the response leg. Malformed payloads are caught at the validator and never reach domain code. @@ -36,7 +36,7 @@ flowchart TB style E fill:#ed8796,stroke:#494d64,color:#24273a,stroke-width:1.5px ``` -## Runtime Sockets +## Runtime sockets The renderer↔main bridge above lives *inside* the Electron app. A separate set of OS sockets connects the app to the other runtimes - mpv and the launcher/plugin. These carry no renderer payloads and bypass the contract/validator layer; they are command and property channels between processes. @@ -67,7 +67,7 @@ flowchart LR How these sockets are established during launch is covered in [Playback Startup Flow](./architecture#playback-startup-flow). -## Core Surfaces +## Core surfaces | File | Role | | --- | --- | @@ -79,7 +79,7 @@ How these sockets are established during launch is covered in [Playback Startup | `src/core/services/anki-jimaku-ipc.ts` | Integration-specific IPC boundary for Anki and Jimaku operations. | | `src/main/cli-runtime.ts` | CLI/runtime command boundary. Handles commands that originate from the launcher or mpv plugin rather than the renderer. | -## Contract Rules +## Contract rules These rules exist to prevent a class of bugs where the renderer and main process silently disagree about message shapes - which surfaces as undefined fields, swallowed errors, or state corruption. @@ -89,13 +89,13 @@ These rules exist to prevent a class of bugs where the renderer and main process - **Keep payloads narrow.** Send only what the handler needs. Avoid passing entire state objects across the bridge - it couples the renderer to internal main-process structure. - **Co-evolve all layers.** When a payload shape changes, update `contracts.ts`, `validators.ts`, `preload.ts`, and the handler in the same commit. Partial updates are treated as bugs. -## Two Message Patterns +## Two message patterns **Invoke (request/response):** The renderer calls a typed bridge method and awaits a result. The main process validates the payload, runs the handler, and returns a structured response. Used for operations where the renderer needs a result - lookups, config reads, mining actions. **Fire-and-forget (send):** The renderer sends a message with no response. The main process validates and handles it silently. Malformed payloads are dropped. Used for notifications where the renderer doesn't need confirmation - UI state hints, focus events, position updates. -## Add a New IPC Action +## Add a new IPC action 1. Add the channel constant in `src/shared/ipc/contracts.ts`. 2. Add or extend the payload validator in `src/shared/ipc/validators.ts`. @@ -104,7 +104,7 @@ These rules exist to prevent a class of bugs where the renderer and main process 5. Add tests for both valid and malformed payload cases in `src/core/services/*`. 6. Update renderer tests when behavior or state transitions change. -## Runtime State Notes +## Runtime state notes - Prefer runtime/domain composition via `src/main/runtime/composers/*` and `src/main/runtime/domains/*`. IPC handlers should delegate to composers rather than containing orchestration logic. - Route shared mutable state updates through transition helpers in `src/main/state.ts` for migrated domains. Direct mutation from IPC handlers bypasses invariant checks. @@ -116,7 +116,7 @@ These rules exist to prevent a class of bugs where the renderer and main process - **Renderer invoke fails:** Verify the preload bridge method exists and matches the channel constant. Check that the handler is registered and returning (not throwing). - **Contract drift:** When invoke calls return unexpected shapes, compare the shared contract, validator, preload bridge, and main handler signatures side by side. One of them was updated without the others. -## Related Docs +## Related docs - [Architecture](/architecture) - [Development](/development) diff --git a/docs-site/jellyfin-integration.md b/docs-site/jellyfin-integration.md index a07197a2..4e29be34 100644 --- a/docs-site/jellyfin-integration.md +++ b/docs-site/jellyfin-integration.md @@ -1,12 +1,12 @@ -# Jellyfin Integration +# Jellyfin integration -[Jellyfin](https://jellyfin.org) is a free, self-hosted media server - think of it as your own private streaming service for video you own. If you keep your anime on a Jellyfin server, SubMiner can play episodes through mpv with the full mining overlay. +[Jellyfin](https://jellyfin.org) is a free, self-hosted media server, a private streaming service for video you already own. If your anime lives on a Jellyfin server, SubMiner plays episodes from it through mpv with the mining overlay attached. ::: tip Who needs this? -This page is only relevant if you already run (or have access to) a Jellyfin server. If you watch local files or YouTube, you can skip it. The in-app setup window (`subminer jellyfin`) is the easiest starting point. +This page only matters if you already run a Jellyfin server or have access to one. Watching local files or YouTube? Skip it. Otherwise start with the in-app setup window (`subminer jellyfin`). ::: -SubMiner can act as a **cast-to-device target** for Jellyfin (similar to jellyfin-mpv-shim). Sign in once, turn on discovery, and SubMiner shows up in the "Play on…" / cast menu of any Jellyfin app - web, phone, or TV. Pick an episode, cast it to SubMiner, and it plays in SubMiner's mpv window with the full overlay and Yomitan click-to-lookup. +SubMiner can register itself as a **cast-to-device target**, the way jellyfin-mpv-shim does. Sign in once, turn on discovery, and SubMiner appears in the "Play on" menu of any Jellyfin client, whether that is the web app, your phone, or a TV. Cast an episode and it opens in SubMiner's mpv window with the overlay and Yomitan lookup live. This is the recommended way to use Jellyfin with SubMiner. A terminal-only option is covered in [Launcher playback](#launcher-playback) at the end. @@ -18,11 +18,11 @@ This is the recommended way to use Jellyfin with SubMiner. A terminal-only optio ## Quick start -### 1. Start SubMiner +### 1. start SubMiner -Launch SubMiner so it's running in the system tray. +Launch SubMiner and leave it in the system tray. -### 2. Sign in to your server +### 2. sign in to your server Open the tray menu and click **Configure Jellyfin**. In the window that opens, enter your **Server URL** (for example `http://127.0.0.1:8096`), **Username**, and **Password**, then click **Login**. @@ -34,14 +34,14 @@ On success, SubMiner: Reopen this window any time to switch servers or **Logout**. -### 3. Turn on discovery +### 3. turn on discovery Discovery is what makes SubMiner appear as a cast target. Two ways to enable it: - **For the current session** - open the tray menu and tick **Jellyfin Discovery**. (This item appears once you've signed in.) - **Automatically on every launch** - already on by default. After your first sign-in, SubMiner auto-connects to Jellyfin at startup, so the cast target is ready without touching the tray. You can change this under [Settings](#settings). -### 4. Cast from any Jellyfin app +### 4. cast from any Jellyfin app In the Jellyfin web UI or mobile app, start playing something, open the **cast / "Play on"** menu, and pick your device - SubMiner appears there named after your computer's hostname. Playback opens in SubMiner. diff --git a/docs-site/jimaku-integration.md b/docs-site/jimaku-integration.md index de387548..cb6841d1 100644 --- a/docs-site/jimaku-integration.md +++ b/docs-site/jimaku-integration.md @@ -1,16 +1,16 @@ -# Jimaku Integration +# Jimaku integration -[Jimaku](https://jimaku.cc) is a community-driven subtitle repository for anime - a shared online library of subtitle files contributed by other learners. SubMiner integrates with the Jimaku API so you can search, browse, and download Japanese subtitle files directly from the overlay - no alt-tabbing or manual file management required. Downloaded subtitles are loaded into mpv immediately. +[Jimaku](https://jimaku.cc) is a community subtitle repository for anime, built from files other learners uploaded. SubMiner talks to the Jimaku API, so you search, browse, and download Japanese subtitle files from inside the overlay. No alt-tabbing, no moving files around. A downloaded track loads into mpv right away. ::: tip Prerequisite: a free API key You need a Jimaku account and an API key (a personal access string) before this feature works. Create an account at [jimaku.cc](https://jimaku.cc), copy your key, and add it to your config as shown under [Configuration](#configuration) below. Without a key, the search modal will report "Jimaku API key not set." ::: -## How It Works +## How it works The Jimaku integration runs through an in-overlay modal accessible via a keyboard shortcut (`Ctrl+Shift+J` by default). -When you open the modal, SubMiner parses the current video filename to extract a title, season, and episode number. Common naming conventions are supported - `S01E03`, `1x03`, `E03`, and dash-separated episode numbers all work. If the filename yields a high-confidence match (title + episode), SubMiner auto-searches immediately. +When you open the modal, SubMiner parses the current video filename to extract a title, season, and episode number. It handles `S01E03`, `1x03`, `E03`, and dash-separated episode numbers. If the filename yields a high-confidence match (title + episode), SubMiner auto-searches immediately. From there: @@ -21,7 +21,7 @@ From there: If no files match the current episode filter, a "Show all files" button lets you broaden the search to all episodes for that entry. -### Modal Keyboard Shortcuts +### Modal keyboard shortcuts | Key | Action | | --- | --- | @@ -64,7 +64,7 @@ The keyboard shortcut is configured separately under `shortcuts`: } ``` -### API Key +### API key An API key is required to use the Jimaku integration. You can get one from [jimaku.cc](https://jimaku.cc). There are two ways to provide it: @@ -73,7 +73,7 @@ An API key is required to use the Jimaku integration. You can get one from [jima If both are set, `apiKey` takes priority. -## Filename Parsing +## Filename parsing SubMiner extracts media info from the current video path to pre-fill the search fields. The parser handles: diff --git a/docs-site/launcher-script.md b/docs-site/launcher-script.md index 0310eec6..5c384c1b 100644 --- a/docs-site/launcher-script.md +++ b/docs-site/launcher-script.md @@ -1,14 +1,14 @@ -# Launcher Script +# Launcher script -The `subminer` launcher is an all-in-one script that handles video selection, mpv startup, and overlay management. It is the recommended way to use SubMiner on Linux and macOS because it guarantees mpv is launched with the correct IPC socket and SubMiner defaults. It's a Bun script distributed as a release asset alongside the AppImage and DMG. +The `subminer` launcher handles video selection, mpv startup, and overlay management in one script. Use it on Linux and macOS: it is the only path that guarantees mpv comes up with the right IPC socket and SubMiner's defaults. It is a Bun script, shipped as a release asset next to the AppImage and DMG. ::: tip Windows users On Windows, the recommended way to launch playback is the **SubMiner mpv** shortcut created during first-run setup - double-click it, drag a file onto it, or run `SubMiner.exe --launch-mpv` from a terminal. See [Windows mpv Shortcut](/usage#windows-mpv-shortcut) for details. ::: -## Video Picker +## Video picker -When you run `subminer` without specifying a file, it opens an interactive video picker. By default it uses **fzf** in the terminal; pass `-R` to use **rofi** instead. +Run `subminer` with no file and it opens an interactive picker. That is **fzf** in the terminal by default, or **rofi** with `-R`. ### fzf (default) @@ -66,7 +66,7 @@ Override with the `SUBMINER_ROFI_THEME` environment variable: SUBMINER_ROFI_THEME=/path/to/custom-theme.rasi subminer -R ``` -## Watch History +## Watch history `subminer -H` (or `--history`) browses your local watch history, sourced from the immersion tracker database. It works with both pickers: fzf by default, rofi with `-R -H`. @@ -87,7 +87,7 @@ After an episode ends or you close mpv, the launcher returns to an action menu f Series whose directories are not currently accessible (e.g. an unmounted network share) are hidden from the list. Watch history requires the immersion tracker database (`immersionTracking.dbPath`, default `<config dir>/immersion.sqlite`), which SubMiner populates during playback. -## Sync Between Machines +## Sync between machines `subminer sync <host>` merges immersion stats and watch history between two machines over SSH, so both end up with the union of sessions, lifetime totals, vocabulary counts, daily/monthly charts, and `--history` entries. `<host>` is anything `ssh` accepts (`user@hostname` or an ssh config alias); SubMiner must be installed on both machines at the same version. The sync engine runs only inside the app (`SubMiner --sync-cli sync ...`): the sync window spawns it that way, `subminer sync` is a thin proxy that forwards to the installed app, and the remote side is found automatically whether it has the launcher or just the app. The command-line launcher is optional everywhere. @@ -135,7 +135,7 @@ Unfinished sessions (a crash mid-playback) are skipped until the app finalizes t Hosts with **Auto-sync** enabled are synced in the background on a configurable interval (default every 60 minutes), including during active playback; results surface as overlay notifications. The unfinished playback session is skipped until a later sync sees it finalized. Host bookkeeping lives in `<config dir>/sync-hosts.json`. -## Common Commands +## Common commands ```bash subminer video.mkv # play a specific file (managed launches auto-start the visible overlay by default) diff --git a/docs-site/mining-workflow.md b/docs-site/mining-workflow.md index 79d1b332..5c1dd219 100644 --- a/docs-site/mining-workflow.md +++ b/docs-site/mining-workflow.md @@ -1,20 +1,20 @@ -# Mining Workflow +# Mining workflow -This guide walks through the sentence mining loop - from watching a video to creating Anki cards with audio, screenshots, and context. +This guide walks the whole sentence mining loop, from starting a video to ending up with an Anki card that has audio, a screenshot, and the surrounding sentence. ## Overview -_Sentence mining_ means turning real sentences you encounter while watching native video into Anki flashcards, so you learn vocabulary in the context where you actually met it. SubMiner automates the tedious parts of that loop. +_Sentence mining_ means turning sentences you hit while watching native video into Anki cards, so you learn a word in the context where you first met it. The idea is old. The tedious part is everything between spotting the word and having a finished card, and that is the part SubMiner does for you. -SubMiner runs as a transparent overlay on top of mpv (the video player). As subtitles play, the overlay displays them as interactive text. You hover a word, trigger a Yomitan dictionary lookup with your configured lookup key/modifier, then create an Anki card with a single action. SubMiner automatically attaches the sentence, an audio clip, and a screenshot to that card - no manual copy-pasting or screen capturing. +SubMiner draws a transparent overlay on top of mpv and renders each subtitle line as interactive text. Hover a word, trigger a Yomitan lookup with your configured key or modifier, then add the card. SubMiner attaches the sentence, an audio clip, and a screenshot on its own, so there is nothing to copy-paste or screenshot by hand. > **Yomitan** is the popup dictionary that shows definitions when you hover or scan a word. **AnkiConnect** is the add-on that lets SubMiner talk to Anki. Both are set up during installation - see [Anki Integration](/anki-integration) if you have not configured them yet. -## Creating Anki Cards +## Creating Anki cards There are four ways to create or enrich cards, depending on your workflow. -### 1. Auto-Update from Yomitan +### 1. Auto-update from Yomitan This is the most common flow. Yomitan creates a card in Anki, and SubMiner enriches it automatically. @@ -27,23 +27,22 @@ This is the most common flow. Yomitan creates a card in Anki, and SubMiner enric - **Sentence**: The current subtitle line. - **Audio**: Extracted from the video using the subtitle's start/end timing (plus optional configured padding). - **Image**: A screenshot or animated clip from the current playback position. - - **Translation**: From the secondary subtitle track, or generated via AI if configured. - **MiscInfo**: Metadata like filename and timestamp. Configure which fields to fill in `ankiConnect.fields`. See [Anki Integration](/anki-integration) for details. -### 2. Manual Update from Clipboard +### 2. manual update from clipboard If you prefer a hands-on approach (animecards-style), you can copy the current subtitle to the clipboard and then paste it onto the last-added Anki card: 1. Add a word via Yomitan as usual. 2. Press `Ctrl/Cmd+C` to copy the current subtitle line to the clipboard. - For multiple lines: press `Ctrl/Cmd+Shift+C`, then a digit `1`–`9` to select how many recent subtitle lines to combine. The combined text is copied to the clipboard. -3. Press `Ctrl/Cmd+V` to update the last-added card with the clipboard contents plus audio, image, and translation - the same fields auto-update would fill. +3. Press `Ctrl/Cmd+V` to update the last-added card with the clipboard contents plus audio and image, the same fields auto-update would fill. Manual clipboard updates always replace generated sentence audio in `ankiConnect.fields.audio`, even when `ankiConnect.behavior.overwriteAudio` is disabled. Normal word-card updates use the configured sentence and audio fields even when Lapis or Kiku support is enabled. -This is useful when auto-update is disabled or when you want explicit control over which subtitle line gets attached to the card. +Use this when auto-update is off, or when the line you want on the card is not the line currently on screen. | Shortcut | Action | Config key | | -------------------------- | ------------------------------- | --------------------------------------- | @@ -51,7 +50,7 @@ This is useful when auto-update is disabled or when you want explicit control ov | `Ctrl/Cmd+Shift+C` + digit | Copy multiple recent lines | `shortcuts.copySubtitleMultiple` | | `Ctrl/Cmd+V` | Update last card from clipboard | `shortcuts.updateLastCardFromClipboard` | -### 3. Mine Sentence (Hotkey) +### 3. mine Sentence (hotkey) Create a standalone sentence card without going through Yomitan: @@ -64,7 +63,7 @@ The sentence card uses the note type configured in `isLapis.sentenceCardModel` a Sentence card creation requires `ankiConnect.isLapis.sentenceCardModel` to name a [Lapis](https://github.com/donkuri/lapis) or [Kiku](https://github.com/youyoumu/kiku) compatible note type that exists in Anki (default: `"Lapis"`). See [Anki Integration - Sentence Cards](/anki-integration#sentence-cards-lapis) for setup. ::: -### 4. Mark as Audio Card +### 4. mark as audio card After adding a word via Yomitan, press the audio card shortcut (`Ctrl/Cmd+Shift+A` by default, `shortcuts.markAudioCard`) to mark the card as an audio card. This sets the audio-card flag and fills sentence, image, and metadata fields alongside the full-subtitle audio clip. @@ -72,9 +71,9 @@ After adding a word via Yomitan, press the audio card shortcut (`Ctrl/Cmd+Shift+ Audio card marking uses the same `ankiConnect.isLapis.sentenceCardModel` note type as sentence cards. See [Anki Integration - Sentence Cards](/anki-integration#sentence-cards-lapis) for setup. ::: -### Field Grouping (Kiku/Senren) +### Field grouping (Kiku/Senren) -If you mine the same word from different sentences, SubMiner can merge the cards instead of creating duplicates. This feature is designed for use with [Kiku](https://github.com/youyoumu/kiku) and [Senren](https://github.com/BrenoAqua/Senren) note types that support grouped fields (Senren calls it scene switching). +If you mine the same word from different sentences, SubMiner can merge the cards instead of creating duplicates. This is built for [Kiku](https://github.com/youyoumu/kiku) and [Senren](https://github.com/BrenoAqua/Senren) note types that support grouped fields (Senren calls it scene switching). 1. You add a word via Yomitan. 2. SubMiner detects the new card and checks if a card with the same expression already exists. @@ -84,15 +83,15 @@ If you mine the same word from different sentences, SubMiner can merge the cards See [Anki Integration - Field Grouping](/anki-integration#field-grouping-kiku-senren) for configuration options, merge behavior, and modal keyboard shortcuts. -## Overlay Model +## Overlay model SubMiner uses one overlay window with modal surfaces. It carries two subtitle bars - a primary reading bar and a secondary translation/context bar - plus modal dialogs that open on top. Toggle the entire overlay window with `Alt+Shift+O` (global) or `y-t` (mpv plugin). -### Primary Subtitle Layer +### Primary subtitle layer -The primary bar renders subtitles as tokenized hoverable word spans. Each word is a separate element with reading and headword data attached. This plane is styled independently from mpv subtitles and supports: +The primary bar renders each subtitle as separate hoverable word spans, each carrying its reading and headword. Its styling is independent of mpv's own subtitle rendering. It supports: - Word-level hover targets for Yomitan lookup - Auto pause/resume on subtitle hover (enabled by default via `subtitleStyle.autoPauseVideoOnHover`) @@ -101,20 +100,17 @@ The primary bar renders subtitles as tokenized hoverable word spans. Each word i - Right-click + drag to reposition subtitles - **Reading annotations** - known words, N+1 targets, character-name matches, JLPT levels, and frequency hits can all be visually highlighted -### Secondary Subtitle Bar +### Secondary subtitle bar -The secondary bar is a compact top-strip region in the same overlay window. It shows a secondary subtitle track (typically English) for translation/context while keeping the primary reading flow below. It is useful for: - -- Quick comprehension checks without leaving the mining flow. -- Auto-populating the translation field on mined cards - when a card is created, SubMiner uses the secondary subtitle text as the translation field value (unless AI translation is configured to override it). +The secondary bar is a compact top-strip region in the same overlay window. It shows a secondary subtitle track, usually English, above the primary reading line. Use it to sanity-check your comprehension without breaking out of the mining flow. For local media, SubMiner can parse supported embedded secondary tracks into timed cues. For remote URLs and files on network mounts, it uses mpv's live secondary subtitle text instead of scanning the media with ffmpeg. -It is controlled by `secondarySub` configuration and shares its lifecycle with the main overlay window. Cycle which track feeds it with `Shift+J`. +The `secondarySub` config controls it, and it opens and closes with the main overlay window. Cycle which track feeds it with `Shift+J`. SubMiner collapses duplicate ASS layers in parsed secondary tracks. Exact repeated lines collapse at any length, while distinct simultaneous short lines remain separate. Long dialogue and positioned-sign copies also collapse when they differ only in whitespace or terminal punctuation. Dense multi-row sign layouts, such as translated timetables, are excluded instead of being concatenated into the secondary bar. -### Display Modes +### Display modes Both the primary and secondary subtitle bars share the same three visibility modes, and each can be changed independently at runtime: @@ -131,11 +127,11 @@ Cycle each bar's mode at runtime with its own shortcut: | `V` | Cycle primary subtitle mode (hidden → visible → hover) | overlay-local | | `Ctrl/Cmd+Shift+V` | Cycle secondary subtitle mode (hidden → visible → hover) | `shortcuts.toggleSecondarySub` | -### Modal Surfaces +### Modal surfaces Jimaku search, field-grouping, runtime options, and manual subsync open as modal surfaces on top of the same overlay window. -## Looking Up Words +## Looking up words 1. Hover over the subtitle area - the overlay activates pointer events. 2. Hover the word you want. SubMiner keeps per-token boundaries so Yomitan can target that token cleanly. @@ -143,7 +139,7 @@ Jimaku search, field-grouping, runtime options, and manual subsync open as modal 4. Yomitan opens its lookup popup for the hovered token. 5. From the popup, add the word to Anki. -### Controller Workflow +### Controller workflow With a gamepad connected and keyboard-only mode enabled, the full mining loop works without a mouse or keyboard: @@ -155,11 +151,11 @@ With a gamepad connected and keyboard-only mode enabled, the full mining loop wo 6. **Close** - press `B` to dismiss the Yomitan popup and return to subtitle navigation. 7. **Pause/resume** - press `L3` (left stick click) to toggle mpv pause at any time. -After controller support is enabled, the controller and keyboard can be used interchangeably - switching mid-session is seamless. Toggle keyboard-only mode on or off with `Y` on the controller. +Once controller support is on, the controller and keyboard both stay live. You can drop the controller mid-episode and keep going with the keyboard. Toggle keyboard-only mode with `Y` on the controller. See [Usage - Controller Support](/usage#controller-support) for setup details and [Configuration - Controller Support](/configuration#controller-support) for the full mapping and tuning options. -## Subtitle Sync (Subsync) +## Subtitle sync (subsync) If your subtitle file is out of sync with the audio, SubMiner can resynchronize it using [alass](https://github.com/kaegi/alass) or [ffsubsync](https://github.com/smacke/ffsubsync). @@ -173,24 +169,22 @@ The reference and the out-of-sync subtitle must be different tracks; the referen For remote streams, including Jellyfin playback, the modal only offers alass with a subtitle reference. Jellyfin subtitle URLs are cached as temporary subtitle files so alass can read them, but the video stream is not downloaded. ffsubsync and the video-file reference need direct access to the local media file and are unavailable for stream URLs. -When you mine a sentence card from the stats dashboard, SubMiner can also use `alass` automatically to align a local English sidecar against the matching local Japanese sidecar before filling the card translation field. The source subtitle files are not modified; SubMiner writes a temporary retimed copy and reuses it while the stats server is running. - Install the sync tools separately - see [Troubleshooting](/troubleshooting#subtitle-sync-subsync) if the tools are not found. ## Texthooker -SubMiner runs a local HTTP server at `http://127.0.0.1:5174` (fixed default port; overridable only via the mpv plugin's `texthooker_port` script-opt) that serves a texthooker UI. This allows external tools - such as a browser-based Yomitan instance - to receive subtitle text in real time. +SubMiner serves a texthooker UI from a local HTTP server at `http://127.0.0.1:5174`. The port is fixed unless you override it with the mpv plugin's `texthooker_port` script-opt. External tools read subtitle text from it as lines arrive, which is how you would feed a browser-based Yomitan instance. The texthooker page displays the current subtitle and updates as new lines arrive. This is useful if you prefer to do lookups in a browser rather than through the overlay's built-in Yomitan. If you want to build your own browser client, websocket consumer, or automation relay, see [WebSocket / Texthooker API & Integration](/websocket-texthooker-api). -## Related Features +## Related features -These features support the mining loop but have their own dedicated pages: +These feed into the mining loop but each has its own page: - **[Jimaku subtitle search](/jimaku-integration)** - search and download anime subtitle files directly from the overlay (`Ctrl+Shift+J` by default), then load them into mpv. -- **[N+1 word highlighting](/subtitle-annotations#n-1-word-highlighting)** - cross-reference your Anki decks to highlight known words, making true N+1 sentences (exactly one unknown word) easy to spot during immersion. +- **[N+1 word highlighting](/subtitle-annotations#n-1-word-highlighting)** - reads your Anki decks and highlights words you already know, so a line with exactly one unknown word stands out while you watch. - **[Immersion tracking](/immersion-tracking)** - log watching and mining activity to a local database and view session times, words seen, and cards mined in the built-in stats dashboard. Next: [Anki Integration](/anki-integration) - field mapping, media generation, and card enrichment configuration. diff --git a/docs-site/mpv-plugin.md b/docs-site/mpv-plugin.md index 01112d8c..16036993 100644 --- a/docs-site/mpv-plugin.md +++ b/docs-site/mpv-plugin.md @@ -1,12 +1,12 @@ -# MPV Plugin +# MPV plugin -**What this is:** mpv is the video player SubMiner overlays subtitles on. The SubMiner mpv plugin is a small Lua script that runs _inside_ mpv and gives you in-player keybindings to control the SubMiner overlay (start/stop/toggle, skip intro, etc.) without leaving the player window. +The SubMiner mpv plugin is a small Lua script that runs _inside_ mpv. It binds in-player keys for controlling the overlay, so start, stop, toggle, and skip-intro all work without leaving the player window. -**Who needs this page:** Most users never touch the plugin directly - SubMiner-managed launches (the app, the `subminer` launcher, or the Windows shortcut) inject the bundled plugin automatically for that session, so there is nothing to install into mpv's global `scripts` directory. Read on if you launch mpv from another tool and want SubMiner's in-player controls, or you want to script mpv against SubMiner. +Most people never touch it. Any SubMiner-managed launch, whether from the app, the `subminer` launcher, or the Windows shortcut, injects the bundled plugin for that session, and nothing lands in mpv's global `scripts` directory. Keep reading if you launch mpv from some other tool and still want the in-player controls, or you want to script mpv against SubMiner. -The plugin ships as a modular Lua package under `plugin/subminer/` (entry point `main.lua`, which loads `init.lua` and sibling modules). Earlier releases shipped a single global `main.lua`; runtime loading replaces it. +The plugin is a modular Lua package under `plugin/subminer/`. `main.lua` is the entry point and loads `init.lua` plus its sibling modules. Earlier releases installed a single global `main.lua`; runtime loading replaced that. -## Runtime Loading +## Runtime loading Launch mpv through the SubMiner app, the `subminer` launcher, or the packaged Windows SubMiner mpv shortcut. These paths pass mpv a bundled plugin path for that playback session only, leaving regular mpv playback untouched. @@ -67,7 +67,7 @@ The AniSkip key is **not** a `y` chord and is not bound by the plugin: the SubMi The bare `v` binding is a forced mpv binding. It overrides mpv's default primary subtitle visibility toggle and routes the action to SubMiner's primary subtitle bar instead. -## Shared Shortcuts (Session Bindings) +## Shared shortcuts (session bindings) The `y-*` chords above are built into the plugin. Everything else you configure under [`shortcuts.*`](/shortcuts) - plus any custom [`keybindings`](/configuration) and the stats toggle/mark-watched keys - is **injected into mpv at runtime**, so the same shortcut works both inside mpv and in the SubMiner overlay. You do not edit any mpv config to enable them. @@ -104,7 +104,7 @@ SubMiner: Select an item by pressing its number. -## Binary Auto-Detection +## Binary auto-detection When `binary_path` is empty, the plugin searches platform-specific locations: @@ -131,7 +131,7 @@ A PowerShell system lookup runs first (running SubMiner process, registry App Pa On Windows the plugin also normalizes a Unix-style `socket_path` (`/tmp/subminer-socket`) to the named pipe `\\.\pipe\subminer-socket` at runtime. -## Backend Detection +## Backend detection When `backend=auto`, the plugin detects the window manager: @@ -145,7 +145,7 @@ When `backend=auto`, the plugin detects the window manager: Native Wayland support is only available for Hyprland and Sway. If you use a different Wayland compositor, auto-detection will fall back to X11 - both mpv and SubMiner must be running under Xwayland, and `xdotool` and `xwininfo` must be installed. ::: -## Script Messages +## Script messages The plugin can be controlled from other mpv scripts or the mpv command line using script messages: @@ -189,7 +189,7 @@ For how the plugin's auto-start fits into the full launch sequence - including w - **MPV shutdown**: The plugin clears its hover/OSD/gate state on shutdown; the overlay app notices the closed IPC socket and shuts itself down. - **Texthooker**: When `texthooker_enabled=yes`, the plugin appends `--texthooker` to the overlay start command so the app starts the texthooker server alongside the overlay. -## Using with the `subminer` Wrapper +## Using with the `subminer` wrapper The `subminer` wrapper script handles mpv launch, socket setup, and overlay lifecycle automatically. You do not need the plugin if you always use the wrapper. diff --git a/docs-site/shortcuts.md b/docs-site/shortcuts.md index 8a64e99e..ca35051b 100644 --- a/docs-site/shortcuts.md +++ b/docs-site/shortcuts.md @@ -1,4 +1,4 @@ -# Keyboard Shortcuts +# Keyboard shortcuts This page is the complete reference for every keystroke SubMiner responds to. If you are just getting started, focus on the **Mining Shortcuts** and **Overlay Controls** sections - those cover the day-to-day mining loop. The rest can wait until you need them. @@ -10,7 +10,7 @@ A few terms used throughout: All shortcuts are configurable in `config.jsonc` under `shortcuts` and `keybindings`. Set any shortcut to `null` to disable it. -## App-Wide Shortcuts +## App-wide shortcuts | Shortcut | Action | Scope | Configurable | | ------------- | ---------------------- | -------------------------------------------- | -------------------------------------- | @@ -21,7 +21,7 @@ All shortcuts are configurable in `config.jsonc` under `shortcuts` and `keybindi `Alt+Shift+O` is dispatched by the overlay window and the mpv plugin, so it works from either surface without OS registration. Only `Alt+Shift+Y` is registered with the OS; if it conflicts with another application, that binding cannot be changed. All `shortcuts.*` keys hot-reload - no restart needed. ::: -## Mining Shortcuts +## Mining shortcuts These work when the overlay window has focus. @@ -39,7 +39,7 @@ When text is selected in the [subtitle sidebar](./subtitle-sidebar.md#selecting- The multi-line shortcuts open a digit selector with a 3-second timeout (`shortcuts.multiCopyTimeoutMs`). Press `1`–`9` to select the total number of subtitle lines to combine, ending at the current line and moving backward through the subtitle timeline. The current line counts toward the selected total. When the shortcut starts from mpv, SubMiner focuses the visible overlay for that selector instead of reserving the number keys in the mpv plugin. -## Overlay Controls +## Overlay controls These control playback and subtitle display. They require overlay window focus. @@ -75,7 +75,7 @@ On macOS managed playback, SubMiner disables mpv's menu-bar shortcuts so configu Mouse-hover playback behavior is configured separately from shortcuts: `subtitleStyle.autoPauseVideoOnHover` defaults to `true` (pause on subtitle hover, resume on leave). -## Subtitle & Feature Shortcuts +## Subtitle and feature shortcuts | Shortcut | Action | Config key | | ------------------ | -------------------------------------------------------- | ------------------------------------------ | @@ -99,7 +99,7 @@ The stats toggle is handled inside the focused visible overlay window. It is con The subtitle sidebar toggle is overlay-local and only opens when SubMiner has a parsed cue list for the active subtitle source. -## Controller Shortcuts +## Controller shortcuts These overlay-local shortcuts open controller utilities for the Chrome Gamepad API integration. @@ -110,7 +110,7 @@ These overlay-local shortcuts open controller utilities for the Chrome Gamepad A Controller input only drives the overlay while keyboard-only mode is enabled. The controller mapping and tuning live under the top-level `controller` config block; keyboard-only mode still works normally without a controller. -## MPV Plugin Chords +## MPV plugin chords When the mpv plugin is installed, all commands use a `y` chord prefix - press `y`, then the second key (the overlay-side chord times out after 1 second; the mpv plugin uses native mpv key sequences). @@ -130,14 +130,14 @@ The bare `v` plugin binding intentionally overrides mpv's native primary subtitl When the overlay has focus, press `y` then `d` to toggle DevTools (debugging helper). -## Drag-and-Drop +## Drag-and-drop | Gesture | Action | | ------------------------- | ------------------------------------------------ | | Drop file(s) onto overlay | Replace current mpv playlist with dropped files | | `Shift` + drop file(s) | Append all dropped files to current mpv playlist | -## Customizing Shortcuts +## Customizing shortcuts All `shortcuts.*` keys accept [Electron accelerator strings](https://www.electronjs.org/docs/latest/tutorial/keyboard-shortcuts), for example `"CommandOrControl+D"`. Use `null` to disable a shortcut. diff --git a/docs-site/subtitle-annotations.md b/docs-site/subtitle-annotations.md index c962dc5d..af9cf737 100644 --- a/docs-site/subtitle-annotations.md +++ b/docs-site/subtitle-annotations.md @@ -1,20 +1,20 @@ -# Subtitle Annotations +# Subtitle annotations -SubMiner annotates subtitle tokens in real time as they appear in the overlay. Four annotation layers work together to surface useful context while you watch: **N+1 highlighting**, **character-name highlighting**, **frequency highlighting**, and **JLPT tagging**. +SubMiner annotates subtitle tokens as they appear in the overlay. There are four layers: **N+1 highlighting**, **character-name highlighting**, **frequency highlighting**, and **JLPT tagging**. -All four are opt-in and configured under `subtitleStyle`, `ankiConnect.knownWords`, and `ankiConnect.nPlusOne` in your config. They apply independently - you can enable any combination. +All four are off by default and live under `subtitleStyle`, `ankiConnect.knownWords`, and `ankiConnect.nPlusOne`. They are independent, so any combination works. ::: tip Tokenization -SubMiner's primary tokenizer is Yomitan itself - subtitle text is tokenized based entirely on the dictionaries you have installed in Yomitan. Installing many large dictionaries can increase noise and slow down lookups, so be selective about which dictionaries you install and their priority order. +Yomitan is the tokenizer, so the dictionaries you installed there decide where word boundaries fall. Piling on large dictionaries adds noise and slows lookups. Be picky about which ones you install and what order you rank them in. ::: Before any of those layers render, SubMiner strips annotation metadata from tokens that are usually just subtitle glue or annotation noise. Standalone particles, auxiliaries, adnominals, common explanatory endings like `んです` / `のだ`, merged trailing quote-particle forms like `...って`, auxiliary-stem grammar tails like `そうだ` (MeCab POS3 `助動詞語幹`), repeated kana interjections, and similar non-lexical helper tokens remain hoverable in the subtitle text, but they render as plain tokens without known-word, N+1, frequency, JLPT, or name-match annotation styling. Kanji vocabulary that MeCab labels `名詞/非自立`, such as `日` or `以外`, remains content for every annotation layer. The `非自立` exclusion only suppresses kana grammar nouns such as `こと` and `もの`. -## N+1 Word Highlighting +## N+1 word highlighting -N+1 highlighting identifies sentences where you know every word except one, making them ideal mining targets. When enabled, SubMiner builds a local cache of your known vocabulary from Anki and highlights tokens accordingly. +An N+1 sentence is one where you know every word but a single unknown. Those are the best mining targets, because the rest of the sentence gives you the context for free. SubMiner caches your known vocabulary from Anki and marks the lines that qualify. **How it works:** @@ -43,9 +43,9 @@ Prefer expression/word fields for `ankiConnect.knownWords.decks`. Reading-only f Set `refreshMinutes` to `1440` (24 hours) for daily sync if your Anki collection is large. ::: -## Known-Word Maturity Highlighting +## Known-word maturity highlighting -Instead of one color for every known word, maturity highlighting tints each known token by the review state of its Anki cards (like asbplayer), giving an at-a-glance sense of how much of a line is solidly learned. +Maturity highlighting tints each known token by the review state of its Anki cards instead of painting every known word the same color, so you can see how much of a line you actually have down. asbplayer does the same thing. **How it works:** @@ -81,7 +81,7 @@ bun run verify-known-word-highlights:electron -- --input /path/to/episode.ja.srt It tokenizes every cue through the real Yomitan/MeCab pipeline with your live known-word cache, prints each line in your configured tier colors, and summarizes the tier counts. `--audit` re-derives each highlighted tier from live Anki card data (`notesInfo` + `cardsInfo` intervals) and lists any token whose color disagrees, with the note ids and intervals behind it. Electron locks the Yomitan profile, so quit SubMiner first or pass `--profile-copy` to run against a scratch copy. Other useful flags: `--refresh` (refresh the cache first), `--limit <n>`, `--quiet`, `--json`. -## Character-Name Highlighting +## Character-name highlighting Character-name matches are built from the active merged SubMiner character dictionary, which auto-syncs character data from AniList for your recently-watched titles. When the current AniList media ID is known, SubMiner ignores loaded entries from other titles for subtitle name matching and inline portraits. Matching names are highlighted in subtitles and become available for hover-driven Yomitan character profiles - portraits, roles, voice actors, and biographical detail. @@ -102,9 +102,9 @@ Character-name matches are built from the active merged SubMiner character dicti For full details on dictionary generation, name variant expansion, auto-sync lifecycle, and configuration, see the dedicated [Character Dictionary](/character-dictionary) page. -## Frequency Highlighting +## Frequency highlighting -Frequency highlighting colors tokens based on how common they are, using dictionary frequency rank data. This helps you spot high-value vocabulary at a glance. For each token, ranks from the installed Yomitan frequency dictionaries are consulted in priority order: the highest-priority dictionary that has the term wins, lower-priority dictionaries fill in terms it lacks, and occurrence-based dictionaries are skipped. +Frequency highlighting colors tokens by how common the word is, so a rare word in an otherwise easy line stands out. Ranks come from your installed Yomitan frequency dictionaries, read in priority order. The highest-priority dictionary that has the term wins, lower-priority ones fill in terms it lacks, and occurrence-based dictionaries are skipped. **Modes:** @@ -137,9 +137,9 @@ Frequency highlighting skips tokens that look like non-lexical noise (kana redup Frequency, JLPT, and N+1 metadata are only shown for tokens that survive the subtitle-annotation noise filter. Standalone grammar tokens like `は`, `です`, and `この` are intentionally left unannotated even if a dictionary can assign them metadata. ::: -## JLPT Tagging +## JLPT tagging -JLPT tagging adds colored underlines to tokens based on their JLPT level (N1–N5), giving you an at-a-glance sense of difficulty distribution in each subtitle line. +JLPT tagging underlines each token in a color for its JLPT level (N1–N5), so the difficulty spread of a line is visible without reading it closely. **How it works:** @@ -164,7 +164,7 @@ All colors are customizable via the `subtitleStyle.jlptColors` object. | `subtitleStyle.enableJlpt` | `false` | Enable JLPT underline styling | | `subtitleStyle.jlptColors.N1`–`N5` | see above | Per-level underline colors | -## Runtime Toggles +## Runtime toggles These annotation layers can be toggled at runtime via the runtime options palette (`Ctrl/Cmd+Shift+O`) without restarting: @@ -177,9 +177,9 @@ These annotation layers can be toggled at runtime via the runtime options palett (Character-name matching, `subtitleStyle.nameMatchEnabled`, is toggled through config or the Settings window, not the runtime palette.) -Toggles only apply to new subtitle lines after the change - the currently displayed line is not re-tokenized in place. +A toggle takes effect on the next subtitle line. SubMiner does not re-tokenize the line already on screen. -## Rendering Priority +## Rendering priority When multiple annotations apply to the same token, the visual priority is: diff --git a/docs-site/subtitle-sidebar.md b/docs-site/subtitle-sidebar.md index da03bda5..245d926d 100644 --- a/docs-site/subtitle-sidebar.md +++ b/docs-site/subtitle-sidebar.md @@ -1,20 +1,20 @@ -# Subtitle Sidebar +# Subtitle sidebar -The subtitle sidebar displays the full parsed cue list for the active subtitle file as a scrollable panel alongside mpv. It lets you review past and upcoming lines, click any cue to seek directly to that moment, and follow along without depending on the transient overlay subtitles. +The subtitle sidebar puts the whole parsed cue list for the active subtitle file in a scrollable panel next to mpv. Scroll back through lines you already passed, look ahead at what is coming, and click any cue to seek straight to it. The overlay only ever shows the current line; the sidebar shows the rest. The sidebar is enabled by default. Set `subtitleSidebar.enabled` to `false` if you want to turn it off. -## How It Works +## How it works When SubMiner parses the active subtitle source into a cue list, the sidebar becomes available. Toggle it with the `\` key (configurable via `subtitleSidebar.toggleKey`). While open: - The active cue is highlighted and kept in view as playback advances (when `autoScroll` is `true`). - Clicking any cue seeks mpv into that line. For overlapping ASS karaoke, SubMiner moves past the previous line's exit animation when the selected cue has enough time remaining. -- The sidebar stays synchronized with the overlay - media transitions and subtitle source changes update both simultaneously. +- The sidebar and the overlay share one cue list, so a media change or subtitle source switch updates both at once. For typeset ASS karaoke and animated signs, SubMiner collapses generated animation frames and repeated full-line color phases before they reach the sidebar. It recovers a clean complete line from a matching timed authoring comment or from full-line events surrounding generated fragments. Ordinary ASS comments, editor notes, alternate lines, repeated dialogue, and separately positioned signs remain distinct. -The sidebar only appears when a parsed cue list is available. External subtitle sources that SubMiner cannot parse (for example, embedded ASS tracks rendered directly by mpv) will not populate the sidebar. +The sidebar only opens when a parsed cue list exists. Subtitle sources SubMiner cannot parse, such as embedded ASS tracks that mpv renders itself, leave it empty. ## Selecting and copying dialogue @@ -24,13 +24,13 @@ Dragging to select does not seek playback. Playback-following auto-scroll stops Selection survives playback updates and Yomitan popup dismissal. Changing media or subtitle sources, refreshing the cue list, or closing the sidebar clears it. Copying an excerpt does not require creating an Anki card. -## Layout Modes +## Layout modes Two layout modes are available via `subtitleSidebar.layout`: **`overlay`** (default) - The sidebar floats over mpv as a panel. It does not affect the player window size or position. -**`embedded`** - Reserves space on the right side of the player and shifts the video area to mimic a split-pane layout. Useful if you want the cue list visible without it covering the video. If you see unexpected positioning in your environment, switch back to `overlay` to isolate the issue. +**`embedded`** - Reserves space on the right side of the player and shifts the video area over, giving you a split pane. Use this when you want the cue list up without it covering the video. Positioning depends on the compositor, so switch back to `overlay` if the geometry comes out wrong. ## Configuration @@ -85,7 +85,7 @@ Styling lives under the `css` object, using CSS property names and CSS custom pr | `--subtitle-sidebar-active-background-color`| `rgba(138, 173, 244, 0.22)` | Active cue background color | | `--subtitle-sidebar-hover-background-color` | `rgba(54, 58, 79, 0.84)` | Hovered cue background color | -## Keyboard Shortcut +## Keyboard shortcut | Key | Action | Config key | | --- | ----------------------- | ------------------------------ | diff --git a/docs-site/troubleshooting.md b/docs-site/troubleshooting.md index e88b010b..5039d836 100644 --- a/docs-site/troubleshooting.md +++ b/docs-site/troubleshooting.md @@ -1,14 +1,16 @@ # Troubleshooting -Common issues and how to resolve them. Most problems fall into one of a few buckets - the overlay shows but subtitles don't (see [MPV Connection](#mpv-connection)), cards aren't being created or come out empty (see [AnkiConnect](#ankiconnect)), or word lookups don't appear (see [Yomitan](#yomitan)). If an error message popped up on screen, search this page for the exact text - most headings below are quoted error strings. +Almost everything that goes wrong lands in one of three places. The overlay shows but no subtitles arrive, which is [MPV Connection](#mpv-connection). Cards get created but come out empty, which is [AnkiConnect](#ankiconnect). Or hovering a word does nothing, which is [Yomitan](#yomitan). -## MPV Connection +If you got an error message on screen, search this page for its exact text. Most headings below are quoted error strings. + +## MPV connection **Overlay starts but shows no subtitles** SubMiner connects to mpv via a Unix socket (or named pipe on Windows). If the socket does not exist or the path does not match, the overlay will appear but subtitles will never arrive. -- Ensure mpv is running with `--input-ipc-server=/tmp/subminer-socket`. +- Check that mpv is running with `--input-ipc-server=/tmp/subminer-socket`. - If you use a custom socket path, set it in both your mpv config and SubMiner config (`mpv.socketPath`). - The `subminer` wrapper script sets the socket automatically when it launches mpv. If you launch mpv yourself, the `--input-ipc-server` flag is required. @@ -18,7 +20,7 @@ If the overlay never appears at all, see [Playback Startup Flow](./architecture# **"Failed to parse MPV message"** -Logged when a malformed JSON line arrives from the mpv socket. Usually harmless - SubMiner skips the bad line and continues. If it happens constantly, check that nothing else is writing to the same socket path. +A malformed JSON line arrived from the mpv socket. SubMiner drops the line and keeps going, so a stray one is harmless. A constant stream of them means something else is writing to the same socket path. ## Updates @@ -85,7 +87,7 @@ Shown when SubMiner tries to update a card that no longer exists, or when AnkiCo **Overlay appears but clicks pass through / cannot interact** -- Make sure you are hovering over subtitle text - the overlay only becomes interactive when the cursor is over a subtitle. +- Hover directly over subtitle text. The overlay only takes pointer input while the cursor is over a subtitle. - On macOS/Windows: toggle the overlay off and back on (`Alt+Shift+O`) to re-enable pointer events. - On Linux: mouse event handling is unreliable in some Electron/compositor combinations. If clicks consistently fail, toggle the overlay off, click the underlying mpv window, then toggle it back on. @@ -99,9 +101,9 @@ Shown when SubMiner tries to update a card that no longer exists, or when AnkiCo SubMiner positions the overlay by tracking the mpv window. If tracking fails: -- Hyprland: Ensure `hyprctl` is available. -- Sway: Ensure `swaymsg` is available. -- X11: Ensure `xdotool` and `xwininfo` are installed. +- Hyprland: `hyprctl` must be on `PATH`. +- Sway: `swaymsg` must be on `PATH`. +- X11: `xdotool` and `xwininfo` must be installed. If the overlay position is slightly off, right-click and drag on subtitle text to fine-tune the overlay subtitle offset. @@ -124,12 +126,12 @@ If you installed from the AppImage and see this error, the package may be incomp **Yomitan lookup popup does not appear when hovering words or triggering lookup** -- Verify Yomitan loaded successfully - check the terminal output for "Loaded Yomitan extension". +- Look for "Loaded Yomitan extension" in the terminal output. - Yomitan requires dictionaries to be installed. Open Yomitan settings (`Alt+Shift+Y` or `SubMiner.AppImage --yomitan`) and confirm at least one dictionary is imported. - If `yomitan.externalProfilePath` is set, import/check dictionaries in the external app/profile instead. SubMiner treats that profile as read-only and does not open its own Yomitan settings window. - If the overlay shows subtitles but hover lookup never resolves on tokens, the tokenizer may have failed. See the MeCab section below. -## MeCab / Tokenization +## MeCab / tokenization **"MeCab not found on system"** @@ -145,19 +147,19 @@ To install MeCab: Japanese word boundaries depend on Yomitan parser output. If segmentation seems wrong: -- Verify Yomitan dictionaries are installed and active. -- Note that CJK characters without spaces are segmented using parser heuristics, which is not always perfect. +- Check that Yomitan dictionaries are installed and active. +- Japanese text has no spaces, so the parser guesses word boundaries. It gets some of them wrong. -## Character Dictionary +## Character dictionary Character names from AniList are matched and highlighted in subtitles via the bundled Yomitan. See [Character Dictionary](/character-dictionary) for setup and the full troubleshooting list - the most common issues: -- **Names not highlighting:** Confirm `subtitleStyle.nameMatchEnabled` is `true`, and that the current media resolved to an AniList entry (SubMiner needs a media ID to fetch characters). No AniList account or token is required - character data uses public GraphQL queries. -- **Inline portraits missing:** Confirm `subtitleStyle.nameMatchImagesEnabled` is `true`. Portraits also require AniList to return an image and the download to succeed during snapshot generation. +- **Names not highlighting:** Check that `subtitleStyle.nameMatchEnabled` is `true` and that the current media resolved to an AniList entry, since SubMiner needs a media ID to fetch characters. No AniList account or token is needed; character data comes from public GraphQL queries. +- **Inline portraits missing:** Check that `subtitleStyle.nameMatchImagesEnabled` is `true`. AniList also has to return an image, and the download has to succeed while the snapshot is generated. - **Wrong characters showing:** Open the in-app manager (`Ctrl/Cmd+D`) and use **Override** to pin the correct AniList match for the series. - **Feature unavailable:** If `yomitan.externalProfilePath` is set, SubMiner runs in read-only external-profile mode and its character-dictionary features are disabled. -## Media Generation +## Media generation **"FFmpeg not found"** @@ -193,7 +195,7 @@ This warning refers to the OS-registered shortcut `Alt+Shift+Y` (Yomitan setting Overlay-local shortcuts (Space, arrow keys, etc.) only work when the overlay window has focus. Click on the overlay or use `Alt+Shift+O` (with the overlay or mpv focused) to toggle it and give it focus. -## Subtitle Timing +## Subtitle timing **"Subtitle timing not found; copy again while playing"** @@ -205,7 +207,7 @@ This OSD message appears when you try to mine a sentence but SubMiner has no tim Resume playback and wait for the next subtitle to appear, then try mining again. -## Subtitle Sync (Subsync) +## Subtitle sync (subsync) Both **alass** and **ffsubsync** are optional external dependencies. Subtitle syncing requires at least one of them to be installed. @@ -229,8 +231,8 @@ Install ffsubsync or configure the path: If subtitle sync fails (the error message is prefixed with the engine name): -- Ensure a reference is selected (alass needs either a second subtitle track or the local video file, and it cannot be the same track that is being retimed). -- Check that `ffmpeg` is available (used to extract the internal subtitle track). +- Select a reference. alass needs either a second subtitle track or the local video file, and it cannot be the track being retimed. +- Check that `ffmpeg` is available, since it extracts the internal subtitle track. - Try running the sync tool manually to see detailed error output. - ffsubsync requires local files and cannot handle remote media streams (e.g., streaming URLs). @@ -254,23 +256,23 @@ Most Linux distributions ship it already. See [TsukiHime Integration](/tsukihime The Jimaku API has rate limits. If you see 429 errors, wait for the retry duration shown in the OSD message and try again. If you have a Jimaku API key, set it in `jimaku.apiKey` or `jimaku.apiKeyCommand` to get higher rate limits. -## Logging and App Mode +## Logging and app mode - Default log output is `warn`. - Use `--log-level` for more/less output. - Use `--dev`/`--debug` only to force app/dev mode (for example to get dev behavior from the overlay/app); they do not change log verbosity. - You can combine both, for example `SubMiner.AppImage --start --dev --log-level debug`, when you need maximum diagnostics. -## Performance and Resource Impact +## Performance and resource impact -### At a glance +### Where the cost comes from -- Baseline: `SubMiner --start` is usually lightweight for normal playback. -- Common spikes come from: - - first subtitle parse/tokenization bursts - - media generation (`ffmpeg` audio/image and AVIF paths) - - media sync and subtitle tooling (`alass`, `ffsubsync`) - - `ankiConnect` enrichment (plus polling overhead when proxy mode is disabled) +Idle playback with the overlay up is cheap. The spikes come from: + +- first subtitle parse/tokenization bursts +- media generation (`ffmpeg` audio/image and AVIF paths) +- media sync and subtitle tooling (`alass`, `ffsubsync`) +- `ankiConnect` enrichment (plus polling overhead when proxy mode is disabled) ### If playback feels sluggish @@ -285,19 +287,16 @@ The Jimaku API has rate limits. If you see 429 errors, wait for the retry durati 2. Reduce rendering pressure: - lower `subtitleStyle.css["font-size"]` -- keep overlay complexity minimal during heavy CPU periods 3. Reduce media overhead: -- keep `ankiConnect.media.imageType` set to `static` (avoid animated AVIF unless needed) +- keep `ankiConnect.media.imageType` set to `static`, since animated AVIF encoding is the most expensive path - lower `ankiConnect.media.imageQuality` - reduce `ankiConnect.media.maxMediaDuration` 4. Lower integration cost: -- disable AI translation when not needed (`ankiConnect.ai.enabled: false`) -- if needed, run immersion telemetry with lower duration expectations (`immersionTracking.enabled: false` for constrained sessions) -- favor the default lightweight YouTube subtitle startup settings on low-resource systems +- set `immersionTracking.enabled: false` to stop session logging and its database writes ### Practical low-impact profile @@ -320,9 +319,6 @@ The Jimaku API has rate limits. If you see 429 errors, wait for the retry durati "imageType": "static", "imageQuality": 80, "maxMediaDuration": 12 - }, - "ai": { - "enabled": false } }, "immersionTracking": { @@ -338,12 +334,12 @@ The Jimaku API has rate limits. If you see 429 errors, wait for the retry durati - Keep the default `warn` level for normal use; raise to `info` or `debug` only for targeted diagnosis. - Reproduce once with `SubMiner.AppImage --start --log-level debug` and open DevTools (`y` then `d`) if freezes recur. -## Platform-Specific +## Platform-specific ### Linux -- **Wayland (Hyprland/Sway only)**: Native Wayland support is limited to Hyprland and Sway. Window tracking uses compositor-specific commands (`hyprctl` / `swaymsg`). If these are not on `PATH`, tracking will fail silently. Other Wayland compositors (KDE Plasma, GNOME, …) are not supported natively - both mpv and SubMiner must run under X11 or Xwayland instead. On those sessions SubMiner forces XWayland automatically for itself and for every mpv it launches (see [KDE Plasma & other Wayland compositors](#kde-plasma-other-wayland-compositors)). -- **X11 / Xwayland**: Requires `xdotool`, `xprop`, and `xwininfo`. If missing, the overlay cannot track the mpv window position. This is the required backend for any Wayland compositor other than Hyprland or Sway - both mpv and SubMiner must be running under X11/Xwayland for window tracking _and_ for the overlay to stay above mpv (Wayland forbids clients from controlling window stacking). SubMiner uses a managed X11 overlay while mpv is windowed, switches to an override-redirect X11 overlay while tracked mpv is fullscreen, and hides/releases that overlay when another X11/Xwayland app takes focus. The visible overlay stays hidden until SubMiner has tracked mpv geometry, so startup should not create a display-sized fallback overlay while tokenization warms up. +- **Wayland (Hyprland/Sway only)**: Native Wayland support covers Hyprland and Sway only. Window tracking shells out to `hyprctl` or `swaymsg`; if neither is on `PATH`, tracking fails silently. Other Wayland compositors such as KDE Plasma and GNOME have no native backend - both mpv and SubMiner must run under X11 or Xwayland instead. On those sessions SubMiner forces XWayland automatically for itself and for every mpv it launches (see [KDE Plasma & other Wayland compositors](#kde-plasma-and-other-wayland-compositors)). +- **X11 / Xwayland**: Needs `xdotool`, `xprop`, and `xwininfo`. Without them the overlay cannot track the mpv window position. This is the required backend for any Wayland compositor other than Hyprland or Sway - both mpv and SubMiner must be running under X11/Xwayland for window tracking _and_ for the overlay to stay above mpv (Wayland forbids clients from controlling window stacking). SubMiner uses a managed X11 overlay while mpv is windowed, switches to an override-redirect X11 overlay while tracked mpv is fullscreen, and hides/releases that overlay when another X11/Xwayland app takes focus. The visible overlay stays hidden until SubMiner has tracked mpv geometry, so startup should not create a display-sized fallback overlay while tokenization warms up. - **Tray icon missing**: SubMiner creates an Electron tray icon in `--background` mode, but Linux trays require a StatusNotifier/AppIndicator host. Hyprland does not provide one by itself; enable a tray in Waybar, Hyprpanel, or another panel. If Electron cannot register the tray, SubMiner logs a warning that mentions the missing tray host. - **Mouse passthrough**: On Linux X11/Xwayland, SubMiner uses `xdotool` to poll the cursor and only enables overlay input while the cursor is over subtitle or popup regions. Outside those regions, pointer input passes through to mpv. Native Wayland compositors other than Hyprland/Sway cannot provide the stacking control SubMiner needs. @@ -401,7 +397,7 @@ SubMiner watches mpv's `fullscreen` property and refreshes the overlay geometry For more details, see the Hyprland docs on [global keybinds](https://wiki.hypr.land/Configuring/Binds/#global-keybinds) and [window rules](https://wiki.hypr.land/Configuring/Window-Rules/). -### KDE Plasma & other Wayland compositors +### KDE Plasma and other Wayland compositors On any Wayland session that is not Hyprland or Sway (KDE Plasma, GNOME, and others), the overlay can only stay above mpv when both processes run under **XWayland** - the Wayland protocol forbids clients from controlling window stacking, so the overlay's "always on top" becomes a no-op on a native Wayland surface. @@ -423,7 +419,7 @@ Requirements: `xdotool`, `xprop`, and `xwininfo` must be installed. SubMiner use This almost always means mpv came up as a **native Wayland** window that the XWayland overlay cannot cover. It happens when mpv is launched **manually** (your own command), because SubMiner can only force XWayland on the mpv processes it launches itself. Fix it one of these ways: - Launch playback through SubMiner (the `subminer` launcher or the tray), which forces XWayland for you, or -- Force XWayland in your own mpv invocation, e.g. `mpv --gpu-context=x11vk,x11egl,x11 …`, or launch with `WAYLAND_DISPLAY= mpv …`, or set `gpu-context=x11vk` (Vulkan) / `gpu-context=x11egl` (OpenGL) in your `mpv.conf`. +- Force XWayland in your own mpv command, for example `mpv --gpu-context=x11vk,x11egl,x11 <file>`. Launching with `WAYLAND_DISPLAY= mpv <file>` works too, as does setting `gpu-context=x11vk` (Vulkan) or `gpu-context=x11egl` (OpenGL) in your `mpv.conf`. To confirm mpv is on XWayland, `xdotool search --class mpv` should return a window id (a native Wayland mpv returns nothing). @@ -436,7 +432,7 @@ SubMiner can only detect focus for X11/Xwayland windows in this mode. If a nativ - **Accessibility permission**: Required for window tracking. Grant it in System Settings > Privacy & Security > Accessibility. - **Gatekeeper**: If macOS blocks SubMiner, right-click the app and select "Open" to bypass the warning, or remove the quarantine attribute: `xattr -d com.apple.quarantine /path/to/SubMiner.app` -## See Also +## See also Feature-specific issues are covered in each feature's own page: diff --git a/docs-site/tsukihime-integration.md b/docs-site/tsukihime-integration.md index 2a086d18..24a4a19c 100644 --- a/docs-site/tsukihime-integration.md +++ b/docs-site/tsukihime-integration.md @@ -1,6 +1,6 @@ -# TsukiHime Integration +# TsukiHime integration -[TsukiHime](https://tsukihime.org) tracks anime torrent releases and extracts every attachment - including embedded subtitle tracks - from the release files, hosting them for direct download. SubMiner integrates with the TsukiHime API so you can pull English subtitles for the currently playing episode straight from the overlay, no torrent client involved. Downloaded subtitles are decompressed, saved next to the video, and loaded into mpv immediately. +[TsukiHime](https://tsukihime.org) indexes anime torrent releases and pulls every attachment out of the release files, embedded subtitle tracks included, then hosts them for direct download. SubMiner talks to the TsukiHime API, so you can grab subtitles for the episode you are watching from the overlay without a torrent client. The download is decompressed, saved next to the video, and loaded into mpv straight away. This is the multi-language companion to the [Jimaku integration](/jimaku-integration). Releases that ship multiple languages (e.g. Netflix `[MultiSub]` rips) expose them all; the modal's tabs pick which ones you see, and each download is saved with its own language suffix. @@ -12,7 +12,7 @@ TsukiHime replaces [Animetosho](https://animetosho.org), which stops processing Unlike Jimaku, TsukiHime needs no account or API key. The only requirement is the `xz` binary on your `PATH` - TsukiHime serves extracted subtitles xz-compressed, and SubMiner shells out to `xz` to decompress them. Most Linux distributions ship it by default (package `xz` or `xz-utils`). ::: -## How It Works +## How it works The integration runs through an in-overlay modal opened with `Ctrl+Shift+T` by default. The modal has two tabs that filter both the release list and the subtitle tracks of the selected release by role: the first follows `secondarySub.secondarySubLanguages` (English when unset), and the second is always **Japanese**, the currently supported primary subtitle language. Each tab lists only the releases whose reported subtitle languages include the tab's language, so the Japanese tab hides the many releases that ship English subtitles only. Releases and tracks with no language tag stay visible on the secondary tab. If nothing on the active tab qualifies, the status line says so and points at the other tab. @@ -24,9 +24,9 @@ From there: 2. **Browse releases** - Select a release to list the text subtitle tracks extracted from its files. English tracks sort first; image-based tracks (PGS/VobSub) are filtered out. 3. **Download** - Selecting a track downloads the xz-compressed subtitle from TsukiHime's storage, decompresses it, saves it next to the video (or a temp directory for remote/streamed media), and loads it into mpv. Japanese tracks are selected as mpv's **primary** subtitle. Tracks from the configured secondary tab are assigned to mpv's **secondary** subtitle slot without replacing the primary. The filename carries the track's language - `<video basename>.en.<ext>` for English, `.ja` for Japanese, and so on - so mpv and media servers detect the language correctly. -Because releases on TsukiHime are the same files circulating as torrents, picking the release that matches your local file (same group, same version) gives you subtitles with exact timing - no resync needed. If your file is a raw or from a different group, pick any release of the same episode and adjust timing with the [subtitle sync tools](/troubleshooting#subtitle-sync-subsync) (`Ctrl+Alt+S`) if necessary. +TsukiHime's releases are the same files that circulate as torrents. Pick the release matching your local file, same group and same version, and the timing lines up exactly with no resync. For a raw or a different group's encode, take any release of the episode and fix the offset with the [subtitle sync tools](/troubleshooting#subtitle-sync-subsync) (`Ctrl+Alt+S`). -### Modal Keyboard Shortcuts +### Modal keyboard shortcuts | Key | Action | | ---------------------------- | ------------------------------- | @@ -38,7 +38,7 @@ Because releases on TsukiHime are the same files circulating as torrents, pickin ## Configuration -The integration works out of the box. An optional `tsukihime` section in `config.jsonc` tunes it: +There is nothing to configure to get started. An optional `tsukihime` section in `config.jsonc` tunes it: ```jsonc { @@ -66,7 +66,7 @@ The keyboard shortcut is configured separately under `shortcuts`: Existing Animetosho configuration remains compatible. SubMiner treats the old `animetosho` section and `shortcuts.openAnimetosho` setting as deprecated aliases. When old and current names are both present, `tsukihime` and `shortcuts.openTsukihime` take precedence. -## Other Ways to Open It +## Other ways to open it - CLI: `subminer --open-tsukihime` - Keybinding command: bind any key to `["__tsukihime-open"]` in the `keybindings` array diff --git a/docs-site/usage.md b/docs-site/usage.md index ad695fa4..2d300204 100644 --- a/docs-site/usage.md +++ b/docs-site/usage.md @@ -1,6 +1,6 @@ # Usage -## Quick Start +## Quick start Play a video with SubMiner: @@ -10,7 +10,7 @@ subminer video.mkv On **Windows**, use the **SubMiner mpv** shortcut created during first-run setup - double-click it, or drag a video file onto it. -That's the simplest way to get started. The `subminer` launcher handles mpv, the IPC socket, and the overlay automatically. +That is the whole setup. The `subminer` launcher starts mpv, opens the IPC socket, and brings up the overlay. > [!IMPORTANT] > SubMiner requires the bundled Yomitan instance to have at least one dictionary imported for lookups to work. @@ -36,17 +36,17 @@ If you want sentence, audio, and screenshot fields on your Anki cards, add this Field names must match a field on your Anki note type. Matching is case-insensitive (an exact match wins, then a lowercase comparison), but the spelling must otherwise match. See [Anki Integration](/anki-integration) for the full reference. ::: -## How It Works +## How it works -When you launch SubMiner, it wires up mpv and the overlay for you: +Launching SubMiner wires up mpv and the overlay for you: 1. SubMiner starts the overlay app in the background 2. mpv runs with an **IPC socket** at `/tmp/subminer-socket` - a small local channel two programs use to talk to each other, so the overlay can ask mpv what subtitle is on screen right now 3. The overlay connects and subscribes to subtitle changes -From there, subtitles render as interactive, hoverable word spans and you mine cards directly from the overlay. For the overlay anatomy and the full mining loop - word lookup, card creation, annotations - see [Mining Workflow](/mining-workflow). +Subtitles then render as hoverable word spans, and you mine cards straight from the overlay. [Mining Workflow](/mining-workflow) covers the overlay layout, word lookup, card creation, and annotations. -### Ways to Launch +### Ways to launch | Approach | Use when | How | | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | @@ -54,11 +54,11 @@ From there, subtitles render as interactive, hoverable word spans and you mine c | **SubMiner mpv shortcut** (Windows) | The recommended Windows entry point. Created during first-run setup, launches mpv with SubMiner's defaults. | Double-click, drag a file onto it, or run `SubMiner.exe --launch-mpv` | | **mpv plugin** (all platforms) | Bundled and injected at runtime. Provides `y` chord keybindings for controlling the overlay from within mpv. No manual install needed. | Automatic when using the launcher or shortcut | -The mpv plugin is always available - it's bundled with SubMiner and injected at runtime. On Linux, normal `subminer` playback auto-installs the launcher-managed runtime plugin copy from the bundled app if that managed copy is missing, so no separate plugin install is needed for standard launcher usage. If you launch mpv yourself (without the launcher), pass `--input-ipc-server=/tmp/subminer-socket` in your mpv config for the overlay to connect. +The mpv plugin is always available, because SubMiner bundles it and injects it at runtime. On Linux, normal `subminer` playback auto-installs the launcher-managed runtime plugin copy from the bundled app if that managed copy is missing, so no separate plugin install is needed for standard launcher usage. If you launch mpv yourself (without the launcher), pass `--input-ipc-server=/tmp/subminer-socket` in your mpv config for the overlay to connect. ## Commands -These are the commands you will actually use day to day. The full inventory of subcommands and flags lives in [Launcher Script](/launcher-script#subcommands). +These are the ones you will use day to day. [Launcher Script](/launcher-script#subcommands) has every subcommand and flag. ```bash subminer video.mkv # Play a specific file @@ -151,7 +151,7 @@ Once Jellyfin is configured, the tray menu includes `Jellyfin Discovery` for sta The tray menu also includes `View Changelog`, which opens the in-app changelog modal. It fetches the changelog from the newest published release, so you see release notes for versions newer than the one you run; if the download fails it falls back to the changelog bundled with your install and says so. Versions in the current `0.x` line are expanded by default and older lines are folded, matching this site's [Changelog](/changelog). A badge marks the version you have installed, and newer versions are tagged `New`. The same modal opens from the `What's New` button on the update-available overlay notification. -### Logging and App Mode +### Logging and app mode - `--log-level` controls logger verbosity. - `--dev` and `--debug` are app/dev-mode switches; they are not log-level aliases. @@ -165,7 +165,7 @@ The tray menu also includes `View Changelog`, which opens the in-app changelog m - Use both when needed, for example `SubMiner.AppImage --start --dev --log-level debug` (or `SubMiner.exe --start --dev --log-level debug` on Windows). - `--playback-feedback <text>` (also `--playback-feedback=<text>`) sends a non-empty text string through the playback-feedback route used for recording/playback prompts. For example: `SubMiner.AppImage --playback-feedback "your feedback"`. -### Windows mpv Shortcut +### Windows mpv shortcut First-run setup creates the config file, then requires Yomitan dictionaries before it can finish. @@ -185,7 +185,7 @@ You can use it three ways: This flow requires `mpv.exe` to be discoverable. Leave `mpv.executablePath` blank to auto-discover from `PATH`, or set it to the full `mpv.exe` path if mpv is installed elsewhere. `SUBMINER_MPV_PATH` is still honored as a fallback. -### Launcher Subcommands +### Launcher subcommands The launcher groups related work under subcommands: `jellyfin` (aliased `jf`), `stats`, `sync`, `dictionary` (aliased `dict`), `texthooker`, `doctor`, `settings`, `config`, `mpv`, `logs`, and `app` (aliased `bin`) for passing arguments straight to the SubMiner binary. @@ -193,9 +193,9 @@ Every subcommand has its own help page, for example `subminer jellyfin -h`. See A _texthooker_ is a web page that displays the current subtitle line as selectable text, so browser-based dictionary extensions and other tools can read along with playback. -### First-Run Setup +### First-run setup -Setup popup appears on first launch, or when setup has not been completed. +The setup window opens on first launch and on any later launch where setup never finished. You can also open it manually: @@ -209,7 +209,7 @@ Setup flow: - config file: create the default config directory and prefer `config.jsonc` - legacy plugin cleanup: remove detected older global SubMiner mpv plugin files if present (the bundled plugin is injected at runtime automatically) - Yomitan shortcut: open bundled Yomitan settings directly from the setup window -- dictionary check: ensure at least one bundled Yomitan dictionary is available, unless an external Yomitan profile is configured +- dictionary check: confirm at least one bundled Yomitan dictionary is present, unless an external Yomitan profile is configured - Windows: optionally create or remove `SubMiner mpv` Start Menu/Desktop shortcuts (`SubMiner.exe --launch-mpv`) - Windows: optionally set `mpv.executablePath` if `mpv.exe` is not on `PATH` - refresh: re-check dictionary state without restarting @@ -225,7 +225,7 @@ AniList character dictionary auto-sync (optional): Use subcommands for Jellyfin workflows (`subminer jellyfin ...`). Top-level launcher flags like `--jellyfin-*` are intentionally rejected. -### MPV Profile Example (mpv.conf) +### MPV profile example (mpv.conf) `subminer` passes the following MPV options directly on launch by default: @@ -264,13 +264,13 @@ secondary-sub-visibility=no ### Yomitan setup -SubMiner includes a bundled Yomitan extension for overlay word lookup. This bundled extension is separate from any Yomitan browser extension you may have installed. +SubMiner bundles its own Yomitan extension for overlay lookups. It is a separate install from any Yomitan you run in a browser, with its own dictionaries and settings. For SubMiner overlay lookups to work, open Yomitan settings (`subminer app --yomitan` or `SubMiner.AppImage --yomitan`) and import at least one dictionary in the bundled Yomitan instance. -If you also use Yomitan in a browser, configure that browser profile separately; it does not inherit dictionaries or settings from the bundled instance. +If you also use Yomitan in a browser, set that profile up separately. It inherits nothing from the bundled instance. -### YouTube Playback +### YouTube playback `subminer` accepts direct URLs (for example, YouTube links) and `ytsearch:` targets. For YouTube playback, SubMiner resolves subtitle selection during startup while mpv is paused: it auto-selects the default primary subtitle track plus a best-effort secondary track, then resumes when primary subtitles are ready. @@ -288,7 +288,7 @@ Notes: For local video files, SubMiner uses the same config-driven language priorities to auto-select the primary and secondary subtitle tracks from internal and external subtitle sources. -## Live Config Reload +## Live config reload While SubMiner is running, it watches your active config file and applies safe updates automatically. @@ -305,16 +305,16 @@ Live-updated settings include: - `mpv.aniskipEnabled`, `mpv.aniskipButtonKey` - `stats.toggleKey`, `stats.markWatchedKey` - `youtube.primarySubLanguages` -- most `ankiConnect.*` settings (including `ankiConnect.ai`) +- most `ankiConnect.*` settings Invalid config edits are rejected; SubMiner keeps the previous valid runtime config and shows an error notification. For restart-required sections, SubMiner shows a restart-needed notification. -## Controller Support +## Controller support -SubMiner supports gamepad/controller input for couch-friendly usage via the Chrome Gamepad API. Controller input drives the overlay while keyboard-only mode is enabled. +SubMiner reads gamepads through the Chrome Gamepad API, so you can mine from the couch. The controller drives the overlay while keyboard-only mode is on. -### Getting Started +### Getting started 1. Connect a controller before or after launching SubMiner. 2. Set `controller.enabled` to `true` in your config. @@ -326,7 +326,7 @@ SubMiner supports gamepad/controller input for couch-friendly usage via the Chro By default SubMiner uses the first connected controller after controller support is enabled. `Alt+C` opens the controller config modal, where you can save the preferred controller and remap bindings inline per controller. The reset button beside each edit pencil restores that binding to its built-in default for the selected controller. `Alt+Shift+C` opens the live debug modal with raw axes/button values for non-standard pads. Both modals stay closed while `controller.enabled` is false, and both shortcuts can be changed through `shortcuts.openControllerSelect` and `shortcuts.openControllerDebug`. -### Default Button Mapping +### Default button mapping | Button | Action | | ----------------------- | --------------------------------------- | @@ -340,9 +340,9 @@ By default SubMiner uses the first connected controller after controller support | `Select` / `Minus` | Quit mpv | | `L2` / `R2` | Unbound (available for custom bindings) | -Note: the default quit binding uses gamepad button index 6. Pads that follow the W3C standard gamepad layout report L2 as index 6 (Select is index 8), so on those controllers the quit action may fire on L2 instead - use `Alt+C` learn mode to remap it for your pad. +The default quit binding uses gamepad button index 6. Pads that follow the W3C standard layout report L2 as index 6 and Select as index 8, so on those controllers quit fires on L2 instead. Remap it with `Alt+C` learn mode. -### Analog Controls +### Analog controls | Input | Action | | --------------------- | --------------------------------------------- | @@ -351,7 +351,7 @@ Note: the default quit binding uses gamepad button index 6. Pads that follow the | Right stick vertical | Jump through Yomitan popup | | D-pad | Fallback for stick navigation when configured | -Learn mode ignores already-held inputs and waits for the next fresh button press or axis direction, which avoids accidental captures when you open the modal mid-input. +Learn mode ignores inputs you are already holding and waits for the next fresh press or axis push, so opening the modal mid-input does not capture whatever your thumb was on. All button and axis mappings are configurable under the `controller` config block. Learned remaps are saved under `controller.profiles` for the selected controller id. See [Configuration - Controller Support](/configuration#controller-support) for the full options. @@ -378,7 +378,7 @@ The changelog modal (tray > `View Changelog`) works the same way: it renders ove Hovering over subtitle text pauses mpv by default; leaving resumes it. Yomitan popups also pause playback by default. Set `subtitleStyle.autoPauseVideoOnHover: false` or `subtitleStyle.autoPauseVideoOnYomitanPopup: false` to disable either behavior. -### Drag-and-Drop +### Drag-and-drop - Drop video files onto the overlay to replace current playback. - Hold `Shift` while dropping to append to the playlist instead. diff --git a/docs-site/websocket-texthooker-api.md b/docs-site/websocket-texthooker-api.md index 9756bf3e..852748e4 100644 --- a/docs-site/websocket-texthooker-api.md +++ b/docs-site/websocket-texthooker-api.md @@ -1,19 +1,19 @@ -# WebSocket / Texthooker API & Integration +# WebSocket and texthooker API -**Who this page is for:** developers and tinkerers who want to consume SubMiner's live subtitle stream from their own tools - a browser tab, an automation script, or another mpv plugin. If you just want subtitles in a browser tab for Yomitan, skip to [Texthooker Integration Guide](#texthooker-integration-guide); the rest is reference for building custom clients. +This page is for people wiring SubMiner's live subtitle stream into their own tools: a browser tab, an automation script, another mpv plugin. If you only want subtitles in a browser tab for Yomitan, jump to [Texthooker Integration Guide](#texthooker-integration-guide). Everything else here is reference for building a client. A *texthooker* is a page/tool that receives the text currently on screen so a dictionary extension (like Yomitan) can look words up. SubMiner ships its own texthooker UI and also broadcasts subtitle text over local WebSockets that any client can connect to. -SubMiner exposes a small set of local integration surfaces for browser tools, automation helpers, and mpv-driven workflows: +SubMiner opens four local integration points: - **Subtitle WebSocket** at `ws://127.0.0.1:6677` by default for plain subtitle pushes. - **Annotation WebSocket** at `ws://127.0.0.1:6678` by default for token-aware clients. - **Texthooker HTTP UI** at `http://127.0.0.1:5174` by default for browser-based subtitle consumption. - **mpv plugin script messages** for in-player automation and extension. -This page documents those integration points and shows how to build custom consumers around them. +The rest of this page documents each one and shows how to build a consumer for it. -## Quick Reference +## Quick reference | Surface | Default | Purpose | | --- | --- | --- | @@ -22,7 +22,7 @@ This page documents those integration points and shows how to build custom consu | `texthooker` | `http://127.0.0.1:5174` | Local texthooker UI with injected websocket config | | mpv plugin | `script-message subminer-*` | Start/stop/toggle/status automation inside mpv | -## Enable and Configure the Services +## Enable and configure the services SubMiner's integration ports are configured in `config.jsonc`. All three services are **off by default** - the block below shows the values to set to turn them on. @@ -52,9 +52,9 @@ SubMiner's integration ports are configured in `config.jsonc`. All three service If you use the [mpv plugin](/mpv-plugin), it can also start a texthooker-only helper process. The launcher derives the plugin's texthooker setting from your SubMiner config (`texthooker.launchAtStartup`) and injects it at runtime - there is no plugin config file to edit. -## Developer API Documentation +## Developer API documentation -### 1. Subtitle WebSocket +### 1. subtitle WebSocket Use the basic subtitle websocket when you only need the current subtitle line as plain text. @@ -86,7 +86,7 @@ When a client connects, SubMiner immediately sends the latest subtitle payload i | `sentence` | string | Plain subtitle text with line breaks represented as `<br>`. No annotation spans or attributes. | | `tokens` | array | Always empty on the basic subtitle websocket. | -### 2. Annotation WebSocket +### 2. annotation WebSocket Use the annotation websocket for custom clients that want the same structured token payload the bundled texthooker UI consumes. @@ -167,7 +167,7 @@ SubMiner also adds tooltip-friendly data attributes when available: If you need a fully custom UI, ignore `sentence` and render from `tokens` instead. -## Texthooker Integration Guide +## Texthooker integration guide ### When to use the bundled texthooker page @@ -221,7 +221,7 @@ Here is a minimal browser client for the annotation stream: </script> ``` -### Build a custom Node client +### Build a custom node client ```js import WebSocket from 'ws'; @@ -245,7 +245,7 @@ ws.on('message', (raw) => { - Reconnect on disconnect; SubMiner does not manage client reconnects for you. - Prefer `payload.text` for logging/automation and `payload.sentence` or `payload.tokens` for UI rendering. -## Plugin Development +## Plugin development SubMiner does **not** currently expose a general-purpose third-party plugin SDK inside the app itself. Today, the supported extension surfaces are: @@ -309,7 +309,7 @@ Examples: - local vocabulary capture helper that writes interesting lines to a file - bridge service that forwards websocket events into your own workflow engine -## Webhook Examples +## Webhook examples SubMiner does **not** currently send outbound webhooks by itself. The supported pattern is to consume the websocket locally and relay events into another system. @@ -342,7 +342,6 @@ ws.on('message', async (raw) => { - **n8n / Make / Zapier relay:** send each subtitle line into an automation workflow for logging, translation, or summarization. - **Discord / Slack notifier:** post only lines that contain unknown words or N+1 targets. - **Obsidian / Markdown capture:** append subtitle lines plus token metadata to a daily immersion note. -- **Local LLM pipeline:** trigger a glossary, translation, or sentence-mining workflow whenever a new line arrives. ### Filtering example: only forward N+1 lines @@ -365,7 +364,7 @@ ws.on('message', async (raw) => { }); ``` -## Recommended Integration Combinations +## Recommended integration combinations - **Browser Yomitan client:** `texthooker` + `annotationWebsocket` - **Custom dashboard:** `annotationWebsocket` only @@ -373,7 +372,7 @@ ws.on('message', async (raw) => { - **mpv-side automation:** mpv plugin script messages + optional websocket relay - **Webhook-style workflows:** `annotationWebsocket` + your own local relay service -## Related Pages +## Related pages - [Configuration](/configuration#websocket-server) - [Mining Workflow - Texthooker](/mining-workflow#texthooker) diff --git a/docs-site/youtube-integration.md b/docs-site/youtube-integration.md index ac1dbdb9..d29eaa2f 100644 --- a/docs-site/youtube-integration.md +++ b/docs-site/youtube-integration.md @@ -1,23 +1,23 @@ -# YouTube Integration +# YouTube integration -SubMiner auto-loads Japanese subtitles when you play a YouTube URL, giving you the same sentence-mining overlay experience as local video files. It probes available subtitle tracks via `yt-dlp`, selects the best primary and secondary tracks, downloads them, and loads them into mpv before playback resumes. +Play a YouTube URL and SubMiner loads Japanese subtitles for it, so mining works the same as it does on a local file. It probes the available tracks with `yt-dlp`, picks a primary and a secondary, downloads both, and loads them into mpv before playback resumes. ## Requirements - **[yt-dlp](https://github.com/yt-dlp/yt-dlp)** must be installed and on your `PATH`. yt-dlp is a free command-line tool that reads YouTube video and subtitle info; SubMiner calls it behind the scenes. (`PATH` is the list of folders your system searches for programs - most installers add yt-dlp to it automatically. If yours did not, set `SUBMINER_YTDLP_BIN` to the full path of the yt-dlp binary.) - mpv with `--input-ipc-server` configured (handled automatically when you launch playback through the `subminer` launcher - no manual setup needed). -## How It Works +## How it works When SubMiner detects a YouTube URL (or `ytsearch:` target), it pauses mpv at startup and runs a subtitle pipeline before resuming playback: -1. **Probe** --- `yt-dlp --dump-single-json` extracts all available subtitle tracks (manual uploads and auto-generated captions) along with video metadata. Every yt-dlp call passes `--no-playlist`, so playlist links (for example a Watch Later URL with `list=`/`index=`) resolve to the single video instead of the whole playlist. -2. **Discover** --- Each track is normalized into a `YoutubeTrackOption` with language code, kind (`manual` or `auto`), display label, and direct download URL. -3. **Select** --- SubMiner picks the best primary track (Japanese, preferring manual over auto) and secondary track (English, preferring manual over auto). -4. **Download** --- Selected tracks are fetched via direct URL when available, falling back to `yt-dlp --write-subs` / `--write-auto-subs`. YouTube TimedText XML formats (`srv1`/`srv2`/`srv3`) are converted to VTT on the fly. Auto-generated VTT captions are normalized to remove rolling-caption duplication. -5. **Load** --- Subtitle files are injected into mpv via `sub-add`. Playback resumes once the primary track is ready; secondary failures do not block. +1. **Probe** - `yt-dlp --dump-single-json` extracts all available subtitle tracks (manual uploads and auto-generated captions) along with video metadata. Every yt-dlp call passes `--no-playlist`, so playlist links (for example a Watch Later URL with `list=`/`index=`) resolve to the single video instead of the whole playlist. +2. **Discover** - Each track is normalized into a `YoutubeTrackOption` with language code, kind (`manual` or `auto`), display label, and direct download URL. +3. **Select** - SubMiner picks the best primary track (Japanese, preferring manual over auto) and secondary track (English, preferring manual over auto). +4. **Download** - Selected tracks are fetched via direct URL when available, falling back to `yt-dlp --write-subs` / `--write-auto-subs`. YouTube TimedText XML formats (`srv1`/`srv2`/`srv3`) are converted to VTT on the fly. Auto-generated VTT captions are normalized to remove rolling-caption duplication. +5. **Load** - Subtitle files are injected into mpv via `sub-add`. Playback resumes once the primary track is ready; secondary failures do not block. -## Pipeline Diagram +## Pipeline diagram ```mermaid flowchart TD @@ -42,8 +42,8 @@ flowchart TD A --> B B --> C C --> D - D -- startup --> E - D -- user request --> F + D - startup --> E + D - user request --> F E --> G F --> G G --> H @@ -52,7 +52,7 @@ flowchart TD K --> L ``` -## Auto-Load Flow +## Auto-load flow On startup with a YouTube URL: @@ -66,7 +66,7 @@ On startup with a YouTube URL: 6. Missing tracks are downloaded to a temp directory and loaded via `sub-add`. 7. Playback unpauses once the primary subtitle is ready. -## Manual Subtitle Picker +## Manual subtitle picker Press **Ctrl+Alt+C** during YouTube playback to open the subtitle picker overlay. This lets you: @@ -80,27 +80,27 @@ card to a success notification after the selected tracks load. The picker displays each track with its language, kind (manual/auto), and title when available. -## Subtitle Format Handling +## Subtitle format handling SubMiner handles several YouTube subtitle formats transparently: | Format | Handling | | ---------------------- | -------------------------------------------------------- | | `srt`, `vtt` | Used directly (preferred for manual tracks) | -| `srv1`, `srv2`, `srv3` | YouTube TimedText XML --- converted to VTT automatically | +| `srv1`, `srv2`, `srv3` | YouTube TimedText XML - converted to VTT automatically | | Auto-generated VTT | Normalized to remove rolling-caption text duplication | For auto-generated tracks, SubMiner prefers `srv3` > `srv2` > `srv1` > `vtt` (TimedText XML produces cleaner output). For manual tracks, `srt` > `vtt` is preferred. -## Card Media Cache +## Card media cache By default, YouTube card audio and screenshots are extracted directly from mpv's active stream URLs. If generated card media fails with YouTube `403` errors, set `youtube.mediaCache.mode` to `"background"`. Background mode starts a separate `yt-dlp` media download after playback loads, including YouTube URLs opened directly in mpv and resolved stream URLs when mpv still exposes the original YouTube playlist entry. It creates text fields immediately, queues audio/image work for mined notes, and fills those fields once the local cache file is ready. Background cache downloads are capped at 720p by default (`youtube.mediaCache.maxHeight`; set `0` for unlimited) and use IPv4 and retry flags to reduce YouTube throttling failures. If the background download still fails, SubMiner shows a cache failure notification, shows queued-card failure notifications, and clears those pending updates so cards are not left waiting silently. -## Configuration Reference +## Configuration reference -### Primary Subtitle Languages +### Primary subtitle languages ```jsonc { @@ -114,11 +114,11 @@ Background cache downloads are capped at 720p by default (`youtube.mediaCache.ma | --------------------- | ---------- | ------------------------------------------------------------------------------------- | | `primarySubLanguages` | `string[]` | Languages that count as a satisfactory primary subtitle (default `["ja", "jpn"]`). Used by the "primary subtitle missing" notification and by managed local/playlist subtitle selection. | -YouTube auto-selection itself always picks a Japanese track first (manual over auto), then falls back to any manual track — `primarySubLanguages` does not change which YouTube track is auto-picked. +YouTube auto-selection itself always picks a Japanese track first (manual over auto), then falls back to any manual track. `primarySubLanguages` does not change which YouTube track is auto-picked. -### Secondary Subtitle Languages +### Secondary subtitle languages -YouTube secondary selection is fixed: SubMiner always tries an English track (manual over auto) and loads it when found. The shared `secondarySub` config does not change YouTube track selection — `secondarySubLanguages` and `autoLoadSecondarySub` apply only to local/Jellyfin sidecar selection — but `defaultMode` still controls how the loaded secondary bar is displayed: +YouTube secondary selection is fixed: SubMiner always tries an English track (manual over auto) and loads it when found. The shared `secondarySub` config does not change YouTube track selection. `secondarySubLanguages` and `autoLoadSecondarySub` apply only to local and Jellyfin sidecar selection. `defaultMode` still controls how the loaded secondary bar is displayed: ```jsonc { @@ -138,10 +138,10 @@ YouTube secondary selection is fixed: SubMiner always tries an English track (ma These settings come from `config.jsonc` (or built-in defaults); there are no CLI flags or environment variables for subtitle language selection. -## Limitations and Troubleshooting +## Limitations and troubleshooting - **No subtitles found**: The video may not have Japanese subtitles. Open the picker with `Ctrl+Alt+C` to see all available tracks. -- **yt-dlp not found**: Install `yt-dlp` and ensure it is on `PATH`, or set `SUBMINER_YTDLP_BIN` to the binary path. +- **yt-dlp not found**: Install `yt-dlp` and put it on `PATH`, or set `SUBMINER_YTDLP_BIN` to the binary path. - **Probe timeout**: `yt-dlp` has a 15-second timeout per operation. Slow connections or rate-limited IPs may hit this. Retry or update `yt-dlp`. - **Card media `403` errors**: Switch `youtube.mediaCache.mode` from `"direct"` to `"background"` so card media is generated from a local `yt-dlp` cache instead of ffmpeg reading an expiring YouTube stream URL. - **Auto-caption quality**: YouTube auto-generated captions vary in quality. Manual subtitles (when available) are always preferred. @@ -149,10 +149,10 @@ These settings come from `config.jsonc` (or built-in defaults); there are no CLI - **Secondary subtitle fails**: Secondary track failures never block playback. The primary subtitle loads independently. - **Native mpv secondary rendering**: Stays hidden during YouTube flows so the SubMiner overlay remains the visible secondary subtitle surface. -## Related Pages +## Related pages -- [Usage --- YouTube Playback](/usage#youtube-playback) -- [Configuration --- YouTube Playback Settings](/configuration#youtube-playback-settings) -- [Configuration --- Secondary Subtitles](/configuration#secondary-subtitles) +- [Usage - YouTube Playback](/usage#youtube-playback) +- [Configuration - YouTube Playback Settings](/configuration#youtube-playback-settings) +- [Configuration - Secondary Subtitles](/configuration#secondary-subtitles) - [Keyboard Shortcuts](/shortcuts) - [Jellyfin Integration](/jellyfin-integration)