PhatLoots

Main Page

Description

This plugin allows Players to receive loot (money/items/exp/etc...) from Chests, Mobs, and more. This is much like the dungeon Chests in the vanilla game except admins can set which items may appear as loot.

Why do I want this plugin?

PhatLoots is the perfect plugin for an RPG server. It allows you to modify which items are dropped by animals and monsters. It can even be used to have monsters spawn with armor and weapons. PhatLoots is also perfect for a minigames server. Chests can be placed around the world and be configured to spawn randomized loot which respawns after time. No matter the server style, PhatLoots can make it more exciting.

Features:

Supports nearly all Bukkit plugins: Supports all major Economies (Requires Vault); Supports all major Permission Plugins; MythicDrops support for easily balancing MythicDrops loot as well as generating Gems and Unidentified Items; Citizens Support to control loot for NPCs; Votifier support to give a Player loot when they vote; MultiWorld support (Different loot per World); Supports custom items made from any plugin that uses the Bukkit API (Plugins accessing NMS may cause conflicts); Simple API for plugin compatibility
Fully configurable: Loot tables may be setup using a Chest GUI to reduce the amount of commands needed; Loots can include money, items, experience, running a command, or a combination of all of these; Chests can be a one time loot, hourly, daily, or reset after any amount of time down to the second; All messages seen by player's are customizable and can even be turned off; Each chest can have it's own loot tables to provide more random loot; Chests may have various reset times so they aren't all refilled at once; Optionally display to Players how much longer they must wait to retrieve more loot
Chest Loot: Any Block may act like a chest (EnderChest, FlowerPot, Crate (Piston), Bookshelf, CakeBlock, etc.); Dispenser support (punch or activate the dispenser and it will dispense your loot); Ninjaing loot can be prevented by providing each Player with their own share of loot (global vs. individual); Chests can be linked to multiple loot tables at once; PhatLoots may be set to autoloot for quicker looting; Chests may be set to break once they are looted and then respawn when they have reset
Mob Loot: Have full control over what items are dropped by mobs; Allow mobs to spawn with weapons, armor, and even potion effects; Allow mobs to drop money; Modify how much experience mobs drop; Modify how often mobs drop loot; Optionally prevent mobs from dropping items unless they are killed by a Player; Mob Loot may replace or include the default Minecraft mob loot; Each type of mob may be linked to a different loot table; Baby Zombies, Zombie Villagers, and Normal Zombies may each have their own loot tables; Villagers may be linked to a loot table based on their Profession (e.g. Blacksmith, Priest, etc.); EpicBoss mob support (requires EpicBossLoot addon); Citizens support, create loot tables for NPCs
Command Loot: PhatLoots can be looted using the command /loot <PhatLoot Name>; A Player can be forced to loot a PhatLoot by using the command /loot give <Player> <PhatLoot Name> [Title]; Plugins which support executing a command can use the loot command to give Players loot
Loot Bags: Items can be linked to a PhatLoot; Loot bags can be right clicked while holding them to get the loot from inside of it; Loot bags are a one time use; Loot bags can even be added as loot themselves
Custom Loot: Commands, money, and exp may be added as loot; Loot collections allow for more control over how many of what type of items are looted; Supports items with custom names and descriptions (Such as items modified with the plugin Lores); Auto Enchant weapons and armors; Auto name items based on their enchantments; Calculate item tiers based on enchantments; Add automatic damage estimations to items (e.g. +1-4 holy damage); Items may have a random amount or durability

Addons:

Addons are separate jars which may be installed to enhance this plugin

SwapLoot - Randomizes which PhatLoot a chest is linked to
MonsterNearby - Prevents Players from looting chests when a monster is nearby
PlayerNearby - Prevents chests from respawning when a Player is nearby
EpicBossLoot - Allows bosses from EpicBoss to drop Mundane loot
RandomizedLore - Generate random numbers within the lore of your loot
AntiCamp - Prevent Players from camping chests until they cooldown

Note:

Use a plugin such as Lores with this plugin to create more interesting loot.

Commands

Commands may be typed in console or in game. When entering commands in console omit the slash. i.e. perm give Codisimus minecraft.command.tp

