Skip to content

feat: update README.md for improved clarity and structure #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-actions merged 1 commit into from
Jun 27, 2026
Merged

feat: update README.md for improved clarity and structure #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 46 additions & 29 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,62 @@
<p align="center">
<a href="https://github.com/TarkovTracker/tarkovdata/issues" alt="Issues">
<img src="https://img.shields.io/github/issues/TarkovTracker/tarkovdata" />
</a>
<a href="https://github.com/TarkovTracker/tarkovdata/discussions" alt="Discussions">
<img src="https://img.shields.io/github/discussions/TarkovTracker/tarkovdata" />
</a>
<a href="https://github.com/TarkovTracker/tarkovdata/commits/master" alt="Commits">
<img src="https://img.shields.io/github/last-commit/TarkovTracker/tarkovdata" />
</a>
<a href="https://img.shields.io/github/contributors/TarkovTracker/tarkovdata" alt="Contributors">
<img src="https://img.shields.io/github/contributors/TarkovTracker/tarkovdata" />
</a>
</p>
<div align="center">

# tarkovdata
tarkovdata is game information for [Escape From Tarkov](https://www.escapefromtarkov.com/) in easy to use formats to enable developing tools for assisting players. Everything here is contributed by the community (like you!) and maintained by developers of community tools like [Tarkov Tracker](https://tarkovtracker.io/), [Tarkov Guru](https://tarkov.guru/), [Tarkov.dev](https://tarkov.dev/), and [Tarkov Tools](https://tarkov-tools.com/) (defunct)
<h1>
TarkovData
</h1>

This repository is still growing, with plans for new sets of data including SVG maps, item properties, localization, and more. Some schemas of data will change over time as the data matures, but breaking schemas will be avoided except when needed for added value.
<p>Community-maintained game data for <strong>Escape From Tarkov</strong>, powering tools built on the <a href="https://tarkovlab.org">TarkovLab</a> ecosystem.</p>

See [quests.json](quests.json) for Quest Data, including requirements, unlocks, and objectives
<!-- Stars -->
<a href="https://github.com/TarkovLab/TarkovData/stargazers">
<img src="https://img.shields.io/github/stars/TarkovLab/TarkovData?style=for-the-badge&logo=github&logoColor=white&color=FFD700&labelColor=1a1a2e" alt="Stars" />
</a>
<!-- Last Commit -->
<a href="https://github.com/TarkovLab/TarkovData/commits/master">
<img src="https://img.shields.io/github/last-commit/TarkovLab/TarkovData?style=for-the-badge&logo=git&logoColor=white&color=4CAF50&labelColor=1a1a2e" alt="Last Commit" />
</a>
<!-- Contributors -->
<a href="https://github.com/TarkovLab/TarkovData/graphs/contributors">
<img src="https://img.shields.io/github/contributors/TarkovLab/TarkovData?style=for-the-badge&logo=github&logoColor=white&color=6C63FF&labelColor=1a1a2e" alt="Contributors" />
</a>
<!-- Pull Requests (all) -->
<a href="https://github.com/TarkovLab/TarkovData/pulls?q=is%3Apr">
<img src="https://img.shields.io/github/issues-pr/TarkovLab/TarkovData?style=for-the-badge&logo=git-pull-request&logoColor=white&color=00BCD4&labelColor=1a1a2e&label=pull%20requests" alt="Pull Requests" />
</a>
<!-- Issues (all) -->
<a href="https://github.com/TarkovLab/TarkovData/issues?q=is%3Aissue">
<img src="https://img.shields.io/github/issues/TarkovLab/TarkovData?style=for-the-badge&logo=github&logoColor=white&color=FF5722&labelColor=1a1a2e" alt="Issues" />
</a>

See [hideout.json](hideout.json) for Hideout Data, including station information, and requirements
</div>

See [items.en.json](items.en.json) for Item Names, in English, both short and long, with BSG UIDs
---

See [traders.json](traders.json) for Trader metadata
## What is TarkovData?

See [maps.json](maps.json) for Map metadata
**TarkovData** is a structured, community-driven dataset containing game information for [Escape From Tarkov](https://www.escapefromtarkov.com/), designed to make building tools and trackers as easy as possible.

See [item_presets.json](item_presets.json) for Weapon Preset configurations
This repository is a **fork of [TarkovTracker/tarkovdata](https://github.com/TarkovTracker/tarkovdata)**, originally created by [Thaddeus](https://github.com/thaddeus), and adapted for use within the [TarkovLab](https://tarkovlab.org) ecosystem.

See [ammunition.json](ammunition.json) for Ammunition metadata

## Contributing

For any contribution, please create a pull request with your changes. If your changes include schema changes, please open an issue in advance to discuss with current maintainers (we don't want you wasting work if the schema change doesn't fit). Our current policy is one approval by a maintainer then feel free to merge.
Contributions are welcome! To get started:

## CLI Tool
1. **Fork** this repository
2. **Create a branch** for your changes
3. **Open a Pull Request** against `master`

To help with some basic data management functions and eventually integrity checks on PRs, a CLI tool is included with the repository.
> If your contribution involves a **schema change**, please open an issue first to discuss it with maintainers — we don't want your work to go to waste if the change doesn't align with the project direction.

Provided you have node/npm installed, you can run `npm cli.js help` to list available commands. Commands like `node cli.js verify-quest-data` and `node cli.js verify-hideout-data` are important to check that no important mistakes were made when modifying the data. Commands like `node cli.js new-quest-id` can find the next consecutive quest ID to utilize for new quests, there are similar commmands for hideout & objectives.
Every PR is automatically validated by the [JSON Syntax Check](.github/workflows/node.js.yml) workflow, which scans **all** `.json` files in the repository dynamically. A PR cannot be merged if any JSON file is invalid.

If you would like to help keep the quest data up to date with changes, please submit a pull request to the master branch. Feel free to utilize the Github discussions feature to talk about data format and potential additions.
---

## License & Credits

- Originally created by **[Thaddeus](https://github.com/thaddeus)** as part of [TarkovTracker](https://github.com/TarkovTracker/tarkovdata)
- Maintained and extended by the **[TarkovLab](https://tarkovlab.org)** community

<div align="center">
<sub>Game content and materials are trademarks and copyrights of Battlestate Games and its licensors. All rights reserved.</sub>
</div>
Loading