这个项目能做什么

tarkov-data-overlay 是一个由社区维护的数据覆盖层,用于对 tarkov.dev API 进行数据修正和补充。其核心动机在于游戏更新速度可能快于数据更新,因此该项目通过两种方式填补空白:修复错误数值(如任务等级或地图要求),以及添加上游 API 不具备的数据类型(如游戏版本)。 使用方法 该覆盖层以 JSON 文件形式发布,并从 jsDelivr CDN 获取。使用者将其与 tarkov.dev 的响应结果进行合并。README 建议在生产环境中使用不可变的发布标签或提交记录,因为分支 URL 会跟踪仓库的滚动状态;内置的摘要可检测数据损坏或陈旧,但不能证明 CDN 响应的真实性。集成详情可见于集成指南,另有独立文档涵盖任务可用性、解锁状态跟踪以及计数器数据合约;文中提到 evaluateTaskProgression 辅助函数可用于验证基于进度的计数器并处理明确的未知结果。 监控 项目提供托管的监控面板,且可通过 npm 脚本在本地运行该监控。默认情况下,监控为只读。本地的“更新覆盖层”操作需要通过重建令牌(rebuild token)明确选择加入,且重建操作始终要求在 Authorization Bearer 请求头中传递非空令牌。服务器默认绑定到回环地址;仅建议在受信任的反向代理或网络边界后绑定到其他地址。当 HTTPS 由受信任的代理终止时,可通过单独的标志启用重建,且在这种模式下,每个客户端的事件流配额使用第一个有效的 X-Forwarded-For 地址,因此代理必须覆盖该请求头。重建操作针对默认的覆盖层输出路径;自定义的本地和 HTTP(S) 覆盖层目标保持只读。 维护 check-overrides 命令将所有覆盖项与当前 API 数据进行对比,并报告哪些项仍被需要、哪些修正已在上游修复可被移除、哪些任务已从 API 中消失,以及上游的数据质量回退。报告是默认行为;三个可选门控控制失败行为,并为严格的不一致检查、上游现已提供数据的陈旧数据(在 CI 中运行的门控)以及上游回退提供不同的退出代码。上游门控被刻意排除在 CI 之外,因为此类问题源自 tarkov.dev 数据,无法在此仓库中清除。本地验证、类型检查和测试通过独立的 npm 脚本运行。 治理与贡献 项目提供了贡献和分拣指南。该项目定义为社区维护且尽力而为,要求在提交修正时提供 Wiki 链接或截图等证明。它将自己定位为数据缺失期间的桥梁而非 tarkov.dev 的替代品,并通过 Git 保持透明的历史记录。许可条款见仓库中的 LICENSE 文件。