diff --git a/.gitignore b/.gitignore index 8da312e..d42112f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,9 @@ # Dependencies node_modules/ +# Superpowers brainstorming +.superpowers/ + # Electron build output out/ dist/ @@ -22,9 +25,7 @@ Thumbs.db .idea/ *.swp *.swo -**/CLAUDE.md environment.toml -**/CLAUDE.md .env .vscode/* diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 0000000..47dc3e3 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file diff --git a/README.md b/README.md index 5e87432..98d9628 100644 --- a/README.md +++ b/README.md @@ -22,15 +22,54 @@ ## What it does -SubMiner is an Electron overlay that sits on top of mpv. It turns your video player into a full sentence-mining workstation: +SubMiner is an Electron overlay that sits on top of mpv. It turns your video player into a full sentence-mining workstation — look up any word with Yomitan, mine it to Anki with one key, and track your immersion progress over time. -- **Look up words as you watch** — Yomitan dictionary popups on hover or keyboard-driven token-by-token navigation -- **One-key Anki mining** — Creates cards with sentence, audio, screenshot, and translation; optional local AnkiConnect proxy auto-enriches Yomitan cards instantly -- **Reading annotations** — N+1 targeting, frequency-dictionary highlighting, JLPT underlining, and character name dictionary for anime/manga proper nouns -- **Immersion stats** — Optional local dashboard and overlay for watch time, anime progress, session drill-down, vocabulary growth, mining throughput, and card mining directly from example sentences; exact lifetime totals are kept locally in SQLite by default +## Features + +### Dictionary Lookups While You Watch + +Yomitan runs directly inside the overlay. Hover over any word in the subtitles or navigate with keyboard/controller to get full dictionary popups without pausing or switching windows. + +### One-Key Anki Mining + +Press a single key to send a word to Anki. SubMiner auto-fills the card with the sentence, audio clip, screenshot, and machine translation — all captured from the exact moment you looked it up. + +
+ One-key Anki card creation — Yomitan popup with dictionary entry and mine button over annotated subtitles +
+ +### Reading Annotations + +Subtitles are annotated in real time with N+1 targeting, frequency-dictionary highlighting, JLPT level tags, and a character name dictionary for anime and manga proper nouns. + +
+ Subtitle annotations with frequency highlighting, JLPT underlines, known words, N+1 targets, and character names +
+ Subtitle annotations with frequency highlighting, JLPT underlines, known words, N+1 targets, and character names +
+ +### Immersion Dashboard + +A local stats dashboard tracks your watch time, anime progress, vocabulary growth, mining throughput, and session history. Drill down into individual sessions or browse your full library. + +
+ Stats dashboard — overview with watch time, cards mined, streaks, and tracking snapshot +

+ Vocabulary tab — unique words, known words, top repeated words, and unmined word list +

+ +
+ +### External Integrations + +- **AniList** — Automatic episode progress tracking +- **Jellyfin** — Remote playback, cast device mode - **Subtitle tools** — Download from Jimaku, sync with alass/ffsubsync -- **Jellyfin & AniList integration** — Remote playback, cast device mode, and automatic episode progress tracking -- **Texthooker & API** — Built-in texthooker page and annotated websocket feed for external clients +- **Texthooker & API** — Custom texthooker page and annotated websocket feed for external clients + +
+ Texthooker page with annotated subtitle lines — known words, N+1 targets, character names, and frequency highlighting +
## Quick start @@ -55,10 +94,10 @@ makepkg -si **Linux (AppImage):** ```bash -wget https://github.com/ksyasuda/SubMiner/releases/latest/download/SubMiner.AppImage -O ~/.local/bin/SubMiner.AppImage -chmod +x ~/.local/bin/SubMiner.AppImage -wget https://github.com/ksyasuda/SubMiner/releases/latest/download/subminer -O ~/.local/bin/subminer -chmod +x ~/.local/bin/subminer +wget https://github.com/ksyasuda/SubMiner/releases/latest/download/SubMiner.AppImage -O ~/.local/bin/SubMiner.AppImage \ + && chmod +x ~/.local/bin/SubMiner.AppImage +wget https://github.com/ksyasuda/SubMiner/releases/latest/download/subminer -O ~/.local/bin/subminer \ + && chmod +x ~/.local/bin/subminer ``` @@ -69,7 +108,7 @@ chmod +x ~/.local/bin/subminer **Windows (Installer/ZIP):** download the latest `SubMiner-.exe` installer or portable `.zip` from [GitHub Releases](https://github.com/ksyasuda/SubMiner/releases/latest). Keep `mpv` installed and available on `PATH`. -**From source** — initialize submodules first (`git submodule update --init --recursive`). Bundled Yomitan is built from the `vendor/subminer-yomitan` submodule into `build/yomitan` during `bun run build`, so source builds only need Bun for the JS toolchain. Packaged macOS and Windows installs do not require Bun. Windows installer builds go through `electron-builder`; its bundled `app-builder-lib` NSIS templates already use the third-party `WinShell` plugin for shortcut AppUserModelID assignment, and the `WinShell.dll` binary is supplied by electron-builder's cached `nsis-resources` bundle, so `bun run build:win` does not need a separate repo-local plugin install step. Full install guide: [docs.subminer.moe/installation#from-source](https://docs.subminer.moe/installation#from-source). +**From source** — see [docs.subminer.moe/installation#from-source](https://docs.subminer.moe/installation#from-source). ### 2. Launch the app once diff --git a/release/release-notes.md b/release/release-notes.md deleted file mode 100644 index 23298b2..0000000 --- a/release/release-notes.md +++ /dev/null @@ -1,15 +0,0 @@ -## Highlights -### Internal -- Release: Seed the AUR checkout with the repo `.SRCINFO` template before rewriting metadata so tagged releases do not depend on prior AUR state. - -## Installation - -See the README and docs/installation guide for full setup steps. - -## Assets - -- Linux: `SubMiner.AppImage` -- macOS: `SubMiner-*.dmg` and `SubMiner-*.zip` -- Optional extras: `subminer-assets.tar.gz` and the `subminer` launcher - -Note: the `subminer` wrapper script uses Bun (`#!/usr/bin/env bun`), so `bun` must be installed and on `PATH`.