Default configuration

default.yml configuration guide

The default config file is default.yml. You can see how a Level-System needs to be created and configurated in here. Things like xp-formula, level-design and other things are automaticly getting created for you in this file.

Disabled Worlds

This list of worlds lets you decide in which Minecraft Worlds the Level-System should work. All worlds listed here won't hook into the Level-System. Players can't progress within these worlds.

disabled-worlds:
- example_world
- custom_world_name

Players (Data-base)

In the next section of the config file all player data gets stored. The format is players.<uuid>.xp. Only global XP gets stored and later on changed into the right Level. As well all already rewarded levels will be stored here.

players:
  c7c4cc0f-c3c1-493e-99cc-ec727f5ed635:
    xp: 100
    rewarded-levels:
    - 1

Tick-speed

This setting is used for animated Level-Designs. Here you can determin how fast the animation should be executed. This setting is then used for the entire Level-System (for every animated Level).

tick-speed: 10

Max Level

This setting changes the maximum level a player can reach. Upon reaching this level there will be no further progress. You can as well add custom permissions to set custom max levels.

max-levels:
  default: 10
  permissions:
    simplelevels.max.premium: 25
    simplelevels.max.vip: 50

Default Design

If no specific design is set for a levle this one will be used. This is important when using the max level and not wanting to set every single level on your own.

default-design:
  display: "&eLevel %level% - &7Default"

Default Rewards

If no specific reward is set for a level this reward will be given to the player on every level up. This setting is optional and can be left empty.

default-reward:
  type: message
  messages:
    - "&aYou reached &eLevel %level%&a!"

Levels

Here you can create as many Levels as you want. Just make sure to get the syntax right. You always need an identifier, which can only exists once per Level-System, and a display for the Level.

  '1':
    display: '&6Level 1 - &7Beginner'

Animated Levels

You can also create animated Level Designs by using the tick-speed setting and by setting multiple lines of display for a Level. These different Level-Design will then switch in the given tick-speed.

  '1':
    display:
    - '&aLevel 1 - &7Beginner'
    - '&cLevel 1 - &7Beginner'
    - '&4Level 1 - &7Beginner'

Rewards

You can as well define rewards that will be given out as soon as a player reaches the Level.

Command Rewards

This type of reward lets you set as many commands as you want, that will be executed by the console as soon as a player reaches the Level.

    reward:
      type: command
      commands:
        - "eco give %player_name% 10"

Message Rewards

This type of reward lets you set as many messages as you want that will be send to the player upon reaching the defined Level.

    reward:
      type: message
      messages:
        - "&aYou have just reached &eLevel 2&a!"

Permissions

You can define if a specific permission is needed to reach a specific level. If a player does not has this permission, he won't be able to reach this level.

   permission: "simplelevels.level.2"

Per-Level XP

You can as well set manuel a specific amount of XP needed for a Level. This can be used when you don't want to use a formula or any other features.

   xp: 10000

Formula

This formula is used to caculate how much XP you need for every Level. In the given example it would be Level 1 = 100 XP, Level 2 would then be base(100)*2 which would equal to Level 2 = 200 XP.

formula:
  base: 100
  multiplier: 2.0