Upgrades

The file names inside upgrades represent currency IDs. For the Vault currency, the id is default, so never remove the default.yml file.

[currencyId].yml

use-personal-bank-upgrades: true
upgrade-no-permission-message: "&cYou don't have permission to upgrade your bank account. (%upgrade-permission%)"
upgrade-not-enough-money-message: "&cYou don't have enough money to upgrade your bank account. (%upgrade-cost%)"
personal-bank-upgrades:
  starter:
    upgrade-display-name: "&aStarter Account"
    upgrade-description:
      - ""
      - "&a>&m--------&r &6Interest Tranches &a&m--------&a<"
      - " &eFirst &610 &emillion %currency-name% yields &b2% &einterest."
      - " &eFrom &610 &eto &615 &emillion yields &b1% &einterest."
      - ""
      - " &7Max interest: &6250,000"
      - "   &8(With 15,000,000 balance)"
      - "&a>&m---------------------------------&a<"
      - ""
      - "&7Max balance: &650 Million %currency-name%"
      - ""
      - "&7This is the default account."
    maximum-balance: 50000000
    interest-intervals:
      "0":
        interest-rate: 0.02
        from-balance: 0
        to-balance: 10000000
      "1":
        interest-rate: 0.01
        from-balance: 10000000
        to-balance: 15000000
  gold:
    upgrade-display-name: "&6Gold Account"
    upgrade-description:
      - ""
      - "&6>&m--------&r &6Interest Tranches &6&m--------&6<"
      - " &eFirst &610 &emillion %currency-name% yields &b2% &einterest."
      - " &eFrom &610 &eto &620 &emillion yields &b1% &einterest."
      - ""
      - " &7Max interest: &6300,000"
      - "   &8(With 20,000,000 balance)"
      - "&6>&m---------------------------------&6<"
      - ""
      - "&7Max balance: &6100 Million %currency-name%"
      - ""
      - "&7Cost: &65,000,000 %currency-name%"
    upgrade-actions:
      - "[message] &fYou just upgraded to &6Gold Account&f!"
      - "[message] &fYour maximum bank balance is now &6100 Million %currency-name%"
      - "[message] &fYour maximum interest is now &6300,000 %currency-name%"
    upgrade-cost: 5000000
    maximum-balance: 100000000
    interest-intervals:
      "0":
        interest-rate: 0.02
        from-balance: 0
        to-balance: 10000000
      "1":
        interest-rate: 0.01
        from-balance: 10000000
        to-balance: 20000000
  deluxe:
    upgrade-display-name: "&dDeluxe Account"
    upgrade-description:
      - ""
      - "&d>&m--------&r &6Interest Tranches &d&m--------&d<"
      - " &eFirst &610 &emillion %currency-name% yields &b2% &einterest."
      - " &eFrom &610 &eto &620 &emillion yields &b1% &einterest."
      - " &eFrom &620 &eto &630 &emillion yields &b0.5% &einterest."
      - ""
      - " &7Max interest: &6350,000"
      - "   &8(With 30,000,000 balance)"
      - "&d>&m---------------------------------&d<"
      - ""
      - "&7Max balance: &6250 Million %currency-name%"
      - ""
      - "&7Cost: &610,000,000 %currency-name%"
    upgrade-actions:
      - "[message] &fYou just upgraded to &dDeluxe Account&f!"
      - "[message] &fYour maximum bank balance is now &6250 Million %currency-name%"
      - "[message] &fYour maximum interest is now &6350,000 %currency-name%"
    upgrade-cost: 10000000
    maximum-balance: 250000000
    interest-intervals:
      "0":
        interest-rate: 0.02
        from-balance: 0
        to-balance: 10000000
      "1":
        interest-rate: 0.01
        from-balance: 10000000
        to-balance: 20000000
      "2":
        interest-rate: 0.005
        from-balance: 20000000
        to-balance: 30000000
  super-deluxe:
    upgrade-display-name: "&5Super Deluxe Account"
    upgrade-description:
      - ""
      - "&5>&m--------&r &6Interest Tranches &5&m--------&5<"
      - " &eFirst &610 &emillion %currency-name% yields &b2% &einterest."
      - " &eFrom &610 &eto &620 &emillion yields &b1% &einterest."
      - " &eFrom &620 &eto &630 &emillion yields &b0.5% &einterest."
      - " &eFrom &630 &eto &650 &emillion yields &b0.2% &einterest."
      - ""
      - " &7Max interest: &6390,000"
      - "   &8(With 50,000,000 balance)"
      - "&5>&m---------------------------------&5<"
      - ""
      - "&7Max balance: &6500 Million %currency-name%"
      - ""
      - "&7Cost: &625,000,000 %currency-name%"
    upgrade-actions:
      - "[message] &fYou just upgraded to &5Super Deluxe Account&f!"
      - "[message] &fYour maximum bank balance is now &6500 Million %currency-name%"
      - "[message] &fYour maximum interest is now &6390,000 %currency-name%"
    upgrade-cost: 25000000
    maximum-balance: 500000000
    interest-intervals:
      "0":
        interest-rate: 0.02
        from-balance: 0
        to-balance: 10000000
      "1":
        interest-rate: 0.01
        from-balance: 10000000
        to-balance: 20000000
      "2":
        interest-rate: 0.005
        from-balance: 20000000
        to-balance: 30000000
      "3":
        interest-rate: 0.002
        from-balance: 30000000
        to-balance: 50000000
  premier:
    upgrade-display-name: "&cPremier Account"
    upgrade-description:
      - ""
      - "&c>&m--------&r &6Interest Tranches &c&m--------&c<"
      - " &eFirst &610 &emillion %currency-name% yields &b2% &einterest."
      - " &eFrom &610 &eto &620 &emillion yields &b1% &einterest."
      - " &eFrom &620 &eto &630 &emillion yields &b0.5% &einterest."
      - " &eFrom &630 &eto &650 &emillion yields &b0.2% &einterest."
      - " &eFrom &650 &eto &6160 &emillion yields &b0.1% &einterest."
      - ""
      - " &7Max interest: &6500,000"
      - "   &8(With 160,000,000 balance)"
      - "&c>&m---------------------------------&c<"
      - ""
      - "&7Max balance: &61 Billion %currency-name%"
      - ""
      - "&7Cost: &650,000,000 %currency-name%"
    upgrade-actions:
      - "[message] &fYou just upgraded to &cPremier Account&f!"
      - "[message] &fYour maximum bank balance is now &61 Billion %currency-name%"
      - "[message] &fYour maximum interest is now &6500,000 %currency-name%"
    upgrade-cost: 50000000
    maximum-balance: 1000000000
    interest-intervals:
      "0":
        interest-rate: 0.02
        from-balance: 0
        to-balance: 10000000
      "1":
        interest-rate: 0.01
        from-balance: 10000000
        to-balance: 20000000
      "2":
        interest-rate: 0.005
        from-balance: 20000000
        to-balance: 30000000
      "3":
        interest-rate: 0.002
        from-balance: 30000000
        to-balance: 50000000
      "4":
        interest-rate: 0.001
        from-balance: 50000000
        to-balance: 160000000
