Mirage: Config File

Overview

Each section below comprises the settings within the /mirage/config.yml file, governing the majority of the plugin’s configurations.

Claiming Plugin Settings

The following settings control how the supported plugins are affected by block regeneration. All the supported plugins will disable block regeneration inside the plugin’s claimed areas if set to true.

towny: true
factionsuuid: true
lands: true
residence: true
grief-prevention: true
protections-stones: true
grief-defender: true

WorldGuard Settings

The region list is based on regions set with the WorldGuard plugin.

disabled-regions:
  # If set to true, block regen will only work in these regions
  whitelist: false
  list:
    - region1
  • whitelist
    • If whitelist is set to true, then blocks will only regen in the listed regions
    • If whitelist is set to false, then blocks will not regen in the listed regions.
    • If you want to regen blocks in all regions, leave the default settings.
  • list
    • List of WorldGuard regions you want to control block regeneration.
    • How this list behaves is based on the whitelist settings.

World Settings

The world list is based on the worlds on your server. It is not plugin specific.

disabled-worlds:
  # If set to true, block regen will only work in these worlds
  whitelist: false
  list:
    - world_nether
  • whitelist
    • If whitelist is set to true, then blocks will only regen in the listed worlds
    • If whitelist is set to false, then blocks will not regen in the listed worlds.
    • If you want to regen blocks in all worlds, set whitelist to false and add a world that doesn’t exist to the list.
  • list
    • List of worlds you want to control block regeneration.
    • How this list behaves is based on the whitelist settings.

Growth Settings

The following settings deal with crop growth and natural growth. Turtle eggs are included in these settings because they can also spawn naturally in your world.

disable_crop_growth: true
disable_melon_growth: true
disable_turtle_egg: false
disable_block_growth: true
  • disable_crop_growth
    • Setting this to true will disable crop growth.
    • This works good if you have longer block regeneration delay and you want the crop to come back fully matured and ready to break.
  • disable_melon_growth
    • Setting this to true will disable melon growth.
    • This includes watermelon and pumpkins.
  • disable_turtle_egg
    • Setting this to true will disable turtle eggs from spawning in your world.
  • disable_block_growth
    • This disables all naturally spawning crops and plants.
    • You may want to disable this if you have a custom world and don’t want more crops and plants spawning than what you already have in your world.

Entries

These settings control what gets regenerated on your server.


entries:
- materials:
  - IRON_ORE
  - GOLD_ORE
  break-material: CRACKED_STONE_BRICKS
  regen-delay: 600
  tool:
    allowed:
    - npchelmet
    message: "You need a helmet to break this!"
    damage: 1
  requirements:
  - "enchantment:silk_touch:1"
  - "FABLED_skill:skill1:5"
  - "FABLED_class:class1:3"
  - "MCMMO_skill:acrobatics:7"
  - "RPGCRAFTING_profession:smelting:2"
  chance:
    iron_ore: 0.5
    gold_ore: 0.25
    diamond_ore: 0.01
  rewards:
    - "exp:5"
    - "VAULT_money:-5"
    - "JOBS_money:5"
    - "JOBS_exp:miner:5"
    - "JOBS_points:5"
    - "FABLED_skill:skill1:5"
    - "FABLED_exp:class:5"
  cancel-drop: true
  command:
  - delay: 0
    as: CONSOLE
    cmd: say {player}
    chance: 100.0
  age: 7
  • material
    • allowed
      • The materials in this list are the materials you want to regenerate when broken.
      • Can be prefixed with:
        • DIVINITY_<name>
        • ORAXEN_<name>
        • ITEMSADDER_<namespace>:<name>
  • break-material
    • This is the material that will be shown while in cooldown.
    • The break-material should not be a block that can be mined or broken by a player.
  • regen-delay
    • This is how long in ticks the cooldown will last before the blocks/crops/plants get regenerated.
  • tool
    • allowed
      • This sets the required tools needed to break the material.
        • Can be prefixed with:
          • DIVINITY_<name>
          • ORAXEN_<name>
          • ITEMSADDER_<namespace>:<name>
    • message
      • The message given when using the wrong tool to break blocks/crops/plants
    • damage
      • The amount of durability lost each time a block/cop/plant is broken.
  • requirements
    • This sets the requirements needed in order to break the blocks/crops/plants
      • enchantment:silk_touch:<level>
      • FABLED_skill:<skillname>:<level> 
      • FABLED_class:<classname>:<level> 
      • MCMMO_skill:<skillname>:<level>
      • FUSION_profession:<professionname>:<level>
  • chance
    • The total of all chance items must equal 1.
      • Example: .1 equals 10 percent.
    • Can be prefixed with:
      • DIVINITY_<name>
      • ORAXEN_<name>
      • ITEMSADDER_<namespace>:<name>
  • rewards
    • exp:5
      • gives vanilla experience
    • VAULT_money:5
      • gives money if using a vault supported economy plugin
    • JOBS:5
      • gives money from the JobsReborn plugin
    • exp:5
      • gives vanilla experience
    • JOBS_exp:miner:5
      • Gives jobs experience
    • FABLED_skill:skill1:5
      • Levels up the skill
    • FABLED_exp:class:5
      • Gives the class experience
  • cancel-drop
    • Prevents vanilla drops
  • command
    • delay
      • How long in ticks before the command is executed
    • as
      • Options are: CONSOLE, PLAYER, OP
    • cmd
      • The command to execute, do not include “/”
    • chance
      • The chance for this command to execute
  • age
    • If this is a crop/plant this will set the age of the plant when it’s regenerated
  • debug
    • If set to true this will print troubleshooting info in the console.