Об этом проекте

tarkov-data-overlay представляет собой поддерживаемый сообществом слой корректировок и дополнений к данным API tarkov.dev. Основная цель проекта — устранение разрыва между обновлениями игры и обновлениями данных: исправление неверных значений (например, уровней заданий или требований к картам) и добавление типов данных, которых нет в основном API (например, изданий игры). Использование Слой публикуется в виде JSON-файла и загружается из CDN jsDelivr. Пользователи объединяют его с ответами tarkov.dev. В README рекомендуется закреплять неизменяемый тег релиза или коммит для использования в продакшене, так как URL ветки отслеживает текущее состояние репозитория; встроенный дайджест позволяет обнаружить повреждение или устаревание данных, но не подтверждает подлинность ответа CDN. Детали интеграции описаны в руководстве по интеграции, а отдельные документы охватывают доступность заданий, отслеживание состояния разблокировки и контракт данных счетчиков; для верифицированных счетчиков прогресса и явных результатов «неизвестно» упоминается помощник evaluateTaskProgression. Мониторинг Доступен хостинг-монитор, который также можно запустить локально с помощью npm-скрипта. По умолчанию он работает в режиме чтения. Действие «Update overlay» при локальном запуске требует явного согласия и токена пересборки; пересборка всегда требует передачи ненулевого токена в заголовке Authorization Bearer. По умолчанию сервер привязывается к loopback; привязка к другим адресам рекомендуется только за доверенным обратным прокси или сетевым барьером. Если HTTPS терминируется доверенным прокси, отдельный флаг включает возможность пересборки, и в этом режиме квоты потока событий для каждого клиента используют первый валидный адрес X-Forwarded-For, поэтому прокси должен перезаписывать этот заголовок. Пересборки направлены в путь вывода оверлея по умолчанию; пользовательские локальные и HTTP(S) цели остаются доступными только для чтения. Обслуживание Команда check-overrides сравнивает все переопределения с текущими данными API и сообщает, какие из них все еще нужны, какие исправления были внесены в основной API и могут быть удалены, какие задания исчезли из API, а также фиксирует регрессии качества данных в основном источнике. Отчетность включена по умолчанию; три опциональных фильтра управляют поведением при сбоях с разными кодами выхода для строгих проверок несоответствия, устаревших данных, которые теперь предоставляет основной API (этот фильтр запускается в CI), и регрессий основного API. Фильтр регрессий намеренно исключен из CI, так как такие проблемы возникают в данных tarkov.dev и не могут быть устранены в этом репозитории. Локальная валидация, проверка типов и тесты запускаются через отдельные npm-скрипты. Управление и вклад Предоставлены руководства по внесению вклада и сортировке задач. Проект описывается как поддерживаемый сообществом и работающий по принципу «best-effort»; для внесения исправлений требуются доказательства (ссылки на вики или скриншоты). Проект позиционирует себя как временный мост при пробелах в данных, а не как замена tarkov.dev, и ведет прозрачную историю через Git. Условия лицензии содержатся в файле LICENSE репозитория.