Surprise Bags

Description

This plugin adds various treasures and surprise bags to your world. These special items will be dropped by naturally-spawned monsters such as Zombies and Spiders. When players obtain the surprise bags, they can open them by clicking the right mouse button while holding them. They will then get a random item and the bag will disappear.

The list of surprise bags is set in the configuration files of the plugin, as well as the list of items that the player can receive when opening each bag. The plugin comes with a predefined set of bags:

• Treasure
• Trick-or-treat Box (perfect for Halloween)
• Surprise Bag
• Unknown Book
• Wintersday Gift (perfect for Christmas)

Each such item has a different drop-rate. Please see the configuration files for more information.

For example, players who open an Unknown Book might get a sharpness I enchanted book or a different enchanted book. Trick-or-treat boxes might get the player a raw fish, a pumpkin pie or, rarely, a diamond helmet.

Commands

There is one main command and several sub-commands:

• /surprisebags version - Get the plugin's version.
• /surprisebags spawn <bag> [count] [player] - Give you or a player a bag by name.
• /surprisebags list - List of existing bags.
• /surprisebags edit <bag> - Edit the bag's contents.
• /surprisebags save <bag> - Save the bag's contents to the configuration file.
• /surprisebags addbag <bag-id> [name] [drop-chance] - Add a new bag
• /surprisebags removebag <bag-id> - remove a custom bag
• /surprisebags reload - Reload the configuration files.

Permissions

There are three permission settings:

• surprisebags.command - Allows you to use the SurpriseBags admin command (defaults to admins only).
• surprisebags.openbag - Allows you to open bags (defaults to everyone).
• surprisebags.edit - Allows you to edit or save the bags contents (defaults to admins only).

Configuration

You may add/remove surprise bags by using the in-game commands. You can change different settings by editing config.yml, which is in the plugin's folder after installation. Each bag has its own YAML file, where you can list the items that players will receive when opening the bag. The players will always receive exactly one item, so adding many items of the same type will increase the chance of receiving them, whereas items which appear only once will be rare. You may open the configuration files of any of the predefined bags (e.g. Trick-or-treat box) to see how these lists work.

You may change the general drop-rate of bags, as well as the specific drop-rate of each bag.

If you have WorldGuard installed, you may limit the drops to one region. The region ID is set on config.yml.

If you want a bag to drop from a specific list of mobs, you can add the "limit-mob" setting to the bag's yaml file. For example:

#
# Limit Mobs
#
# Limit the drop of this bag to the listed mobs only.
#
limit-mob:
  - creeper
  - zombie

Note that this should be in the bag's file, not in config.yml (in other words, it is defined per bag).