Upgrades.yml

This page details the configuration file "upgrades.yml", providing context as to how to edit it properly and providing the default configuration file for the plugin.

If you have any questions, check the FAQ, and if you're still not sure, feel free to ask in our discord server.

Note: Most of what is outlined here is for reference only - if you copy sections of text to use in your own configuration file, it may break it, so use it at your own risk.

Breakdown

General Layout

Each upgrade follows a standard layout, as described below.

• nameOfUpgrade: The name of the upgrade specified.

  • enabled: Whether the upgrade should be enabled (If not enabled, only upgrade level 1 will apply).

  • item: see Items

  • upgrades: This section defines what upgrades are available.

    • upgradeLevel: What level the upgrade will be (i.e. 1), you can add more upgrades by adding more level sections.

      • money: The amount that the upgrade costs in the economy currency.

      • crystals: The amount that the upgrade costs in island crystals.

Upgrade Types

Each type of upgrade has its own values set, as described below.

• sizeUpgrade: Upgrading the size of the island, up to max value size set in configuration.yml.

  • size: The total size of the island after upgrade.

• memberUpgrade: Upgrading the amount of members the island is allowed to have.

  • amount: The total amount of island members allowed after the upgrade.

• blockLimitUpgrade: Upgrading the amount of a block that is allowed to be placed.

  • BLOCK: #: The block being limited, and the total amount allowed to be placed on the island after the upgrade.

• warpsUpgrade: Upgrading the amount of warps the island can have.

  • amount: The amount of warps available after the upgrade.

• oresUpgrade: Upgrading the Cobblestone and Basalt generators to allow more blocks to generate and increase generation rates.

  • ores: Blocks generated in the Cobblestone Generator.

  • netherOres: Blocks generated in the Basalt Generator.

    • BLOCK: #: The type of block and the chance of it generating in the given generator.

Adding your own upgrades

It is possible to add your own Upgrades via the API, located Here

Default Configuration File

---
sizeUpgrade:
  enabled: true
  item:
    material: "GRASS_BLOCK"
    amount: 1
    displayName: "&b&lIsland Size"
    headData: null
    headOwner: null
    lore:
    - "&7Need more room to expand? Buy this"
    - "&7upgrade to increase your island size."
    - ""
    - "&b&lInformation:"
    - "&b&l * &7Current Level: &b%level%"
    - "&b&l * &7Current Size: &b%size%x%size% Blocks"
    - "&b&l * &7Upgrade Cost: &b%crystalscost% Crystals and $%vaultcost%"
    - "&b&lLevels:"
    - "&b&l * &7Level 1: &b50x50 Blocks"
    - "&b&l * &7Level 2: &b100x100 Blocks"
    - "&b&l * &7Level 3: &b150x150 Blocks"
    - ""
    - "&b&l[!] &bLeft Click to Purchase this Upgrade"
    slot: 11
  upgrades:
    1:
      money: 1000
      crystals: 15
      size: 50
    2:
      money: 1000
      crystals: 15
      size: 100
    3:
      money: 1000
      crystals: 15
      size: 150
memberUpgrade:
  enabled: true
  item:
    material: "ARMOR_STAND"
    amount: 1
    displayName: "&b&lIsland Members"
    headData: null
    headOwner: null
    lore:
    - "&7Need more members? Buy this"
    - "&7upgrade to increase your member count."
    - ""
    - "&b&lInformation:"
    - "&b&l * &7Current Level: &b%level%"
    - "&b&l * &7Current Member: &b%amount% Members"
    - "&b&l * &7Upgrade Cost: &b%crystalscost% Crystals and $%vaultcost%"
    - "&b&lLevels:"
    - "&b&l * &7Level 1: &b9 Members"
    - "&b&l * &7Level 2: &b18 Members"
    - "&b&l * &7Level 3: &b27 Members"
    - ""
    - "&b&l[!] &bLeft Click to Purchase this Upgrade"
    slot: 12
  upgrades:
    1:
      money: 1000
      crystals: 15
      amount: 9
    2:
      money: 1000
      crystals: 15
      amount: 18
    3:
      money: 1000
      crystals: 15
      amount: 27
