This plugins allows you to create a "Discoveries Inventory" where your players can access information about specific regions, people, monsters they've encountered. Codex is a plugin that adds a little bit of RPG experience to your Minecraft server, by providing context and lore to the player.
You can create any "Discovery" you want, players will unlock them by entering regions for the first time, talking to NPCs, killing monsters, and you can even unlock discoveries to players by using a console command! So the plugin allows you to create discoveries associated with aspects of other plugins.
For example, you can create a Region Discovery which will be unlocked if the player arrives at certain city. The player has the possibility to access the Codex by using /codex and read the lore of this city which provides more information.

You need Spigot or Paper for the plugin to work. Don't use Craftbukkit.

This dependency is completely optional.
If you want players to unlock discoveries by entering WorldGuard regions, then you need this plugin. Works with 6.x and 7.x versions.
https://dev.bukkit.org/projects/worldguard

This dependency is completely optional.
If you want to use PlaceholderAPI variables in the inventory then you need this plugin. https://www.spigotmc.org/resources/placeholderapi.6245/

This dependency is completely optional.
It allows players to unlock discoveries by killing MythicsMobs mobs:
https://www.spigotmc.org/resources/5702/

To install the plugin on your server just place the Codex file inside your plugins folder and start your server. Examples will be generated in the categories folder, you can use them as a reference or delete them.

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.

The name of this category. It will be displayed in the
Codex inventory.

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.

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.

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

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

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

The name of this discovery. It will be displayed in the
discovery message and the Codex inventory.

Description of this discovery, to be displayed in the
Codex inventory.

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.

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/javadoc ... ity/EntityType.html

You can specify the ID of a MythicMobs mob, just remember to remove the type and name options.

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)

With my plugin you can fully modify the Codex inventory, so it is possible you'll find this section a little bit complicated to understand! Here I will show you an example with a single category.

You will always need to maintain[注1] the "main" path, which represents the main inventory when using the /codex command. Here you can define different items by setting the slot number on the same section name as shown in the config.

If an item represents a Discovery category you need to add the type option and write the category name (the name of the file). This will allows you to add variables such as:
%name% (The name of the category)
%unlocked% (Total of unlocked discoveries from this category)
%percentage% (Percentage of completition of this category)
%progress_bar% (Progress bar showing the completition of this category)

You can add the open_inventory option to open another created inventory when the player clicks on the item. In this case, in the main inventory there is an item in slot 21 which will open the history_discoveries inventory. In this inventory there is an item on slot 39 to go back to the main inventory.

If you want an item to represent[注2] a Discovery instead of a Category you need to add the same type option but this time adding a ; followed with the name of the discovery. This wills allows you to add variables such as: %name% (The name of the discovery) %lore% (The lore of the discovery)

Here are two images showing this example ingame:

Number of slots for this inventory. Use one of these numbers:
9, 18, 27, 36, 45, 54

Name of this inventory.

Use a number on this section to represent the slot of an item in the inventory. You can also use multiple slots on the same section for
creating the same item on different positions.

If this item represents a Codex category or discovery you need to use
this option.
For Codex category use:
type: category_name
For Codex discovery use:
type: category_name;discovery

Material of this item. Use this names for latest versions:
​​https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
Use these names for 1.8:
​https://github.com/Attano/Spigot ... ukkit/Material.java

Name of the item. You can use the %name% variable to show the name of this category OR discovery. You can use
PlaceholderAPI variables.

Lore of the item. You can use the %unlocked% and
%percentage% variables. You can use PlaceholderAPI variables.

Custom model data of the item if you need to add it.

You can add this option if you want to open another
inventory when clicking on this item.

If you want to close the whole inventory, use:
open_inventory: close

If you want to place a player head with texture as an item, add this option with its corresponding skull
texture. Here you can find player heads:
https://minecraft-heads.com/
The text you need is the 'Value'.

You can add this option to execute commands from the console for players when they click on this item. If the item represents a Codex discovery, the player must have it unlocked first to execute the command.

If you want to execute a command from the player use:
"player_command: <command>"

There is just one permission to access commands: codex.admin

Codex provides you some PlaceholderAPI variables you can use in the /codex inventory or in another plugin.

In this section I will explain you how to use my plugin ConditionalEvents with Codex. ConditionalEvents allows you to assign multiple conditions to a certain event and execute different actions. For example, if a player pickups an item or clicks on a button, something configurable will happen.

So, with my plugin ConditionalEvents you can create as many Codex discoveries you want. Let's suppose you want players to unlock a discovery when they consume an item, for example eat an apple. We create the category first:

As you can see we have created just one discovery in the category of "Food" (the name of the file could be food.yml). Now we proceed to create an event with ConditionalEvents:

This event will check if a player tries to eat an Apple called "Mystery Apple". If so, the Strength potion effect will be given to the player for 600 ticks (30 seconds) and the /codex unlock %player% food 1 command will be executed from the console. This will unlock the discovery we have created for the player. If the player eats a Mystery Apple again, the same command will be executed but nothing will happen since the player has already unlocked the discovery.

The same you can do with multiple events you want. If you are interested on my plugin ConditionalEvents you can check the wiki: CLICK HERE