AzuTear
e76d88e0c7
Import the existing Electron + React + TypeScript app as the version-control baseline before the scanner rework (C# input/capture sidecar, resolution-anchored layout profiles, OCR preprocessing, eval harness, rescan-merge, GOOD interop). Housekeeping in this commit: - Remove orphaned temp_inputhelper_block.ts (duplicate of the input-helper script). - Ignore .claude/scheduled_tasks.lock local session state. - Add .gitattributes to normalize line endings (LF in repo). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
136 lines
5.1 KiB
Markdown
136 lines
5.1 KiB
Markdown
# Decisions
|
|
|
|
This document contains Architecture Decision Records.
|
|
|
|
## ADR Index
|
|
|
|
| ID | Title | Status | Date |
|
|
| --- | --- | --- | --- |
|
|
| ADR-001 | Build a local Electron app first | Accepted | 2026-07-04 |
|
|
| ADR-002 | Use screen capture as the primary scanner source | Accepted | 2026-07-04 |
|
|
| ADR-003 | Keep APIs and GOOD compatibility optional | Accepted | 2026-07-04 |
|
|
| ADR-004 | Treat in-game marking as a later opt-in feature | Accepted | 2026-07-04 |
|
|
| ADR-005 | Use a generated Genshin data package for OCR matching | Accepted | 2026-07-04 |
|
|
| ADR-006 | Persistent input helper and JSON artifact store before SQLite | Accepted | 2026-07-04 |
|
|
|
|
## ADR-001: Build A Local Electron App First
|
|
|
|
### Status
|
|
|
|
Accepted
|
|
|
|
### Context
|
|
|
|
The product needs a Windows desktop UI, local screen capture, possible overlay windows, and future optional input automation.
|
|
|
|
### Decision
|
|
|
|
Use Electron with React and TypeScript for the MVP.
|
|
|
|
### Consequences
|
|
|
|
- Fast UI iteration and easy local packaging.
|
|
- Electron main-process code must be treated as a separate boundary from renderer code.
|
|
- Native or Rust sidecars can be added later for high-performance capture/OCR work.
|
|
|
|
## ADR-002: Use Screen Capture As The Primary Scanner Source
|
|
|
|
### Status
|
|
|
|
Accepted
|
|
|
|
### Context
|
|
|
|
The user wants an app that works without Inventory Kamera, Genshin Optimizer, Enka, or HoYoLAB as core dependencies.
|
|
|
|
### Decision
|
|
|
|
Use local screen capture as the primary source. Current Smart Capture focuses Genshin, hides the app, captures the primary screen through Windows GDI, detects the artifact detail panel, then OCRs focused crops.
|
|
|
|
### Consequences
|
|
|
|
- The app remains offline-first.
|
|
- OCR and crop reliability are core product risks.
|
|
- UI language, resolution, HDR, and game layout changes need explicit test coverage.
|
|
|
|
## ADR-003: Keep APIs And GOOD Compatibility Optional
|
|
|
|
### Status
|
|
|
|
Accepted
|
|
|
|
### Context
|
|
|
|
External APIs and existing optimizer formats can speed up setup, but should not define the main user workflow.
|
|
|
|
### Decision
|
|
|
|
Keep Enka, HoYoLAB, Akasha, Genshin Optimizer, and GOOD import/export as optional future compatibility layers.
|
|
|
|
### Consequences
|
|
|
|
- The app can work without external accounts or cookies.
|
|
- Data package and scanner quality become more important.
|
|
- Compatibility can be added when it helps testing, migration, or export.
|
|
|
|
## ADR-004: Treat In-Game Marking As A Later Opt-In Feature
|
|
|
|
### Status
|
|
|
|
Accepted
|
|
|
|
### Context
|
|
|
|
Locking or marking artifacts in game may save time, but input automation increases ToS and misclick risk.
|
|
|
|
### Decision
|
|
|
|
Do not ship in-game marking in the scanner MVP. If implemented later, it must be off by default, reversible, whitelisted, previewed before execution, and stoppable with ESC or user mouse movement.
|
|
|
|
### Consequences
|
|
|
|
- Early scanner work stays lower risk.
|
|
- App-internal triage remains the first decision layer.
|
|
- No delete, feed, enhance, or resource-spending automation is allowed.
|
|
|
|
## ADR-005: Use A Generated Genshin Data Package For OCR Matching
|
|
|
|
### Status
|
|
|
|
Accepted
|
|
|
|
### Context
|
|
|
|
Hardcoded arrays for characters and artifact sets caused repeated scanner failures whenever the user tested a newer character, set, or artifact name.
|
|
|
|
### Decision
|
|
|
|
Generate `src/data/genshinGameData.json` from `genshin-db` and use it as the local matching dictionary for artifact sets, artifact piece names, characters, slots, main stats, and substats.
|
|
|
|
### Consequences
|
|
|
|
- The scanner can recognize new characters and sets as soon as the local data package is regenerated from an updated `genshin-db`.
|
|
- Parser logic stays generic and testable instead of growing one-off fixes.
|
|
- OCR still needs good crops and text quality; the data package improves recognition but cannot solve unreadable screenshots by itself.
|
|
|
|
## ADR-006: Persistent Input Helper And JSON Artifact Store Before SQLite
|
|
|
|
### Status
|
|
|
|
Accepted
|
|
|
|
### Context
|
|
|
|
Per-action PowerShell scripts recompiled the Win32 interop for every click, scroll, and capture (1-2s each) and one `Marshal::SizeOf` call was broken in Windows PowerShell 5.1, so SendInput clicks silently never executed. Scan results were also not persisted anywhere; only review samples reached disk. Adding `better-sqlite3` (native module) was considered too heavy for this step.
|
|
|
|
### Decision
|
|
|
|
Run one persistent PowerShell helper process (compiled once, JSON protocol over stdin/stdout) for focus, cursor/ESC state, click, scroll, and GDI capture. Persist parsed artifacts into `artifact-store.json` in userData, deduplicated by a content signature that excludes the equipped character. Keep SQLite as the planned future store; the JSON store is the migration source.
|
|
|
|
### Consequences
|
|
|
|
- Batch scans become fast enough to be testable and the failsafe (ESC or user mouse movement aborts) can poll cheaply between actions.
|
|
- Automated clicks are verified by checking that the parsed detail signature changed; repeated failures abort with a diagnosis hint instead of clicking blindly.
|
|
- Leveling an artifact changes its signature and creates a new record; rescan-merge is an open follow-up.
|
|
- If the helper process dies it is respawned on the next request; pending requests fail loudly instead of hanging.
|