Codex: Title Scrolls

Codex: Title Scrolls

Players find a Title Scroll in loot, right-click it to unlock a title, then open /title to see their collection and pick the title they want to wear. Titles they haven't found yet show as "?" with no name, rarity or flavor text.

No titles are built in. Every title is a small JSON file in a datapack, so each server writes its own.

Features

• One item for every title. Which title a scroll gives is stored on the stack, set by a loot table entry or a command.
• Unlocked titles and the active title are saved per player and survive relogs and deaths.
• /title opens a grid menu, 54 titles per page. Click a title to wear it, click it again to take it off.
• Rarity shows as the slot border: green common, blue rare, purple epic, gold legendary, red unique.
• Hovering a scroll in your inventory shows its title and rarity.
• Locked titles are never sent to the client, so nothing can be read ahead of time.
• A scroll for a title you already own is not used up, so it can be traded.
• Titles reload with vanilla /reload.

Adding titles

Add a file at data/<namespace>/titles/<id>.json:

{
  "display": "&6Kitsune",
  "rarity": "unique",
  "flavor_text": "Outfoxed the impossible.",
  "chat_color": "&6"
}

• display (required): the title text. & color codes work.
• rarity (optional, default common): common, rare, epic, legendary or unique.
• flavor_text (optional): a line shown in the menu once unlocked.
• chat_color (optional): the color of the player's chat messages while they wear the title, e.g. &b or &#FFD700. It's read by your chat mod and never sent to the /title menu.

A title's id is its file name (kitsune). If two datapacks use the same file name, the second one is used as namespace:id and a warning is logged.

Giving a title

/titlescroll give <player> <title> [amount]

Title ids tab-complete. Needs OP level 2. Scrolls that don't fit in the player's inventory drop at their feet.

As a loot table entry:

{
  "type": "minecraft:item",
  "name": "titlescrolls:title_scroll",
  "functions": [
    {
      "function": "minecraft:set_components",
      "components": { "titlescrolls:grants_title": "kitsune" }
    }
  ]
}

Showing titles in chat

Title Scrolls works on its own through /title. To show the active title in chat, use a chat mod that reads it. With NeoEssentials, Title Scrolls registers an {active_title} placeholder for your chat format.

Updating from 1.0.1

1.0.2 moves Title Scrolls into the Codex family. The jar is now named