Knokko's Custom Items
Note: this plug-in requires a different installation procedure than most other plug-ins. You really need to check the installation section or one of the tutorials.
Description
This plug-in allows the owners and developers of servers to create custom items with their own textures. (It requires a server resource pack.) Everyone who would like to use this plug-in needs to download the Editor and use that to create their own custom item set.
Installation
- Download and run the Editor. Editor.jar can be found in the Files section. If you have a working Java installation, you can just download and double-click this file. If not, you can either install Java or download a native version of the Editor from https://github.com/knokko/custom-items-gradle/releases
- Put this plug-in (CustomItems.jar) in your plug-ins folder
- Configure the items and textures you want (in the Editor)
- Click on the Export... button, and follow the steps (in the Editor)
- Optional: Install ActionBarAPI to display custom tool durability and wand/gun cooldowns. See https://knokko.github.io/custom items/compatibility/positive.html for details.
If you need more detailed information about these steps, you can ask for help on the Discord server.
Discord server
Invite link: https://discordapp.com/invite/bmF3Zvu
New tutorials:
https://www.youtube.com/watch?v=GsC-pNlBjwg
Old basic tutorials:
Text: https://knokko.github.io/custom%20items/index.html
Video: https://www.youtube.com/playlist?list=PLcc-tPs9PuADC-shEBRynL9s2j6slSWCa
Old advanced tutorials:
Custom containers (video): https://knokko.github.io/custom%20items/tutorials/containers/index.html
Wands and guns (text): https://knokko.github.io/custom items/tutorials/wands and guns/index.html
Troubleshooting
If you can, use /kci debug
If that doesn't work, check out https://knokko.github.io/custom items/troubleshooting.html
Supported minecraft server versions
Minecraft 1.8.x and earlier: impossible to support (at least without mods)
Minecraft 1.9.x, 1.10.x and 1.11.x: not supported, but could be if there would be enough interest
Minecraft 1.12.2: supported
Minecraft 1.13.2: supported
Minecraft 1.14.4: supported
Minecraft 1.15.2: supported, but misses custom tridents
Minecraft 1.16.4: supported, but misses custom tridents
Minecraft 1.16.5: supported, but misses custom tridents
Minecraft 1.17.0: supported, but misses custom tridents
Minecraft 1.17.0: supported, but misses custom tridents
Minecraft 1.18.2: supported, but misses custom tridents
Minecraft 1.19.4: supported, but misses custom tridents and special melee damage sources
Minecraft 1.20.4: supported, but misses custom tridents and special melee damage sources
Minecraft 1.21.x and later: didn't exist at the time of writing this
Notes when using alongside ViaRewind
Players will only be able to see the right textures, if the resourcepack format of their client version is the same as the resourcepack format of the server version. The following versions use the same resourcepack format:
Minecraft 1.8 and earlier (Note: this resourcepack format misses required features and therefor can't be supported)
Minecraft 1.9 to minecraft 1.12 (Note: even though this plug-in can't be used on servers with minecraft 1.11 or earlier, players from minecraft 1.9 to 1.11 may be able to join and see custom textures if you use a minecraft 1.12 server)
Minecraft 1.13 and minecraft 1.14
Minecraft 1.15 and minecraft 1.16
Features
-Custom items with their own display name, lore, attribute modifiers and textures
-Custom tools with their own damage and durability
-Custom bows with their own damage, speed and durability
-Custom armor with their own armor value and other attribute modifiers, unfortunately without model texture.
-Crafting recipes that can use vanilla ingredients and custom items (or combined)
-Block & mob drops for custom items
-Custom containers (like a custom furnace, but much more powerful, unfortunately without block texture)
-Custom projectiles with custom wands to launch them
-Custom blocks (but still in beta)
Commands
- /customitems damage <amount> [player name] will decrease the remaining durability of the custom tool in the main hand of the target player (the player with name player name) by amount. If the remaining durability is smaller than (or equal to) amount, it will be destroyed. Only players with the customitems.damage permission can use this command.
- /customitems debug will let the plug-in do check for installation problems and send the results in the chat to the player who executed the command. Note that this command will not work if the installation is too bad. Only players with the customitems.debug permission can use this command. Note: if you use a big server resourcepack, this command can freeze the server for multiple seconds, so anyone with this command has the power to freeze the server by repeatedly using this command.
- /customitems encode will create a text representation of the item in the main hand of the command executor and put that in the server console. This can be used for complex crafting ingredients in the Editor. Only players with the customitems.encode permission can use this command.
- /customitems give <item name> [player name] [amount] to give the custom item with that name to the player with the given name (by default the player that executes the command). Only players with the customitems.give permission can use this command.
- /customitems list sends the names of all custom items to the player who executed the command. This can be nice for testing or when you forgot the name of a custom item. Only players with the customitems.list permission can use this command.
- /customitems reload will reload the config.yml and the current .cis file (or .txt file). Only players with the customitems.reload permission can use this command.
- /customitems repair <amount> [player name] will increase the remaining durability of the custom tool in the main hand of the target player (the player with name player name) by amount. This command will not repair the tool beyond the maximum durability (if current durability + amount is larger than the maximum durability, the durability will be set to the maximum durability). Only players with the customitems.repair permission can use this command.
- /customitems setblock <custom block> [x] [y] [z] [world] will place a custom_block at location (x, y, z) in world. Only players with the permission customitems.setblock can use this command.
- /customitems take [page] [target player] lets the target player take custom items from an in-game GUI. The page is needed when you have more than 54 custom items. By default, this command will use the command executor as target player and page 1. This command requires the permission customitems.take
- /kci playsound <sound> [x] [y] [z] [world] [volume] [pitch] plays the given custom sound at the given location (or the location of the command executor when no location is specified). If no volume or pitch is given, they will get the default value of 1
- /kci tag is a debug command that sends the NBT tag of the item in your main hand via the chat
When you put disableoutput between /kci and the rest of the command, you can disable command feedback/output, which can be useful for commands that are executed automatically.
Source code (programmers only)
Please 1.16
In reply to dranard_:
I forgot to update the list of supported versions. 1.16 is already supported, but has some problems. For instance, there is some bug related to custom diamond weapons and netherite.
Is it possible to give equipped armor a new texture?
(Not just in your inventory ... )
In reply to Forge_User_82321139:
This can be done, but will only be visible to players with Optifine. Currently, this requires quite some manual work, but I will try to change this in the near future. There is a tutorial/example in the discord channel on how this can be done for now.
In reply to knokko:
Nice ... thank you!
I'd like to make a food texture pack. Is it possible?
In reply to hozzap_foodman:
It may be in a future update but at the moment that is not possible. It is on the todo list though, so stay tuned.
Plz 1.9
I admire the plugin. really amazing but i want it to support version 1.9 please
In reply to raksodnus_:
It would be possible to support 1.9, but it requires a couple of annoying problems to be solved. This will take quite some time, which I don't have now. Also, you are the only one who ever showed interest in supporting this version, so other features will have much more priority than this.
Anyway, why are you on such an old minecraft version?
In reply to knokko:
Thank you very much, but I want the texture replacement service to remain. Can you provide this to me?
In reply to raksodnus_:
The texture replacement will remain because it's the only one that works for mc 1.13 and earlier.
But what are you thanking me for? I just said that it will take a long time before mc 1.19 will be supported, if it will ever be supported.
In reply to knokko:
You will struggle (effort) for that, so you deserve a thank you
Would it be possible to do a video tutorial? There is a YouTube named soulstriker who does very clean easy to follow plugin tutorials. I have created item sets and everything seems to be working without errors however when I use the give /customitems give command it says the item doesnt exist. Console only shows that it was an un recognized command. Also when trying to craft the item nothing happens.
In reply to magepals678:
If that is an unrecognized command, things don't seem to work at all. Show your console and show the part where the plug-in is being enabled. Or paste your full console log in the troubleshooter (the link at the end of the tutorial) and see what it can tell.
I currently do not have the microphone or time to record a youtube tutorial, but maybe someone else has done it.
In reply to knokko:
I found out the custom items file I was using was the 6.2 and editor was 6.5 so that fixed the item spawn and commands however I'm having trouble figuring out why it wont grab the texture now.
In reply to magepals678:
That is most likely an issue with the server resourcepack. My favorite host minepack is gone, so this process has become more difficult. What is the url of your server resourcepack now?
In reply to knokko:
I actually got it working. Took a few hours but it works. I do have a couple questions though. Is it possible to give the item(sword) an enchantment(fire aspect) without the enchantment effect on the sword? It makes the texture I made not look as good. Second I know you have mentioned block integration, do you have any idea when that will happen or if that's even a for sure update? I understand you're busy but that would be such an amazing integration. Thank you by the way for this amazing plugin. This changes my server completely.
In reply to magepals678:
I don't think you can give a sword fire aspect without the enchantment glow. And I encountered quite severe issues with custom blocks, so I will drop that, at least for now.
In reply to knokko:
Okay not a big deal. Is custom food going to be an addition?