Sobre o projeto
O tarkov-data-overlay é uma sobreposição de correções e adições de dados mantida pela comunidade para a API tarkov.dev. A motivação declarada é que as atualizações do jogo podem superar as atualizações de dados, portanto, o projeto preenche a lacuna de duas formas: corrigindo valores incorretos, como níveis de tarefas ou requisitos de mapa, e adicionando tipos de dados que a API upstream não possui, como edições do jogo.
Uso
A sobreposição é publicada como um arquivo JSON e recuperada do CDN jsDelivr. Os consumidores a mesclam com as respostas do tarkov.dev. O README aconselha a fixar uma tag de versão imutável ou commit para uso em produção, já que uma URL de branch rastreia o estado rotativo do repositório; o digest incorporado pode detectar corrupção ou dados obsoletos, mas não prova a autenticidade de uma resposta do CDN. Os detalhes de integração estão em um guia de integração, com documentos separados cobrindo a disponibilidade de tarefas e o rastreamento de estado de desbloqueio e um contrato de dados de contador; um helper evaluateTaskProgression é referenciado para contadores baseados em progresso verificados e resultados desconhecidos explícitos.
Monitor
Um monitor hospedado está disponível, e o mesmo monitor pode ser executado localmente via script npm. Ele é somente leitura por padrão. Uma ação local de "Update overlay" requer opt-in explícito com um token de rebuild, e os rebuilds sempre exigem um token não vazio passado em um cabeçalho Authorization Bearer. O servidor vincula-se ao loopback por padrão; a vinculação em outro local é recomendada apenas atrás de um proxy reverso ou limite de rede confiável. Quando o HTTPS é terminado por um proxy confiável, uma flag separada habilita os rebuilds e, nesse modo, as cotas de event-stream por cliente usam o primeiro endereço X-Forwarded-For válido, portanto, o proxy deve sobrescrever esse cabeçalho. Os rebuilds visam o caminho de saída padrão da sobreposição; alvos de sobreposição locais e HTTP(S) personalizados permanecem somente leitura.
Manutenção
Um comando check-overrides compara todas as sobreposições com os dados atuais da API e relata quais ainda são necessárias, quais correções foram corrigidas no upstream e podem ser removidas, quais tarefas desapareceram da API e regressões de qualidade de dados do upstream. O relatório é o padrão; três gates de opt-in controlam o comportamento de falha, com códigos de saída distintos para verificações de inconsistência rigorosas, dados obsoletos que o upstream agora fornece (o gate executado em CI) e regressões do upstream. O gate de upstream é deliberadamente excluído do CI porque tais problemas originam-se nos dados do tarkov.dev e não podem ser resolvidos neste repositório. Validação local, verificação de tipos e testes são executados através de scripts npm separados.
Governança e contribuição
Guias de contribuição e triagem são fornecidos. O projeto descreve-se como mantido pela comunidade e de melhor esforço (best-effort), exige provas como links de wiki ou capturas de tela para correções, apresenta-se como uma ponte durante lacunas de dados em vez de um substituto para o tarkov.dev e mantém um histórico transparente através do Git. Os termos da licença estão no arquivo LICENSE do repositório.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.