Packages

Feb 19, 2016
Packages
  • This is the Packages wiki page. Here you can find in-depth information about the Packages plugin.

    Dynamic Packages
    Dynamic packages can have unlimited rewards and chances. They work similar to crates, in which you have some rewards with different chances. When you open a Package you will get a random reward from the rewards in the config.
    Static Packages
    Static packages have one set reward, like a kit. You can set one reward in the config for the static packages. The opener will get the one reward when they open the Package.

    Requirements
    There are no special plugins required for Packages to run, but there are optional plugins.
    WorldGuard: You can disable opening packages in certain regions
    Commands
    Aliases: packages, pp
    (/command - permission - description)
    /package - none - Shows a help page with all the commands you can use.
    /package give <player> <package name> <amount> - packages.give - Gives a certain amount of packages to a player
    /package giveall <name> <amount> - packages.giveall - Gives a certain amount of packages to all players online
    /package list - packages.list - Lists all packages available to use
    /package claim (package) - packages.claim.<package> - Allows a player to claim a certain package if they have the permission. If the player does not specify a package, it will show them the available packages they have and when they are next available.
    /package send <player> - packages.send - If a player is looking at a chest, it will send the contents of the chest to the player. If the receiver is offline, it will wait until the receiver is online to give them the package. If the player is online, it will send them the package.
    /package reload - packages.reload - Used to reload all the configs, you must use this if you want to add new Packages into the plugin or change the language file.

    Configs
    Code (Text):

    package: #The name of the package
      item: #This contains information about the Package item
        material: CHEST
        name: '&cPackage'
        lore: #Remove the whole section to remove lore
        - Yesterday it worked.
        - Today it is not working.
        - Plugins are like that.
        glow: true
      items: #Allows custom items to be given to players
      - c:BossSword
      commands: #List of commands to run when a player opens a package
      - eco give %player% 50
      - broadcast %player% opened a package!
      - say We know that, broadcast. Congrats %player%. Here's another $100!
      - eco give %player% 100
      claim-delay: #Settings for claiming the package
        claimable: true
        delay: 1440 #How long the player must wait to claim the Package again in seconds
        claim-amount: 1 #How many Packages the player will get when they claim
      firework: #Settings for a custom firework
        enabled: true
        power: 1 #Set how high/powerful the firework will be
        effects: #List of effects in the firework
        - flicker:true #This mst be present
        - trail:true #This also must be present
        - with:BALL #Check the "other" section on the Wiki for a list of with types
        - withColor:255,0,255 #R,G,B colors
        - withFade:0,255,255 #R,G,B colors
        #Continue adding - withColor:r,g,b to add more colors onto the firework
      particles: #Particle settings when opening a package
        enabled: true
        type: MOBSPAWNER_FLAMES #Check the "other" section on the Wiki for a list of particle types
        offset-x: #Set the minimum and maximum radius of the particles on the x-axis
          min: -1.0
          max: 1.0
        offset-z: #Set the minimum and maximum radius of the particles on the z-axis
          min: -1.0
          max: 1.0
        amount: 10 #Set how many particles should be displayed
        id: 0 #Must be used for block breaking particles
        data: 0 #Must be used for block breaking particles
        speed: 0.1 #Sets how fast the particles should move
        radius: 15 #Sets how far away players can see the particles
      sound: #Settings for sound effects
        enabled: true
        type: CLICK #Check the "other" section on the wiki for a list of sound types
        volume: 5.0 #Set how loud the sound will be
        pitch: 0.0 #Sets the pitch of the sound
      enabled-worlds: #Set the worlds a package can be used in
      - world
      - world_nether
      - world_the_end
      disabled-regions: #Set the disabled WorldGuard regions Packages can't be used in (Needs WorldGuard to work)
      - region1
      - region2
      show-name-when-dropped: true #Boolean value (true/false) of the Package to show it's name when dropped on the ground
     
    Code (Text):

    [B]Package: #The name of the package, must not conflict with a static package name
      item: #This contains information about the Package item
        material: CHEST
        name: '&cDynamic Package'
        lore: #Remove the whole section to remove lore
        - Yesterday it worked.
        - Today it is not working.
        - Plugins are like that.
        glow: true
      rewards: #Copy and paste a reward to make a new reward, make sure all the chances add up to 100%.
               #The reward names can be anything
        reward1: #The name of the Reward, can be anything.
          chance: 75 #Sets the chance of getting the reward
          items: #Set the custom items a player can get when opening a Package
            enabled: true
            list:
            - c:BossSword
          commands: #List of commands to run when a player opens a package
            enabled: true
            list:
            - eco give %player% 40
            - broadcast %player% opened a package!
            - say We know that, broadcast. Congrats %player%. Here's another $30!
            - eco give %player% 30
        reward2: #The name of the Reward, can be anything.
          chance: 25 #Sets the chance of getting the reward
          items: #Set the custom items a player can get when opening a Package
            enabled: true
            list:
            - c:BossSword
          commands: #List of commands to run when a player opens a package
            enabled: true
            list:
            - eco give %player% 350
            - broadcast %player% opened a package!
            - say We know that, broadcast. Congrats %player%. Here's another $250!
            - eco give %player% 250
      claim-delay: #Settings for claiming the package
        claimable: true
        delay: 1440 #How long the player must wait to claim the Package again in seconds
        claim-amount: 1 #How many Packages the player will get when they claim
      firework: #Settings for a custom firework
        enabled: true
        power: 1 #Set how high/powerful the firework will be
        effects: #List of effects in the firework
        - flicker:true #This mst be present
        - trail:true #This also must be present
        - with:BALL #Check the "other" section on the Wiki for a list of with types
        - withColor:255,0,255 #R,G,B colors
        - withFade:0,255,255 #R,G,B colors
        #Continue adding - withColor:r,g,b to add more colors onto the firework
      particles: #Particle settings when opening a package
        enabled: true
        type: MOBSPAWNER_FLAMES #Check the "other" section on the Wiki for a list of particle types
        offset-x: #Set the minimum and maximum radius of the particles on the x-axis
          min: -1.0
          max: 1.0
        offset-z: #Set the minimum and maximum radius of the particles on the z-axis
          min: -1.0
          max: 1.0
        amount: 10 #Set how many particles should be displayed
        id: 0 #Must be used for block breaking particles
        data: 0 #Must be used for block breaking particles
        speed: 0.1 #Sets how fast the particles should move
        radius: 15 #Sets how far away players can see the particles
      sound: #Settings for sound effects
        enabled: true
        type: CLICK #Check the "other" section on the wiki for a list of sound types
        volume: 5.0 #Set how loud the sound will be
        pitch: 0.0 #Sets the pitch of the sound
      enabled-worlds: #Set the worlds a package can be used in
      - world
      - world_nether
      - world_the_end
      disabled-regions: #Set the disabled WorldGuard regions Packages can't be used in (Needs WorldGuard to work)
      - region1
      - region2
      show-name-when-dropped: true #Boolean value (true/false) of the Package to show it's name when dropped on the ground[/B]
     
    Custom Items can be referenced in the packages, when putting c:<name> in the items list.
    Code (Text):
    BossSword: #The name of the item
      material: IRON_SWORD #Material
      amount: 1 #How many of the item should be used in the Item Stack
      data: 0 #The data of the item
      name: '&6&lBoss Sword' #A custom name
      lore: #Custom lore
      - Yesterday it worked.
      - Today it is not working.
      - Plugins are like that.
      enchants: #Enchants of the item
      - DAMAGE_ALL:7
      - PROTECTION_ENVIRONMENTAL:6
    lang.yml - Contains all the messages for the plugin, and it supports color codes. You can change each message of the plugin.
    delays.yml - Contains data for claim delays for players, should not be touched.
    custom_package_data.yml - Contains information of custom packages players send to eachother. Shouldn't be touched.

    Other
    Firework Effect Types
    Particle Effect Types
    Sound Effect Types


    If you think anything is missing, or you need clarification on something, please PM me and I will add it and inform you about it ASAP. Thanks for reading :)
  • Loading...
  • Loading...