ContentLib Documentation

These docs are still highly a work in progress. I decided that if I waited until finishing these to release the U5 update, it would be months before anyone got their hands on the mod, and these docs are only really relevant to a smaller portion of the ContentLib userbase.

If you have any suggestions for these docs, or are willing to contribute, please open a Pull Request or contact me (Robb) on the Nog’s Mods discord server.

Welcome to the ContentLib documentation!

You can find the source code for the mod here.

For further support, please join the Nog’s Mods discord server.

These docs are still largely a work in progress. If you’d like to contribute, feel free to open a PR, or contact me (Robb#6731) on the discord.

For Users

If you’d just like to make a couple recipe or item tweaks, these pages may be of use to you.

For Developers

You can use ContentLib to define the Items, Recipes, and Schematics for your own mods!

Not only is it a lot faster to write items this way, and faster to iterate, it also makes it easy for end users to configure recipes to their own balance preferences.

Additionally, the data-driven nature of ContentLib can help you quickly create Recipes or Items if you want to automatically generate them from another source.

If you’d like to package your own ContentLib scripts for distribution as a mod on Satisfactory Mod Repository, these pages may be of use to you.

For Advanced Developers

If you’d like the use ContentLib’s blueprint and C++ APIs, these pages may be of use to you.

The data-driven nature of ContentLib can help you quickly create Recipes or Items if you want to automatically generate them from another source. For example, Aquilla uses ContentLib to allow users to make their own recipes in-game.

ContentLib also has some capabilities not accessible via JSON, and useful for creating mods of your own. These include:

  • Easily processing (and modifying) all loaded recipes or items in the game

  • Runtime content generation (ex. generate new recipes for every fluid in the game, like Aquilla does in the mod Free Fluids - CL)

  • Reverse lookup (ex. "What recipes can I use to make this item?")

  • Recipe power cost analysis

To use these features, you will need to set up a full modding project by following the Getting Started Guide and bring in the ContentLib, JsonStructs, and ContentInspector plugins to your project.

Ask on the Discord for further help doing this, since these docs are still a work in progress.

  • You will need the source of ContentLib loaded in your editor as well. The git repo is the plugin source folder.

  • You must also have source of the updated versions of the JsonStructs and ContentInspector mods as loaded plugins, else packaging will fail

    • JsonStructs source can be found here

    • ContentInspector source can be found here

  • More coming soon.