このプロジェクトについて

tarkov-data-overlayは、tarkov.dev APIに対するデータ修正および追加を行う、コミュニティ維持のオーバーレイです。開発の動機は、ゲームのアップデートがデータの更新速度を上回ることがあるためであり、本プロジェクトは「タスクレベルやマップ要件などの誤った値の修正」と、「ゲームエディションなど、アップストリームAPIに含まれていないデータ型の追加」という2つの方法でそのギャップを埋めています。 利用方法 このオーバーレイはJSONファイルとして公開され、jsDelivr CDNから取得されます。利用者はこれをtarkov.devのレスポンスとマージして使用します。READMEでは、ブランチURLはリポジトリの状態を追跡するため、本番環境では不変のリリースタグまたはコミットを固定することを推奨しています。組み込まれたダイジェストでデータの破損や古さを検出できますが、CDNレスポンスの真正性を証明するものではありません。統合の詳細は統合ガイドに記載されており、タスクの利用可能性とアンロック状態の追跡、およびカウンターデータコントラクトに関する個別のドキュメントが用意されています。また、検証済みの進行状況ベースのカウンターと明示的な不明な結果を処理するためのevaluateTaskProgressionヘルパーが参照されています。 モニター ホストされたモニターが利用可能であり、同じモニターをnpmスクリプト経由でローカルに実行することもできます。デフォルトでは読み取り専用です。ローカルの「Update overlay」アクションにはリビルドトークンによる明示的なオプトインが必要であり、リビルドには常にAuthorization Bearerヘッダーで空でないトークンを渡す必要があります。サーバーはデフォルトでループバックにバインドされます。それ以外へのバインドは、信頼できるリバースプロキシまたはネットワーク境界の後ろでのみ推奨されます。信頼できるプロキシでHTTPSが終端される場合、別のフラグでリビルドを有効にでき、そのモードではクライアントごとのイベントストリームクォータに最初の有効なX-Forwarded-Forアドレスが使用されるため、プロキシがそのヘッダーを上書きする必要があります。リビルドはデフォルトのオーバーレイ出力パスを対象とします。カスタムのローカルおよびHTTP(S)オーバーレイターゲットは読み取り専用のままとなります。 メンテナンス check-overridesコマンドは、すべてのオーバーライドを現在のAPIデータと比較し、引き続き必要なもの、アップストリームで修正され削除可能なもの、APIから消えたタスク、およびアップストリームのデータ品質の退行を報告します。報告がデフォルトの動作であり、3つのオプトインゲートが失敗時の挙動を制御し、厳格な不整合チェック、アップストリームが提供し始めた古いデータ(CIで実行されるゲート)、およびアップストリームの退行に対して個別の終了コードを返します。アップストリームゲートは、問題がtarkov.devのデータに起因し、本リポジトリでは解決できないため、意図的にCIから除外されています。ローカルの検証、型チェック、テストは個別のnpmスクリプトを通じて実行されます。 ガバナンスと貢献 貢献およびトリアージガイドが提供されています。本プロジェクトはコミュニティ維持のベストエフォートであると定義されており、修正にはWikiリンクやスクリーンショットなどの証拠を求めています。tarkov.devの代替ではなく、データギャップ期間中のブリッジとして位置づけられており、Gitを通じて透明な履歴を保持しています。ライセンス条項はリポジトリのLICENSEファイルに記載されています。