SubMiner

Immersion mining overlay for mpv — look up words, mine to Anki, and enrich cards with context without leaving the video.

---

Features

• Yomitan Integration — Hover subtitle words to trigger dictionary lookups in the player
• Anki Card Enrichment — Fills sentence, audio, screenshot, and translation on new cards automatically
• Dual-Layer Subtitles — Interactive visible overlay + invisible click-through layer aligned with mpv rendering
• N+1 Highlighting — Marks known vocabulary from your Anki deck so you can spot new words at a glance
• Texthooker & WebSocket — Built-in texthooker page with WebSocket streaming for external tools
• Subtitle Download & Sync — Search Jimaku, sync with alass or ffsubsync — all from the player
• Queue Control In-Player — Drop videos on overlay to load/queue in mpv; Ctrl/Cmd+A appends clipboard path
• Keyboard-Driven — Mine, copy, cycle display modes, and navigate from configurable shortcuts
• Config Hot Reload — Apply subtitle style and shortcut updates from config.jsonc without restarting
• Japanese Tokenization — MeCab-powered word boundary detection with smart grouping

Requirements

• mpv with IPC socket support
• mecab and mecab-ipadic
• Linux: Hyprland (hyprctl) or X11 (xdotool + xwininfo)
• macOS: Accessibility permission for window tracking

Optional: yt-dlp, fzf, rofi, chafa, ffmpegthumbnailer

Install

Linux (AppImage)

wget https://github.com/ksyasuda/SubMiner/releases/download/v0.1.0/SubMiner-0.1.0.AppImage -O ~/.local/bin/SubMiner.AppImage
chmod +x ~/.local/bin/SubMiner.AppImage
wget https://github.com/ksyasuda/SubMiner/releases/download/v0.1.0/subminer -O ~/.local/bin/subminer
chmod +x ~/.local/bin/subminer

The subminer wrapper uses a Bun shebang, so bun must be on PATH.

From Source

git clone --recurse-submodules https://github.com/ksyasuda/SubMiner.git
cd SubMiner
bun install
cd vendor/texthooker-ui && pnpm install --frozen-lockfile && cd ../..
make build
make install

For macOS builds and platform details, see the installation docs.

Quick Start

1. Copy config.example.jsonc to ~/.config/SubMiner/config.jsonc
   • Regenerate anytime from source: make generate-example-config or bun run generate:config-example
2. Start mpv with IPC:

   mpv --input-ipc-server=/tmp/subminer-socket video.mkv
   

3. Launch SubMiner:

   subminer --start video.mkv
   SubMiner.AppImage --background  # tray/background mode (desktop launcher default)
   

Config tip: while SubMiner is running, safe config edits (subtitle style, keybindings, shortcuts, secondary subtitle default mode, and ankiConnect.ai) hot-reload automatically.

subminer                        # pick video from cwd (fzf)
subminer -R                     # rofi picker
subminer -d ~/Videos            # set source directory
subminer -r -d ~/Anime          # recursive search
subminer -p gpu-hq video.mkv    # override mpv profile
subminer -T video.mkv           # disable texthooker
subminer https://youtu.be/...   # YouTube playback
subminer jellyfin -d            # Jellyfin cast discovery mode
subminer doctor                 # dependency/config/socket diagnostics
subminer config path            # print active config file path
subminer mpv status             # mpv socket readiness check

Launcher Subcommands

• subminer jellyfin / subminer jf — Jellyfin workflows (-d discovery, -p play, -l login)
• subminer yt / subminer youtube — YouTube shorthand (-o/--out-dir, -m/--mode)
• subminer doctor — quick environment health checks
• subminer config path|show — inspect active config path/content
• subminer mpv status|socket|idle — mpv socket and idle-launch helpers
• subminer texthooker — texthooker-only shortcut

Use subminer <subcommand> -h for command-specific help pages (for example subminer jellyfin -h).

CLI Logging and Dev Mode

• Use --log-level to control logger verbosity (for example --log-level debug).
• Use --dev and --debug only for app/dev-mode behavior; they are not tied to logging level.
• Default logging is info, except --background mode defaults to warn unless --log-level is set.

Overlay Queue Controls

• Drag/drop video file(s) onto overlay:
  • default: replace current playback with first file, append remaining dropped files
  • hold Shift: append all dropped files
• Press Ctrl/Cmd+A to append the clipboard path when it points to a readable local video file.

MPV Plugin

cp plugin/subminer.lua ~/.config/mpv/scripts/
cp plugin/subminer.conf ~/.config/mpv/script-opts/
# or: make install-plugin

Default chord prefix: y (y-y menu, y-s start, y-S stop, y-t toggle overlay). Jimaku shortcut: Ctrl+Shift+J.

Documentation

Full guides at docs/: Installation · Usage · Mining Workflow · Configuration · Anki Integration · MPV Plugin · Troubleshooting · Architecture

Acknowledgments

• GameSentenceMiner — Inspiration for the overlay and Yomitan integration
• Jimaku.cc — Japanese subtitle provider
• mpvacious, Anacreon-Script, autosubsync-mpv — Mining and sync logic ported to TypeScript

Third-party: Yomitan · texthooker-ui · yomitan-jlpt-vocab · Jiten Frequency Dictionary

License

GNU General Public License v3.0