[SimplePetsAddon] ItemEconomy Addon

What is this addon?

This is a SimplePets Addon that allows server owners/admins set prices for pets to be purchased via in-game items without needing external/other plugins

Plugin/Resource Links:

• SimplePets (REQUIRED)

• Custom Items (OPTIONAL)

• ItemsAdder (OPTIONAL)

• Or any other plugin that adds custom item models

  (The CustomModelData number and the base material is needed from these types of plugins)

How to install:

The addon can be installed a few different ways it can be done via the install command, via the GUI installer, or manually

Install via Command: (Easiest)

• Simply type the /pet addon install ItemEconomy command
  It will also attempt to load and enable it

Install via GUI Installer:

• Run the /pet addon command
• Click the Install Addons item that is in the bottom row of the GUI
• Locate the ItemEconomy item in the GUI
• Once found simply click it

NOTE: If it gets stuck saying "Installing..." then check your console for any errors, If there are none then try one of the other methods.

Install Manually:

• Open the SimplePets plugin folder
• Open the Addons folder
  (If the folder is not there then simply create one)
• Download the addon from one of the download locations
• Drop the addons jar file into the Addons folder
• Restart your server (This is to actually get the addon loaded into the plugin)

Default Config:

# Disabling this will make the items show the price, but if the player has bypass permissions he wont have to pay
# 
# Default: 'true'
Hide-Price-If-Bypassed: true

# Should players have to pay each time they spawn a pet?
# 
# Default: 'false'
Pay-Per-Use-Enabled: false

Price:
  # If a pet is free this will be in the place of the price in the lore
  # 
  # Default: 'FREE'
  Free: FREE
  # If the player has the bypass permission, will be in the place of the price in the lore
  # 
  # Default: 'BYPASSED'
  Bypassed: BYPASSED

Cost:
  # If the player does not have enough items, this is the color it will display as (Used in the Lore)
  # 
  # Default: '&#fa7d7d'
  Short: '&#fa7d7d'
  # If the player has over to total items, this is the color it will display as (Used in the Lore)
  # 
  # Default: '&#99ffac'
  Over: '&#99ffac'

# Here is where you can set the translations for the 2 boolean values (true/false)
Boolean:
  # Default: '&#92fc98true'
  'true': '&#92fc98true'
  # Default: '&#fa7d7dfalse'
  'false': '&#fa7d7dfalse'

Messages:
  PurchaseSuccessful:
    # This message will be sent if the purchase it successful
    # Placeholders:
    # - {type} (will get what type of pet it is)
    # - {cost-display} (A custom display of what the pet will cost)
    # 
    # Default: '&eSimplePets &6>> &7You have successfully purchased the {type} pet.'
    One-Time-Purchase: '&eSimplePets &6>> &7You have successfully purchased the {type}
      pet.'
    # This message will be sent if the purchase it successful
    # Placeholders:
    # - {type} (will get what type of pet it is)
    # - {cost-display} (A custom display of what the pet will cost)
    # 
    # Default: '&eSimplePets &6>> &7You have successfully paid for the {type} pet.'
    Pay-Per-Use: '&eSimplePets &6>> &7You have successfully paid for the {type} pet.'

  # This message will be sent if the purchase it successful
  # Placeholders:
  # - {type} (will get what type of pet it is)
  # - {cost-display} (A custom display of what the pet will cost)
  # 
  # Default: '&eSimplePets &6>> &cYou do not have the item(s) to buy this pet, you need to have {cost-display}'
  InsufficientFunds: '&eSimplePets &6>> &cYou do not have the item(s) to buy this pet, you need to have {cost-display}'

  Lore-Lines:
    # These Lore Lines will only be used if 'Pay-Per-Use' is set to false
    # Placeholders:
    # - {type} (will get what type of pet it is)
    # - {cost-display} (A custom display of what the pet will cost)
    # - {current-total} (How many of the item the player currently has in their inventory)
    # - {cost} (How many of the item the player needs to have to purchase the pet)
    # - {purchased} (true/false if the player purchased the pet)
    # 
    # Default: '[&#ffbf5ePrice: &#99ffac{cost-display}, &#ffbf5ePurchased: {purchased}]'
    One-Time-Purchase:
      - '&#ffbf5ePrice: &#99ffac{cost-display}'
      - '&#ffbf5ePurchased: {purchased}'

    # These Lore Lines will only be used if 'Pay-Per-Use' is set to true
    # Placeholders:
    # - {type} (will get what type of pet it is)
    # - {cost-display} (A custom display of what the pet will cost)
    # - {current-total} (How many of the item the player currently has in their inventory)
    # - {cost} (How many of the item the player needs to have to purchase the pet)
    # - {purchased} (true/false if the player purchased the pet)
    # 
    # Default: '[&#ffbf5ePrice: &#99ffac{cost-display}]'
    Pay-Per-Use:
      - '&#ffbf5ePrice: &#99ffac{cost-display}'


