Description

Coded from scratch as a 1.9+ replacement for and improvement on the inactive SurpriseBags plugin, MysteryBags adds special customizable items into your world that can drop from mobs and animals. After a player obtains one, he/she can hold the item and right click to open the bag, causing the bag to disappear, and leaving the player with a random item!

Bags can be created with a simple in-game command. Afterwards, you can edit it to your heart's content in the plugin's folder!

Commands

<Required field> [Optional field]

/mbag list - Lists the ids of all loaded Mystery Bags.
/mbag addbag <id> [material]:[data] - Adds a new Mystery Bag. Unless you know what you're doing, always use this command to create a new bag file!
/mbag removebag <id> - Unloads a loaded Mystery Bag, but does not delete the file. Use this command before deleting the file.
/mbag spawn <id> [amount] [player] - Exactly what the command implies: spawns Mystery Bags.
/mbag edit <id> - Open the Content Editor GUI for the specified Mystery Bag.
/mbag save <id> - Saves changes from the Content Editor GUI to the bag's config file.
/mbag reload - Reloads config options and bags from disc.

/mbag stack <#> - Sets the literal amount of held item as used in item weights.
/mbag amount <#> - Sets the amount of that item that can be obtained from a MysteryBag without affecting chance. Allows <#-#> to specify a range of values (inclusive).
/mbag command <cmd> - Spawns a Written Book with data holding the command. If received from a MysteryBag, the player will not get the book, but will have the commands run from console. Using this command while holding an existing Command Book will add more commands to it.
- Allowed parameters in commands (case sensitive): • %P% - player's name • %W% / %X% / %Y% / %Z% - player's world and coords

/mbag setname <name> - Sets the custom name of held item.
/mbag setlore <lore> - Sets the custom lore of held item. Use '/' for multiple lines.
/mbag addlore <lore> - Appends lines of lore to held item. Use '/' to add multiple lines.
/mbag removelore [#lines] - Removes lines of lore from an item, starting at the bottom, ex. '/mbag removelore 2' removes the bottom-most 2 lines of lore from held item.
/mbag unbreakable - Toggles the Unbreakable status of held item. Requires that the server be running Spigot.

Permissions

mysterybags.open - allows opening of Mystery Bags. Default: Everyone
mysterybags.admin - allows the usage of MysteryBag commands. Default: Operators

Notable Differences

This plugin is designed to be as closely compatible with existing SurpriseBags configs as possible; however, there are obviously still changes that need to be made before porting over old bags and configs!

Prevents players from crafting, smelting, or brewing with Mystery Bags!
Region and World limits on bag drops are based on where the mob is killed (as opposed to where it spawned).
Bags can be opened both in the Main and Off hand slots. Having a bag in each hand opens both of them at the same time!
Removed "global" drop chance for bags. The only RNG roll for bag drops is now specified in each individual bag.
Drop chances can be further varied by mob type, ex. skeletons may have a higher chance to drop a certain bag than any other mobs.
Player bag-open counts and "rare" rewards can be tracked and are logged to output.yml.
Ability to specify "rare" rewards and announce to the server whenever a lucky player receives one, with optional firework and sound effect. The broadcasted message is fully customizable.
The bag ID is no longer visible in the item's lore.
Tons of other additional config options!

To update SurpriseBag configs into MysteryBag configs, simply copy/paste from THESE into the respective files (and edit them as needed).

Default Configs

Can be found HERE.

------------------------------------------------------------

Found a bug? Got a feature request or suggestion?

Please leave a comment or shoot me a PM!

------------------------------------------------------------

View the SOURCE on GitHub.

------------------------------------------------------------

Mystery Bags