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
This looks a bit like the syntax I used in ExperienceMod (with ; instead of 1), and I can tell you - it's a pain to maintain and use. Granted, it's less of a usability issue with only two variables, but it may require a bit of an internal rewrite in ItemRenamer.
The configuration system got so complex in ExperienceMod that implementing proper commands for configuring it would have taken way too much effort (if I'd even succeeded).
I may get some time to look at it next weekend.
@gustebeast
Sure, it's a simple matter of extracting the current item ID, damage value and enchantment.
@TommehRRR
Renaming items that are in your hand is a must have though. It is simply the best way to do it.
@alexk252
I think a gun plugin would handle this much better than the vanilla arrow shooting. http://dev.bukkit.org/server-mods/modernweapons/
Although i think this idea is good, something like this syntax:
Does this support enchantments? As I want to rename a bow to: Pistol, and a bow with Power IV to: Rifle. Would this work, and if so, how would I do it?
Maybe change it so you can rename the item in your hand, as suggested below, and it would change the name for all the other items like that.
So I could hold a bow, and use: "/renamer sethand name Pistol".
Then I could hold a Power IV bow, and use: "/renamer sethand name Rifle"
Thankyou, and great plugin! If you could tell me if Im going wrong somewhere, or add this, this plugin would be the best. Literally.
Thankyou, and have a good weekend, Alex. K
@aadnk
Its simple really. This feature would also make renaming easier in many cases.
You hold whatever item you want to rename in your hand and type "/renamer sethand name <name>"
That command would follow with your current format, but really I would go for something more like "/rename <name> <lore> <ect..>", and just have it always use the item in your hand. I think it would be easier for most people to use this method than to enter in the item ID and such. If they really want a manual method they can just edit the config by hand.
@gustebeast
You can rename sticks (item ID 280), but you can't currently restrict this naming to sticks with a specific enchantment. In those cases, I suggest using an anvil.
It wouldn't be impossible to implement, but I'm not sure how to extend the configuration format to support it.
How would I rename the item "stick with punch I enchantment". There is no defined sub ID so it would have to be in the configuration somewhere.
@FIRESTORMER1
1.5.2 just fixed a couple of bugs, so it works as well as in 1.5.1.
Does this work with 1.5.2?
@barnabas02
I think this is something you should report to the maintainers of CraftbukkitUptodate, not with each individual plugin that happens to use a different naming convention.
@Fern_Silverthorn
Sorry, but don't see any way to remove this existing "lore". It's hard-coded on the client, so only a client mod would be able to remove it.
Hi I am newish to bukkit so don't know a lot about java but I have noticed that music disks keep there default lore! If you could, in the next release fix this or tell me if its not possible that would be great (i use disks as custom re textured items since they don't have recipes) the on;y confirmed problems is with item 2267 (or pistol ammo on my server) its not a big deal but players keep asking why the pistol ammo says its a music disc i'm considering making an item based economy (with the gold disc of course) if you/i can fix this thanks for a great plugin and sorry for a awful post its about 11:00 and I slept awfully last night here is my config: http://pastebin.com/3kaXU2Rf
Please don't include the version number in the filename, thus preventing the use of updater plugins, such as CraftbukkitUptodate. Thanks in advance
@thejackstur
YAML files doesn't work that way. If you use the same key multiple times, it will overwrite the existing key (and its values) each time, meaning that only the last entry will take effect.
So ... you must put them all under one '351':
@aadnk
this worked with one dye but when i tried to rename another it did not work
http://pastie.org/7750213
this works thanks you!
@thejackstur
Just use the same format as the rest of the configuration file:
@BirdTheRocket
that did not work
@thejackstur
use 351.6
can you please help me, i want to rename cyan dye(351:6) but when i put the ':6' it says 'ID not found' please help