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 jessefjxm jessefjxm Dec 18, 2014 at 02:04 UTC - 1 like

    The newest version still break with newest spigot 1.8. Can't wait to see the full updated version :)

    Edit: a suggestion, sending fake metadata to client, so we can use default texture rather than "the missing texture" in 1.8 .(in 1.8 texture can modified per metadata)

    Last edited Dec 20, 2014 by jessefjxm

    为什么Bukkit没有显示用户国籍的功能呢~

  • Avatar of TheMcGuider TheMcGuider Dec 12, 2014 at 21:54 UTC - 0 likes

    I am quite sure that you guys are aware of this issue but I'm going to leave it here anyways: http://pastebin.com/qDFb18ML, you should move over to Spigot forums as it seems like you guys will have to compile this plugin with Spigot as API, great work on this plugin, just got my server back and I am looking forward to use this again!

  • Avatar of CommodoreAlpha CommodoreAlpha Dec 12, 2014 at 16:48 UTC - 0 likes

    @rladbsgh: Go

    Enchant Lore (and the lore you find on Discs) are handled differently. They're not really "lore", more like built-in text. You might want to try playing around with "GLOW" (judging by its description) but I'm not sure if it will work or not.

    Server Information: "antarcticspecops.webs.com"

    Antarctic Special Operations, home of the buggiest (modded) server ever! With the most incompetent admin (me) also! Currently unplayable on survival due to construction accidents involving but not limited to a rebar in the face. I'll consider opening for Beta testing as soon as I overcome my incompetence. <3

  • Avatar of rladbsgh rladbsgh Dec 09, 2014 at 09:44 UTC - 0 likes

    Does NO_ATTRIBUTES 1 hide enchant lore? It doesn't seem to remove things like "Efficiency I" on tools.

  • Avatar of Sponsfelix Sponsfelix Dec 07, 2014 at 23:21 UTC - 1 like

    Would love to see this one updated to spigot 1.8 Great plugin!

  • Avatar of murderersrow42 murderersrow42 Dec 01, 2014 at 18:13 UTC - 1 like

    Please update to spigot 1.8, I love this plugin!

  • Avatar of KoolKrafter KoolKrafter Nov 16, 2014 at 21:27 UTC - 1 like

    @meiskam: Go

    Yeah, the Spigot 1.8 build is broken. I'm trying to figure out why, seems to be multiple problems though.

    http://i.imgur.com/mnQdsWc.png

    BFAK:90688910,13fd6ce31d4bc312f15db7484b64cb6704e3f5e621e093eacfe28747d0da56f5

  • Avatar of CommodoreAlpha CommodoreAlpha Oct 19, 2014 at 23:34 UTC - 0 likes

    @meiskam: Go

    No, I mean the newer lore, like "Attack Damage +4".

    It can be removed via command - as depicted in an example above - but I want to directly edit the config file. In other words, what tag do I use to tell the plugin to "erase" the vanilla lore?

  • Avatar of meiskam meiskam Oct 19, 2014 at 21:39 UTC - 0 likes

    @Leeman1234: Go
    @BrvtvsC: Go
    @Bobacadodl: Go

    Are you guys using "ProtocolLib - Spigot Hack 1.8", or an older version?

    @CommodoreAlpha: Go

    Such as the music disk lore? I don't think that can be removed without a client-side mod.

    Last edited Oct 19, 2014 by meiskam

    BFAK:meiskam,74919,2d6c5de1b19d7aabc1fb74542e178ac033f9e170a90b33ea1616af55a9476d26

  • Avatar of CommodoreAlpha CommodoreAlpha Oct 17, 2014 at 22:04 UTC - 0 likes

    I'm not a fan of using commands to edit the config, so I was wondering how one would go about configuring an item to not display any vanilla attribute text.

Facts

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

Authors

Relationships

Required dependency
ProtocolLib