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
@bloodless2010
Upgrade ProtocolLib to 2.6.0 or the latest developer build of PL.
@Joymo
I weren't really able to reproduce this problem, but I might need to try other versions as well. Did you try the very latest developer build on the Jenkins server? Or 1.7.3?
@TommehRRR
Try the very latest development build of ItemRenamer.
Please help, I'm using latest version!
Posted a bug, currently this plugin messes with item movement.
https://github.com/meiskam/ItemRenamer/issues/2
@aadnk
There is some strange glitch with name spacing, try using this item as a config, then just re select the item again, and again... and again!
@aadnk
Okay, I think its a problem with my chat plugin messing with zpermissions, and not zpermissions itself. Thanks I think I got it figured out now.
@jjacobson
Try upgrading zPermissions to the latest version, or report that error to the developer(s) of zPermissions so they can have a chance to fix it.
Hey can you help me with this error please? http://pastebin.com/xumm4ixH
Using spigot.
@aadnk
the rest of my config does not look like that - i didn't use commands for them, the only item i tried was the wooden sword - which ended up not working
Renaming still works ;)
@ChillaxTeam
Hm, you might have to set the current pack (default example):
If that doesn't rename anything, try setting the rename pack for the current world:
@aadnk
I did that renamed one item
Then tried to do a second item but then it kept saying "You must select a pack".
@ChillaxTeam
Okay ... have you tried using the "select hand" command?
That way, you don't have to learn the configuration format or the complicated command syntax. Just get an item you want to rename, put it in your inventory bar, and type the following:
Then you can use these commands to set its new name or add additional lore:
You may have to select a rename pack though:
If you've done it correctly, the item will be automatically renamed in your hand.
This is to complicated for my taste.
@TommehRRR
No, attributes will only be removed on items with NO_ATTRIBUTES, and then ONLY if the item has custom attributes in the new system. For instance, potions and records will still have their descriptions, even though it looks similar to the new attribute "lore" lines.
I can add a global setting, sure, but I'd first like to fix the "junk" in the display name. That's caused by a hack that clearly isn't working ... it's probably best to fix bugs before I add new features.
@aadnk
Yeah thanks, maybe you should also add a default enabled effect? Something like at the top of the config
"Item Attributes Enabled?: false"
Also, will renamed items have removed attributes? I will have alot of renamed items, would be a shame if not everything is fixed (Not TOO crucial though, only hestetics)
@TommehRRR
Looks like that item is a bit bugged. The extra junk in the display name shouldn't be there, that should only exist on the client side.
Try adding enchantments directly to packs: YOUR_PACK: 268 in the configuration file.
@aadnk
Thanks, i'll find a way to get this working, anyway.
Probably making some sort of typo
I still see the attributes.
I will look into the source code, maybe i might make it activated as a default ;)
@TommehRRR
Yeah, applied "null" is a bug, but it should work if you refresh the inventory (or relog). Though, it may use the wrong selector in the configuration, like OTHER instead of ALL. To see what the command did, simply type "/renamer save" and open the configuration file.
You should see something like this:
You add enchantments by adding them to "enchantments", just like you would with "lore". The enchantment name is the key, and the integer value is the enchantment level. Of course, NO_ATTRIBUTES doesn't really have an enchantment "level", but you still have to give it a number.
@aadnk
Hey, sorry to bug you, but i can't seem to understand the enchantement system.
Could you show how this would look in the config? It's strangely easier for me to understand configs better than commands.
When i use the command it gives me a applied null to every item, although i see no difference.
Thanks anyway
@rladbsgh
@ZeEye
As I've explained earlier, use the NO_ATTRIBUTES enchantment (select the item you want to rename):
@rladbsgh
I am wondering the same. Anyone got a solution yet?