[MECH] OtherDrops 2.5 - Ultimate block/mob/player drop editing-supports SpoutMaterials! [1.2.3R0.1]

OtherDrops - Customize any drop!
Version: 2.3-beta4 (2012/02/13)

Want to fix glass/stairs/boat drops? Want to gather ice/glowstone/grass in a balanced manner? Want to smelt ore with golden tools? Want to cause chaos with undead that rise again? Now you can, simply by enabling the included example files or delve into the more advanced customisation and make drops work the way you want.

OtherBlocks aims to give you ultimate control over what item that blocks/entities drop when destroyed, depending on how they were destroyed. Compatible with WorldGuard. Lightweight! Only scans what it needs to and ignores the rest.
Download: BukkitDev (download link on there) | Source Code

Backup your configs before upgrading, just in case. Old configs should still work - you will need to copy the global config file from the OtherBlocks folder to the OtherDrops folder & rename it to otherdrops-drops.yml.
Let me know of any bugs or post to the issue tracker. New features and other details are on the dev.bukkit page here.

Included Modules
* Fix undroppables: fix drops for stairs, glass (don't use your hands - ouch), boats & bookshelves (1.8 stairs included)
* Gold tools (basic): gold tools have a chance of dropping the complete block for grass, ice & glowstone.
* Gold tools (smelt): gold tools have a chance of mining an ingot directly from ores.
* Ore Extraction: using the usual tools, ingots are ripped out of ores, leaving the stone behind.
* Leaf overhaul: adds leaf drops (apples, cocoa, leaves, sticks & a very small chance of golden apple).
* Undead Chaos: beware the night! Zombies & skeletons rise again and even players rise back from the dead (player deaths spawn more zombies/skeletons).
* and more...

Custom Configuration Examples

Code:

    # Simple glass drop fix
    GLASS:
      - drop: GLASS
 
    # Players drop Zombies on death, 50% of the time
    PLAYER:
      - drop: CREATURE_ZOMBIE
        chance: 50%
 
    # Spiders killed with any sword at night have a 10% chance to drop web,
    # otherwise they drop whatever they normally would
    CREATURE_SPIDER:
      - tool: ANY_SWORD
        time: NIGHT
        drop: WEB
        chance: 10%
 
    # Trees drop apples (or cocoa from birch trees)
    SPECIAL_LEAFDECAY@GENERIC:
      - drop: APPLE
        chance: 5%
    SPECIAL_LEAFDECAY@BIRCH:
      - drop: DYE@BROWN
        chance: 5%

Other examples:

• allow gathering of Glowstone Dust on the overworld by breaking Redstone ore with a golden pickaxe, any other pickaxes drop the normal redstone dust
• disable (or just nerf) mob traps/grinders by reducing drop chances on lava/fall/drowning deaths
• allow ingots to be mined directly from their ores if you use Flint and Steel
• start the day of the dead by setting Zombies to drop Zombies half the time (they just wont stay down!)
• invoke Isaiah Mustafa and decree "THE LEAVES ARE NOW DIAMONDS!"

• modify the drop list of blocks, mobs, vehicles or other entities (paintings, torches, redstone, furnace, etc)

• economy support: (via Register - supports both iConomy & Boseconomy)

• data values: (eg. WOOL@RED, DYE@BLUE, LOG@BIRCH)

• tools: decide what drops with damage from swords, hoes, fire, water, falling and more (group synonyms such as ANY_SWORD, ANY_PICKAXE)

• chance: anywhere from 100% to 0.0000000001%

• quantity: any integer or a range (eg 1-5)

• damage: add extra damage to tools or damage the player (eg. breaking glass)

• messages: add a custom message to your rare drops

• player drops: use PLAYER or PLAYER@<name> to add drops on player deaths

• permissions support: you can add OtherBlocks functionality to select groups or users

• events: blocks or mobs can explode, strike lightning or sprout into an instant tree (if over dirt) when broken/killed.

Parameters/conditions


For simple drops you can use just the "tool" and "drop" parameters as in the examples above.

For more advanced customisation many other optional parameters exist, here's a list at the time of writing this:

Conditions: tool, toolexcept, quantity, chance, worlds, weather, biomes, time, height, permissions, permissiongroups, exclusive, attackrange, regions.

Actions: drop, color, event, message, damagetool, damageattacker, delay, runcommands.

See the Wiki page for full details on these parameters.

/odr : reload config file
/od show <blockname> : show config for blockname (can also be CREATURE_... names)
/od profile <on/off/leafdecay/blockbreak/drop> : for debugging - used to measure how long functions take

otherdrops.admin.show - allow access to '/od show' command
otherdrops.admin.reloadconfig - allow access to '/odr' to reload the config files

otherdrops.custom.<permissions> - used for the 'permissions' condition in drops

Note: the current version of OtherBlocks (1.95) does not support Permissions 3.16 or the SuperPermsBridge. PermissionsEx with it's permissions (2/3) bridge works fine - the old Permissions 2.x work fine too (or you can disable "usepermissions" in the config).

OtherDrops 2.0 will support the new standard Bukkit permissions only.

To install, simply extract the zip file to your plugins directory. Then, take a look in OtherDrops/otherdrops-drops.yml and simply enable any of the default included files (just remove the comment "#" character) or add new custom drops to the end.

If you are getting errors with the word "snakeyaml" in it, your config file isn't properly formatted.
Test it on this website (or this one).

See the dev.bukkit page for full details on how to set up OtherDrops, a complete parameters list and further examples.

Todo List

• See full issues list here.

Changelog

Newest changelog details here.

Version 2.2.1 (2012/01/30)

* Quickfix for messages in some configs showing 0 for %q

Version 2.2 (2012/01/30)

* DEFAULT now works correctly with fishing actions
* new aliases (SPAWN_EGG for MONSTER_EGG, GLISTERING_MELON for SPECKLED_MELON)
* od-fix_undroppables now has endermen dropping their contents on death

Version 2.2-beta1 (2012/01/29)

* added FISH_CAUGHT & FISH_FAILED actions
* mooshroom now works instead of being seen as a cow
* fix bug where PROJECTILE_ARROW didn't send messages
* attempt fix NPE in SimpleData.get()
* new flexible way of checking creature names
* added HELM as alias for HELMET (eg. IRON_HELM)

Fishing example:

Code:

    PLAYER:
        - dropgroup: fishcaught
          action: FISH_CAUGHT
          drops:
            - drop: IRON_HELM@50
              message: "Bonus!You found an iron helmet - a little rusty but still ok."
              chance: 5%
              exclusive: 1
            - drop: {DIAMOND, GOLD_ORE, OBSIDIAN}
              chance: 3%
              exclusive: 1
              message: "Woo, you hooked a precious stone!"
 
        - action: FISH_FAILED
          drop: LEATHER_BOOTS
          chance: 2%

Currently this will always drop the default fish as well, that will be fixed in the next release (then you will have to add drop: DEFAULT if you want the fish as well).

Caveats: currently we cannot add items to your inventory and there's no way to determine the location of the fishing "bobble" so it just drops items at your feet.

Bonus: you can use all the usual conditions (biome, weather, world, etc) to customise fishing.

Version 2.1.2 (2012/01/25)
* add dropgroup conditions back in
* fix "drop:" default value (if not specified) - was DEFAULT, now NOTHING (more intuitive)
* stop "drop: NOTHING" replacing blocks on actions other than blockbreak

Version 2.1.1 (2012/01/25)
* fix for "drop: default" not working
* fix for "ALL:" & "ANY_CREATURE"
* fix chance condition for dropgroups

Version 2.1 (2012/01/24)
* enchantment support! eg. "drop: DIAMOND_SWORD@!DAMAGE_ALL#3, FIRE_ASPECT#2" - see here for more details
* fix for bug where if an embedded chance fails the block doesn't break

Version 2.0.1 (2012/01/23)
* remove hawkeye logging (it worked, but made plugin dependant on hawkeye - use "2.0" only if you have HawkEye)

Version 2.0-beta12 (2012/01/22)
Beta12:
* fix "delay bug" choosing same location
* dropgroups now have separate messages (handy for delays - show immediate message then delayed messages with event)
* fix IN_MOB_ARENA flag
* fix UNIQUE flag
* update hawkeye logging (hopefully rollback works? not tested)
* remove ProjectileAgent debug msg
* fix for negative regions (region: [-here])
* fix for ANY_BLOCK (using replacement block or DENY changed any block to the first block you broke)

Version 2.0-beta11
* remove spawn_egg alias to allow compability with Minecraft 1.0.1 Bukkit
* clear up a couple of debug messages
* fix NPE in weather check
* add datavalues for magma_cube

Version 2.0-beta10
* basic support for enchantments
* fix no death animation & entities removing block within
* update to 1.0 & 1.1 (mobs/items)
* ignore players in creative mode (onblockbreak)


Version 2.0-beta6 (2011/09/22)
* support STEP@BRICK & STEP@SMOOTH_BRICK
* fix issues with "worlds" in "defaults" section - made more robust
* made "flags" more robust (flags: UNIQUE works now)
* fix NPE (due to randomised loc not being initialised)

Version 2.0-beta5 (2011/09/21)
* add XP@<amount> drop
* fix for iConomy6
* fix tnt overriding worldguard setting
* finetune error/startup messages
* material aliases in tools (eg. hands=air)
* fix defaults blocks in example configs
* updated creature groups with 1.8 mobs
* added CREATURE_BUG group
* more work on making the config more robust (eg. cope with RED ROSE for RED_ROSE, cope with alternate parameter names - world/worlds, tool/tools, etc)
* fix for NPE when boats burn
* fix for vehicles with drops not being removed

Version 2.0-beta4 (2011/09/20)
* fixed the entity drops issue (including money)
* fix permissions
* add ob-stop_mob_farms.yml (not yet working)
* update help docs
* remove the "location" debug message
* add new aliases:

# format: ALIAS(OFFICIAL_BUKKIT_NAME)

GLASS_PANE(THIN_GLASS),
WOODEN_SPADE(WOOD_SPADE), WOODEN_AXE(WOOD_AXE), WOODEN_HOE(WOOD_HOE), WOODEN_PICKAXE(WOOD_PICKAXE), WOODEN_SWORD(WOOD_SWORD),
WOODEN_PLATE(WOOD_PLATE), PLANK(WOOD), WOODEN_PLANK(WOOD), WOOD_DOOR(WOODEN_DOOR),
STONE_PRESSUREPLATE(STONE_PLATE), WOOD_PRESSUREPLATE(WOOD_PLATE), WOODEN_PRESSUREPLATE(WOOD_PLATE),
HANDS(AIR),
TALL_GRASS(LONG_GRASS),
DANDELION(YELLOW_FLOWER), ROSE(RED_ROSE), RED_FLOWER(RED_ROSE),
MOSS_STONE(MOSSY_COBBLESTONE), MOSSY_COBBLE(MOSSY_COBBLESTONE),
GUNPOWDER(SULPHUR), SULFUR(SULPHUR),
TRAPDOOR(TRAP_DOOR),
SLAB(STEP), DOUBLE_SLAB(DOUBLE_STEP),
CRAFTING_TABLE(WORKBENCH),
FARMLAND(SOIL),
VINES(VINE),
STONE_BRICK(SMOOTH_BRICK),

* extra comments in fix_undroppables

Version 2.0-beta3 (2011/09/18)
* improve fix_undroppables (1.8 support)
* add loc-offset (eg. loc-offset: x/y/z) - adds location offset for drops/events/effects
* renamed randomiseloc to loc-randomise
* add NORMAL/MOSSY/CRACKED for SMOOTH_BRICK
* fix for synonym drops (eg. ANY_AXE)
* fix NPE for DAMAGE_FALL

Version 2.0-beta2 (2011/09/16)
* fix worldguard bug (not respecting build rights)
* fix player drops
* od-dyewool module (by Celtic Minstrel)
* other minor bugfixes

Version 2.0-beta1 (2011/09/01)
* "RANGE-" is optional in drops (eg. can now use drop: WOOL@1-6 for random wool drops with data between 1 & 6)
* fix for soundeffects/smoke
* add randomiseloc (eg. randomiseloc: x/y/z - gives a random offset value for events and effects)
* fix for entity deaths removing ladders
* fix for dropgroups
* added MONEY-DROP to allow dropping "real coins" with the MoneyDrop plugin
* fix for NPE when using messages with no "drop" value

Version 1.96 (2011/09/05)
* fix for onBlockBreak event not checking if event was cancelled

Version 1.95 (2011/08/29)
* fix mobarena support (it worked but also disabled wolf drops outside the arena)
* removed debug message

Version 1.94 (2011/08/28)
* support for mobarena
* Register update (iConomy 4/5/6, BOSEconomy 6/7, Essentials & MultiCurrency supporT)
* Added usepermissions option back in (for those having issues with SuperPermsBridge or Permissions 3.16)

Version 1.93 (2011/08/17)
* fix for pig drops not working
* fix for blockbreak removing 1 item

Version 1.92 (2011/08/16)
* fixed bug with clickright defaulting to "damagetool: 1"
* fixed player drops (NullPointerException)
* fixed rare ConcurrentModificationException

Version 1.91 (2011/08/11)
* replacementblock now honors physics by default
* new event: NOPHYSICS

Version 1.9 (2011/08/10)
* left/rightclick blocks
* rightclick entities
* shear/unshear/sheartoggle events
* runcommands - allows you to specify commands to run if the conditions are met. Start command with "*" to run as first OP in ops.txt, start with "!*" to suppress OP messages being sent to player (send to console instead), "%p" will be substituted with players name
* /ob profile - for debugging/speed testing (example usage: /ob profile on, break some blocks, /ob profile blockbreak, /ob profile drops, /ob profile off)
* FORCETREE - will create a tree on almost anything (excludes things with contents - chest, furnaces and dispensers)
* damagetool removes items (eg. rightclick with bonemeal, remove 1 or 2 or x bonemeal)
* fixed ore_extraction - now enforces correct pickaxes
* shortcut for "drop: droptype/chance%/quantity"
* replacementblock now supports data values
* fixed DENY drop
* fixed dropdata when dropping creatures (eg. can drop SHEEP@RED now)

Version 1.82
added lightlevel, fix for drops appearing too high, added tool/toolexcept to dropgroups, dropspread is now default (use dropspread:false for one itemstack)

Version 1.81
* add slime size as datavalue (TINY, SMALL, BIG, HUGE) - or use an integer at your own risk (anything bigger than 32 probably can't move)
* added dropspread option (TRUE or a percentage) - drops individual blocks rather than a single itemstack
* added ore_extraction sample
* improved permissions system (permissions enabled by default, now honours build rights correctly - otherblocks.active not needed)

Version 1.8
* fixed major bug in worlds/height/etc
* added better WorldGuard support (honors regions you can't build in)
* fixed regions
* added replacement block (be careful with this - examples to come)

Version 1.71
* Fix damageattacker not stopping with exclusive flag

Version 1.7
* added "delay" parameter (time specified in ticks)
* added BigBrother API support
* added WorldGuard "regions" condition to DropGroups
* added messages to DropGroups
* added events: LIGHTNING@PLAYER (strikes where the player currently is), LIGHTNING@PLAYERLOCATION (strikes where the player was at time block was broken, useful in combination with delay) and harmless variants.

Version 1.5
* added regions condition (based on WorldGuard regions - you can now specify drops to occur only within a specific region or list of regions)
* added admin command "/ob show <block>" so you can check your drops loaded properly.

Version 1.11
* tool defaults to ALL, drop defaults to DEFAULT, fix for player drops not working

Version 1.1
* fixed the ANY_REDSTONE_ORE block
* added tool data - tools can now be "WOOL@RED" or "WOOL@14" and added BLOCK_DISPENSER kills, allowed DAMAGE_ENTITY_ATTACK to count for all entity attacks (other than players)
* attackrange: mainly for bow & arrow - specify how far away you need to be (good for rewarding long distance archers)

Code:

    CREATURE_COW:
      - tool: DAMAGE_ENTITY_ATTACK@BLOCK_DISPENSER  # only drop if attacked by something from a dispenser
        drop: GOLD_ORE
      - tool: DAMAGE_ENTITY_ATTACK@CREATURE_SKELETON # only drop if attacked by a skeleton
        drop: DIAMOND
      - tool: DAMAGE_ENTITY_ATTACK # drop for any entity attack (including the two above)
        drop: APPLE
      - tool: BOW # drop from a player hitting with a bow or firing an arrow (cannot currently distinguish)
        attackrange: ">10" # but we can now say the attack has to be from so far away :)
        drop: DIAMOND
      - tool: WOOL@RED
        drop: WOOL@BLUE

Version 1.03
* added dropgroups (eg. allow small chance of sand to drop map/compass together)
* re-structured code so it should be more lightweight
* cleaned up debug messages/added more messages at higher verbosity levels

Version 1.02
* small fix for tabs in configs, clean up configs & debug messages (2011/07/18)

Version 1.01 (2011/07/16)
* 1.01 fix for boats, support for "&3" colors in messages, small bug fixes

Version 1.0 final (2011/07/16)
* fixed a few bugs, cleaned up debug messages

Version 1.0beta2
* major internal code restructure in prep for drop groups - this shouldn't change the config files at all, let me know if there are any issues there
* more lightweight - the plugin now only checks through drops applicable to the block being broken, entity killed, etc (previously it quickly scanned through every drop in the config file for matches, now it uses a hashtable to directly get only the right drops).
* some small bug-fixes/consistency, drop: DENY stops leaf decay (but doesn't work with other drops because leafs can keep decaying), exclusive: option should work for entities but I haven't tested this.
* permissions/permissionsexcept option - this is more powerful than the current permissiongroups option. See the example below:

Code:

###########
# Permissions:
# In the example below you need to give the player or group the
# 'otherblocks.custom.glass' permission to drop the glass block.
# Giving them 'otherblocks.custom.glass.pain' as well will add the pain
# and giving 'otherblocks.custom.glass.*' will give both.
#########
#    GLASS:
#        - tool: ANY
#          drop: GLASS
#          quantity: 1
#          permissions: "glass"
#        - tool: AIR
#          drop: NOTHING
#          damageattacker: 2
#          permissions: "glass.pain"
#          message: "Ouch! That hurt."
#          chance: 25

Version 1.0 (beta1) (2011/07/12)
* include-files option to include separate config files
* extra config examples included as "include-files"
* "defaults" parameter for separate config files (eg. you can specify a default world and it will apply to every drop in that file - can save a lot of typing )
* bugfix: /obr bug (didn't work without permissions turned on, now will use ops if no permissions)
* bugfix: sheep dropdata fixed - you can now drop coloured sheep, if you so desire
* bugfix: PLAYER drops now default to dropping inventory - use drop: NODROP to disable player inventory drops

Version 0.9.9-2
* fix for issue where drops missing the color parameter no longer work

Version 0.9.9-1
* fix for color parameter bug

Version 0.9.9 (2011/07/11)

• basic "exclusive" parameter (blocks only - entities and leafdecay later)
• "damageattacker" parameter
• drop: DENY (to deny block breakage)
• PLAYER (any) drops
• integer values for block and drop

Version 0.9.8 (2011/07/07)

• previous beta stable
• added dropitem@dropdata support (inc. range for random)
• fix treespawn for blockbreak

Version 0.9.8beta (2011/07/04)

• fixed leaf decay
• added permissiongroupexcept
• attempted integer data values - not working yet
• attempted exclusive option - not working yet
• added more help files and reincluded the sample file that got lost in the last few versions

Version 0.9.7 (2011/07/01)

Code:

        SAND:
            - tool: ALL
              drop: DIAMOND
              height: "<64"
            - tool: ALL
              drop: EGG
              height: ">63"
            - tool: ALL
              toolexcept: [IRON_PICKAXE, SAPLING]
              drop: CREATURE_SPIDER
              biome: DESERT
 
        PLAYER@Xarqn:
            - tool: ALL
              drop: COAL
              quantity: 2
            - tool: SAPLING
              drop: DIAMOND
              quantity: 2
 
        PLAYERGROUP@CITIZEN:
            - tool: ALL
              drop: LOG
              quantity: 2
 

Yay for weird examples! The first bit basically says if you break sand below height 64 with anything you get a diamond, if above 63 you get an egg. You also get a bonus spider if you break the sand in a desert biome with anything _except_ an ironpickaxe or sapling.

Then if a player called Zarius dies by any means he'll drop two coal but if you manage to kill him with a sapling he'll drop two diamonds.

Any player within the group "Citizen" (not case sensitive) will drop two logs (in addition to specific player drops).

• toolexcept: [IRON_PICKAXE,SAPLING] (excludes tools from the drop condition)
• permissiongroup takes a string list
• player & playergroup drops (PLAYER@name and PLAYERGROUP@group)
• reload permission for /obr "otherblocks.admin.reloadconfig" (or just use "otherblocks.admin.*")
• height condition (height: "<64" or height: ">100") - must have quotation marks and one of the "<>=" signs.
• biome condition (can also be a list) eg. biome: [DESERT, FOREST]

Version 0.9.6 (2011/06/30)

• fix for quantity error (1-2 now correctly gives 1 or 2 at random)
• new "permissiongroup" option for drops

Version 0.9.4 (2011/06/29)

• fix for clash with MobRider & other plugins using the Common library

Version 0.9.3 (2011/06/28)

• small fix for debug message I left in the startup messages
• slimmed down startup messages from around 5 to 3.

Version 0.9.2 (2011/06/27)

• allow sapling drops to specify type by name (GENERIC, BIRCH, REDWOOD)

Version 0.9.1 (2011/06/27)

• messages now allow for %q as a placeholder for the quantity (eg. "You've found %q dollars.")
• MONEY drops can now be decimal to two places (eg. 0.96-5.52)
• MONEY drops can be negative (use ~ for a range - eg. -5~-2)
• fix for dropItemNaturally with quantity zero spawning semi-infinite blocks
• can now specify tool for paintings (for other damage only DAMAGE_WORLD works)
• permissions now works for paintings and entities
• messages now work for paintings and entities
• permissions check defaults to disabled (enable at the top of the config file)

Version 0.9.0z (2011/06/24)

• weather condition (RAIN, THUNDER, CLEAR or a list)
• economy support (via Register, supports iConomy and Boseconomy)
• event system (accompany the drop with lightning, treespawn or explosions)
• see examples file for details on usage

Version 0.8.1z (2011/06/23)

• fixed bug on 0.8.0 where time was not optional (oops)

Version 0.8.0z (2011/06/23)

• allow separate drops for CREATURE_PIG@SADDLED, CREATURE_PIG@UNSADDLED; CREATURE_WOLF@NEUTRAL, CREATURE_WOLF@TAMED, CREATURE_WOLF@ANGRY; CREATURE_CREEPER@UNPOWERED, CREATURE_CREEPER@POWERED.
• added "time" condition to limit a particular drop to only day or night

Version 0.7.8z (2011/06/22)

• Merged in Celtic Minstrels changes - configurable vehicle drops, paintings and water damage (water damage doesn't work yet)

Version 0.7.7z

• fixed drops from LEAVES
• added "message:" option - currently works with block breaks only, can take a list and will select a message at random

Version 0.7.6z

• added /otherblocksreload (or /obr) command to reload config file

Version 0.7.5z

• added support for Permissions (primarily to prevent groups without build rights destroying otherblocks blocks)
• added support to LogBlock (previously could not log blocks that had an otherblocks drop

See original threadfor previous changes.

Inspired by decino's goldenNether plugin.

Original author: @cyklo
Main author: @Zarius
Contributors: @Celtic Minstrel, raws