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)
In reply to epicestgamerest:
That's quite weird. Could you send me your .cisb file?
In reply to knokko:
here
In reply to epicestgamerest:
The only thing that is overwritten is the crafting recipe, which is a bug you just found out! Thanks for finding this out, I will fix it soon.
In reply to knokko:
thanks!
In reply to epicestgamerest:
CustomItems 6.1 has been released and that version should not have this bug.
I tried Spigot 1.12.2 items worked but resource packs not working. I created model and texture. I installed it in the required places but it didn't work. do you make a tutorial video for plugin?
In reply to nitronik14:
There is a tutorial, but it is written (the link is almost at the top of this page).
And could you send me the resourcepack you are using? (Or just post its url if you use it as server resourcepack)
In reply to knokko:
Link Removed: http://www.mediafire.com/folder/e17hwxva4w2vj/epik
Link Removed: http://www.mediafire.com/folder/e17hwxva4w2vj/epik
I read tutorial but I couldn't find a title about the model
In reply to nitronik14:
It looks like your resourcepack somehow got corrupted: many occurrences of the 'i' character were replaced by '`y' or 'ı'. I don't know why or when this happened (maybe something in the editor or maybe some problem while uploading it?)
Could you check if the resourcepack is also corrupted on your computer? You can check by exporting again and opening up the resourcepack in your Custom Item Sets folder right after exporting, go to assets/minecraft/models/item and check if the names are correct. It should be 'iron_pickaxe.json' and not 'ıron_pıckaxe.json'.
If the name is correct there, it means something went wrong during uploading to mediafire. If you are lucky, it will work fine if you upload it again. If the name is already incorrect in the Custom Item Sets folder, it means that the editor seems to have issues with the 'i' character on your computer and will require more investigation.
Also, it seems that your models are not finished yet (for instance, 1 of them has a red handle, but no head).
In reply to knokko:
hey I fixed characters but not worked
In reply to nitronik14:
Those characters occur all over the place, not only in those 3 file names, but also within the files and in files on the other folders as well. When I fixed them all, your resourcepack worked for me.
Also, please try to check when the corruption happened (was it already corrupted or only after uploading?). And what happens when you simply export again?
In reply to knokko:
can you look "items menu" in editor
"Internal item type" problem is here item names not correct. and I tried export problem is same
look names: https://prnt.sc/qmbqeu
In reply to nitronik14:
That's quite fascinating, I have never seen that before! It looks like an incorrect conversion from upper case to lower case happened in the editor. I never realized until now that such functions behave differently depending on the country in which the computer is located... (which is why I never had this problem myself)
I will improve this soon. Until then, you can only use internal item types that do not contain a lower case 'i' (so pickaxes won't work until then).
In reply to knokko:
thanks for information, I am waiting for new update :)
In reply to nitronik14:
Editor 6.1 has released, which should no longer have this issue (unfortunately, it's hard to test for me, so I'm not absolutely sure).
In reply to knokko:
thanks it is working perfectly.
Do you plan to add 1.8 - 1.11 version support? (editor and plugin)
In reply to nitronik14:
1.8 uses an old resourcepack format that lacks the required features, so I can't support it. Also, this version is pretty ancient by now and thus doesn't deserve so much attention. I don't understand why people still use this version since there are plug-ins for old combat mechanics anyway.
1.9 to 1.11 could be supported with some effort, but these versions are quite old and rarely used as far as I know.
In reply to knokko:
I have viaversion. some players playing different version. I think to support them all
In reply to nitronik14:
Which resourcepack is required depends on the minecraft version the players are using. Since 1.9.x up to and including 1.12.x use the same resourcepack format, you can support everyone who uses one of those versions by just using the resourcepack for minecraft 1.12.
Minecraft 1.8.x and older use an older resourcepack format that lacks required features, so they simply can't be supported.
I use spigot1.14.x, can't I select diamond or block by type from item?