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
@TommehRRR
It is currently not possible to change your configs to make it work like this, however it would be possible to add this feature to the plugin.
@MrKorvic
Any item that has a NBT tag associated with it will stack strange in a player's inventory, this is a client-side bug. No matter if you rename it with this plugin, rename it with a anvil, or add an enchantment to a stack of items, they will cause glitches when moving the stacks around in the inventory. This can only be fixed by Mojang or a third-party client-side mod.
Is it just me, or is everyone's inventory stacking all weird? I think it may be this plugin conflicting with it's own saved values for different items, or it's RecipeManager. I'm going to post there as well, but they're both essential plugins and I would like it if it could be fixed somehow. (Might not be this plugin though.)
Not to spam, but is it possible to make a 'damage value' -untill another 'damage value'?
@meiskam
Thank you, it worked.
@jjacobson
Everything in the "example" pack is saved into the plugins internal configs. Rename that pack to something else and it'll work how you expect.
I am baffled right now.... this is my config
Yet I still get all the default config values ingame, like the wool names and diamond name even when there is absolutely nothing about them in my config.
How about a feature to use a damage value - untill a damage value?
helpefull for making "ranking" sword durability, 1-50 uses is a "sharp sword"
51-100 is a "Imperfect Sword"
101-200 is a "Bent sword"
and the other would be "Breaking Sword"
it would look like this in the config:
'267':
'0'-'50':
name: Ultra Sharp Broad Sword
lore:
- Iron Sword
'51'-'70':
name: Very Sharp Broad Sword
lore:
- Iron Sword
'71'-'100':
name: Broad Sword
lore:
- Iron Sword
'101'-'125':
name: Dull Broad Sword
lore:
- Iron Sword
other:
name: Bent Broad Sword
lore:
- Iron Sword
Is this possible?
it can help alot!
@ThedarkdudeZ
Yes, as long as you contain it within apostrophes.
@aadnk
I messed around in my config, and managed to make it work. It was something I'd done wrong with colour codes. Is it actually possible to do colour codes for the lore of items?
@SheerAwesomeness
@delsolsi213
Change your "worlds:" configuration option in config.yml to the following:
But yeah, it's due to a bug introduced in v1.5.0021.
@ThedarkdudeZ
You mean it doesn't actually rename anything? Try deleting your configuration file, or try other versions of Item Renamer and ProtocolLib.
What other plugins are you using?
This has stopped working for me. I don't know whether Craftbukkit 1.4.7 R1.0 is causing it, or if it is the "Recipe Creator" plugin for some reason. Any ideas how to fix this, I love this plugin!
@delsolsi213
I get this too, in survival and adventure mode, all the items are invisible!
hey, everytime i go to the nether the texdtures for all my items vanish, the items are still in my inventory, but you just cant see them :(. also how do i remove the names from the bedrock etc, i tired deleting them in the config and they'll still be there >.<
@jessefjxm
@Codisimus
Should be fixed with version 1.5.0021, thanks for the report.
It seems that our plugins aren't playing nice with each other. They like to argue over wut the name of an item should be. I suppose your plugin is strong because it always wins the fights. I am hoping to resolve this issue so we might all get along and play nice.
My plugin PhatLoots can generate items with custom names. However these custom names are being overwritten by this plugin. Perhaps you could add a check to see if there is already a custom name for the item (and if there is don't rename it). I know that this will benefit mutual fans of ours.
Thanks for your time. let me know if you need any additional information.
So does this rename ALL items with the id, or just the one in the command user's inventory?
This is a great plugin, as it really helps me in fine-tuning (AKA bending most Minecraft mechanics) to my desires. Also, this plugin really goes great with a plugin like RecipeManager (though outdated), since you can "make" new items.
when u rename 373:16 it dose not work but it works with others
@meiskam
Shame really :/ It's a great plugin otherwise!
@SheerAwesomeness
I've noticed this buggy behavior, and found it to be completely client-side, and thus would require a client mod to fix.