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
@aadnk
Does it auto-detect if the User is German? I think i will install it, great Plugin :)
@destroyer4017
Seems to work fine in 1.6.0. What kind of items are you talking about?
@KoBrA1135
What do you mean? I don't think ItemRenamer should override anvils nor enchantments, which it doesn't.
@TommehRRR
No problem. :)
I had to rewrite the entire plugin though.
@GlabbichRulz
ItemRenamer will override it. But an administrator could assign a different item name pack per player if Vault is installed. So, you could have both an English and a German version on the same server.
Whats happening if a client has choosen another language than english in his settings?
Haha, Nice job!
Thanks for taking my idea into considderation!
Add a support for anvils, enchantement tables. It does change after when you done the enchanting with books or by levels. Please fix it :/
There seems to be a strange bug where some items you pick up (like from a player death) will not stack with other items in your inventory, only affecting renamed items. I feel like I'm going crazy.
@ZwingGX
I've pushed a new release of ItemRenamer that fixes this issue (among other things). You can get it on the Jenkins server if it's not already out on BukkitDev.
Hello, error report
http://pastebin.com/hMDL9Qh5
test: Spigot #517 ProtocolLib-2.2.0.
@jmartin657
I believe you're misunderstanding the config option that you changed. If you want to run the example pack in a world called steve, then your setup would look like this:
@CybrgDragon
This appears to be a client-side bug, and would require a client-side mod to fix it.
PS: Are you CyborgDragon? I notice the name is misspelled but your avatar is the same. If so, I love MCNostalgia :D
@CybrgDragon
Um, no I simply added the plugin and ProtocolLib and changed the default config file world name from example to world.
So if there is a problem with how the config file is written then why did you make it the default one?
@aadnk:
There is an issue with this mod, in that it prevents one from using inventory sorters such as the Inventory Tweaks mod. All the items just jump back to their original place. Do you think you could fix this issue?
@Turtlez3659
@jmartin657
This means your config is broken, or you haven't set a pack for the world you're on. Make sure when you use quotation marks in names, that you double them up.
@Turtlez3659
never got it to work either.... and to top it off it adds a bug where in creative when i try to add an item to my inventory it just deletes the item
This plugin doesnt work for me IDK why I TRIED EVERYTHING but it NEVER loads the names and idkwtf to do plz help
@Tealk123
It doesn't sound entirely within the scope of this plugin though - it's mainly focused on the customization of item names and lore, not removal of potion effects (and presumably) and enchantments.
@aadnk
ok that would be grate, and what is with the potions?
@MCwolski
Use the latest version, downloadable from the Jenkins server. I'll probably update BukkitDev soon, possibly with new features. :)
@Tealk123
Possibly. I'll consider adding support for permission nodes, allowing you to specify a "rename" pack per player.
@Lostferret13
It's not possible to make this work on 1.2.5 as it uses 1.4 features, which are only in 1.4 and later.
any way to get this to work on 1.2.5?
the config shows, and ProtcolLib works fine, but no item names change. also using NEI (for Tekkit)
is it possible to add a permission node that a player see the ogrinal names of certain items??
and how i edit/remove the effekt?
http://saved.im/mtg5mda1emj5/2013-02-04_220607.png
I'm using v1.5.0021 and ProtocolLib-2.1.0, when players go to other worlds, their items will disappear (but items exist actually). Is that plugin bug? Or conflict with other plugins? :(