CustomPets Configuration

Jun 5, 2017
CustomPets Configuration
  • Configuration

    This page's goal is to teach you how to properly configure and successfully create your own pets for the CustomPets plugin. There are 3 main configuration files in this plugin: config.yml, messages.yml, and pets.yml. The config.yml is for managing most of the systematic things. The messages.yml file is for customizing your own messages for the plugin. And the pets.yml is the most important file. This file is where you create and customize your own pets. This is what the pets.yml file should look like when you first run the plugin:
    Code (Text):
    #########################################################
    #   Welcome to the default pets.yml file of CustomPets  #
    #All Pets created/modified in this file                 #
    #To learn how to create your own pets, click here:      #
    #https://www.spigotmc.org/wiki/custompets-configuration/#
    #########################################################

    TurboPig:
      type: PIG
      permission: cp.pet.turbopig
      name: '&b&o&lTURBO&r &dPig'
      gui:
        id: PORK
        lore:
        - '&cJust a really fast pig...'
      pet: HEART,5
      trail: CLOUD
      saddle: true
      speed: 100
    PumpkinMinion:
      type: ZOMBIE
      permission: cp.pet.pumpkinminion
      name: '&6&lPumpkin Minion'
      gui:
        id: PUMPKIN
        lore:
        - '&cWoah, SPOOKY!'
      silent: true
      invisible: true
      baby: true
      helmet:
        id: PUMPKIN
      hand:
        id: IRON_HOE
        enchanted: true
    Vampire:
      type: ZOMBIE
      permission: cp.pet.vampire
      name: '&f&lVampire'
      gui:
        id: GHAST_TEAR
        lore:
        - '&cThis human/bat will stalk you wherever you go.'
      trail: LARGE_SMOKE
      silent: true
      invisible: true
      helmet:
        id: SKULL
        data: 1
      chestplate:
        id: LEATHER_CHESTPLATE
        color: 0,0,0
        enchanted: true
     
    If you are not experienced with YAML Configuration, this might look a bit overwhelming at first, but by the end of this entire page, it shouldn't be (hopefully :p)

    Step 1:

    The first thing you have to do is to make a new line and type in the name of the pet you want to create. Here's an example:
    Code (Text):
    DirtFace:
    For this tutorial, I will create a pet called "DirtFace". Take note that it is CAPS sensitive.

    Step 2:

    The next things you'd want to do is to set the EntityType - what kind mob the pet will be, and the permission players are required to have before being able to use the pet. You can do this by adding the fields: "type" and "permission". Make sure you add two (2) spaces before adding the fields. Here's what it should look like now:
    Code (Text):
    DirtFace:
      type: Zombie
      permission: cp.pet.dirtface
    As you can see, I set the EntityType of this pet to "Zombie" and set the permission to "cp.pet.dirtface". Spawning the pet will require the permission: "cp.pet.dirtface", and the pet will be a Zombie. For a list of the EntityTypes of every mobs, click here.

    Step 3:

    Note that none of these things below are required, but are very essential in making your pets look better. There are some more fields that can be used to make your pet look cooler. All fields can be found here. Here is an example of the pet we made with it's finished customization:
    Code (Text):
    DirtFace:
      type: Zombie
      permission: cp.pet.dirtface
      gui:
        id: DIRT
      helmet:
        id: GRASS
      chestplate:
        id: LEATHER_CHESTPLATE
        color: 0,102,0
      leggings:
        id: LEATHER_LEGGINGS
        color: 134,89,45
      boots:
        id: LEATHER_BOOTS
        color: 122,122,122
     

    Step 4:

    After creating the pet, save the pets.yml file and type in the command "/cp reload". And there, you're finally done making your first pet. Give yourself the permission and type "/pet [pet]" to spawn it in. In my case, I gave myself the permission "cp.pet.dirtface" and typed the command "/pet DirtFace". Here is my end result:

    [​IMG]
    Now that you're done making your very first pet, time to make some more! :p
  • Loading...
  • Loading...