⚫
UltraBreeds WIKI
  • 😃Startup
  • STARTING
    • CONFIGURATION
      • BREEDS.YML
  • COMMANDS
    • BREED
      • CREATE
      • EDIT
      • DELETE
      • SELECT
    • ULTRABREEDS
      • SET
      • TOKEN
      • RELOAD
      • CHANGE
      • IMPORT
  • BREEDS
    • Default
    • How to create Breed
  • API
    • ACCESSING
    • USER
    • BREED
  • ADDONS
    • ADDONS
Powered by GitBook
On this page
  • CONFIG.YML
  • Settings
  • HOOKS
  • MENU SELECT
  • PLACEHOLDERS IN CONFIG.YML
  • STAMINA
  1. STARTING

CONFIGURATION

We will discuss breeds.yml and config.yml files.

PreviousStartupNextBREEDS.YML

Last updated 2 years ago

The plugin has 6 configuration files, don't get overwhelmed, most of them don't need much attention, focus on config.yml for now. If you find the configuration unintuitive and the wiki doesn't help much, don't forget to contact us on our Discord, we will support you as soon as possible!. (https://discord.gg/4JvPTmaznf)

CONFIG.YML

This is the plugin prefix (what you see at the back of all messages) This value can be modified to 2 things, messages_EN or messages_ES the ES would be the messages translated to Spanish and the EN would be the messages translated to English.

Settings

storage-mode: This path defines the way to save the data, you could put MySQL to save it in MySQL or YAML to save it in saves.yml. rgb-color: This if you don't know what it means just ignore it but if you do, you can alternate the hex colors between normal and legacy. stamina-enable: The plugin has a stamina module to make it more "RPG" and better, if you set it to false (Disable) this module will be disabled and therefore players will have no stamina. Token-reset-Breed: This is also another module that contains the plugin, if you deactivate it both admins and players will not be able to use or give tokens to each other. This also belongs to the Tokens module and what it does is that with the command /ultrabreeds change, you need a minimum of tokens to be able to change race

HOOKS

For now the plugin only has hook with AuthMe, if it is set to true and AuthMe.jar is on the server the hook is activated, this hook interacts when registering the session or login, after doing that you will open the GUI where you select your race. If you want me to add a hook remember to notify me on Discord in the ticket channel open one and say!

MENU SELECT

The plugin supports Custom Model Data (1.14+), if you are from 1.8 and want to add an item I recommend using the IDs, soon we will explain how to use them (Commands). For now this inventory would be the one shown to the players when they are going to select their race or change it, the numbers (Keys) are where the items are going to go, The material would be the type of item for example a diamond sword (DIAMOND_SWORD) Amount would be the amount of items to show in that slot, Name would be the name shown for that item, Lore would be the description of the item to show, in this example is empty but in the next picture I show an example of the lore and how it would look in game, Glow if set to true serves to highlight the item making it look like enchanted, and Model Data is the support to Custom Model Data (1. 14+) those of 1.8 cannot use it.

Lore: - "&7&l&m "

- "&B&LYOUR SERVER.COM"

- "&7&l&m "

PLACEHOLDERS IN CONFIG.YML

STAMINA

The action bar is supported by all versions!

%ultrabreeds_breed_prefix% Will be replaced by what is here

Page cover image