Lore Template Engine

A Paper plugin for defining custom item lore and tooltip layouts through config.

Tag an item with a template, and its lore is generated from that template whenever the item changes (crafting, enchanting, admin commands, ...).

How it works

The config uses KDL and has three parts:

• Variables: single values read from an item (rarity, item_level)
• Groups: lists of values read from an item (enchantments, attributes, tags)
• Templates: arrange variables and groups into a lore layout

Examples

A variable with display text:

variable "rarity" {
    source "pdc" key="rarity"
    lookup {
        "common" "<gray>Common"
        "epic"   "<light_purple><bold>Epic"
    }
    default "<gray>Common"
}

A template:

template "weapon_default" {
    var "rarity"

    blank collapse-if-empty="enchantments"
    group "enchantments" each="<gray><ench_name> <ench_level_roman>" empty="skip"

    text "<red>Hello, World"
}

Lines marked with collapse-if-empty disappear when their group has nothing to show, so an item without enchantments has no leftover gaps.

Extending a template and adding a tooltip style (resource pack):

template "vanilla_extended" extends="vanilla" tooltip-style="simple" {
    group "description" each="<gray><line>" empty="skip"
    var "rarity"
}

Commands

/lore set template weapon_default
/lore set variable rarity epic
/lore set group description First line\nSecond line

Documentation

Full config reference (variables, groups, templates, extending, tooltip styles) is on the wiki.

For developers

Other plugins can apply templates and read item data through the developer API. Setup and dependency instructions are on the wiki.