Item Renamer

Example ItemRenamer items

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.

ConfigDefaultRangesDescription
autoupdatetrue[true/false]Will remind you when a new version is available
creativedisabletrue[true/false]Will disable ItemRenamer while you're in creative mode
worlds.<worldname>Pack nameWill set this world to run the pack you put here
packs.<packname>.<itemid>.<data>.nameAny stringWill rename itemid:data to your string
packs.<packname>.<itemid>.all.nameAny stringWill rename all itemid data values to your string
packs.<packname>.<itemid>.other.nameAny stringWill rename all unset itemid data values to your string
packs.<packname>.<itemid>.<data>.nameAny stringWill add your name to itemid:data
packs.<packname>.<itemid>.<data>.loreAny stringWill add your lore list to itemid:data
packs.<packname>.<itemid>.<first>-<last>.nameAny stringWill add your name to every itemid with a data value of the give range.
packs.<packname>.<itemid>.<first>-<last>.loreAny stringWill add your lore list to every itemid with a data value of the give range.
packs.<packname>.<itemid>.all.loreAny stringWill add your lore list to all itemid data values
packs.<packname>.<itemid>.other.loreAny stringWill 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

Donate

Donate

Metrics

MCStats Plugin Metrics for Item Renamer

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of Superboop Superboop Aug 30, 2014 at 14:30 UTC - 0 likes

    The stackrestrictor option no longer works for 1.7.9-R02 (current beta build). All renamed items are joining into one stack.

    Last edited Aug 30, 2014 by Superboop
  • Avatar of pilvimaa pilvimaa Aug 18, 2014 at 18:17 UTC - 0 likes

    Dev build 22 caused constant disconnects on Spigot 1.7.10 build 1609.

    Reverting back to build 20 fixed the problem.

    The client error message was something about too many bytes of information in some package. I'm sorry but I could not find the error message. It seems my client has stopped writing logs a month ago for some reason and there was nothing relevant in server logs.

    But I could find this. Possibly related, from server logs:

    http:pastebin.com/5763JCpi

  • Avatar of EgyptianKings EgyptianKings Jul 28, 2014 at 08:15 UTC - 0 likes

    I've renamed a paper but under the lore it says Miscellaneous. Is this normal or is there a way around this?

    BFAK:90853393,698340adfadac74863444014eec78835fc4c54b06d47f587d582d9b8c721bca7

  • Avatar of OzOwnz OzOwnz Jul 23, 2014 at 20:42 UTC - 0 likes

    @dilbukon: Go

    I tested the bug you explained, but for me, I regular click the smelted ores, and 1 iron ore appears in the to-be-smelted slot. That's really the only bug, when it finished another smelt, it reverts back to the correct quantity and ore type. No exploits, just a random ingot in the wrong place.

  • Avatar of dilbukon dilbukon Jul 22, 2014 at 02:17 UTC - 0 likes

    I have no idea why a plugin like this is causing, but there's a major exploit on furnacing.

    If you shift-click on the finished (smelted) item from a furnace, the amount of the same finished item appears on the "to-be-smelt" inventory on the furnace while the smelting is in progress, then the player can take the appeared items additionally from it to skip the smelting process.

    For instance, you put 64 iron ores on the furnace, and wait until 3 of them are smelted into ingots, and shift-click on the 3 iron ingots. On the left side where 61 iron ores should be, 3 iron ingots will appear. You can click on them and drag them into the player's inventory to gain 3 iron ingots in addition to what they've gotten initially, totaling 6 iron ingots in a 3 iron ingot smelting period.

    This is a huge deal for me and I would really love to this get this fixed. Thank you.

  • Avatar of McGuider McGuider Jul 05, 2014 at 19:26 UTC - 0 likes

    Amazing project, love it.

  • Avatar of Pwood13 Pwood13 Jun 29, 2014 at 16:14 UTC - 0 likes

    Does the color codes work????

  • Avatar of SirComputer SirComputer May 30, 2014 at 08:51 UTC - 0 likes

    @smilarex: Go

    Give him an error log from your console, and as long as you've installed the ProtocolLib plugin, Aadnk will help. The plugin should be compatible with all plugins as long as they don't do what ItemRenamer does.

  • Avatar of smilarex smilarex Apr 22, 2014 at 20:06 UTC - 0 likes

    @aadnk: Go

    I NEED HELP. It dont work and does this plugin work with all plugins

  • Avatar of aadnk aadnk Apr 16, 2014 at 21:00 UTC - 0 likes

    @CommodoreAlpha: Go

    That's just a warning that checks if a world specified in the configuration cannot be found when the plugin has loaded, usually because the world name has been misspelled.

    But, I suppose it's possible Multiverse hasn't quite loaded the world at that point - or, is ItemRenamer definitely loaded after those other worlds have been loaded? I haven't really Multiverse, so I don't quite know off the top of my head.

    Is this warning accurate, by the way? You mentioned that half of your worlds doesn't load with ItemRenamer - are these worlds mentioned in the warnings?

Facts

Date created
Nov 06, 2012
Categories
Last update
Dec 22, 2013
Development stage
Release
License
MPL-2.0
Curse link
Item Renamer
Downloads
24,602
Recent files

Authors

Relationships

Required dependency
ProtocolLib