WhatIsIt
WhatIsIt - Item and entity names library and plugin
Help support development of WhatIsIt: Donate (Total donated to date: 6 USD)
This plugin aims to fill the hole of friendly item names in Minecraft server. This plugin is a must include for any other plugin requiring friendly item names, such as auction and trading plugins, and is a memorable toy for any server which has items, blocks or entities.
This plugin has been developed primarily for:
Drop by and pay us a visit!
Features
This plugin is primarily a library to get friendly names from a yml file for entities, blocks, items and enchantments. Easy access to public static commands makes integration into any plugin fast and easy.
All names are stored in names.yml. Storing the names in a customizable .yml file allows for easy language conversion and support for custom items with new item id's which would not normally be recognized by plugins which are not Spout compatible.
- Added monster type support to monster spawner blocks. (v1.0.2)
- If any spawner drop plugins assign the typeid to the data or damage, it should also display properly. (v1.0.2)
Videos
Plans
- Add authors for books.
Commands
Requires permission "whatisit.use":
- /wis - What is this? Shows friendly item info for the held item.
- /wit - What is that? Shows friendly entity or block info for what you're targeting.
Requires permission "whatisit.admin":
- /wis itis {String name} - Set name for item and save names.yml.
- /wit itis {String name} - Set name for item and save names.yml.
- /wis reload - Reload names.yml before showing item name.
- /wit reload - Reload names.yml before showing item name.
Permissions
- whatisit.use - Allows you to use the /wis and /wit commands. (default: op)
- whatisit.admin - Allows administrative functions. (default: op)
Permission Notes
- These permissions do not affect other plugins calling shared functionality.
- Vault is required in 1.b.1, but a fallback to superPerms has been added in 1.0.0.
Setup
This plugin is installed much like every other plugin. Put the WhatIsIt.jar file in your /plugins/ folder and restart the server. The config files automagically appear in the /plugins/WhatIsIt/ folder. Set up your permissions per the permissions plugin directions of your choice (this supports Vault, so any perms works, without Vault, uses bukkit's built-in system).
- In v1.b.0, the names.yml file is being generated with the config.yml content. Please use the uploaded names.yml file available on the file list on the right.
Configuration
In the config.yml file's config section, there is only one option, display-data-values. Set to true or false, the default is true. This will display the data values when using the /wis and /wit commands. This does not affect other plugins display of data values, they will not be sent data values from this plugin.
Everything else in config.yml is editable messages. Except the parenthesis around the data values and names, all output from WhatIsIt is specified in the messages section of config.yml. Edit here if you want to change these. These messages affect only WhatItIs output and not any plugin that calls WhatItIs.
In the names.yml file, separated by type, are id/name pairs. These are the values used to generate the names. You can edit them in game with commands or in the file itself. It may be safer for those unfamiliar with YML format to use the in game commands. For the rest of you, a semi-colon is used to separate the item id and data/damage info. %d can be used to insert the data value into the item name (added in 1.2.0 to show the map #).
Linking from your Plugin
See this useful linking page: Linking WhatIsIt (javadoc)
@incredinex
Thank you :)
@Bobacadodl
You mean you want it to display the enchantments when you /wis or /wit I take it. Makes sense. Seems reasonable. I'll see what I can do.
@incredinex
Could you please add Enchantment support? (Enchantment -> String or vice versa)
@ShakyTom
Got the git source up.
@ShakyTom
Sorry about that. I was out of town and hadn't had a chance...then forgot to take a chance, and now Minecraft login server are down...so...I guess I'll go do it.
@Bobacadodl
Thanks dude. And I understand.
Just donated $1. not much but its meant to show my appreciation.
Why is the git not updated?
@rasnyderiii
Per your original comment, which was emailed to me including "http://pastebin.com/C2bx9Zub is my config." There was an issue I hadn't been aware of until working on 1.3 causing new installs of WhatIsIt to not have a the full config file generated when being installed. The 1.3.0 fixes this issue and adds "%r" and "%a" to the "UNKNOWN" part of the enchantment levels referring to roman (I, II, III, IV, V, etc.) and arabic (1, 2, 3, 4, 5, etc.) numbers, so "'1': I, etc." part of the config isn't even necessary anymore.
@incredinex
Thank you again for your help!
@rasnyderiii
They were generated in some way where they are not a CraftItemStack (I'm still kinda new at dealing with CraftItemStacks...I had to use them to get the head information). It wasn't something I forsaw, but I'll try to get some code in there that will take care of these items too. It might take me a bit because I'll have to actually rewrite that section because I don't have access to my normal computer and I didn't upload the source of 1.2.2 to github.
The format to use is just like the format for 1-5:
and the next would be (make sure to use correct spacing, these comments remove the spaces)
etc.
CB 2488 / WII 1.2.2
I do not understand the format for me to put in the custom level higher enchantments so they show in FloAuction? example: damage_all(6)
They display fine in inventory, just in in auction or wis and wit throws error
http://pastebin.com/vjAfg549
If you're looking for head names (items only, not blocks yet), try 1.2.2.
@2Andri
Stupid potions. I didn't realize that the potions coming out of creative have a different value than those made by hand. I'm making an update that will take into account already in-use names so I don't ever have to tell anyone to delete the names.yml or anything like that.
EDIT: Uploaded and (finally) approved.
@2Andri
Try removing the offending records from the names.yml file, or delete the whole file and it'll rebuild itself. Mojang actually changed existing potions to "add" the new ones.
Also, make sure you're using the full WhatIsIt 1.2 and not the names.yml file I uploaded before it. That was incomplete as I wasn't aware of the potions when I uploaded it.
@incredinex
Some potion names are incorrect.
Looks like it's getting about time for me to start looking into the configuration updates for 1.4. It looks like most of the new items are utilizing normal data (which is accessed in the names.yml file via a semicolon) so it's possible I won't need any actual programming updates.
@melrose123
You know, I was just thinking about things on this line of reasoning, custom items. I was considering it in the notion of spout...but I'll see what I can find out about tekkit as well.
EDIT: To directly answer your question, as far as I'm aware there isn't. I don't know of any reason WhatIsIt wouldn't work with custom items right now, but I've not yet looked into it.
Is their a tekkit item list?
Okay, guys. I've reworked the way potions work entirely (hence the minor version increase to 1.1). I've added the 1.3 items (which by themselves would only force a tertiary update, e.g. 1.0.3).
On the potions, now, you specify the prefixes/suffixed based on bits for anything above 63 (damage). Everything else, you specify in the normal "373;N" way in the config except water bottle which is in a special "absolute-zero" field.
Uploading the file now.
@snrclub
Well, like I have said before, it's mainly a library for other plugins to link into when they need to know the actual name of an item/etc. in a friendly way to present to the user in a multi-language supporting way. Some servers like to make it a donator perk, as the /wis and /wit commands are kinda fun. But yes, I suppose it is interesting. floAuction finds it quite useful :).
Hmm, looks like an interesting plugin, to say the least