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 /ctb reload.

On Level Selection Title

The title of the opened inventory when inside the level selection of this category.

on_level_selection_title: "&8[&b&lEasy&8] &6&lLevels"

On Game Title

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

on_game_title: "&8[&b&lEasy&8] &6Level %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.

inventory_items:
  category:
    id: PURPLE_TERRACOTTA
    name: "&8[&5&lVery Hard&8] &6&lLevels"
    lore:
      - "&78x6 and 9x6 Levels"
      - "&840 Levels"
      - ""
      - "&7Rewards:"
      - "&8- &a$110 &7on each level."
      - "&8- &e11XP &7on each level."
      - ""
      - "&eStatus: &8[%progress%&8] %percentage%%"

Variables:

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

• %percentage% (Percertange 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.

inventory_items:    
  category_no_requirements:
    id: GRAY_DYE
    name: "&8[&5&lVery Hard&8] &6&lLevels"
    lore:
      - "&78x6 and 9x6 Levels"
      - "&840 Levels"
      - ""
      - "&cYou must complete the HARD"
      - "&clevels first."

Level Items

Each level of this category will be represented on the level section inventory 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.

inventory_items:     
  level_unlocked:
    id: YELLOW_TERRACOTTA
    name: "&2Level %level%"
    lore:
      - "&7Type: &e%type%"
      - "&7Status: &6[UNLOCKED]"

Variables:

• %level% (Number of this level)

• %type% (Type/Form of this level)

2. Level Blocked

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

inventory_items:  
  level_blocked:
    id: CYAN_TERRACOTTA
    name: "&2Level %level%"
    lore:
      - "&7Type: &a%type%"
      - "&7Status: &c[BLOCKED]"

Variables:

• %level% (Number of this level)

• %type% (Type/Form of this level)

3. Level Completed

The item displayed when the level has been completed.

inventory_items:  
  level_completed:
    id: LIME_TERRACOTTA
    name: "&2Level %level%"
    lore:
      - "&7Type: &e%type%"
      - "&7Status: &a[COMPLETED]"
      - ""
      - "&7Completed in: &e%time%(s)"

Variables:

• %level% (Number of this level)

• %type% (Type/Form of this level)

• %time% (Time taken to complete 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!

modify_levels_amount: true

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.

rewards:
  per_level:
    - "playsound: ENTITY_PLAYER_LEVELUP;1;1"
    - "message: &7Level &b%level% &7completed in &b%time%(s)&7. You earned &a$110 &7and &e11 XP&7."
    - "console_command: eco give %player% 110"
    - "console_command: xp give %player% 11"

Variables:

• %level% (Number of the current level)

• %time% (Time taken to complete the level)

All Levels

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

rewards: 
  all_levels:
    - "centered_message: &b&m                  &b[ VERY HARD LEVELS COMPLETED! ]&b&m                  "
    - "centered_message: "
    - "centered_message: &eYou completed the VERY HARD category, take these rewards:"
    - "centered_message: &7- &a$25000"
    - "centered_message: &7- &e2500XP"
    - "centered_message: "
    - "centered_message: &b&m                  &b[ VERY HARD LEVELS COMPLETED! ]&b&m                  "
    - "console_command: eco give %player% 25000"
    - "console_command: xp give %player% 2500"

Requirements

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

requirements:
  - "%player_has_permission_ctb.very_hard% == yes"
  - "%connecttheblocks_category_completed_hard% == true"

No Requirements Error Message

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

no_requirements_error_message: "&cYou must complete the HARD levels first."

Levels

Levels are automatically saved on this file when creating them using /ctb createlevel.

Type

The type/form of the level. You should not modify this property manually. Types are defined in the level_inventory_types configuration on the inventory.yml file.

type: 5x5

Blocks

The position of default blocks. You should not modify this property manually. Blocks are defined in the game_blocks configuration on the config.yml file.

blocks:
  - red;29;15
  - blue;20;13
  - green;12;6
  - yellow;38;42

Rewards

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

rewards:
  - "playsound: ENTITY_PLAYER_LEVELUP;1;1"
  - "message: &7Congrats on finishing your first level! You earned &a$500 &7and &e1 diamond&7."
  - "console_command: eco give %player% 500"
  - "console_command: give %player% diamond 1"

Inventory Rewards

Enable this option is you want to give items to the player as reward.

inventory_rewards: true