UltraItems
<font color="red" size="5">UltraItems is going to be merged with SpoutBlocks into SpoutMaterials.</font>
UltraItems creates custom items (with custom title and texture). You can also set crafting recipe and left / right mouse button click action. Action is something to post in chat (eg. command or some message), so you need another plugin to handle this. It is recommended to have commandhelper installed to do advanced commands (command chaining). This plugin requires Spout to be installed, otherwise items will have default texture. You can get item via command /ultraitems (alias /ui).
What you can do with this: wands, food, <s>tools</s>, <s>change stackability</s>
What you can't do (for now): armor, blocks, entities, change durability
<font color="red" size="5">Warning: This plugin requires development version of spoutcraft (check 'use latest dev build' in spoutcraft options) because of bug where items.png is in inventory instead of texture.</font>
Frequently Asked Questions
- Why ain't my permissionbypass working?
- You have to use some permission manger using SuperPerms (like PermissionsBukkit or PemissionsEx or bPermissions)
- How can i set healing staff?
- You can set negative damage.entity option to achieve that
- Will you add maxstacksize soon?
- I have asked Olloth (he's working on custom item api in spout) and he said that method for changing stackability isn't something that can be done easily.
- Will you add crafting with different data values soon?
- See IRC log
- What about furnace crafting from custom items?
- See Spout issue #800
- Will you add custom blocks soon? What will be possible to set?
- Yep. Luminescence, opacity, drop, friction, hardness, whether is powered, explosion resistance. I also like the idea it would act like tree block. And some events like place.
- Why i can't change id of base item?
- Not a preferred way of creating item with spout api anymore.
- How can i set mob drops?
- Use one of following plugins: CookieMonster, EcoCreature or MoneyDrop
- How do i convert old items (pre 0.8) to new spout compatible items?
- Follow this info.
- How can i find out id and data value of item?
- It is shown in console on start-up or after performing /ui reload.
- What does 'Config is unproperly formated?' mean?
- You either don't have UltraItems as root node or you have BOM signature in your config.
Example configuration
Following example should be working with dev version. If you can't use something, download dev version first.
UltraItems: # main container
flashwand: # item name (used when obtaining item via command)
title: Lightning wand # title shown when cursor moved on item in inventory
url: http://ogion.cz/files/items/flash.png # url of image to set to inventory item (it is currently only in inventory and in-hand)
lclick: # left click section
action: |
/zap # command sent when left clicking with item in-hand
let them burn! #you can specify more action as same as multiple permissions to bypass just add multi-line notation (pipe, vertical bar or whatever you call |)
#also you can use variables $player, $coords, $world
permissionbypass: flashplugin.zap # temporarily adds specified permission (removed after performing of action), not recommended to use (if you leave item in chest everybody can use it).
rclick: # right click section
action: /zap multi# command sent when right clicking with item in-hand
cracker:
title: Notch crackers
url: http://ogion.cz/files/items/notch.png
rclick:
health: 20 # 2 = 1 hearth, you can use negative values too
hunger: 20 # 2 = 1 hunger unit (chicken leg), you can use negative values too
consume: true # whether or not is item consumed after clicking
sound: http://ogion.cz/files/items/crunch.ogg
<s>maxstacksize: 6 # maximal size of stack</s>
recipes:
- type: shaped
amount: 2 # amount of items gained by crafting
ingredients: |
0 266
266 357 266
0 266
osword:
title: Obsidian sword
url: http://dl.dropbox.com/u/1189439/osword.png
instantbreak: true # instantly breaks the block being destroyed
damage:
entity: 80 # damage caused to entity (2 = 1 hearth)
recipes:
- type: furnace # you can use furnace, shaped or shapeless
ingredients: "49" # ingredient id:data
- type: shaped
ingredients: |
0 49
0 49
0 cracker
# note you can use item names in recipes (item has to be specified before used in recipe)
Permissions
- ultraitems.* - All UltraItems' commands
- ultraitems.reload - Reload config (default: op)
- ultraitems.list - Show list of items (default: true)
- ultraitems.give - Give item (default: true)
- ultraitems.give.* - Give all items (default: true)
- ultraitems.craft.* - Craft all items (default: true)
Commands
- /ultraitems <itemname> [amount] - gives player item itemname
- /ultraitems list - shows list of items
- /ultraitems reload - reloads configuration file (this works quite weird if you updated recipes so rather use /reload)
- /ultraitems replace - replaces items before new spout item api with new ones
Future releases
- Support for mana plugins
- Complex scripting language for more customisable items
- Block enemy attack (like right click with weapon in mc)
- Integration into give command (General plugin)
- More food properties (poison) and animation
- More events (blockplace, drop, pick, destroyed, walkedon, walkedoff)
- Explosions
- Custom blocks
- Config generator
- Delay option
- Advanced consumption (another items, replacing item)
- Entity shooting (arrows, fireballs)
Changelog
0.9
- Added crafting permissions
- Added amount for give command
- Some crafting fixes (you can use custom item names in recipes)
- Added basic api
- Added instantbreak option
0.8.1
- New bukkit config api
- /ui replace command for replacing old items with new ones
- Info about added items
0.8
- Compatible with new spout api
- Entity damage multiplier changed to absolute number
- Removed multiple spaces bug, data values can be now separated with :,;-
0.7.1
- Fixed data values in recipes
0.7
- Disabled consume for left click action
- Added crafting recipes
- Added health and hunger options
- Colored messages
- Prevented stacking of items with different data values
- Added maxstacksize option
- Added permissionbypass option
0.6
- Added entity damage multiplier
- Enabled data value 0 for click action
0.5
- Better error handling
- Enabled data value 0
- Blocking all right click actions
0.4
- Moved action, consume into l/rclick section
- Action not required for other settings
- Sound setting supported
0.3
- Added consume option
- Enhanced exception handling (incorrect spout)
- Fixed onPlayerInteract without item causing NPE
0.2
- Working reload command
- No errors in console mode
- Restructured returns
- Removed dev messages
0.1
- Initial release
- SuperPerms support
Known bugs
New features are tested before being released but it can miss some bug. If you find any, please report it to the comments or issues section.
- Sound sometimes isn't played (Spout's bug?)
- Reloading config doesn't reset item titles and textures if removed from config (you can use /reload command from bukkit)
- Consume on left click not working correctly (had to disable it because it caused internal server error - bukkit's issue?)
- Maxstacksize isn't working correctly
Download
You can find it in files section. Source is in repository
You can get latest dev version on DropBox.
-
View User Profile
-
Send Message
Posted Oct 15, 2011@Lisured
Nice , That could help a lot for people who do not know the long word of english like me :S
-
View User Profile
-
Send Message
Posted Oct 15, 2011@Codex_Arcanum
New spout item api uses flint as base. If you have old items you can use /ui replace to replace all old items in inventory.
@maxi1134
It could be possible.
@BioRage
There should be ogg, wav and midi supported.
@Hoot215
API has higher priority because it is useful for clean the code. I have some parts of same code on multiple places what isn't ideal because if i edit it one place i have to edit it everywhere.
Actualy i was working on block damage when i decided to create api because of duplicity of code. But only thing i can do is instant break.
-
View User Profile
-
Send Message
Posted Oct 15, 2011@BioRage
Well, if Spoutcraft supports .wav files then I'm sure it will work. Just FYI though, .ogg files are also very high quality.
-
View User Profile
-
Send Message
Posted Oct 15, 2011@Hoot215
BCMUSIC supported .wav files, since it was better quality for in-game music, however each file was bloody 20-50MB in sound files.
-
View User Profile
-
Send Message
Posted Oct 15, 2011@BioRage
Correct me if I'm wrong, but I think that Minecraft/Spoutcraft only supports .ogg and .mod files.
EDIT: It's actually .ogg .wav and .mus files.
-
View User Profile
-
Send Message
Posted Oct 15, 2011@Lisured
Sorry for the late reply, but usually when you have food in your hand and right-click a door, it will open the door instead of eating the food.
Also, why does the API have a higher priority than custom blocks and damage values in crafting? I personally think that those two are more important than the API.
EDIT: One last question, are there more types of damage than just entity? I'd like to see something like block damage (To make custom picks and shovels, etc.), if it isn't already there.
Thanks again for making an incredible plugin!
-
View User Profile
-
Send Message
Posted Oct 15, 2011@Lisured
Thanks boss! :)
Also, does it support .wav/.mp3? or only .ogg'[s?
-
View User Profile
-
Send Message
Posted Oct 15, 2011Lisured can u make when we start the plugins first time he make a default config ?
-
View User Profile
-
Send Message
Posted Oct 15, 2011-
View User Profile
-
Send Message
Posted Oct 15, 2011@BioRage
sound option isn't limited for food
you can get itemid in console on startup i can add command info if you want bat easier is use /ui reload and it will be in console.
-
View User Profile
-
Send Message
Posted Oct 15, 2011@Lisured
Thanks Lisured, I'm very aware of those, should of been more spefic,
I meant in terms of custom items, is it still possible to drop;
Example: 280 ITEM is now a custom item. Will it be possible for a custom item to drop, rather than the stick?
ALSO:
Is it possible to add custom sounds for weapons, and such? (other than food)
-
View User Profile
-
Send Message
Posted Oct 15, 2011@BioRage
Huh page 15, but found it: http://dev.bukkit.org/server-mods/ultraitems/?comment=192
Mob drops aren't thing this plugin should handle. Use one of the plugins mentioned in post linked above.
-
View User Profile
-
Send Message
Posted Oct 15, 2011@Lisured
My good developer Lisured.
Is it possible for custom items created to be dropped from monsters?
-
View User Profile
-
Send Message
Posted Oct 15, 2011@Hoot215
How would you like to see it work?
Data values in crafting are priority #3 (after api and custom blocks).
-
View User Profile
-
Send Message
Posted Oct 15, 2011@Lisured
The bug where you're holding a custom piece of healing item, and you right click a door, it will open and close the door, and consume the item.
Also, thanks. Will there be any chance of adding support for damage values in crafting recipes?
-
View User Profile
-
Send Message
Posted Oct 15, 2011@Hoot215 What door bug?
I believe shapeless recipe format is same as shaped. I wasn't thinking about shapeless recipes (i don't even have use for them, are there any in mc?) so maybe it doesn't make sense. Ad data values in recipes: nope not supported atm.
-
View User Profile
-
Send Message
Posted Oct 15, 2011@Lisured
Oh that's great! That should fix some of the bugs, like the food-in-hand-right-click-door bug. But what format do you use for shapeless recipes?
EDIT: And can you use damage values with the shapeless recipes or the shaped recipes?
-
View User Profile
-
Send Message
Posted Oct 15, 2011@Hoot215
For now only visible change is that healing is calling event (for other plugins to handle it) and you can't heal yourself more than full health bar (same things for hunger option).
I am not working on it until tomorrow so it should be stable for now.
I believe shapeless recipe format is same as shaped. I wasn't thinking about shapeless recipes (i don't even have use for them, are there any in mc?) so maybe it doesn't make sense. Ad data values in recipes: nope not supported atm.
Priorities are new options for tools and api for other plugins to use now and also for me (i have a lot of dupe code so i need to wrap it in some manager). And then blocks.
-
View User Profile
-
Send Message
Posted Oct 15, 2011Also, I assume that v1.8.2 is on the DropBox link? What changes are there? If it's stable, do you think that you could post it on this page? And one last thing: What is the format for shapeless recipes, and can you use damage values in the recipe?
-
View User Profile
-
Send Message
Posted Oct 15, 2011@Lisured
Dude im french and u use too much word for me XD