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
Hello, I'm just wondering why I got a message like this:
When that world is indeed loaded by Multiverse. And I'm fairly sure my config isn't invalid. Half of my worlds load fine with ItemRenamer, but the other half don't. I'm not doing anything inconsistent in my config (and all the worlds load up).
I'm more curious than concerned, as I can probably troubleshoot it myself (I've yet to start testing plugins alone and all that diagnostic stuff).
@aadnk
It appears to be fixed. Thank you.
@pilvimaa
Ah, sorry - I misread you. I thought you wanted ItemRenamer to override items renamed with anvils.
I managed to find the problem though - turns out, ItemRenamer only skipped renamed items for rules with a damage value. Other rules, such as ALL and OTHER, would still override them.
This should be fixed in version #11 on the Jenkins server. Let me know if it works for you. :)
If I understood correctly we can expect a fix for named items in the next version?
@Rich_Justice
That's probably because you failed to install ProtocolLib, or an up-to-date version of ItemRenamer.
But there's no need to get nasty here. Sure, ItemRenamer could have printed a more readable error message in the console and in-game, but the dependency Is listed in the documentation and installation procedure. Even if you can't read the console log, you should have simply gone back to the plugin page when you noticed the problem.
Most Bukkit plugins require you to install dependencies manually, and ItemRenamer is no exception.
@pilvimaa
Right, ItemRenamer ignores items that have been renamed with an anvil. This was originally a simple optimization back when you could only rename and add lore to an item, but I suppose other effects (like custom enchantments) should still apply. Anvils should still override the display name, though otherwise there would be no need for them.
As for potions - unfortunately, the potion effect line is entirely client side. It might be possible to convert the potion to a water bottle with a custom name and lore, but then you would lose the potion color.
I'm having a bit of trouble with weapons (and armor, possibly? Haven't tried).
When I rename a diamond swords for example Itemrenamer doesn't respect items that have custom names named with anvil or by other means.
Other items like food, blocks, etc work just fine in this regard but axes, swords etc don't show the custom names only the name renamed with Itemrenamer.
EDIT:
Also, would it be possible to have custom enchantment that hides the descriptions from potions similiar than the one that works with weapons? Potions have these "Fireproof (3:00)" etc descriptions. I tried the "NO_ATTRIBUTES 1" enchantment, but it didn't seem to do much good with potions.
Does not work. Garbage. Doesnt even make a file in my plugins to config. no commands in game either.. thanks for nothing
@TommehRRR
Check your console log next time. Looks like ItemRenamer threw a ConcurrentModificationException in this situation.
It should be fixed in build #8 on the Jenkins server though.
For some reason, if i want to give different Enchants to the same item, just with a different damage value, The plugin doesn't rename anymore.
Thanks.!
Update:
The renaming stops anytime there is an item with the enchantements line in it.
ok, thanks :D
@B3stcraft
What you want is not possible with this plugin. The items are not actually renamed on the server, nor track-able. If someone were to take a renamed item from one world to another, it would lose it's rename.
is It possible to add a lore to all blocks at a time? I have a creative world and I want all blocks get from this world a lore that say "Get from creative", so if someone bug it and pass items to others normal worlds, I could track them ;D
@McPixel
What do you mean? Could you post an example from your configuration?
@aadnk
heloo , why i cant make GLOW on my custom items with lore ? or its just used for vanila items ?
@KoBrA1135
It's not supposed to - ItemRenamer will never make any functional changes to item stacks, as it only changes the client side. This merely affects the appearance of item stacks, as the server is responsible for handling functionality such as enchanting effects.
If you want these effects to actually work, you should simply enchant each tool as normal (or use a plugin).
Nop, The enchantments and glow still don't work them selves.
I added enchantments they show the enchantments but the actually enchantments does not work at all...
Here is my example of config:
http://pastebin.com/mfGgBqNy
276 is crafted by ID 276:1 is enchanted by ID
when i tried on a zombie or on a player the knockback did not work at all.
@KoBrA1135
Try resetting your configuration file before using any of the "add commands":
As for NO_DURABILITY - try using this:
There is support for unsafe enchantments, though they don't necessarily show up as "Infinity 1000". Instead, they're visible as Infinity enchantment.level.1000. This is a client-side limitation I can do nothing about.
All new features does not work properly, The enchantment addition is broken.
1) GLOW: 1 does not work at all 2) NO_DURABILITY: does not hide durabilities of the items 3) Enchantments such as DAMAGE_ALL: 3 is not working, None of enchantments work on weapons or tools. Also even when you add DAMAGE_ALL: 300 not working.
Enchantments does not work at all :(, also add support for unsafe enchantments
basically we can go over Sharpness 5 up to 1000 etc....
@MrCobayo
That's very difficult, and would probably be buggy even if I got it working.
The problem is that an item named "Coin" and a stack named "Coins" would be considered different by the client, and thus not allow the player to place a "Coin" on top of a stack of "Coins". This is a client-side limitation I would have to find a way around, if there even is a way.
I just don't think it's worth the effort, sorry.