use-shared-bank-upgrades: true
shared-bank-upgrades:
  starter:
    upgrade-display-name: "&aStarter Account"
    upgrade-description:
      - ""
      - "&a>&m--------&r &6Interest Tranches &a&m--------&a<"
      - " &eFirst &610 &emillion %currency-name% yields &b2% &einterest."
      - " &eFrom &610 &eto &615 &emillion yields &b1% &einterest."
      - ""
      - " &7Max interest: &6250,000"
      - "   &8(With 15,000,000 balance)"
      - "&a>&m---------------------------------&a<"
      - ""
      - "&7Max balance: &650 Million %currency-name%"
      - "&7Player limit: &b4 players"
      - ""
      - "&7This is the default account."
    maximum-members: 4
    maximum-balance: 50000000
    interest-intervals:
      "0":
        interest-rate: 0.02
        from-balance: 0
        to-balance: 10000000
      "1":
        interest-rate: 0.01
        from-balance: 10000000
        to-balance: 15000000
  gold:
    upgrade-display-name: "&6Gold Account"
    upgrade-description:
      - ""
      - "&6>&m--------&r &6Interest Tranches &6&m--------&6<"
      - " &eFirst &610 &emillion %currency-name% yields &b2% &einterest."
      - " &eFrom &610 &eto &620 &emillion yields &b1% &einterest."
      - ""
      - " &7Max interest: &6300,000"
      - "   &8(With 20,000,000 balance)"
      - "&6>&m---------------------------------&6<"
      - ""
      - "&7Max balance: &6100 Million %currency-name%"
      - "&7Player limit: &b4 players"
      - ""
      - "&7Cost: &65,000,000 %currency-name%"
    upgrade-actions:
      - "[message] &fYou just upgraded to &6Gold Account&f!"
      - "[message] &fYour maximum bank balance is now &6100 Million %currency-name%"
      - "[message] &fYour maximum interest is now &6300,000 %currency-name%"
    maximum-members: 4
    upgrade-cost: 5000000
    maximum-balance: 100000000
    interest-intervals:
      "0":
        interest-rate: 0.02
        from-balance: 0
        to-balance: 10000000
      "1":
        interest-rate: 0.01
        from-balance: 10000000
        to-balance: 20000000
  deluxe:
    upgrade-display-name: "&dDeluxe Account"
    upgrade-description:
      - ""
      - "&d>&m--------&r &6Interest Tranches &d&m--------&d<"
      - " &eFirst &610 &emillion %currency-name% yields &b2% &einterest."
      - " &eFrom &610 &eto &620 &emillion yields &b1% &einterest."
      - " &eFrom &620 &eto &630 &emillion yields &b0.5% &einterest."
      - ""
      - " &7Max interest: &6350,000"
      - "   &8(With 30,000,000 balance)"
      - "&d>&m---------------------------------&d<"
      - ""
      - "&7Max balance: &6250 Million %currency-name%"
      - "&7Player limit: &b5 players"
      - ""
      - "&7Cost: &610,000,000 %currency-name%"
    upgrade-actions:
      - "[message] &fYou just upgraded to &dDeluxe Account&f!"
      - "[message] &fYour maximum bank balance is now &6250 Million %currency-name%"
      - "[message] &fYour maximum interest is now &6350,000 %currency-name%"
    maximum-members: 5
    upgrade-cost: 10000000
    maximum-balance: 250000000
    interest-intervals:
      "0":
        interest-rate: 0.02
        from-balance: 0
        to-balance: 10000000
      "1":
        interest-rate: 0.01
        from-balance: 10000000
        to-balance: 20000000
      "2":
        interest-rate: 0.005
        from-balance: 20000000
        to-balance: 30000000
  super-deluxe:
    upgrade-display-name: "&5Super Deluxe Account"
    upgrade-description:
      - ""
      - "&5>&m--------&r &6Interest Tranches &5&m--------&5<"
      - " &eFirst &610 &emillion %currency-name% yields &b2% &einterest."
      - " &eFrom &610 &eto &620 &emillion yields &b1% &einterest."
      - " &eFrom &620 &eto &630 &emillion yields &b0.5% &einterest."
      - " &eFrom &630 &eto &650 &emillion yields &b0.2% &einterest."
      - ""
      - " &7Max interest: &6390,000"
      - "   &8(With 50,000,000 balance)"
      - "&5>&m---------------------------------&5<"
      - ""
      - "&7Max balance: &6500 Million %currency-name%"
      - "&7Player limit: &b5 players"
      - ""
      - "&7Cost: &625,000,000 %currency-name%"
    upgrade-actions:
      - "[message] &fYou just upgraded to &5Super Deluxe Account&f!"
      - "[message] &fYour maximum bank balance is now &6500 Million %currency-name%"
      - "[message] &fYour maximum interest is now &6390,000 %currency-name%"
    maximum-members: 5
    upgrade-cost: 25000000
    maximum-balance: 500000000
    interest-intervals:
      "0":
        interest-rate: 0.02
        from-balance: 0
        to-balance: 10000000
      "1":
        interest-rate: 0.01
        from-balance: 10000000
        to-balance: 20000000
      "2":
        interest-rate: 0.005
        from-balance: 20000000
        to-balance: 30000000
      "3":
        interest-rate: 0.002
        from-balance: 30000000
        to-balance: 50000000
  premier:
    upgrade-display-name: "&cPremier Account"
    upgrade-description:
      - ""
      - "&c>&m--------&r &6Interest Tranches &c&m--------&c<"
      - " &eFirst &610 &emillion %currency-name% yields &b2% &einterest."
      - " &eFrom &610 &eto &620 &emillion yields &b1% &einterest."
      - " &eFrom &620 &eto &630 &emillion yields &b0.5% &einterest."
      - " &eFrom &630 &eto &650 &emillion yields &b0.2% &einterest."
      - " &eFrom &650 &eto &6160 &emillion yields &b0.1% &einterest."
      - ""
      - " &7Max interest: &6500,000"
      - "   &8(With 160,000,000 balance)"
      - "&c>&m---------------------------------&c<"
      - ""
      - "&7Max balance: &61 Billion %currency-name%"
      - "&7Player limit: &b5 players"
      - ""
      - "&7Cost: &650,000,000 %currency-name%"
    upgrade-actions:
      - "[message] &fYou just upgraded to &cPremier Account&f!"
      - "[message] &fYour maximum bank balance is now &61 Billion %currency-name%"
      - "[message] &fYour maximum interest is now &6500,000 %currency-name%"
    maximum-members: 5
    upgrade-cost: 50000000
    maximum-balance: 1000000000
    interest-intervals:
      "0":
        interest-rate: 0.02
        from-balance: 0
        to-balance: 10000000
      "1":
        interest-rate: 0.01
        from-balance: 10000000
        to-balance: 20000000
      "2":
        interest-rate: 0.005
        from-balance: 20000000
        to-balance: 30000000
      "3":
        interest-rate: 0.002
        from-balance: 30000000
        to-balance: 50000000
      "4":
        interest-rate: 0.001
        from-balance: 50000000
        to-balance: 160000000

