SubMiner/docs/index.md

layout, title, titleTemplate, hero, features

layout	title	titleTemplate	hero	features
home	SubMiner	Immersion Mining Workflow for MPV	name text tagline image actions SubMiner Immersion Mining for MPV Look up words, mine to Anki, and enrich cards with context — all without leaving the video. src alt /assets/SubMiner.png SubMiner logo theme text link brand Get Started /installation theme text link alt Mining Workflow /mining-workflow	icon title details src alt /assets/mpv.svg mpv icon Built for mpv Connects via IPC to track subtitles in real time and render a self-contained overlay — everything bundled in a single application. icon title details src alt /assets/yomitan-icon.svg Yomitan logo Yomitan Integration Hover over any word in the subtitle overlay to trigger dictionary lookups — instant definitions without leaving the player. icon title details src alt /assets/anki-card.svg Anki card icon Anki Card Enrichment Add a word from Yomitan and SubMiner fills in the sentence, audio clip, screenshot, and translation automatically. icon title details src alt /assets/dual-layer.svg Dual layer icon Dual-Layer Subtitles Interactive visible overlay plus an invisible layer aligned with mpv's own rendering for seamless click-through lookup. icon title details src alt /assets/highlight.svg Highlight icon N+1 Highlighting Marks words you already know from your Anki deck so you can spot new vocabulary and identify N+1 sentences at a glance. icon title details src alt /assets/texthooker.svg Texthooker icon Texthooker & WebSocket Built-in texthooker page that receives subtitles over WebSocket — use it as a clipboard inserter or connect external tools. icon title details src alt /assets/subtitle-download.svg Subtitle download icon Subtitle Download & Sync Search and download Japanese subtitles from Jimaku, then sync to audio with alass or ffsubsync — all from within the player. icon title details src alt /assets/keyboard.svg Keyboard icon Keyboard-Driven Mine sentences, copy subtitles, cycle display modes, and trigger field grouping — all from configurable shortcuts.

<style> .demo-section { max-width: 960px; margin: 0 auto; padding: 0 24px; } .demo-section h2 { font-size: 1.5rem; font-weight: 600; margin-bottom: 0.5rem; letter-spacing: -0.01em; } .demo-section p { color: var(--vp-c-text-2); margin-bottom: 1.25rem; line-height: 1.6; } .demo-section video { width: 100%; border-radius: 12px; border: 1px solid var(--vp-c-divider); box-shadow: 0 4px 24px rgba(0, 0, 0, 0.15); } .workflow-section { max-width: 960px; margin: 4rem auto 0; padding: 0 24px 3rem; } .workflow-section h2 { font-size: 1.5rem; font-weight: 600; margin-bottom: 1.5rem; letter-spacing: -0.01em; } .workflow-steps { display: grid; grid-template-columns: repeat(4, 1fr); gap: 1px; background: var(--vp-c-divider); border-radius: 12px; overflow: hidden; } @media (max-width: 768px) { .workflow-steps { grid-template-columns: 1fr; } } .workflow-step { padding: 1.25rem 1.5rem; background: var(--vp-c-bg-soft); } .workflow-step .step-number { display: inline-block; font-size: 0.7rem; font-weight: 700; letter-spacing: 0.05em; color: var(--vp-c-brand-1); margin-bottom: 0.5rem; font-variant-numeric: tabular-nums; } .workflow-step .step-title { font-weight: 600; font-size: 1rem; margin-bottom: 0.35rem; } .workflow-step .step-desc { font-size: 0.85rem; color: var(--vp-c-text-2); line-height: 1.5; } </style>

How It Works

01

Watch

Play a video in mpv. SubMiner connects via IPC and captures subtitles in real time.

02

Look Up

Hover over a word in the subtitle overlay and hold Shift to trigger a Yomitan lookup.

03

Mine

Add the word to Anki from Yomitan. SubMiner detects the new card automatically.

04

Enrich

SubMiner fills in the sentence, audio clip, screenshot, and translation — no extra steps.

CLI Quick Reference

subminer                    # Default picker + playback workflow
subminer jellyfin -d        # Jellyfin cast discovery mode (foreground)
subminer jellyfin -p        # Jellyfin play picker
subminer yt -o ~/subs URL   # YouTube subcommand with output dir shortcut
subminer doctor             # Dependency/config/socket health checks
subminer config path        # Active config file path
subminer config show        # Print active config
subminer mpv status         # MPV socket readiness
subminer texthooker         # Texthooker-only mode

See Usage for full command and option coverage.

See It in Action