Item Renamer
Tired of blocks called Sand? Want your enderpearls to say Grenade instead? Want to add extra lines of text below item names? Do all that and more with ItemRenamer. You can create your own custom item names for all items in your server, but still let users rename with an anvil. You can create your very own language pack!
Installation
- Download ProtocolLib and put it in your plugins folder
- Place ItemRenamer.jar in your plugins folder, on server start the configuration will be generated
- Test out the example config by setting your world to run the example pack, to see how it works
- Go crazy and make your own language pack
Developer Build
Development builds of this project can be acquired at the provided continuous integration server.
These builds have not been approved by the BukkitDev staff. Use them at your own risk.
Jenkins server
For developers
ItemRenamer 2.0.0 contains a fully-fledged API. Click here for more information.
Configuration
Default configuration can be found here.
| Config | Default | Ranges | Description |
|---|---|---|---|
| autoupdate | true | [true/false] | Will remind you when a new version is available |
| creativedisable | true | [true/false] | Will disable ItemRenamer while you're in creative mode |
| worlds.<worldname> | Pack name | Will set this world to run the pack you put here | |
| packs.<packname>.<itemid>.<data>.name | Any string | Will rename itemid:data to your string | |
| packs.<packname>.<itemid>.all.name | Any string | Will rename all itemid data values to your string | |
| packs.<packname>.<itemid>.other.name | Any string | Will rename all unset itemid data values to your string | |
| packs.<packname>.<itemid>.<data>.name | Any string | Will add your name to itemid:data | |
| packs.<packname>.<itemid>.<data>.lore | Any string | Will add your lore list to itemid:data | |
| packs.<packname>.<itemid>.<first>-<last>.name | Any string | Will add your name to every itemid with a data value of the give range. | |
| packs.<packname>.<itemid>.<first>-<last>.lore | Any string | Will add your lore list to every itemid with a data value of the give range. | |
| packs.<packname>.<itemid>.all.lore | Any string | Will add your lore list to all itemid data values | |
| packs.<packname>.<itemid>.other.lore | Any string | Will add your lore list to all unset itemid data values |
- Note: place lore in [square brackets] OR on seperate lines starting with a dash -
Player-specific packs
If you want to customize the renamer pack for a specific group of players, regardless of world, you may use the player info itempack along with the desired renamer pack. This feature requires Vault and a permission/chat plugins that supports player info.
This can be done as follows with PermissionEx:
users: Player: group: - Members options: itempack: none
Usage
It's possible to configure ItemRenamer without ever having to touch the configuration file or deal with the more complicated (but powerful) commands. Simply select an item you want to rename, and type the following:
/renamer select hand
That will select your current item's ID and durability (except for armor and tools), along with any enchantments, potion/fireworks effect, etc. Then use set name and add lore to rename the item and every other like it on the server:
/renamer set name Nameless Tool /renamer add lore Unknown Artifact
This will automatically be applied to the current world you're in. Use "renamer set pack" to apply it to a different item pack, or teleport to the world with the item pack you want to rename.
Commands
- Change whether or not to automatically check for updates:
/renamer set setting autoupdate [true|false] - Get what item pack has been assigned to a particular world:
/renamer get world [world_name] - Assign an item pack to the given world:
/renamer set world [world_name] [pack_name] - Add a new item pack:
/renamer add pack [pack_name] - Delete an item pack:
/renamer delete pack [pack_name] - Select a item pack to use for all subsequent commands:
/renamer select pack [pack_name] - Rename all items similar to the one the player currently is holding:
/renamer select hand - Deselect the current item pack, going back to manually typing it:
/renamer select none - Get the rename rule for a particular item:
/renamer get item [pack_name] [itemID] [all|other|0-32767] - Set the name of an item(s) matching a single or multiple damage values:
/renamer set name [pack_name] [itemID] [all|other|0-32767] [0-32767] [name (with spaces)] - Add a new lore line to an item(s) matching a single or multiple damage values:
/renamer add lore [pack_name] [itemID] [all|other|0-32767] [0-32767] [lore (with spaces)] - Remove all the existing lores for a particular set of items:
/renamer delete lore [pack_name] [itemID] [all|other|0-32767] [0-32767] - Add a new enchantment to a set of items: /renamer add enchantment [pack_name] [itemID] [all|other|0-32767] [0-32767] [enchantment_name] [level]
- Remove an existing enchantment for a set of items: /renamer remove enchantment [pack_name] [itemID] [all|other|0-32767] [0-32767] [enchantment_name] [level]
- Reload configuration:
/renamer reload - Save configuration now instead of during server shutdown:
/renamer save
All commands default to OP, but also have permissions.
Modify enchantments
It is also possible to add or remove existing enchantments to any given item. The easiest method is to mark the item you want to modify in your hotbar, and type the following command:
/renamer select hand /renamer add enchantment NO_ATTRIBUTES 1
Every vanilla enchantment is supported:
- Bow: POWER, PUNCH, INFINITY, FLAME
- Weapon: SHARPNESS, BANE_OF_ARTHROPODS, SMITE, FIRE_ASPECT, KNOCKBACK, LOOTING, UNBREAKING
- Tool: FORTUNE, EFFICIENCY, UNBREAKING, SILK_TOUCH
- Armor: RESPIRATION, PROTECTION, BLAST_PROTECTION, FEATHER_FALLING, FIRE_PROTECTION, PROJECTILE_PROTECTION, THORNS, AQUA_AFFINITY
There's also three custom enchantments:
- GLOW 1: Preserve the enchantment glow with no visible enchantment name
- NO_ATTRIBUTES 1: Remove all the attribute lines introduced in 1.6.1 and 1.6.2.
- NO_DURABILITY 0: Remove any visible durability on the item. Switch out 0 with any other number to force a durability value.
Permissions
itemrenamer.config.get — read-only access to configs
itemrenamer.config.set — can edit configs or reload from disk
itemrenamer.update — gets a notification when update is ready, and can use update command
Notes
- Join us on irc at: irc://esper.net/ItemRenamer
- Items in the creative menu are only client-side, and thus cannot be renamed by this plugin. But creative players will see their items renamed in the main inventory bar.
- This plugin doesn't actually edit any items, they just appear renamed .. if you were to suddenly stop using this plugin all items should go back to normal
- If a player renames an item in an anvil, that name should take precedence over the ItemRenamer one
- When setting lore in game make sure to wrap the text in square brackets, each line separated by a comma, and enclosed in quotes if it contains special characters
Sourcecode
Access the source code via GitHub:
https://github.com/meiskam/ItemRenamer


