Levels/Categories Tutorial

In this page you will find all properties of levels/categories configuration files. Everytime you modify something in these files you must reload the plugin using /minewords reload.

On Game Title

The title of the opened inventory when playing on a level of this category.

on_game_title: "#ff8417&lLevel %level%"

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.

Category Items

Each category will be represented by its own item in the main inventory. This item will vary depending on the current state of the category. For now there are two possible states.

1. Category

The item displayed by default. You can tell the players on this item the amount of levels the category has, the difficulty of them, and maybe the possible rewards.

Variables:

  • %progress% (A progress bar showing the progress of the levels completed from this category)

  • %percentage% (Percertage of the levels completed from this category)

2. Category No Requirements

The item displayed when the player doesn't have the necessary requirements to play on this category. You should tell the players on this item, what requirements are needed.

Level Items

Each level of this category will be represented on the category inventories by its own item. This item will vary depending on the current state of the level. These are the possible states.

1. Level Unlocked

The item displayed when the level is ready to be played.

Variables:

  • %level% (Number of this level)

  • %progress% (Current progress of this level depending on found words)

2. Level Blocked

The item displayed when the level is blocked, which means the previous level has not been completed.

Variables:

  • %level%(Number of this level)

  • %progress% (Current progress of this level depending on found words)

3. Level Completed

The item displayed when the level has been completed.

Variables:

  • %level% (Number of this level)

  • %hidden_word% (Hidden word of the level)

Modify Levels Amount

Whether the amount value of the Level Items should be changed depending on the number of the level. Be careful if your category has more than 64 levels!

Rewards

Rewards are given through actions. All Actions can be found HERE.

Per Level

Default actions to be executed when the player finishes a level from this category.

Variables:

  • %level% (Number of the current level)

  • %player% (The name of the player)

All Levels

Default actions when the player finishes all levels from this category.

Variables:

  • %player% (The name of the player)

Requirements

Requirements needed to unlock this category. You can add multiple requirements/conditions. More info HERE.

No Requirements Error Message

Message to be sent to the player when requirements are not satisfied.

Levels

All Levels follow the same structure. Make sure levels are in order, writing the number correctly, starting from level 1.

Level Structure

The level structure contain the words to find of the level. Each line corresponds to a word.

  • Each element of the list must have 8 characters.

  • Words don't necessarily need to have 8 letters. If you want a shorter word, use a "-". This character will be replaced by the no_letter custom item in the inventory.

  • You can add as many words as you want.

If you make a change on the number of words, the level will be reset for players that have a certain % of progress.

Words Structure

For each element of the level structure (starting from element 1), you need to set a hint or a description of the word to find.

For example in this case, the word 1 corresponds to the first element of the previous list, which is "CALORIE". The word 2 corresponds to "PRIMER", and so on.

Hidden Column

This will allow you to set a hidden word on a certain column of the inventory (a vertical word instead of a horizontal one). You can completely remove this option if you don't want it.

If you want to use this option, the idea is to put the words on a certain order so the hidden word is in fact a real word and not just gibberish.

The possible values are: 1 to 8.

As you can see, the hidden word is in the second column.

Sometimes you want to set a phrase instead of a single word, having multiple columns in yellow. To manage that follow this format:

For example. If you want to create a hidden word like "MY PLUGIN", in columns 4 and 5:

Hidden word on fourth and fifth column.

Custom Inventory Items

You can replace the Level Items with custom ones used only for this level.

Level Unlocked

The item displayed when the level is ready to be played. All variables from HERE apply.

Level Blocked

The item displayed when the level is blocked, which means the previous level has not been completed. All variables from HERE apply.

Level Completed

The item displayed when the level has been completed. All variables from HERE apply.

Custom Rewards

Allows you to set custom rewards for this level only. Will replace the default per level rewards from this category.

PreviousHow to StartNextItems

Last updated