Introduction and README

JSON

A set of JSON files for developing applications with Helldivers 2

Goals

Provide a set of 'static' information like planets, factions and sectors. Applications that need this information (because they map from the API etc.) can pull this data into their application and whenever new data is discovered and added they can simply update this repository and get the updated information.

How to use

While you can simply download the JSON files and use them directly the recommended way is to use submodules.

The reasoning is that it's easy to update the JSON files with 1 command and not have to manually check for updates.

To add this in your own project use the following command:

git submodule add https://github.com/helldivers-2/json.git <folder>

# Or if you prefer using SSH
git submodule add git@github.com:helldivers-2/json.git <folder>

To update the submodule simply run (see docs):

# Folder is the directory in which your submodule lives
cd <folder>
git fetch
git merge origin/master

One (small) caveat is that when cloning your repository you have to tell Git to pull the submodules as well. Fortunately, this is easy!

git clone --recurse-submodules <your git repo>

# Or if you already cloned the repo and forgot to init the submodules:
git submodule update --init <folder>

Learn more

You can learn more about submodules on Git's documentation.

Last modified: 23 April 2024