-
View User Profile
-
Send Message
Posted Jul 10, 2013break, when using minecraft 1.6.2 running spigot build 1021 using itemrenamer dev build 36(maybe on others too) and looking at / loading into, a Villagers trade window. (also uses shopkeepers plugin, dose that effect it?)
-
View User Profile
-
Send Message
Posted Jul 9, 2013@CommodoreAlpha
Yeah, just remember to use the latest version on Jenkins.
Unfortunately, CraftBukkit 1.6.2 has really messed up ItemRenamer's ability to deal with creative mode. There's no easy way to fix this.
-
View User Profile
-
Send Message
Posted Jul 7, 2013@aadnk
The server just kind of ends once the error occurs. It's as if one were to use the stop command, except nothing is saved.
I'm pretty sure that it's a problem within Storm, though, since it's outdated (I was using 1.5.2).
-
View User Profile
-
Send Message
Posted Jul 7, 2013Does this plugin do any overriding on book names? (e.g. if I finish a book and set its title, will this plugin override that title?) I'm asking because I had a few books in a chest that have the name I set in the configuration instead of the name I gave them when setting their title.
I'm also curious if it's possible to override "vanilla lore" (e.g. enchantments, attributes, etc.) with one's own custom lore and/or cancel out the "vanilla" lore completely. Those would sound like really nice features.
-
View User Profile
-
Send Message
Posted Jul 7, 2013@rladbsgh
Are you running 1.6.1? The storm plugin doesn't seem to support any higher than 1.5.1.
But in any case, I wasn't able to reproduce the problem on a 1.5.1 server with only Storm and ItemRenamer installed. By the way, by crashing, do you mean that the entire server locks up and is unresponsive? That could be caused by a deadlock.
-
View User Profile
-
Send Message
Posted Jul 7, 2013I get an error upon using the /renamer command or getting a renamed item, reloading the server, then using /renamer or getting a renamed item again.
This error shows up:
The server then crashes. It's quite miserable.
EDIT: It seems to be an incompatibility with the Storm plugin. I'll look into this further tomorrow.
-
View User Profile
-
Send Message
Posted Jul 5, 2013@VergilPrime
It wasn't necessary. I only had to update ProtocolLib for 1.6.1 (CraftBukkit for 1.6.2 isn't out yet).
-
View User Profile
-
Send Message
Posted Jul 5, 20131.6.2 update? :D
-
View User Profile
-
Send Message
Posted Jun 30, 2013@shankomaster
I've added a simple API for ItemRenamer in the latest developer build. :)
To use it, add depend: [ItemRenamer] to your plugin.yml, add ItemRenamer-1.7.2-SNAPSHOT.jar to your Build path, and do something like this:
I'll probably push a new version out on BukkitDev, if this works okay.
-
View User Profile
-
Send Message
Posted Jun 30, 2013@aadnk
Yes, specifically an easy way to get the display name of a particular ItemStack a player has. I am going to use it for a PVP Plugin and I want to be able to pull the name of the item to print it out in death messages and in other areas.
-
View User Profile
-
Send Message
Posted Jun 30, 2013@shankomaster
There's no API for it yet, but I could write one.
You want to determine what changes ItemRenamer makes to a particular ItemStack for a player? What about altering the configuration - would that be useful?
I guess I could also make a ItemRenameEvent, and allow plugins to interact directly in the process, a bit like TagAPI.
-
View User Profile
-
Send Message
Posted Jun 30, 2013Hello,
Amazing plugin! I have really been enjoying it. I am wanting to get some of the names of the items set by this plugin from my own plugin. Is there any API or easy way to get the item names that were set using this plugin?
Thanks!
-
View User Profile
-
Send Message
Posted Jun 29, 2013@OrbisGaming
Yeah, you have to explicitly set the worlds (by name) that will have renamed items in the configuration:
If a world is not in this list, its items will not be renamed.
-
View User Profile
-
Send Message
Posted Jun 29, 2013Doesn't work for me at all, I have the other required plugin as well. I have multiple worlds is this a problem?
-
View User Profile
-
Send Message
Posted Jun 28, 2013@aadnk
Thanks dude, you're an awesome programmer :)
-
View User Profile
-
Send Message
Posted Jun 28, 2013@bloodless2010
My point was that a "Nausea" potion is not a custom potion made by a random individual, but rather a hidden potion made by Mojang. It's not proof that the server really did offer custom potions.
But, there might be a way to do this:
However, that bottle will always be tinted blue. And you will need a different plugin to add the custom potion effects.
@amitkilo
You can now rename already named items (with lore). Just select it with renamer select hand, and set the desired name/lore. I might add a way to remove lore lines later.
This new version can be downloaded here.
-
View User Profile
-
Send Message
Posted Jun 28, 2013@aadnk
im sorry but i dont understand what you meant by stinky potions, all I want is to make a potion with a custom (effect time:time) lore on it
-
View User Profile
-
Send Message
Posted Jun 27, 2013@bloodless2010
That's just a hidden potion type in the game. For instance, you can get Stinky Potions by typing the following command:
Certain things just aren't possible with a Bukkit plugin.
-
View User Profile
-
Send Message
Posted Jun 27, 2013but I have seen servers that use custom effects, like Potion name Nausea (0:03)
-
View User Profile
-
Send Message
Posted Jun 26, 2013@bloodless2010
Sorry, but that's not possible without also installing a client mod.
You should probably use a different item than potions instead.