Categories Tutorial

In the categories folder you can create as many files you want. Each of these files corresponds to one "Discovery" category. In the next example you will see the content of the regions.yml file. Below you will find information about every option you can use here.

name: "&c&lWorld &7&lRegions"
discover_title:
  title: "&c&lCODEX UPDATED"
  subtitle: "&7Region: %name%"
  fade_in: 20
  stay: 60
  fade_out: 20
discover_message:
- "{centered}&f&m00                                                 00"
- " "
- "{centered}&c&lCODEX UPDATED"
- "{centered}&7World Region: %name%"
- " "
- "{centered}&7Check it now by using &e/codex"
- " "
- "{centered}&f&m00                                                 00"
discover_sound:
  name: BLOCK_GILDED_BLACKSTONE_STEP
  volume: 10
  pitch: 0.1
discoveries:
  1:
    name: "&a&lShadow Swamp"
    lore:
    - "&7The shadow swamp is a dark place full of"
    - "&7magical creatures. It has been uninhabited"
    - "&7for several years."
    discovered_on_region: shadow_swamp
  2:
    name: "&a&lCity of Kryngel"
    lore:
    - "&7The center of commerce and the capital of"
    - "&7the Yubbin province."
    discovered_on_region: kryngel

Categories options

Option	Description
name: "&c&lWorld &7&lRegions"	The name of this category. It will be displayed in the Codex inventory.
discover_title: title: "&c&lCODEX UPDATED" subtitle: "&7Region: %name%" fade_in: 20 stay: 60 fade_out: 20	The title that will be displayed to the player when unlocking a discovery from this category. Use the %name% variable to show the name of the discovery. fade_in, stay and fade_outoptions are measured in ticks. (20 ticks = 1 second). If you don't want to display a title, you can delete this whole section.
discover_message: -"&c&lCODEX UPDATED" -"&7World Region: %name%" -"&7Check it now by using &e/codex"	The message that will be sended to the player when unlocking a discovery from this category. Use the %name% variable to show the name of the discovery. You can use the {centered} tag at the beginning of a line, to center the message. If you don't want to send a message, you can delete this whole section.
discover_sound: name: BLOCK_GILDED_BLACKSTONE_STEP volume: 10 pitch: 0.1	The sound the player will hear when unlocking a discovery from this category. Here you can find all Sound names: For latest versions: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html For 1.8: https://helpch.at/docs/1.8.8/index.html?org/bukkit/Sound.html

Discoveries options

You can create different discoveries for the same category. Here is an example of a Discovery:

discoveries:
  1:
    name: "&a&lShadow Swamp"
    lore:
    - "&7The shadow swamp is a dark place full of"
    - "&7magical creatures. It has been uninhabited"
    - "&7for several years."
    discovered_on_region: shadow_swamp

In this case, the discovery is called "1" but you can rename it as you want.

Option	Description
name: "&a&lShadow Swamp"	The name of this discovery. It will be displayed in the discovery message and the Codex inventory.
lore: -"&7The shadow swamp is a dark place full of" -"&7magical creatures. It has been uninhabited" -"&7for several years."	Description of this discovery, to be displayed in the Codex inventory.
discovered_on_region: shadow_swamp	If you want the player to unlock this discovery by entering a WorldGuard region for the first time, you need to add this option with the region name.
discovered_on_mob_kill: type: ZOMBIE name: "Shadow Warrior" discovered_on_mob_kill: type: SKELETON discovered_on_mob_kill: mythic_mobs_id: SkeletonKing	If you want the player to unlock this discovery by killing an entity, you need to add this option specifying the type of the entity, the name of the entity, or both. You can find all entity types here: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html You can specify the ID of a MythicMobs mob, just remember to remove the type and name options.
commands: -"xp give %player% 50" -"msg %player% &7+50 &6XP"	If you need to, you can execute commands for the player when unlocking the discovery.

Remember: If a discovery doesn't have a discovered_on_region or discovered_on_mob_kill option, it means it will only be obtainable by console command! (/codex unlock)