Notation	Description
Text without brackets	Items you must type as shown
<Text inside angle brackets>	Placeholder for which you must supply a value
[Text inside square brackets]	Optional items
Vertical bar (\|)	Separator for mutually exclusive items; choose one
Ellipsis (…)	Items that can be repeated

In-Game Help:

/loot help - Display the PhatLoots Help Page

/loot help <command> - Display a command's usage

/loot help time - Displays the usage details of the time command
Creating a PhatLoot:

/loot make <Name> - Create a PhatLoot with the given name

/loot make Epic - Creates a new PhatLoot of the name Epic

PhatLoot names are case sensitive and cannot include spaces (use underscore instead)

/loot link <Name> - Link the target Chest with a PhatLoot

/loot link Epic - Links the Chest that you are currently looking at to the Epic PhatLoot

Chest may also refer to a dispenser or any other block supported in the config file

/loot link hand <Name> - Link the item in hand with a PhatLoot

/loot link hand Epic - Links the item that you are currently holding to the Epic PhatLoot

The linked item is known as a Loot Bag

Only that specific itemstack is linked and not any other items of the same type

/loot rename <PhatLoot> <Collection> <NewName> - Rename a PhatLoot Collection

/loot rename Epic Weapons Melee_Weapons - Renames the Weapons Loot Collection of to Melee_Weapons for the Epic PhatLoot

This command only renames Loot Collections, A PhatLoot can be renamed by renaming the YAML save file

/loot unlink [Name] - Unlink the target Block from a PhatLoot

/loot unlink - Unlinks the Chest that you are currently looking at from all PhatLoots

/loot unlink Epic - Removes the Epic PhatLoot as linked with the Chest that you are currently looking at (all other linked PhatLoots remain present)

/loot delete <Name> - Delete a PhatLoot

/loot delete Epic - Deletes the PhatLoot which is named Epic

Deleting a PhatLoot also unlinks it from all Chests deletes all Loot Collections associated with it
Setting up a PhatLoot:
If Name is not specified then all PhatLoots that are linked to the target Block will be affected. Amount may be a number (100) or range (100-500)

/loot time <Name> <Days> <Hrs> <Mins> <Secs> - Set the cooldown time for the specified PhatLoot

/loot time 0 1 30 0 - Sets the cooldown time to 1 hour and 30 minutes

Once looted, Players must wait this amount of time to receive more loot from the same Chest

/loot time <Name> never - Set the PhatLoot to only be lootable once per chest

/loot time never - Sets the PhatLoot to never cooldown

Once looted, Players will never be able to receive more loot from the same Chest

/loot global <Name> <true|false> - Configure cooldown type of the specified PhatLoot

/loot global true - Sets the PhatLoot to a global cooldown (early bird gets the worm)

/loot global false - Sets the PhatLoot to an individual cooldown (worms for everyone)

If you want every Player to share the loot within a Chest then set global to true. If you want each Player to have their own loot then set global to false

/loot autoloot <Name> <true|false> - Configure whether Players will need to manually remove items from chests of the specified PhatLoot

/loot autoloot true - Sets the PhatLoot to have loot items automatically added to the Player's inventory

/loot autoloot false - Sets the PhatLoot to require Players to manually take items from the PhatLoot chest

When autolooted, items which don't fit in the Player's inventory will stay in the chest (or will spawn on the ground if there is no chest)

The chest inventory view will not be shown if all items were autolooted

/loot round <Name> <true|false> - Configure whether the specified PhatLoot will round down cooldown times

/loot round true - Sets the PhatLoot to round down cooldown times to the closest value

/loot round false - Sets the PhatLoot to take the entire cooldown time to reset

Setting round to true is used to create hourly or daily loots

/loot cost <Name> <Amount> - Set the cost of looting the specified PhatLoot

/loot cost 10 - Players will be charged $10 whenever they loot a chest of the specified PhatLoot

/loot money 0-3 - Players will be charged a random amount of money between $0 and $3 (inclusive) whenever they loot the specified PhatLoot

Players are not charged if the chest is currently on cooldown

If the Player cannot afford the payment then they do not receive loot

This feature requires an economy plugin as well as Vault

/loot money <Name> <Amount> - Set the amount of money to be gained upon looting the specified PhatLoot

