Community resources

From Satisfactory Wiki
(Redirected from Docs.json)
Jump to navigation Jump to search

There is a number of resource files included with every public build of Satisfactory to simplify the development of community-made tools and mods.

File location

These files are located in at the game's install location (not in the save file location), by default:

  • Steam: C:\Program Files\Steam\steamapps\common\Satisfactory\CommunityResources
  • Epic Games: C:\Program Files\Epic Games\SatisfactoryEarlyAccess\CommunityResources

Docs.json

The Docs.json file is a data dump of class descriptors in the game. It contains information about Satisfactory's items, equipment, fluids, buildings, recipes and schematics (unlocks).

The file itself is readable in any text editor, but primarily intended to be machine-readable. It allows to easily develop tools by the player community. The wiki itself relies on Docs.json as well to generate recipe tables and infoboxes, among other features.

While a large amount of data is contained in the file, it does not cover the game in its entirety. For example, any data about creatures, the location of Resource Nodes, Crash Sites, collectibles, etc. is not included.

Docs.json does not come with any explicit license.

History

The first version of the Docs.json file was shared by developer Markus Rannare in the now defunct Closed Alpha Discord server on January 20, 2019. The file contained a lot of information on dropped, prototype and (at the time) unreleased features. Once players noticed, it was quickly removed and replaced with a more sanitized version which had that information removed. The file can be downloaded here.

The first few versions of the file were manually generated and distributed with the game, although subsequent versions of the file are automatically generated as the game is compiled and included with the distribution and updates of the game.

Header files

Header files contain information about how the game's code is structured and some developer comments about its purpose. The information has little practical use for typical users. However, they drastically improve the quality of information and available to mod developers and help them modify existing game behavior.

PDB files

The Program Debug Database (PDB) files have information that enables crash logs to contain useful information for both game developers and mod developers, and enable mod developers to attach debugging tools.

Dedicated Server API Docs

The release of 1.0 adds and documents two APIs: the HTTPS API and the Lightweight Query API