The add-on makes use of the MBedwars' messaging system - it doesn't generate its own messages file. You have to add them manually to the MBedwars messaging file. This means:
/MBedwars/language/<language>.ymlYou may reload using the command /bw reload
Located at: /MBedwars/add-ons/Cosmetics/configs.yml
Default content: https://pastebin.com/dW7mTbP3
This file contains all the miscellaneous configurations. This file gets automatically replaced and updated with updates and requires no regular maintenance.
Located at: /MBedwars/add-ons/Cosmetics/currencies.yml
Default content: https://pastebin.com/rFp53kNv
It's possible to purchase items within the shops in this addon. For that, you may configurate the currencies that shall be used. You may add as many currencies as you want. It's possible to create custom ones and it's also possible to hook into the systems of other plugins. Those "types" or "hooks" are called "providers". You may use one of these providers:
Stores your currencies within MBedwars' internal storage. Works with both SQL and Local.
gems: # The id that's being used to store it. DO NOT CHANGE IT AFTER GOING PRODUCTION. All balances will get reset otherwise.
name: "Gems"
format: "{number}"
number-format: "%,.2f" # Basically, how the number is being translated into a string. Default value would turn it into: 2,000,000.00 ; If you instead want to display 2.000.000,00 use "%.,2f"
provider: CUSTOM
Hooks into Vault. With this, you may likely use your default economics plugin. This includes e.g. Essentials.
dollar:
name: "Dollar"
format: "${number}" # Optional, otherwise uses the default one given by the economics plugin
number-format: "%,.2f" # Basically, how the number is being translated into a string. Default value would turn it into: 2,000,000.00 ; If you instead want to display 2.000.000,00 use "%.,2f"
provider: VAULT
# vault-provider: "EssentialsX Economy" # Optional, if you have multiple plugins that hook into vault. See wiki for more info
If you have multiple plugins that hook into Vault, you might want to look into configuring the vault-provider config accordingly. It specifies the plugin that creates/handles the economy or the name of that economy (if you have multiple from the same plugin) itself. If this config is not present, a random one will be chosen.
In case the config is not specified (or a vault-provider's wrong name), you will find the following lines in your console:
[MBedwars-Cosmetics] Available vault economy providers:
[MBedwars-Cosmetics] - "EssentialsX Economy"
[MBedwars-Cosmetics] - "Essentials Economy"
This exact ones will likely differ from the one you will see. Make sure to copy the one you want and to insert it in the vault-provider config instead.
Hooks into PlayerPoints.
points:
name: "Points"
format: "{number} Points"
number-format: "%,.2f" # Basically, how the number is being translated into a string. Default value would turn it into: 2,000,000.00 ; If you instead want to display 2.000.000,00 use "%.,2f"
provider: PLAYER_POINTS
Hooks into PvPLevels.
points:
name: "EXP"
format: "{number} EXP"
number-format: "%,.2f" # Basically, how the number is being translated into a string. Default value would turn it into: 2,000,000.00 ; If you instead want to display 2.000.000,00 use "%.,2f"
provider: PVPLEVELS
Located at: /MBedwars/add-ons/Cosmetics/shops/
Default files:
Their configuration is very smilar to MBedwars' ArenasGUIs. Manage them using the /bw commands shop command. Read this page to learn more about how you can make a player open them.
Located at: /MBedwars/add-ons/Cosmetics/animations.yml
Default content: https://pastebin.com/Quwj2AW3
These are animations that may be played by shop items. While they may also be configured within the shop config files themselves, some categories which more complex animations were outsourced to this file. Each animation has a list of handlers, each performs something differently and thereby accept different configurations. These are all that exist, including their configurations:
Spawns one or multiple particles.
| Name | Default | Info |
| particle | "cloud" | The particle that shall be played. Accepted syntax |
| repeated | false | false: only play it once, true: play it multiple times |
| amount-per-second | 5 | "repeated" must be set to true |
Spawns one or multiple entities.
| Name | Default | Info |
| entity | "PIG" | The entity that shall be spawned |
| velo-x / velo-y / velo-z | 0.0 | The velocity (force) that the entity will have when it spawns |
| radius-x / radius-y / radius-z | 0.0 | The radius in which the entity can spawn |
| repeated | false | false: only play it once, true: play it multiple times |
| amount-per-second | 5 | "repeated" must be set to true |
| amount | -1 | The maximum amount of total entities that shall be spawned. An infinitive amount can be spawned if the value is 0 or less. |
Plays a sound once or repeatedly.
| Name | Default | Info |
| sound | "(random)" | The sound that shall be played. Only accepts vanilla sounds |
| volume | 1.0 | The volume of the sound |
| pitch | 1.0 | The pitch of the sound |
| volume-at-end | NULL | "repeated" has to be enabled. Fades into the given volume with each sound. NULL means that the effect does not apply. |
| pitch-at-end | NULL | "repeated" has to be enabled. Fades into the given pitch with each sound. NULL means that the effect does not apply. |
| repeated | false | false: only play it once, true: play it multiple times |
| amount-per-second | 5 | "repeated" must be set to true |
Places a block.
| Name | Default | Info |
| material | "stone" | The material of the block that shall be placed |
Displays a hologram with custom text.
| Name | Default | Info |
| lines | [ "&eHello &6World" ] | The lines that shall be displayed. Placeholders: {player}, {related-player} |
Spawn a bunch of entities in an explosion-like matter.
| Name | Default | Info |
| entities | [ "PIG" ] | Picks a random one of these entities each time one shall get spawned. |
| velo-x / velo-y / velo-z | 1.5 | The velocity (force) that the entity will have when it spawns. The actual velocity will be random for which the minimum value will be the one specified in the "min-velo-*" configs. |
| min-velo-x / min-velo-y / min-velo-z | 0.0 | The minimum values of the randomness factor as described in the "velo-*" configs. |
| velocity-against-damager | false | Causes the entities fly in the direction in which the damager (related player) is looking at. |
| trail-particle | NULL | Plays this particle as the trail for all spawned entities. NULL means that none shall be played. Accepted syntax |
| poof-particle | NULL | Plays this particle whenever an entity dies. NULL means that none shall be played. Accepted syntax |
| repeated | true | false: only play it once, true: play it multiple times |
| amount-per-second | 5 | "repeated" must be set to true |
| amount | -1 | The maximum amount of total entities that shall be spawned. An infinitive amount can be spawned if the value is 0 or less. |
| radius-x / radius-y / radius-z | 0.0 | The radius in which the entity can spawn |
| death-on-ground | true | Automatically kills entities that touch the ground (a block) |
Spawns an entity and makes the player ride it.
| Name | Default | Info |
| entity | "BAT" | The entity that shall be spawned and get ridden by the player |
| flying | true | They'll fly in the direction at which the player is looking at |
| fly-speed | 1.0 | "flying" has to be set to true. Their flight speed |
| trail-particle | NULL | The particle of their trail. NULL means that none will be played. Accepted syntax |
| poof-particle | NULL | The particle that will be played when the entity despawns. NULL means that none will be played. Accepted syntax |
| shoot-fireballs | false | Whether it should shoot fireballs at the direction the player is looking at. Used for dragon rider |
| shoot-fireballs-frequency | 0.8 | The delay in seconds for the repeated fireball shooting. "shoot-fireballs" must be set to true |
Spawns an entity and makes it fly up or to a specified direction like a rocket.
| Name | Default | Info |
| entity | [ "BAT" ] | |
| velo-x / velo-y / velo-z | 0.0 | The velocity (force) that the entity will have when it spawns |
| acceleration-x / acceleration-y / acceleration-z | 0.0 | The acceleration that gets constantly added to the velocity (making him start slow and fly faster with time) |
| fixed-yaw | NULL | Whether the yaw direction shall always be the same. NULL means that the entitiy is still able to move his head in the yaw axis. |
| fixed-pitch | NULL | Whether the pitch direction shall always be the same. NULL means that the entitiy is still able to move his head in the pitch axis. |
| trail-particle | NULL | The particle of the entity's trail. NULL means that none will be played. Accepted syntax |
| poof-particle | NULL | The particle that will be played when the entity despawns. NULL means that none will be played. Accepted syntax |
Spawns a head and makes it fly like a rocket.
| Name | Default | Info |
| owner | NULL | The name/base64 texture of the owner of the head. You may also use "@@PLAYER" or "@RELATED-PLAYER" to choose the one of an involved player |
| yaw-rotation-speed | 0.0 | The speed in which the head shall get rotated in the yaw axis |
| pitch-rotation-speed | 0.0 | The speed in which the head shall get rotated in the pitch axis |
| velo-x / velo-y / velo-z | 0.0 | The velocity (force) that the entity will have when it spawns |
| trail-particle | NULL | The particle of the head's trail. NULL means that none will be played. Accepted syntax |
| poof-particle | NULL | The particle that will be played when the head despawns. NULL means that none will be played. Accepted syntax |
| slow-start | false | Accelerates the head slowly at the beginning, causing a rocket-like effect |
Plays particles that move from position A to position B.
| Name | Default | Info |
| particle | "cloud" | The particle that shall be played. Accepted syntax |
| target-x / target-y / target-z | 0.0 | The relative positions of the destination |
| amount-per-second | 5 | How frequently the particles shall be played per second |
Spawns particles that look like a cone.
| Name | Default | Info |
| particle | "cloud" | The particle that forms the cone. Accepted syntax |
| height | 2.0 | The height of the cone |
| width | 1.0 | The width of the cone |
| twists | 3.0 | How many twists the cone shall have |
| yaw | 0.0 | The yaw rotation of the cone |
| pitch | 0.0 | The pitch rotation of the cone |
| add-direction | false | Whether the direction of the related player's head shall be added to the yaw and pitch. With this, it's possible to make it look like it's coming out of the players mouth |
| particle-count | 2 | The depth of the particles. The more there are, the better it will look like, however the more lag it can cause |
| increasing-height | false | Whether it should start small and get increasingly bigger |
Changes the time of the world.
| Name | Default | Info |
| time | 0 | The new time |
| relative-to-world | false | Whether the "time" value shall simply be added the number of the current one |
| apply-to-all | true | Whether this shall apply for all players in the arena |
| cycle-speed | NULL | Repeatedly at an amount to the time causing a day/night cycle. Use NULL to force the time to be static |
Change the current weather of the world.
| Name | Default | Info |
| raining | true | Whether it shall start to rain or stop |
| apply-to-all | true | Whether this shall apply for all players in the arena |
Changes a single block at the beginning and then increasingly gets bigger like a virus.
| Name | Default | Info |
| materials | [ "stone" ] | Chooses for each block a random material of this list |
| persistent | false | Whether this effect shall stay, even when this animation has stopped |
| amount-per-second | 5 | How many times per second it shall spread |
Plays particles that form text.
| Name | Default | Info |
| particle | "coloured_dust:255,0,0" | The particle that shall be used. Accepted syntax |
| size | 5 | The size of the text |
| text | "Hello, {player}!" | The text that shall be displayed. Placeholders: {player}, {related-player} |
| density | 0.15 | How dense the particle shall be. The lower the value, the better it will look. However, this will also generate more lag |
| yaw | 0 | The yaw rotation of the text |
| amount-per-second | 5 | How many times per second particles shall be spawned |
Displays an actual image as colored particles. Used for glyphs.
| Name | Default | Info |
| image-path | Required, otherwise error | The path to the image file, relative to the Cosmetics folder. E.g. "images/sprays/color_splash.png" |
| density | 0.15 | How dense the particle shall be. The lower the value, the better it will look. However, this will also generate more lag |
| yaw | 0 | The yaw rotation of the text |
| amount-per-second | 5 | How many times per second particles shall be spawned |
Spawns many NPCs in the radious of the player that perform a certain activity.
| Name | Default | Info |
| activity | SNEAK | The activity they perform. Available options: SNEAK |
| radius | 10.0 | The radius around the player in which the NPCs may spawn |
| amount | 6 | The amount of NPCs that may spawn |
| amount-per-second | 5 | How many times per second the activity shall be performed |