# Here I will explain what each value controls for all the pet type customization.
# - 'enabled'
#    This will allow you to toggle if the pet is FREE or if they have to pay
# - 'display'
#    This is what will be displayed as the 'price' of the item
#    This is customizable so you should be able to use Custom Items (Custom Model Data Items)
# 
#    Note: Colors can be used here ;)
# - 'material'
#    This is what controls what material the players have to pay with
#    If you are using CustomModels this will have to be the base item for the item
# 
#    See: https://hub.spigotmc.org/stash/projects/SPIGOT/repos/bukkit/browse/src/main/java/org/bukkit/Material.java#123
# - 'count'
#    This one is self explanatory how many of said item will the player pay with
# - 'custom-model-data'
#    If you have a resource pack that adds custom models chances are you use CustomModels
#    This allows you to specify what model of item you are using
#    (This is how other plugins such as ItemsAdder have support)
# 
#    Note: If you are not using Custom Models then set the value to -1
#    See:  https://mcmodels.net/how-to-tutorials/resource-pack-tutorials/what-is-custommodeldata-2/
type:
  allay:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  armor_stand:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  axolotl:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  bat:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  bee:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  blaze:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  camel:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  cat:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  cave_spider:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  chicken:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  cod:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  cow:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  creeper:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  dolphin:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  donkey:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  drowned:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  elder_guardian:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  enderman:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  endermite:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  evoker:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  fox:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  frog:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  ghast:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  giant:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  glow_squid:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  goat:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  guardian:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  hoglin:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  horse:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  husk:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  illusioner:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  iron_golem:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  llama:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  magma_cube:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  mooshroom:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  mule:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  ocelot:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  panda:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  parrot:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  phantom:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  pig:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  piglin:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  piglin_brute:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  pillager:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  polarbear:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  pufferfish:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  rabbit:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  ravager:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  salmon:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  sheep:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  shulker:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  silverfish:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  skeleton:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  skeleton_horse:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  slime:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  sniffer:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  snowman:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  spider:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  squid:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  stray:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  strider:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  tadpole:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  trader_llama:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  tropical_fish:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  turtle:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  vex:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  villager:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  vindicator:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  wandering_trader:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  warden:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  witch:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  wither:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  wither_skeleton:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  wolf:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  zoglin:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  zombie:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  zombie_horse:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  zombie_villager:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1
  zombified_piglin:
    enabled: true
    display: 10 Diamonds
    cost:
      material: DIAMOND
      count: 10
      custom-model-data: -1


bypass_permissions:
  # This is the master permission, Will ignore all individual bypass permissions listed below
  parent: pet.itemeconomy.bypass
  type:
    # This is a bypass permission for the allay pet, who ever has this permission will now have to pay for this pet
    allay: pet.itemeconomy.bypass.allay
    # This is a bypass permission for the armor_stand pet, who ever has this permission will now have to pay for this pet
    armor_stand: pet.itemeconomy.bypass.armor_stand
    # This is a bypass permission for the axolotl pet, who ever has this permission will now have to pay for this pet
    axolotl: pet.itemeconomy.bypass.axolotl
    # This is a bypass permission for the bat pet, who ever has this permission will now have to pay for this pet
    bat: pet.itemeconomy.bypass.bat
    # This is a bypass permission for the bee pet, who ever has this permission will now have to pay for this pet
    bee: pet.itemeconomy.bypass.bee
    # This is a bypass permission for the blaze pet, who ever has this permission will now have to pay for this pet
    blaze: pet.itemeconomy.bypass.blaze
    # This is a bypass permission for the camel pet, who ever has this permission will now have to pay for this pet
    camel: pet.itemeconomy.bypass.camel
    # This is a bypass permission for the cat pet, who ever has this permission will now have to pay for this pet
    cat: pet.itemeconomy.bypass.cat
    # This is a bypass permission for the cave_spider pet, who ever has this permission will now have to pay for this pet
    cave_spider: pet.itemeconomy.bypass.cave_spider
    # This is a bypass permission for the chicken pet, who ever has this permission will now have to pay for this pet
    chicken: pet.itemeconomy.bypass.chicken
    # This is a bypass permission for the cod pet, who ever has this permission will now have to pay for this pet
    cod: pet.itemeconomy.bypass.cod
    # This is a bypass permission for the cow pet, who ever has this permission will now have to pay for this pet
    cow: pet.itemeconomy.bypass.cow
    # This is a bypass permission for the creeper pet, who ever has this permission will now have to pay for this pet
    creeper: pet.itemeconomy.bypass.creeper
    # This is a bypass permission for the dolphin pet, who ever has this permission will now have to pay for this pet
    dolphin: pet.itemeconomy.bypass.dolphin
    # This is a bypass permission for the donkey pet, who ever has this permission will now have to pay for this pet
    donkey: pet.itemeconomy.bypass.donkey
    # This is a bypass permission for the drowned pet, who ever has this permission will now have to pay for this pet
    drowned: pet.itemeconomy.bypass.drowned
    # This is a bypass permission for the elder_guardian pet, who ever has this permission will now have to pay for this pet
    elder_guardian: pet.itemeconomy.bypass.elder_guardian
    # This is a bypass permission for the enderman pet, who ever has this permission will now have to pay for this pet
    enderman: pet.itemeconomy.bypass.enderman
    # This is a bypass permission for the endermite pet, who ever has this permission will now have to pay for this pet
    e