mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-05-26 00:55:16 -07:00
sudacode
c02edc90cc
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/.
40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
<!-- read_when: changing runtime wiring, moving code across layers, or trying to find ownership -->
|
|
|
|
# Architecture Map
|
|
|
|
Status: active
|
|
Last verified: 2026-05-23
|
|
Owner: Kyle Yasuda
|
|
Read when: runtime ownership, composition boundaries, or layering questions
|
|
|
|
SubMiner runs as three cooperating runtimes:
|
|
|
|
- Electron desktop app in `src/`
|
|
- Launcher CLI in `launcher/`
|
|
- mpv Lua plugin in `plugin/subminer/`
|
|
|
|
The desktop app keeps `src/main.ts` as composition root and pushes behavior into small runtime/domain modules.
|
|
|
|
## Read Next
|
|
|
|
- [Domains](./domains.md) - who owns what
|
|
- [Layering](./layering.md) - how modules should depend on each other
|
|
- Public contributor summary: [`docs-site/architecture.md`](../../docs-site/architecture.md)
|
|
|
|
## Current Shape
|
|
|
|
- `src/main/` owns composition, runtime setup, IPC wiring, and app lifecycle adapters.
|
|
- `src/main/boot/` owns boot-phase assembly seams so `src/main.ts` can stay focused on lifecycle coordination and startup-path selection.
|
|
- `src/core/services/` owns focused runtime services plus pure or side-effect-bounded logic.
|
|
- `src/renderer/` owns overlay rendering and input behavior.
|
|
- `src/config/` owns config definitions, defaults, loading, and resolution.
|
|
- `src/types/` owns shared cross-runtime contracts via domain entrypoints; `src/types.ts` stays a compatibility barrel.
|
|
- `src/main/runtime/composers/` owns larger domain compositions.
|
|
|
|
## Architecture Intent
|
|
|
|
- Small units, explicit boundaries
|
|
- Composition over monoliths
|
|
- Pure helpers where possible
|
|
- Stable user behavior while internals evolve
|