Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt

Use this file to discover all available pages before exploring further.

Global Placeholders

Prefix: %typewriter_*%
PlaceholderReturnsExample
%typewriter_total_quests%Total quests across all categories42
%typewriter_total_completed%Total completed quests15
%typewriter_total_in_progress%Total in-progress quests (also _inprogress)5
%typewriter_total_not_started%Total not-started quests (also _notstarted)22
%typewriter_total_progress%Formatted progress15/42

Category Placeholders

Replace <name> with the category name in lowercase with underscores (e.g., main_quests).
PlaceholderReturnsExample
%typewriter_category_<name>%Total quests in category10
%typewriter_category_<name>_completed%Completed quests in category3
%typewriter_category_<name>_in_progress%In-progress quests in category (also _inprogress)2
%typewriter_category_<name>_not_started%Not-started quests in category (also _notstarted)5
%typewriter_category_<name>_progress%Formatted progress3/10

Template Variables

These are not PAPI placeholders. They are replaced dynamically inside @Placeholder fields in entry configurations.
VariableWhere It WorksReplaced With
<category>Category menus, entry fieldsThe category’s display name
<category_name>Same as <category>Same value
<completed>categoryLoreQuestCountNumber of completed quests
<total>categoryLoreQuestCountTotal number of quests
{priority}Quest lore (tracked quests)Tracking priority (1, 2, 3…) or empty

Usage Examples

In a Text Display

Progress: %typewriter_total_progress%
Main quests: %typewriter_category_main_quests_progress%

In a Scoreboard

lines:
  - "&fQuests: %typewriter_total_progress%"
  - "&fMain: %typewriter_category_main_quests_progress%"

In Menu Lore (via quest codex settings)

categoryLoreQuestCount:
  - "<gray>Progress: <completed>/<total></gray>"
  - "<gray>Global: %typewriter_total_progress%</gray>"