/loot money 50 - Players will be given $50 whenever they loot the specified PhatLoot

/loot money 10-100 - Players will be given a random amount of money between $10 and $100 (inclusive) whenever they loot the specified PhatLoot

Players are not given money if the chest is currently on cooldown

This feature requires an economy plugin as well as Vault

/loot exp <Name> <Amount> - Set the amount of experience to be gained upon looting the specified PhatLoot

/loot exp 1000 - Players will be given 1000 experience whenever they loot the specified PhatLoot

/loot exp 100-500 - Players will be given a random amount of experience between 100 and 500 (inclusive) whenever they loot the specified PhatLoot

Players are not given experience if the chest is currently on cooldown
Managing PhatLoots:

/loot gui [Name] - Opens the info GUI of the specified PhatLoot

If Name is not specified then all PhatLoots that are linked to the target Block will be affected

/loot reset [Name] - Resets the loot history for the specified PhatLoot

/loot reset Epic - Resets all chests of the Epic PhatLoot

/loot reset - Resets the target PhatLoot chest

/loot reset all - Resets all PhatLoot chests

Resetting a PhatLoot chest will cancel the cooldown allowing it to be looted immediately

/loot clean [Name] - Cleans the loot history for the specified PhatLoot

/loot reset Epic - Cleans all chests of the Epic PhatLoot

/loot reset - Cleans the target PhatLoot chest

/loot reset all - Cleans all PhatLoot chests

Cleaning a PhatLoot chest will remove all outdated data which is no longer relevant

PhatLoot chests are automattically cleaned before being saved
Administrative Commands:

/loot list - Lists all existing PhatLoots

/loot give <Player> <PhatLoot> [Title] - Forces a Play to loot the specified PhatLoot

If Title is specified then the chest GUI will be renamed to the title provided

/loot rl - Reloads the PhatLoots plugin, configuration file, and add-ons
Manage Loot Commands:

/loot <add|remove> <Item|ID|hand> [Parameter]...: Add/Remove an item as loot

/loot add hand #1-16 %32 - 32% of the time, 1 to 16 of the item you are holding will be generated

/loot add bow earrow_fire(2) earrow_infinite %5 - 5% of the time, a bow with level 2 Flame and Infinity will be generated

The item may be referenced by it's name, ID, or hand to indicated the item you are holding

/loot <add|remove> coll <Name> [Parameter]...: Add/Remove a collection as loot

/loot add coll Weapon %25 #2 - 25% of the time, 2 loot from the Weapon collection will be generated

/loot add coll Armor %10 #0 - 10% of the time, each loot within the Armor collection will be rolled for

/loot <add|remove> cmd [Parameter]... /<Command>: Add/Remove a command which will be executed if generated

/loot add cmd /say <player> has found a chest! - Announces the message Codisimus has found a chest! if Codisimus loots the PhatLoot

/loot <add|remove> msg [Parameter]... -<Message>: Add/Remove a message which will be sent to the looter if generated

/loot add msg cWeapon %50 -§5Here, take this weapon with you in your travels! - Assumming the Weapon collection is set to roll for each item individually, the message §5Here, take this weapon with you in your travels! will be shown to the looter 50% of the time that the Weapon collection is generated

Each Parameter begins with a single character id as follows:
p: The name of the PhatLoot to modify

pEpic - Indicates the Epic PhatLoot

If the PhatLoot parameter is not specified then all PhatLoots linked to the target Block will be affected

%: The probability (or chance) of spawning the loot

%50 - Indicates the loot will be spawned 50% (half) of the time

%0.01 - Indicates the loot will be spawned about once in every 10,000 loots

If the probability parameter is not specified then the loot will be spawned 100% (all) of the time

c: The id of the loot collection to specify

cWeapons - Indicates the loot will be modified within the Weapons collection

cFood - Indicates the loot will be modified within the Food collection

If the collection parameter is not specified then the loot will be modified in the top level of the PhatLoot, outside of all collections

#: The amount of the item to be spawned

#10 - Indicates that 10 of the loot will be spawned

#1-64 - Indicates that the amount of loot which will be spawned will fall between 1 and 64 (inclusive)

