Bukkit

Introduction (v2.0.0+) - English

Introduction

BoomcMMoReward acts when a player gain a new mcMMO's level.
It uses yaml file to know what to do on 'rewards' and if it must do it on 'conditions'.

A player gains mcMMO's POWER level everytime he gains a SKILL's level because his POWER's level is the sum of all his SKILL's level.
Understand that when he gains a new EXCAVATION's level he gains automatically a new POWER's level (global).
BoomcMMoReward works with yaml files that you create yourself. It doesn't need a server restart to take your changes on existent yaml files or to take effect for your new created yaml's files.

The yaml reward file

A yaml reward file can contains some scenarios.
A scenario can have 2 parts: a 'conditions' part and a 'rewards' part.

The 'conditions' part is optional.
You can set in it some conditions that the player who gains the level must fullfill like:

• money
• world
• permissions/groups
• his POWER level
• his SKILL level

The 'rewards' part contains the player's rewards like:

• money/lotteryMoney
• item/lotteryItem/luckyItem/luckyKit
• permissions/groups for add/remove
• for advanced user you can send commands as console sender
  

The name of the yaml reward file is a number that represents the level reached or a multiple of the level reached.
It depends on where you place this yaml reward file.
Examples:

• a yaml reward file POWER/EVERY/1.yml
  it'll be executed EVERYTIME the player's POWER level is multiple of 1
• a yaml reward file POWER/ONE/1.yml
  it'll be executed WHEN the player's POWER level = 1
• a yaml reward file SKILLS/EXCAVATION/EVERY/1.yml
  it'll be executed EVERYTIME the player's EXCAVATION level is multiple of 1
• a yaml reward file SKILLS/EXCAVATION/ONE/1.yml
  it'll be executed WHEN the player's EXCAVATION level = 1
  
  

The Folder Structure

When a player reach a new mcMMO level, BoomcMMoReward checks inside its folder:

• on plugins/BoomcMMoReward/POWER
  
• on plugins/BoomcMMoReward/SKILLS
  

So it could interact on POWER level up and SKILL level up.
On the SKILLS's folder it has one sub-folder for each existent mcMMO's skill:

• plugins/BoomcMMoReward/SKILLS/ACROBATICS
• plugins/BoomcMMoReward/SKILLS/ARCHERY
• plugins/BoomcMMoReward/SKILLS/AXES
• plugins/BoomcMMoReward/SKILLS/EXCAVATION
• plugins/BoomcMMoReward/SKILLS/FISHING
• plugins/BoomcMMoReward/SKILLS/HERBALISM
• plugins/BoomcMMoReward/SKILLS/MINING
• plugins/BoomcMMoReward/SKILLS/REPAIR
• plugins/BoomcMMoReward/SKILLS/SMELTING
• plugins/BoomcMMoReward/SKILLS/SWORDS
• plugins/BoomcMMoReward/SKILLS/TAMING
• plugins/BoomcMMoReward/SKILLS/UNARMED
• plugins/BoomcMMoReward/SKILLS/WOODCUTTING

On this SKILLS's sub-folder and the POWER's folder you will find 2 others folders:

• /EVERY
• /ONE

The EVERY folder

The EVERY folders for POWER and every SKILLS must contains yaml reward files that will be execute everytime the player's POWER level is multiple of the number represented by the name of the yaml reward file.

The ONE folder

The ONE folders for POWER and every SKILLS must contains yaml reward files that will be execute when the player's POWER level equals the number represented by the name of the yaml reward file.