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)
Looks like 1.3 is out. Yay! Now we get to wait for bukkit and all our beloved plugins to update. Except for the config file, WhatIsIt shouldn't need too much of anything. I'll try to get an update out today, but in the mean time, if bukkit gets 1.3 working and you guys need WhatIsIt updated, just add this to your names.yml:
Make sure after copy/pasting this that your spacing is the same as the rest of the files and that you don't have any tabs. Otherwise, you should be good.
@incredinex
Okay, monster spawner blocks taken care of....for now, we'll see what 1.3 throws at us.
There we have it..."Monster Spawners now support extra information for the mobs it spawns. This allows unmodified games to have spawners for special variants of mobs. The player still requires external or modified means to set these parameters, though. Some examples of what Monster Spawners can spawn are Charged Creepers, Endermen holding specific blocks, Green Robe Villagers, and Villagers with custom trade offers." And I was beginning to like @Dinnerbone. I have no idea how this is going to affect WhatIsIt. It's possible that it doesn't...
I probably should look into seeing if I can identify the type of spawner better from the names.yml. Right now it's just:
I'll see what I can do.
I'm taking a huge guess here for the new wooden stairs flavors in 12w25a. I could probably figure it out pretty easy if I actually downloaded the snapshot. Ah well, I'll check the wiki later to see if I guessed right.
Very cool! I love it +Download
http://www.mojang.com/2012/06/minecraft-snapshot-week-24/ Snapshot is out, no sign of new items needing names.
The week 23 snapshot is out with no new items. I have mixed feelings about this.
Okay, so I've been made aware that Vault has added item name functionality. The comprehensive nature of combining some of the functionality of this plugin with some of the functionality of the one that does the reverse (i.e. human friendly output of item names vs. easy reference to items) is a great idea. The hard-coded nature (as it appears from github), however does not make it effective for one of my points, and a feature of the doppelganger, interlingual support.
It might be nice to combine all 3 components...along with Vault (or even by themselves). I'll look into the concept.
I'm not updating the names.yml until the next Minecraft official is actually released because frankly, it's irrelevant until then and they might add more stuff. No reason to make unnecessary version number increases. But, here are the new values anyways, if you want to update your names.yml files manually.
I'm thinking about making an announce item description command...having trouble coming up with a short command name for it. People have been using my auction software to brag about their enchantments. Perhaps /describe?
Concept: /describe [target] {player}
[target] value: this or that, this being the held item, that being the item in crosshairs
{player} optional, without it, broadcasts to the server
Yeah, I see the new items in 12w22a. I don't have the ids yet, but here's a stub for when I get them:
Looks like the 1.3 update to Minecraft is going to have a few new items. I'm not entirely sure about the Super Golden Apple's id, so I took an educated guess. I haven't added these to WhatIsIt yet, but this should be able to be inserted as-is into the names.yml:
I'm guessing they still have a bit left to do on it considering the magnitude of the update, so there may be more new items. Since @Dinnerbone's group joined the team, it seems new items are just pouring out of them. This kinda illuminates the necessity of this kind of plugin even more. :)
No new items were added in 1.2.5 according to my reading (twice) and WhatIsIt was using no depreciated functions in 1.2.4. Therefore, it should work perfectly in 1.2.5. When bukkit updates, I will test and post back a confirmation. I think version 1.0.0 of WhatIsIt should work from everything between 1.1.0 and 1.2.5 of MC. Anyone have different results with this, or errors, please let me know here or create a ticket, remembering to include the craftbukkit build.
I've noticed that since I uploaded the "release" version 1.0.0, that people have still been downloading the pre-release versions. If this is because you're not using 1.2.4 yet, please note that this is fully backwards compatible to 1.2.3 and should be well compatible beyond that. Any names in the database for items that don't exist are simply ignored.
Also, I haven't used any depreciated methods or accessed any low level components, so even if I don't update this, it should be compatible well into the future (though, of course, I am planning on updating it whenever needed).
Hahaha, I spend an hour trying to find the item id for this new "Pick Block" key to add it to names.yml...turns out it's not an item, it's not even a key, it's a mouse button.
@smbarbour
Already was added, see:
I agree about the usefulness...frankly, I'm flabbergasted that this didn't previously exist, or more that it wasn't built-in in the first place.
Hhmm, I might set the default whatisit.admin to op instead of false in the next version.
"itis" in those commands, by the way is shortened "it is" if that wasn't obvious to anyone.
This would be tremendously useful for those of us who run mods on Bukkit. May I suggest adding commands to use in-game to modify the list of friendly names?
I'm thinking this is about ready to be out of alpha. Instead of 1.a.2, I'm planning on going to 1.b.0.
If anyone builds a plugin using this one as a library and wants to be listed on a "what plugins use this plugin" page (I might rename that), PM me and I'll start compiling a list.