Skip to content

Custom Rarity Tutorial

elsiff edited this page Jan 24, 2019 · 9 revisions

It's possible to change the odds of rarity and to create your own rarity, if you want it.

rarity-list:
  rarity_name:
    display-name: "Display name of the rarity"
    default: false
    chance: 70
    color: "reset"
    catch-announce: 0
    skip-item-format: false
    no-display: true
    firework: false
    additional-price: 0.0

rarity_name is the internal name of rarity.

display-name is the name shown when the fishing message was sent.

default marks the rarity as the default chance. (100% - [sum of other rarity chances])

chance means the odds of appearing. Type of this value is double. Make sure that the sum of all chances is 100.

color is the color of display text. See https://hub.spigotmc.org/javadocs/spigot/org/bukkit/ChatColor.html

commands is the list of commands which will be sent by server when the fish was caught. This value isn't always required.

catch-announce set the way to send catching messages. This property is optional.
'-1' means server broadcast, '0' is only for the catcher, and the positive number means the radius of announcing messages. When this number is set to '100', the players in 100 blocks will receive the message.

skip-item-format makes your fish do not have the fish-item-format. (No display name, no lore.) Default value is false.

no-display toggles showing the display name on fishing messages.
When this value is true, %fish_with_rarity% variable will return only the fish's name with color, without the rarity. Refer to https://github.com/elsiff/MoreFish/wiki/Configuration#messages

firework launches blue firework on catcher.

additional-price is bonus price to be used for Fish Shop.
(Price = (Length × Multiplier) + Additional Price From Rarity + Additional Price From Fish Type)

Clone this wiki locally