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
@AlexisNight
@AlexisNight
@CommodoreAlpha
I'll take a look at the stacking problem when I get back from my Easter vacation.
In the meantime, try using the latest developer version. I've added a configuration option that will temporarily disable the stack restrictor that might be causing these issues:
Any news on enchantments?
There are quite a lot of problems, the objects which not " stack " not always very well, and when we place objects in the workbench: he tends sometimes has to disappear, to reappear, badly to take place, etc.... Is it possible to correct all this?
@CommodoreAlpha
Yes ! Need fixes ! I have the same problem and it is very irritating !
There is one issue I ran across on my testing server with this plugin installed: stacking items is rather iffy. Sometimes, when I try to stack items together in the inventory, they absolutely refused to be stacked. I haven't tried it out with dropping the two conflicting stacks on the ground and picking both up to see what happens.
While I normally don't like to complain (and rush the developers), I feel that this "bug" (I've to do further testing to find the nature of this issue) is beyond just an inconvenience, and can actually affect gameplay (e.g. items like food and potions not stacking correctly in combat).
On a sidenote, there is one minor bug associated with crafting, in that the result of a certain recipe doesn't always show up, but clicking the "product box" will still give you the product. That, and I have to run tests with this plugin and ProtocolLib only to see if the issue is only this plugin, or a combination of plugins.
@aadnk
That's much easier now, thank you!
@Zombine911
You're right, it's a bit complicated.
I'll add a "add pack" command, along with a "select pack" command that automatically inserts the pack name into each command.
You can download this version here.
@irdoom1337
Yes. Look at the default configuration file for an example.
In command form, this becomes (if the world uses the example item pack):
You can also select the item pack on a separate line, which might make it easier to type additional commands:
You need the permission itemrenamer.config.set for this to be permitted.
Quite the frustrating plugin. I want to create my own pack and not have to use the example pack and tediously remove all of the names set in that one. Every time I attempt to make a new pack, the plugin can never find it. Add a command such as /renamer add pack <packname>
Would make this a lot easier. Or add a tutorial.
will this plugin let me rename a sword to something like cow and what is the perm and command
@aadnk
Okay I really dont understand but thanks!
@aadnk
I asked because of custom crafting plugins such as Recipe Creator and UnlimitedRecipes.
Currently they only support crafting items with different damage values which works flawlessly with your plugin since they immediately get renamed after being crafted. I'm hopeful though that crafting certain player skulls will be added in the future and support on your end would be icing on the cake.
Ex. Craft BlameTC's player skull and recieve "Skull Cap".
@artlune
Not at the moment, no. But this could be introduced through whatever plugin you're using to add player skull drops, or however you grant players these items.
@jhs232
It won't rename items that have already been renamed, so yes.
@trkah
Take a look at the default configuration file. It contains examples for how to rename items (using their item ID) and data values.
Though, this can't be limited to, say, the current selected item. It will affect every item on the server. This is by design.
please how do I rename one item? like the one im holding in my haand? and give it a description
Does this plugin respect other plugins that rename items, such as CrackShot (http://dev.bukkit.org/server-mods/crackshot) and InfiniteKits which I use to add custom potions, and those custom potions have custom Name & Lore. If it does respect other plugins, then it's awesome!
Can this plugin handle player skulls?
@Lostferret13
You've made a mistake in the configuration. Delete it and start again - it should be fairly clear how to correctly change it.
Options can be used to override the default item pack per world and specify them per group. So - you could for instance let some users have an English pack, while others would get a German pack.
In GroupManager, I believe you can do this under "info":
using the latest reccomended of craftbukkit and protocolLib and Itemrenamer and I keep getting this error:
(scroll to bottom)
http://pastebin.com/S7rX61A7
what is this about setting an option in permissions? (using GM)
@artlune
It's intended to show how to configure ItemRenamer - so just remove everything you don't want or need.
@kahlilnc
Have you set the option itempack in PermissionEx or similar?
http://pastiebin.com/513e7238d3165
There seems to be a random "packs:" thrown into the default config. Is this intentional? Is this meant to change just a single itemID for a pack and leave the rest the same?