Lore Specification

Lore Specification

The primary format of a Lore entry. A full example can be found here.

{
    "key": LoreKey
    "content": Content
    "sortingIndex": 1,
    "autoAdd": true,
    "defaultLore": false,
    "notify": true,
    "hidden": false,
    "requirements": [
        LoreKey...
    ],
    "trigger": TriggerData,
    "action": ActionData
}

Field	Description
key	See the LoreKey serializer. Required
content	See the Content serializer. Required
sortingIndex	Used to order Lore entries per-category. If multiple Lore of the same category have the same sortingIndex, it will sort by which was registered first. This is usually dependent on filename. Optional - Default 0
autoAdd	Automatically add this Lore to the Player's knowledge when they have the Lore Scrap in their inventory or when it is picked up. Optional - Default true
defaultLore	Add this Lore to the Player's knowledge as soon as their data entry in the playerData map is created. These are checked for whenever a player joins the world and when the /lore reload command is run. Optional - Default false
notifiy	Displays an overlay when the player receives this lore. Optional - Default true
hidden	Hides the lore entry from the Journal. Optional - Default false
requirements	Lore required to be known before the Player can learn this one. This is a list of LoreKey's separated by commas. Bypassed by defaultLore. Optional - Default []
trigger	See the TriggerData serializer. Optional - Default null
action	See the ActionData serializer. Optional - Default null