Two Main Sections

This upgrade contains two main sections that are repetitive. Upgrades for personal banks and shared banks.

Upgrades setup

Even with upgrades disabled, there must exist at least one upgrade so the bank can use proper metadata of maximum balance.

personal-bank-upgrades:
  upgrade-config-name1:
    <<upgrade config>>
  upgrade-config-name2:
    <<upgrade config>>
  ...
  any-upgrade-config-name:
    <<upgrade config>>
    
shared-bank-upgrades:
  upgrade-config-name1:
    <<upgrade config>>
  upgrade-config-name2:
    <<upgrade config>>
  ...
  any-upgrade-config-name:
    <<upgrade config>>

When other documentation sections refer to an upgrade's config name or the upgrade's id, they refer to the setting names you see above as upgrade-config-name1/upgrade-config-name2/any-upgrade-config-name.

Upgrade Config

Example Upgrade Config

upgrade-config-name:
  upgrade-display-name: ""
  upgrade-description:
    - ""
    - ""
  upgrade-actions: # will be ignored for the default upgrade
    - ""
    - ""
  maximum-members: 4 # for banks that support members
  upgrade-cost: 50000000 # will be ignored for the default upgrade
  upgrade-permission: "a.permission" # optional
  maximum-balance: 50000000
  interest-intervals:
    "0":
      interest-rate: 0.02
      from-balance: 0
      to-balance: 10000000
    "1":
      interest-rate: 0.01
      from-balance: 10000000
      to-balance: 15000000

