Document local setup and OCR workflow

2026-08-11 16:51:48 +03:00
parent 37399dd365
commit f9271d4ab9
11 changed files with 3158 additions and 1 deletions
@@ -1,2 +1,40 @@
-# l2-market-parser
+# L2 Market Parser

+Кроссплатформенный локальный прототип для захвата нескольких окон Lineage II, калибровки областей на скриншоте и OCR-распознавания результата.
+
+## Запуск
+
+Нужен Node.js 20 или новее и Chrome либо Edge.
+
+```bash
+npm install
+npm run dev
+```
+
+Открой адрес, который напечатает Vite, обычно `http://127.0.0.1:5173`.
+
+На macOS браузеру потребуется разрешение **System Settings → Privacy & Security → Screen & System Audio Recording**. После выдачи разрешения браузер иногда нужно перезапустить.
+
+## Сценарий
+
+1. В разделе «Источники» нажми «Добавить окно» для каждого окна игры.
+2. В разделе «Калибровка» сделай снимок или загрузи готовый скриншот.
+3. Выдели маленький неизменяемый элемент торгового окна как якорь.
+4. Выдели области названия, цены и количества.
+5. Сохрани калибровку и нажми «Распознать все».
+
+Калибровка хранится в `localStorage` текущего браузера. При первом OCR Tesseract.js загружает английскую языковую модель и кеширует её в браузере.
+
+## Ограничения прототипа
+
+- Источники выбираются вручную после каждого обновления страницы.
+- Одна калибровка рассчитана на один масштаб интерфейса Lineage II.
+- Распознавание запускается вручную, фонового сканирования и отправки на сервер пока нет.
+- Для нескольких строк товара нужно отдельно выделить поля каждой строки.
+
+## Проверки
+
+```bash
+npm test
+npm run build
+```