mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-05-26 00:55:16 -07:00

Files

T

docs: audit and refresh user-facing and internal docs

Cross-check every config key, shortcut, default, and command against the
current source and fix the drift (mpv.socketPath, auto_start_overlay
default, AniSkip TAB key, JLPT N4 color, secondary-sub font/defaults,
secondary-sub language behavior, modular mpv plugin layout, and more).
Add plain-language intros and first-use definitions across onboarding and
integration pages so non-technical readers can follow along.

Internal docs/: fix stale module paths in architecture/domains.md, add
missing contract entry points and catalog rows, and bump verified dates.
Remove the obsolete docs/plans/ directory (its only plan shipped in
0.15.0) and reframe planning.md so plans live with the work, not in docs/.

2026-05-23 21:21:16 -07:00

5.1 KiB

Raw Blame History

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 sidebar is enabled by default. Set subtitleSidebar.enabled to false if you want to turn it off.

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 to that timestamp.
The sidebar stays synchronized with the overlay — media transitions and subtitle source changes update both simultaneously.

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.

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.

Configuration

Enable and configure the sidebar under subtitleSidebar in your config file:

{
  "subtitleSidebar": {
    "enabled": true,
    "autoOpen": false,
    "layout": "overlay",
    "toggleKey": "Backslash",
    "pauseVideoOnHover": true,
    "autoScroll": true,
    "fontFamily": "\"M PLUS 1\", \"Noto Sans CJK JP\", sans-serif",
    "fontSize": 16
  }
}

Option	Type	Default	Description
`enabled`	boolean	`true`	Enable subtitle sidebar support
`autoOpen`	boolean	`false`	Open the sidebar automatically on overlay startup
`layout`	string	`"overlay"`	`"overlay"` floats over mpv; `"embedded"` reserves right-side player space
`toggleKey`	string	`"Backslash"`	`KeyboardEvent.code` for the toggle shortcut
`pauseVideoOnHover`	boolean	`true`	Pause playback while hovering the cue list
`autoScroll`	boolean	`true`	Keep the active cue in view during playback
`maxWidth`	number	`420`	Maximum sidebar width in CSS pixels
`opacity`	number	`0.95`	Sidebar opacity between `0` and `1`
`backgroundColor`	string	`rgba(73, 77, 100, 0.9)`	Sidebar shell background color
`textColor`	string	`#cad3f5`	Default cue text color
`fontFamily`	string	`Hiragino Sans, M PLUS 1, Source Han Sans JP, Noto Sans CJK JP`	CSS `font-family` applied to cue text
`fontSize`	number	`16`	Base cue font size in CSS pixels
`timestampColor`	string	`#a5adcb`	Cue timestamp color
`activeLineColor`	string	`#f5bde6`	Active cue text color
`activeLineBackgroundColor`	string	`rgba(138, 173, 244, 0.22)`	Active cue background color
`hoverLineBackgroundColor`	string	`rgba(54, 58, 79, 0.84)`	Hovered cue background color

Keyboard Shortcut

Key	Action	Config key
`\`	Toggle subtitle sidebar	`subtitleSidebar.toggleKey`

The toggle is overlay-local and only opens when SubMiner has a parsed cue list for the active subtitle source. See Keyboard Shortcuts for the full shortcut reference.

5.1 KiB Raw Blame History