For collections, this number indicates the amount of loot which will be spawned from the collection

#0 - When the loot type is coll, this indicates that each loot within a collection will be rolled for individually

#0-3 - When the loot type is coll, this indicates that each a maximum of 3 loot will be spawned from the collection

If the amount parameter is not specified then the amount of loot spawned will be 1 (or the amount you are holding if using the hand command

d: The data or durability value of the item
d1 - Indicates the data value of the item
- If the item is Sand, it will be Red Sand
- If the item is Golden Apple then it will be Enchanted Golden Apple
- If the item is Flower, it will be Blue Orchid
- If the item is armor or a tool, it will be have 1 use remaining
t: Display the calculated Tier of the item

t - Calculates and displays the tier of the item when generated based on the material and enchantments

l: Display randomized lore on the item

l - Displays a custom name as well as lore for the item when generated based on the material and enchantments

e: Add enchantments to the item

earrow_infinite - Enchants the item (bow) to provide unlimited arrows

eprotection_fire(3) - Enchants the item to provide protection from fire at level 3

eauto - Enchants the item with random applicable enchantments at varying levels

auto enchanting has the possibility of generating items with no enchantments

Permissions

Permission nodes may be given to Players or permission groups using any permissions plugin such as CodsPerms.

phatloots.loot.* - Needed to receive loots from all restricted PhatLoots

phatloots.loot.EpicLoot - Needed to receive loot from the PhatLoot named EpicLoot

Any PhatLoot name may be substituted in place of EpicLoot
This permission node is only required for PhatLoots which are set as restricted within the config file

phatloots.moneyfrommobs - Needed to receive money from mobs

This permission node is set to true by default

phatloots.commandloot - Needed to receive loots through command

phatloots.rl - Needed to reload the PhatLoots plugin

Explicitly allows for use of the /loot rl command

phatloots.reset - Needed to reset the list of users who looted PhatLoots

Explicitly allows for use of the /loot reset command

phatloots.clean - Needed to remove loot times that are no longer relevant

Explicitly allows for use of the /loot clean command

phatloots.list - Needed to list all current PhatLoots

Explicitly allows for use of the /loot list command

phatloots.info - Needed to see loot information of a given PhatLoot and modify it with the loot gui

Explicitly allows for use of the /loot gui command

phatloots.give - Needed to force a Player to loot a PhatLoot

Explicitly allows for use of the /loot give command

phatloots.admin - Needed to break linked Blocks

Broken blocks will be automatically unlinked

phatloots.make - Needed to create a new PhatLoot

Explicitly allows for use of the /loot make command

phatloots.delete - Needed to delete a PhatLoot

Explicitly allows for use of the /loot delete command

phatloots.link - Needed to link a PhatLoot to a chest

Explicitly allows for use of the /loot link command

phatloots.unlink - Needed to unlink a PhatLoot from a chest

Explicitly allows for use of the /loot unlink command

phatloots.manage - Needed to add or remove loot for a PhatLoot

Explicitly allows for use of the /loot add command

Explicitly allows for use of the /loot remove command

phatloots.time - Needed to set the reset time of a PhatLoot

Explicitly allows for use of the /loot time command

phatloots.global - Needed to set whether a PhatLoot has a global cooldown

Explicitly allows for use of the /loot global command

phatloots.autoloot - Needed to set whether a PhatLoot is autolooted

Explicitly allows for use of the /loot autoloot command

phatloots.round - Needed to set whether a PhatLoot's reset time is rounded down

Explicitly allows for use of the /loot round command

phatloots.cost - Needed to set the cost to loot a PhatLoot

Explicitly allows for use of the /loot cost command

phatloots.money - Needed to set how much money is looted from a PhatLoot

Explicitly allows for use of the /loot money command

phatloots.exp - Needed to set how much experience is looted from a PhatLoot

Explicitly allows for use of the /loot exp command

phatloots.create - Parent node for the following permission nodes:

phatloots.make: true
phatloots.delete: true
phatloots.link: true
phatloots.unlink: true
phatloots.manage: true
phatloots.time: true
phatloots.global: true
phatloots.autoloot: true
phatloots.round: true
phatloots.cost: true
phatloots.money: true
phatloots.exp: true