mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-03-24 00:11:27 -07:00
* fix: harden preload argv parsing for popup windows * fix: align youtube playback with shared overlay startup * fix: unwrap mpv youtube streams for anki media mining * docs: update docs for youtube subtitle and mining flow * refactor: unify cli and runtime wiring for startup and youtube flow * feat: update subtitle sidebar overlay behavior * chore: add shared log-file source for diagnostics * fix(ci): add changelog fragment for immersion changes * fix: address CodeRabbit review feedback * fix: persist canonical title from youtube metadata * style: format stats library tab * fix: address latest review feedback * style: format stats library files * test: stub launcher youtube deps in CI * test: isolate launcher youtube flow deps * test: stub launcher youtube deps in failing case * test: force x11 backend in launcher ci harness * test: address latest review feedback * fix(launcher): preserve user YouTube ytdl raw options * docs(backlog): update task tracking notes * fix(immersion): special-case youtube media paths in runtime and tracking * feat(stats): improve YouTube media metadata and picker key handling * fix(ci): format stats media library hook * fix: address latest CodeRabbit review items * docs: update youtube release notes and docs * feat: auto-load youtube subtitles before manual picker * fix: restore app-owned youtube subtitle flow * docs: update youtube playback docs and config copy * refactor: remove legacy youtube launcher mode plumbing * fix: refine youtube subtitle startup binding * docs: clarify youtube subtitle startup behavior * fix: address PR #31 latest review follow-ups * fix: address PR #31 follow-up review comments * test: harden youtube picker test harness * udpate backlog * fix: add timeout to youtube metadata probe * docs: refresh youtube and stats docs * update backlog * update backlog * chore: release v0.9.0
201 lines
6.6 KiB
TypeScript
201 lines
6.6 KiB
TypeScript
import { ConfigTemplateSection } from './shared';
|
|
|
|
const CORE_TEMPLATE_SECTIONS: ConfigTemplateSection[] = [
|
|
{
|
|
title: 'Overlay Auto-Start',
|
|
description: [
|
|
'When overlay connects to mpv, automatically show overlay and hide mpv subtitles.',
|
|
],
|
|
key: 'auto_start_overlay',
|
|
},
|
|
{
|
|
title: 'Texthooker Server',
|
|
description: ['Configure texthooker startup launch and browser opening behavior.'],
|
|
key: 'texthooker',
|
|
},
|
|
{
|
|
title: 'WebSocket Server',
|
|
description: [
|
|
'Built-in WebSocket server broadcasts subtitle text to connected clients.',
|
|
'Auto mode disables built-in server if mpv_websocket is detected.',
|
|
],
|
|
key: 'websocket',
|
|
},
|
|
{
|
|
title: 'Annotation WebSocket',
|
|
description: [
|
|
'Dedicated annotated subtitle websocket for bundled texthooker and token-aware clients.',
|
|
'Independent from websocket.auto and defaults to port 6678.',
|
|
],
|
|
key: 'annotationWebsocket',
|
|
},
|
|
{
|
|
title: 'Logging',
|
|
description: ['Controls logging verbosity.', 'Set to debug for full runtime diagnostics.'],
|
|
key: 'logging',
|
|
},
|
|
{
|
|
title: 'Controller Support',
|
|
description: [
|
|
'Gamepad support for the visible overlay while keyboard-only mode is active.',
|
|
'Use Alt+C to pick a preferred controller and remap actions inline with learn mode.',
|
|
'Trigger input mode can be auto, digital-only, or analog-thresholded depending on the controller.',
|
|
'Override controller.buttonIndices when your pad reports non-standard raw button numbers.',
|
|
],
|
|
key: 'controller',
|
|
},
|
|
{
|
|
title: 'Startup Warmups',
|
|
description: [
|
|
'Background warmup controls for MeCab, Yomitan, dictionaries, and Jellyfin session.',
|
|
'Disable individual warmups to defer load until first real usage.',
|
|
'lowPowerMode defers all warmups except Yomitan extension.',
|
|
],
|
|
key: 'startupWarmups',
|
|
},
|
|
{
|
|
title: 'Keyboard Shortcuts',
|
|
description: ['Overlay keyboard shortcuts. Set a shortcut to null to disable.'],
|
|
notes: ['Hot-reload: shortcut changes apply live and update the session help modal on reopen.'],
|
|
key: 'shortcuts',
|
|
},
|
|
{
|
|
title: 'Keybindings (MPV Commands)',
|
|
description: [
|
|
'Extra keybindings that are merged with built-in defaults.',
|
|
'Set command to null to disable a default keybinding.',
|
|
],
|
|
notes: [
|
|
'Hot-reload: keybinding changes apply live and update the session help modal on reopen.',
|
|
],
|
|
key: 'keybindings',
|
|
},
|
|
{
|
|
title: 'Secondary Subtitles',
|
|
description: [
|
|
'Dual subtitle track options.',
|
|
'Used by the YouTube subtitle loading flow as secondary language preferences.',
|
|
],
|
|
notes: ['Hot-reload: defaultMode updates live while SubMiner is running.'],
|
|
key: 'secondarySub',
|
|
},
|
|
{
|
|
title: 'Auto Subtitle Sync',
|
|
description: ['Subsync engine and executable paths.'],
|
|
key: 'subsync',
|
|
},
|
|
{
|
|
title: 'Subtitle Position',
|
|
description: ['Initial vertical subtitle position from the bottom.'],
|
|
key: 'subtitlePosition',
|
|
},
|
|
];
|
|
|
|
const SUBTITLE_TEMPLATE_SECTIONS: ConfigTemplateSection[] = [
|
|
{
|
|
title: 'Subtitle Appearance',
|
|
description: ['Primary and secondary subtitle styling.'],
|
|
notes: ['Hot-reload: subtitle style changes apply live without restarting SubMiner.'],
|
|
key: 'subtitleStyle',
|
|
},
|
|
{
|
|
title: 'Subtitle Sidebar',
|
|
description: ['Parsed-subtitle sidebar cue list styling, behavior, and toggle key.'],
|
|
notes: ['Hot-reload: subtitle sidebar changes apply live without restarting SubMiner.'],
|
|
key: 'subtitleSidebar',
|
|
},
|
|
];
|
|
|
|
const INTEGRATION_TEMPLATE_SECTIONS: ConfigTemplateSection[] = [
|
|
{
|
|
title: 'Shared AI Provider',
|
|
description: [
|
|
'Canonical OpenAI-compatible provider transport settings shared by Anki and YouTube subtitle fixing.',
|
|
],
|
|
key: 'ai',
|
|
},
|
|
{
|
|
title: 'AnkiConnect Integration',
|
|
description: ['Automatic Anki updates and media generation options.'],
|
|
notes: [
|
|
'Hot-reload: ankiConnect.ai.enabled updates live while SubMiner is running.',
|
|
'Shared AI provider transport settings are read from top-level ai and typically require restart.',
|
|
'Most other AnkiConnect settings still require restart.',
|
|
],
|
|
key: 'ankiConnect',
|
|
},
|
|
{
|
|
title: 'Jimaku',
|
|
description: ['Jimaku API configuration and defaults.'],
|
|
key: 'jimaku',
|
|
},
|
|
{
|
|
title: 'YouTube Playback Settings',
|
|
description: ['Defaults for SubMiner YouTube subtitle loading and languages.'],
|
|
key: 'youtubeSubgen',
|
|
},
|
|
{
|
|
title: 'Anilist',
|
|
description: [
|
|
'Anilist API credentials and update behavior.',
|
|
'Includes optional auto-sync for a merged MRU-based character dictionary in bundled Yomitan.',
|
|
'Character dictionaries are keyed by AniList media ID (no season/franchise merge).',
|
|
],
|
|
key: 'anilist',
|
|
},
|
|
{
|
|
title: 'Yomitan',
|
|
description: [
|
|
'Optional external Yomitan profile integration.',
|
|
'Setting yomitan.externalProfilePath switches SubMiner to read-only external-profile mode.',
|
|
'For GameSentenceMiner on Linux, the default overlay profile is usually ~/.config/gsm_overlay.',
|
|
'In external-profile mode SubMiner will not import, delete, or modify Yomitan dictionaries/settings.',
|
|
],
|
|
key: 'yomitan',
|
|
},
|
|
{
|
|
title: 'Jellyfin',
|
|
description: [
|
|
'Optional Jellyfin integration for auth, browsing, and playback launch.',
|
|
'Access token is stored in local encrypted token storage after login/setup.',
|
|
'jellyfin.accessToken remains an optional explicit override in config.',
|
|
],
|
|
key: 'jellyfin',
|
|
},
|
|
{
|
|
title: 'Discord Rich Presence',
|
|
description: [
|
|
'Optional Discord Rich Presence activity card updates for current playback/study session.',
|
|
'Uses official SubMiner Discord app assets for polished card visuals.',
|
|
],
|
|
key: 'discordPresence',
|
|
},
|
|
];
|
|
|
|
const IMMERSION_TEMPLATE_SECTIONS: ConfigTemplateSection[] = [
|
|
{
|
|
title: 'Immersion Tracking',
|
|
description: [
|
|
'Enable/disable immersion tracking.',
|
|
'Set dbPath to override the default sqlite database location.',
|
|
'Policy tuning is available for queue, flush, and retention values.',
|
|
],
|
|
key: 'immersionTracking',
|
|
},
|
|
{
|
|
title: 'Stats Dashboard',
|
|
description: [
|
|
'Local immersion stats dashboard served on localhost and available as an in-app overlay.',
|
|
'Uses the immersion tracking database for overview, trends, sessions, and vocabulary views.',
|
|
],
|
|
key: 'stats',
|
|
},
|
|
];
|
|
|
|
export const CONFIG_TEMPLATE_SECTIONS: ConfigTemplateSection[] = [
|
|
...CORE_TEMPLATE_SECTIONS,
|
|
...SUBTITLE_TEMPLATE_SECTIONS,
|
|
...INTEGRATION_TEMPLATE_SECTIONS,
|
|
...IMMERSION_TEMPLATE_SECTIONS,
|
|
];
|