Discoveries/Categories Tutorial
In this page you will find all properties of discoveries/categories configuration files. Everytime you modify something in these files you must reload the plugin using /codex reload.
Inventory Items
The format of each item is the following:
inventory_items:
<type>:
<item>Remember that the item to be displayed has the properties listed HERE.
You can use PlaceholderAPI variables on the name and lore of all these items.
1. Category
Each category will be represented by its own item in the main inventory. You can tell the players on this item the amount of discoveries the category has and information of the category.
category:
id: MAP
name: "&7Category: #6bcbfe&lWorld Regions"
lore:
- "#eeeeeeDifferent regions you've explored will"
- "#eeeeeebe displayed here."
- ""
- "&7Unlocked: %unlocked% &8[%progress_bar%&8] &8(&7%percentage%&8)"Variables:
%unlocked%(Will be replaced with the following messages.yml messages depending of the status of discoveries found: currentUnlockedDiscoveriesColorNone, currentUnlockedDiscoveriesColorAll, currentUnlockedDiscoveriesColorIncomplete)%progress_bar%(A progress bar showing the progress of the discoveries unlocked from this category)%percentage%(Percertage of the discoveries unlocked from this category)
2. Discovery Unlocked
The item displayed on the category inventory when the discovery has been unlocked.
Variables:
%name%(Name of the discovery)%description%(Description of the discovery)%date%(Date the discovery was unlocked)
3. Discovery Blocked
The item displayed on the category inventory when the discovery has not been found.
Rewards
Rewards are given through actions. All Actions can be found HERE.
Per Discovery
Default actions to be executed when the player finds a discovery from this category.
Variables:
%name%(Name of the discovery)%player%(Name of the player)
All Discoveries
Default actions to be executed when the player finds all discoveries from this category.
Variables:
%player%(Name of the player)
Discoveries
Discoveries must be added below the discoveries section using the following format.
Name
Name of the discovery. Used to be displayed on inventories and messages.
Description
Description of the discovery. Used to be displayed on inventories and messages.
Discovered On
Determines how can this discovery be unlocked.
WorldGuard Region
The discovery is unlocked when entering a WorldGuard (https://dev.bukkit.org/projects/worldguard) region.
Residence Region
The discovery is unlocked when entering a Residence (https://www.spigotmc.org/resources/residence-1-7-10-up-to-1-21.11480/) region.
Mob Kill
The discovery is unlocked when killing a vanilla entity.
Mythic Mob Kill
The discovery is unlocked when killing a MythicMobs (https://www.spigotmc.org/resources/5702/) mob.
Elite Mob Kill
The discovery is unlocked when killing a EliteMobs (https://www.spigotmc.org/resources/elitemobs.40090/) mob.
Click Actions
Actions to be executed when the player clicks on the inventory item associated with this discovery, when the discovery has been found. All actions HERE. Optional.
Click Actions Cooldown
Adds a cooldown (in seconds) to execute the defined actions when clicking on the discovery item.
Custom Inventory Items
You can replace the Category Inventory Items with custom ones used only for this discovery.
Discovery Unlocked
The item displayed on the category inventory when THIS discovery has been unlocked. All variables from HERE applies.
Discovery Blocked
The item displayed on the category inventory when THIS discovery has not been found. All variables from HERE applies.
Custom Rewards
You can replace the Per Discovery Rewards with custom ones only for this discovery.
Last updated
Was this helpful?