¶ Location
The configuration file is located at /MBedwars/upgrades-shop.yml.
¶ Available Layouts
The configuration file was built with the thought of granting you the ability to customize anything easily. With this, you simply add all the upgrades and the plugin will automatically construct a beautiful UI from that. The way the upgrades are displayed in the UI are defined by Upgrade Shop Layouts. By default, the plugin has 4 included, however more can be easily added through API.
¶ Format
Apart from the many misc configurations that are included within the file itself, the ability of modifying the upgrades themselves, including their behaviours, tier levels, prices and more is what greatly stands out.
In the first layer of the upgrades config, you will see all the existing variants:
Each basically being a button that you can click in the shop.
Each upgrade variant contains another list that holds all the levels at which a team may perform their upgrades:
and each level explicitly contains the info of what exactly shall be done when the team reaches the given level:
The screenshot above shows an upgrade that is based on tiered upgrades system.
However, you are not just limited to that type. You may read more about the variants and its differences in the following:
¶ Tiered Upgrades
An upgrade is tiered when there is a unique behaviour with each incrementing level, it being e.g. the price. There is also a certain limit of how often a team can upgrade, it being the highest tier.
You can create a tiered upgrade using the levels config. The id of the upgrade section (armor-protection in the example below) does not matter (as long it does not contain special, non-ascii characters). The handler is what specifically specifies the action of the upgrade level.
upgrades:
armor-protection:
levels:
lvl-1:
icon: golden_chestplate
handler: bedwars:armor_protection
amplifier: 1.0
duration: 0
price:
spawner: diamond
amount: 4
lvl-2:
icon: golden_chestplate
handler: bedwars:armor_protection
amplifier: 2.0
duration: 0
price:
spawner: diamond
amount: 8
- To clearify it a bit further: The example represents an upgrade that adds protection with each upgrade. The team's armor has no protection added (or at least none that isn't already a part of the bought armor) at the beginning.
- The first upgrade costs 4 emeralds and adds 1 further level of protection to all armor parts to all players in the team.
- The second upgrade costs 8 emeralds and adds 2 further level (the ones of the first upgrade are not included) of protection to all armor parts to all players in the team.
- With the second upgrade, the team has reached its maximum and may progress with another upgrade
¶ Repeatable Upgrades
Repeatable upgrades are made up of a single upgrade level that can be purchased multiple, basically an endless, amount of times. They generally were designed for traps, but can be used for non-traps as well.
You can create a repeatable upgrade using the repeatable-level config. The id of the upgrade section (mining-fatigue-trap in the example below) does not matter (as long it does not contain non-ascii characters), the handler is what specifies the action of the upgrade. Repeatable upgrades come with an additional config called price-auto-scale. If enabled, the price of the upgrade will be doubled with each purchase.
upgrades:
mining-fatigue-trap:
price-auto-scale: true
repeatable-level:
icon: wooden_pickaxe
handler: bedwars:mining_fatigue_trap
amplifier: 1.0
duration: 8
price:
spawner: diamond
amount: 1
¶ Restrictions (Upgrades varying per arena)
It is possible to make certain upgrades only available for certain arenas. With this, you may also e.g. modify the prices depending on the mode (solo, duo...) of the arena. This is supported for both tiered and repeatable upgrade types.
Example:
upgrades:
armor-protection-No1:
restriction: '[players_per_team=1]'
levels:
lvl-1:
...
price:
spawner: diamond
amount: 1
armor-protection-No2:
restriction: '[players_per_team!=2]'
levels:
lvl-1:
...
price:
spawner: diamond
amount: 2
With this example, the price of upgrading to the first level would be 1 diamond on solo arenas (arenas where there's only 1 player per team). The price on any other arena would be 2 diamonds.
You must pass in an arena picker as the value of the config. Read more about them.
¶ Configurations for levels
| Name | Description | Default Value |
|---|---|---|
| icon | The material that shall be shown as the icon in i.a. the shop. It uses this syntax | "STONE" |
| handler | The id of the handler. Defines the effective functionality of the upgrade. A list of all available ones can be found in the page below | causes error; required |
| force-slot | Icon in the shop GUI will be moved to that slot (starting at 0). Setting it to -1 disables this feature | -1 |
| amplifier | The amplification of the upgrade. Exact behaviour may depend on the used handler. Some might not use it at all | 1.0 |
| duration | The duration (in seconds) of the upgrade. Exact behaviour may depend on the used handler. Some might not use it at all | 0 |
| price.spawner | The id of the spawner that has been defined within the [spawners.yml](/en/Configuration/Spawners) file | causes error; required |
| price.amount | The amount of dropped spawners that are needed to purchase it | 1 |
| price-auto-scale | (Only for repeatable upgrades). If set to true, the price.amount will double which each incrementing level |
true |
¶ Available upgrade handlers
These are all the available upgrade trigger handlers that MBedwars delivers out-of-the-box. Developers are able to add further ones using the API, meaning that you are technically actually not limited to these.
| Name | Description | Usage of amplifier config | Usage of duration config |
|---|---|---|---|
| bedwars:sharpness | Adds sharpness enchantment to swords and axes | Amount of added enchantment levels | No |
| bedwars:armor_protection | Adds protection enchantment to armor | Amount of added enchantment levels | No |
| bedwars:haste | Gives team members the haste effect | The level of the effect | No |
| bedwars:spawner_multiplier | Increases the dropping speed of spawners within the base | Speed amplification. 1 = normal, 2.5 = 2.5x as fast... | No |
| bedwars:heal_pool | Gives regeneration effect to players within the base | The amplification of the effect (0=lvl 1, 1=lvl 2 etc.) | No |
| bedwars:regular_trap | Gives an infiltrating player blindness and slowness | The level of the effects | No |
| bedwars:counter_offensive_trap | Gives players speed and jump boost when there is an infiltrating player | The level of the effects | How long the effects will last |
| bedwars:alarm_trap | Reveals infiltrating players who are invisible | No | Time until they are hidden again |
| bedwars:mining_fatigue_trap | Gives mining fatigue effect to infuriating players | The level of the effects | How long the effects will last |
¶ Default Content
Also available at: https://pastebin.com/WDNhPJmG
Click to open:
#########################
## Visit the wiki page for further info: https://s.marcely.de/mbww10
#########################
# Do not change this
file-version: 1
# Change the layout of the shop here
# The purpose of a layout configure how the upgrade shop displays all the upgrades
# You are able to choose between:
# - Normal
# - NormalV2
# - Hypixel
# - HypixelV2
layout-name: NormalV2
# You may also display players playing Minecraft's Bedrock Edition a different layout
# Use "equally" to display the same layout as with the "layout-name" config
layout-name-bedrock: equally
upgrades:
sharpness:
levels:
lvl-1:
icon: iron_sword
handler: bedwars:sharpness
amplifier: 1.0
duration: 0
price:
spawner: diamond
amount: 8
protection:
levels:
lvl-1:
icon: iron_chestplate
handler: bedwars:armor_protection
amplifier: 1.0
duration: 0
price:
spawner: diamond
amount: 4
lvl-2:
icon: iron_chestplate
handler: bedwars:armor_protection
amplifier: 2.0
duration: 0
price:
spawner: diamond
amount: 8
lvl-3:
icon: iron_chestplate
handler: bedwars:armor_protection
amplifier: 3.0
duration: 0
price:
spawner: diamond
amount: 12
lvl-4:
icon: iron_chestplate
handler: bedwars:armor_protection
amplifier: 4.0
duration: 0
price:
spawner: diamond
amount: 16
haste:
levels:
lvl-1:
icon: gold_pickaxe
handler: bedwars:haste
amplifier: 1.0
duration: 0
price:
spawner: diamond
amount: 2
lvl-2:
icon: gold_pickaxe
handler: bedwars:haste
amplifier: 2.0
duration: 0
price:
spawner: diamond
amount: 4
spawner-multiplier:
levels:
lvl-1:
icon: furnace
handler: bedwars:spawner_multiplier
amplifier: 1.5
duration: 0
price:
spawner: diamond
amount: 2
lvl-2:
icon: furnace
handler: bedwars:spawner_multiplier
amplifier: 2.0
duration: 0
price:
spawner: diamond
amount: 4
lvl-3:
icon: furnace
handler: bedwars:spawner_multiplier
amplifier: 2.5
duration: 0
price:
spawner: diamond
amount: 6
lvl-4:
icon: furnace
handler: bedwars:spawner_multiplier
amplifier: 3.0
duration: 0
price:
spawner: diamond
amount: 8
heal-pool:
levels:
lvl-1:
icon: beacon
handler: bedwars:heal_pool
amplifier: 1.0
duration: 0
price:
spawner: diamond
amount: 1
regular-trap:
price-auto-scale: true
repeatable-level:
icon: tripwire_hook
handler: bedwars:regular_trap
amplifier: 1.0
duration: 10
price:
spawner: diamond
amount: 1
counter-offensive-trap:
price-auto-scale: true
repeatable-level:
icon: feather
handler: bedwars:counter_offensive_trap
amplifier: 1.0
duration: 15
price:
spawner: diamond
amount: 1
alarm-trap:
price-auto-scale: true
repeatable-level:
icon: redstone_torch_off
handler: bedwars:alarm_trap
amplifier: 1.0
duration: 0
price:
spawner: diamond
amount: 1
mining-fatigue-trap:
price-auto-scale: true
repeatable-level:
icon: wood_pickaxe
handler: bedwars:mining_fatigue_trap
amplifier: 1.0
duration: 8
price:
spawner: diamond
amount: 1
# The max amount of traps a team can own at one time
max-traps-queueable: 3
# The minimum time between a teams trap triggers
trap-trigger-queue-duration: 15
# Colors used to build upgrade icons (names, and lore)
upgrade-name-purchased-color: GREEN
upgrade-name-purchasable-color: YELLOW
upgrade-name-cannot-purchase-color: RED
upgrade-levels-purchased-color: GREEN
upgrade-levels-unpurchased-color: GRAY
# The levels placeholder displays all the levels with an upgrade
upgrade-levels-placeholder-format: '{purchase-color}Tier {level}: {level-name} {level-roman},
&b{price-amount} {price-type}'
# Lore format used in the shop for upgrades with more than one level
upgrade-multi-level-lore:
- '&7{description}'
- ' '
- '{levels}'
- ' '
- '{buy-state}'
# Lore format used in the shop for upgrades with a single level
upgrade-single-level-lore:
- '&7{description}'
- ' '
- '&7Cost: &b{price-amount} {price-type}'
- ' '
- '{buy-state}'