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
Hi,
Is there a way to override the "default lore" in certain items (Such as the new swords having "+# damage" lore, or the music discs, etc.)
@CollinDesigns
Heh, this isn't related to Item Renamer, but I've gotten a similar issue before. Instead of a mob though, it was a sign that had too many characters on the same line. The only (sensible) solution would be to MCEdit the offending entity (or tile entity) out of there. Deleting chunks is usually a last resort, and is saved for corrupt chunks, and in your case, I doubt you have a corrupt chunk.
The only "fix" for this would be to have a better safeguard against extremely long strings, in that if a string with too many characters is detected, it will automatically cut off the extra characters. There's no way to make MC support more characters without a client mod. Unfortunately, I'd like to blame Mojang (again) for not having (or barely having) a safeguard against such situations.
Also, in case you haven't known, the "(91 > 64)" thing means that the string had 91 characters, but the maximum MC can support is 64. Or something like that.
@TommehRRR
The easiest method is to use select hand:
I'm not sure i understand how to use enchantements, i also tried using the no item thing enchantement, that's supposed to remove the blue +7 damage lore.
How would i do this for a wood sword?
@CollinDesigns
Hm, I can't reproduce the crash, actually. What plugins are you using? And what plugin gives you the command "anvil"?
Also, did you try deleting the mobs with MCEdit?
@CollinDesigns
Oh damn, looks like the hack I used for storing data in the "display name" of item stack could be pretty dangerous. I'll switch to using lore for spawner eggs and naming tags instead. There is a check against too long display names, but only for anvils and setting the . Plugins can still make this mistake.
This is all because the Bukkit team decided to strip incoming item stacks for custom NBT tags ...
In any case, you can get the updated version here.
EDIT: I'll put a big, red warning at the top for this version. I'll also push out a fix on BukkitDev.
When renaming a nametag (with colors, example: /anvil &5&lMy &4&lgood &2&lepic &6&lhorse) or even a smaller example and applying it to any mob it will auto kick everyone and say: string length longer than maximum allowed (91 > 64) and prevents anyone from logging in. And /killall or /butcher via console won't kill the animal/mob so you have to delete the chunk and regen it in order to be able to log in again... so by fixing the bug you also will lose any stuff/buildings inside that region... :s
Can you fix this?
@CookieGamerzMC
For renaming individual items as a player, sure. But sometimes it's useful or necessary to automatically rename every item of a kind on the server.
One use is custom language-packs that recreate a specific theme (game, pirates, etc.). Or it can be used to modify the items created by a certain plugin.
Besides, anvils doesn't support lore or fake enchantments.
Just Use a Anvil! XD
@aadnk
Awesome; removes the need for an entirely separate plugin like AttributeHider. Not that that plugin was bad or anything.
@John__B
Yes, but the "latest" ProtocolLib could be the latest on BukkitDev, not the Jenkins server, which is what I'm referring to. Version 2.4.8-SNAPSHOT, in other words.
@aadnk
your telling me to read what you wrote, but I told you im using the latest protocallib did you read that...
Ill pop in the 1.7.4 you have on my server tho.
I've now pushed out a new version of ItemRenamer. It contains all the new features added since 1.7.2-SNAPSHOT, including a new custom enchantment that hides the new 1.6.2 attributes (such as +7 Attack Damage on swords).
It should be out on BukkitDev soon, but meanwhile it can be downloaded on my Jenkins server.
@Joymo
Sure, I'll just add that to the latest snapshot version. You can now set the default pack with the following command:
Or simply add the following to your configuration:
Is there a way to enable a pack for ALL worlds somehow? We have a lot of them <_<
@John__B
Please read what I'm writing. You need to upgrade to the latest version of ProtocolLib from the Jenkins server.
I've also updated ItemRenamer for 1.6.2. Creative mode should no longer be an issue.
@aadnk
Ideas on the villager one?
@John__B
Ah, I see.
This is why I hate YAML. It's too "lax" and accepts too many mistakes as valid data. It's also enormously complex, which is not exactly making the first problem any less common.
Sill, it is the standard configuration format for Bukkit.
@aadnk
I hav latest protocal lib and twotuxlib running all the time ;P
I tripple checked the packs thing, i had an extra Packs: in by mistake :P
@John__B
Could you pastebin the error?
@John__B
Try this version of ProtocolLib.
bug? minecraft 1.6.2 running spigot build 1021 using itemrenamer dev build 36
plugin config.yml can not contain more then 1 Pack (causes error on load/and reload)