Configuring a Repository

Where:

/plugins/CollectablesCodex/collectables/<repository>.yml

Examples: collectables/notes.yml, collectables/fish.yml

What it defines:


Fields (with defaults & behavior)

Key Type Required Description
enabled boolean No (default true) Toggle this repository on/off. If false, it won’t load or show.
namespace string Yes Unique ID prefix used for keys, e.g. notes, fish. Final keys are namespace:id.
display_name string (MiniMessage) No The formatted name shown in menus, e.g. "<gold>Ancient Notes</gold>". Supports MiniMessage + placeholders.
plain_display_name string (plain text) No Plain-text fallback. If missing/blank, it’s auto-derived from display_name (stripped of formatting).
icon ItemEntry No Menu icon for this repo. If the icon has no explicit raw name, it auto-uses display_name.
selected_icon ItemEntry No Icon shown when this repo is “active/selected.” If no raw name, also auto-uses display_name.
show_when_locked boolean No (default true) If true, locked entries are still visible (as “unknown”) in the repo menu.
entries map Yes Child map of entry definitions keyed by ID (e.g., torn_page, fish_1)

🔗 Configuring Icons with ItemEntry

Both icon and selected_icon use the ItemEntry format, which lets you define:

👉 See the ItemEntry Config Page for the full schema and examples on customizing ItemStacks