For upgrade actions you can use the standard actions defined at Click Actions.

You can not define click types though, just use the standard one line actions ([message]/[command]/etc)

Interest setup

The interest formula might be a bit complex. Lets take the premier upgrade's interest intervals for example:

interest-intervals:
  "0":
    interest-rate: 0.02
    from-balance: 0
    to-balance: 10000000
  "1":
    interest-rate: 0.01
    from-balance: 10000000
    to-balance: 20000000
  "2":
    interest-rate: 0.005
    from-balance: 20000000
    to-balance: 30000000
  "3":
    interest-rate: 0.002
    from-balance: 30000000
    to-balance: 50000000
  "4":
    interest-rate: 0.001
    from-balance: 50000000
    to-balance: 160000000

Lets rewrite it a bit:

[0, 10 millions], [10 millions, 20 millions], [20 millions, 30 millions], [30 millions, 50 millions], [50 millions, 160 millions]

• [0, 10 millions] - 2% (2/100 = 0.02)

• [10 millions, 20 millions] - 1% (1/100 = 0.01)

• [20 millions, 30 millions] - 0.5% [(5/10)/100 = 5/1000 = 0.005]

• [30 millions, 50 millions] - 0.2% [(2/10)/100 = 2/1000 = 0.002]

• [50 millions, 160 millions] = 0.1% [(1/10)/100 = 1/1000 = 0.001]

The total interest is calculated as the sum of the all interval formulas.

TotalInterest = Interval0 + Interval1 + Interval2 + Interval3 + Interval4

The interval formula relies on 4 variables:

• FROM_BALANCE - the lower limit of the interval

• TO_BALANCE - the upper limit of the interval

• INTEREST_RATE - a percent

• BALANCE - the actual balance in the bank

IntervalFormula = [MIN(TO_BALANCE, BALANCE) - FROM_BALANCE] * INTEREST_RATE

IntervalFormula applies of course, only if BALANCE > FROM_BALANCE, otherwise we would get negative interest.

Interest Examples for Premier

BALANCE = 9 millions ->

• [0, 10 millions] - 2% -> [MIN(10 mil, 9 mil) - 0] * 0.02 = 9 mil * 0.02 = 180,000

• further intervals do not apply, 9 mil is smaller than FROM_BALANCE

INTEREST = 180,000

---

BALANCE = 12 millions ->

• [0, 10 millions] - 2% -> [MIN(10 mil, 12 mil) - 0] * 0.02 = 10 mil * 0.02 = 200,000

• [10 millions, 20 millions] - 1% -> [MIN(20 mil, 12 mil) - 10 mil] * 0.01 = 2 mil * 0.01 = 20,000

INTEREST = 200,000 + 20,000