Inventory.yml Tutorial

Here you can modify aspects of the inventories of Codex.

Inventories

There are different inventories on the plugin:

• main_inventory: Main inventory opened using the /codex command. Categories will appear here. You can even create more inventories like this one.

The main_inventory inventory must not be removed from the inventory.yml file. You can create your own inventories following the same format under the inventories path if you need to.

• category_<category>: You must create inventories associated with a category, replacing the <category> tag with the name of the category. For example, category_monsters represents the inventory for the monsters category (monsters.yml file). If you create a new category file, for example "npcs.yml", then you must add a new inventory on the inventory.yml file called category_npcs.

If you want to create multiple inventories associated with a category, for example multiple pages, you can add an inventory with the following name:

category_<category>;<something>

This inventory will be also associated with the selected category, meaning you can add its discoveries inside. For example, if you need multiple pages for the monsters category, you can create the following inventories:

category_monsters

category_monsters;page2

category_monsters;page3

Then, using the open_inventory property, you can redirect the player to the different pages.

Inventories Properties

Each inventory has 3 properties show below:

inventories:
  main_inventory:
    slots: 45
    title: "&4Codex &7» &8All Categories"
    21:
      type: "category: history"
    22:
      type: "category: regions"
    23:
      type: "category: monsters"
    0;8;36;44:
      item:
        id: RED_STAINED_GLASS_PANE
        name: " "
    1;7;9;17;27;35;37;43:
      item:
        id: BLACK_STAINED_GLASS_PANE
        name: " "
    40:
      item:
        id: BARRIER
        name: '&7Close'
      click_actions:
        - "message: &7Closing the menu."
        - "close_inventory"

Slots

Defines the amount of slots this inventory will have. You can only use 9, 18, 27, 36, 45 or 54.

Title

Defines the title of this inventory.

Item Slot

Position of an item in the inventory. For a much simpler way of placing items on inventories you can use some formats:

Format 1

<slot>:
  <item>

This will set an item on the slot 0.

0:
  item: 
    id: BLACK_STAINED_GLASS_PANE
    name: " "

Format 2

<slot1>;<slot2>;<slotN>:
  <item>

This will set the same item on slots 0, 8 and 16.

0;8;16:
  item: 
    id: BLACK_STAINED_GLASS_PANE
    name: " "

Format 3

<slot1>-<slotN>:
  <item>

This will set the same item from slots 0 to 8 (0, 1, 2, 3, 4, 5, 6, 7, 8).

0-8:
  item: 
    id: BLACK_STAINED_GLASS_PANE
    name: " "

Combining formats

This will set the same item on slots 0 to 7, 9, and 17 to 26.

0-7;9;17-26:
  item: 
    id: BLACK_STAINED_GLASS_PANE
    name: " "

Item Slots Properties

On these item slots you can create your own items.

Item

This is the item itself. Use the guide from HERE to create them.

0-8;9;17;18-26:
  item:
    id: "BLACK_STAINED_GLASS_PANE"
    name: " "

Open Inventory

Add this option to open another created inventory when the player clicks on this item.

36:
      item:
        id: ARROW
        name: "&7Go back"
      open_inventory: main_inventory

Click Actions

Adds a list of actions to be executed when clicking on the item. List of actions HERE.

40:
      item:
        id: BARRIER
        name: '&7Close'
      click_actions:
        - "message: &7Closing the menu."
        - "close_inventory"

Type: Category

You can place a category display item on the GUI by using the type: category option. If you do so, all other item properties are ignored. Format: type: "category: <category_name>"

22:
   type: "category: regions"

Type: Discovery

You can place a discovery display item on the GUI by using the type: discovery option. If you do so, all other item properties are ignored. Format: type: "discovery: <discovery_id>"

You can only use this type of item inside a category_<category> inventory.

11:
  type: "discovery: shadow_swamp"