Inventory Descriptions

Inventory Descriptions: JSON

Inventory descriptions defined for CML should follow this template:

As seen in the above template, a description is not necessary. However, it is highly recommended. Adding a description helps players to know what your item does.

If you want the output to look nice and tidy, make sure to include a preceding  character, as seen in the template.

Please note: You cannot modify pre-existing inventory descriptions with this method. In other words, this method is only additive. It will not replace conflicting descriptions. If you would like to modify a pre-existing inventory description, please use the Merge System

Defining in CML

Inventory descriptions are very simple to define in CML. All you need to do is open or create  inside of , and give the path to your inventory description file(s) relative to the   (  →  ). Note: The linked file(s) must be somewhere inside of the. $THIS_MOD/Path/To/Your/Inventory/Description/File.json You can define a new path on each new line. However - do not add any blank lines, or else CML will read it as an invalid definition.

An Example

The following files have been directly copied from the Example Mod.

$THIS_MOD/Objects/Database/InventoryDescriptions/inventorydescriptionfilewithwhatevernameyoufeellikegivingit.json

And there you have it! The Example items now have inventory descriptions!