blockLimitUpgrade:
  enabled: true
  item:
    material: "HOPPER"
    amount: 1
    displayName: "&b&lIsland Block Limits"
    headData: null
    headOwner: null
    lore:
    - "&7Need to place more blocks? Buy this"
    - "&7upgrade to increase the amount of blocks you can place."
    - ""
    - "&b&lInformation:"
    - "&b&l * &7Current Level: &b%level%"
    - "&b&l * &7Upgrade Cost: &b%crystalscost% Crystals and $%vaultcost%"
    - ""
    - "&b&l[!] &bLeft Click to Purchase this Upgrade"
    slot: 13
  upgrades:
    1:
      money: 1000
      crystals: 15
      limits:
        HOPPER: 15
        PISTON: 10
        SPAWNER: 10
    2:
      money: 1000
      crystals: 15
      limits:
        HOPPER: 20
        PISTON: 15
        SPAWNER: 15
    3:
      money: 1000
      crystals: 15
      limits:
        HOPPER: 25
        PISTON: 20
        SPAWNER: 20
    4:
      money: 1000
      crystals: 15
      limits:
        HOPPER: 30
        PISTON: 25
        SPAWNER: 25
    5:
      money: 1000
      crystals: 15
      limits:
        HOPPER: 40
        PISTON: 30
        SPAWNER: 30
warpsUpgrade:
  enabled: true
  item:
    material: "END_PORTAL_FRAME"
    amount: 1
    displayName: "&b&lIsland Warps"
    headData: null
    headOwner: null
    lore:
    - "&7Need more island warps? Buy this"
    - "&7upgrade to increase your island warps."
    - ""
    - "&b&lInformation:"
    - "&b&l * &7Current Level: &b%level%"
    - "&b&l * &7Upgrade Cost: &b%crystalscost% Crystals and $%vaultcost%"
    - "&b&lLevels:"
    - "&b&l * &7Level 1: &b1 Warp"
    - "&b&l * &7Level 2: &b2 Warp"
    - "&b&l * &7Level 3: &b3 Warp"
    - "&b&l * &7Level 4: &b4 Warp"
    - "&b&l * &7Level 5: &b5 Warp"
    - ""
    - "&b&l[!] &bLeft Click to Purchase this Upgrade"
    slot: 14
  upgrades:
    1:
      money: 1000
      crystals: 15
      amount: 1
    2:
      money: 1000
      crystals: 15
      amount: 2
    3:
      money: 1000
      crystals: 15
      amount: 3
    4:
      money: 1000
      crystals: 15
      amount: 4
    5:
      money: 1000
      crystals: 15
      amount: 5
oresUpgrade:
  enabled: true
  item:
    material: "DIAMOND_ORE"
    amount: 1
    displayName: "&b&lIsland Generator"
    headData: null
    headOwner: null
    lore:
    - "&7Want to improve your generator? Buy this"
    - "&7upgrade to improve your island generator."
    - ""
    - "&b&lInformation:"
    - "&b&l * &7Current Level: &b%level%"
    - "&b&l * &7Upgrade Cost: &b%crystalscost% Crystals and $%vaultcost%"
    - ""
    - "&b&l[!] &bLeft Click to Purchase this Upgrade"
    slot: 15
  upgrades:
    1:
      money: 1000
      crystals: 15
      ores:
        COBBLESTONE: 3
        COAL_ORE: 1
      netherOres:
        BASALT: 1
    2:
      money: 1000
      crystals: 15
      ores:
        DIAMOND_ORE: 1
        IRON_ORE: 10
        REDSTONE_ORE: 10
        GOLD_ORE: 10
        LAPIS_ORE: 10
        COAL_ORE: 20
        COBBLESTONE: 40
      netherOres:
        BASALT: 20
        GLOWSTONE: 20
        NETHER_QUARTZ_ORE: 20
        NETHER_GOLD_ORE: 20
        NETHERRACK: 20
        ANCIENT_DEBRIS: 1
    3:
      money: 1000
      crystals: 15
      ores:
        DIAMOND_ORE: 10
        IRON_ORE: 10
        REDSTONE_ORE: 10
        GOLD_ORE: 10
        LAPIS_ORE: 10
        COAL_ORE: 20
        COBBLESTONE: 40
      netherOres:
        BASALT: 10
        GLOWSTONE: 10
        NETHER_QUARTZ_ORE: 10
        NETHER_GOLD_ORE: 10
        NETHERRACK: 10
        ANCIENT_DEBRIS: 1