From 1f5afaf80d2d71fa3b62e8f1380d4141a45c02b3 Mon Sep 17 00:00:00 2001 From: Niv Date: Sat, 27 Jun 2026 22:03:53 +0200 Subject: [PATCH] feat: update README.md for improved clarity and structure --- README.md | 75 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 46 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 57a1d59..5914d91 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,62 @@ -

- - - - - - - - - - - - -

+
-# 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) +

+ TarkovData +

-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. +

Community-maintained game data for Escape From Tarkov, powering tools built on the TarkovLab ecosystem.

-See [quests.json](quests.json) for Quest Data, including requirements, unlocks, and objectives + + + Stars + + + + Last Commit + + + + Contributors + + + + Pull Requests + + + + Issues + -See [hideout.json](hideout.json) for Hideout Data, including station information, and requirements +
-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 + +
+ Game content and materials are trademarks and copyrights of Battlestate Games and its licensors. All rights reserved. +