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 aalljkhhd:
It looks like you are asking the same questions twice: both here and on Github. Please use only 1 of the 2. (My response time won't change, but I get more notifications than needed.) I already answered it on Github.
Hello, how can I use custom permission for crafting an item ?
In reply to Holo795:
Not yet. This might be added in the future, but probably not very soon.
does mending working on that custom durability ?
In reply to djigsaw68:
Yes
I am not being able to make a custom container, could you make a video about it?
I got both the editor and plug-in and put them in the plug-in folder. I also received the cores and installed three in the plug-in folder, but I can't do it because I don't know the command to run the GUI.
In reply to 슈온:
There is no command to run the GUI because the Editor is not a minecraft plug-in, but a desktop application.
See the text or video tutorial (at the top of this page) for more details.
Can you add food type to internal item type?
For example, apples, golden apples, beef
In reply to gmrdhc:
No unfortunately we need the internal item types to be tools, otherwise we could not make custom items. Custom food is in the works, but those will also have tools as internal item type. Internal item type will not be seen by the outside world, they are internal for the resourcepack and plugin only, they will appear as what you have configured them to be to everybody.
I have a 1.16.3 server but the plugin doesn't work Solution??
In reply to gamerxmatti:
Unless you give more information (server console logs, try https://knokko.github.io/custom items/troubleshooting.html ), I can only guess what the problem is. In this case, I think (but this is just a guess) you can solve it by upgrading your server to minecraft 1.16.4. Alternatively, you can use KnokkoCore for mc 1.16 v3 instead of KnokkoCore for mc 1.16 v4.
In reply to knokko:
I do all the steps mentioned in the tutorial but I don't load the resource pack (I used a netherite item)
In reply to gamerxmatti:
If you post the resourcepack url here, I can take a look.
In reply to knokko:
Ok
https://www.dropbox.com/s/101dcsohqu6f96r/obsidian_set.rar?dl=1
In reply to gamerxmatti:
That is just a RAR containing some files. You need to use the resourcepack made by the editor. It should be a ZIP file in your Custom Item Sets folder (next to your .cis and .cisb file).
In reply to knokko:
Ok here is the Custom Item Sets
https://www.dropbox.com/sh/3rx6cg2teubsyxs/AACwgIJqeQFkyVv9XcYq5auCa?dl=0
In reply to gamerxmatti:
Ok, it looks like half of the files that are supposed to be in that folder, are missing. Unfortunately, these missing files include the log files and your resourcepacks. I have seen a similar problem once before, which was when the Avast anti-virus bocked the Editor. Briefly turning off your anvi-virus right before clicking Export might resolve this problem. (And enable it once you have the resourcepack.) Also, did you see any red messages on top of the Editor window upon exporting?
Hi its great plugin, but is there a way to take custom item from player? I mean something like command to just take 1 item from specific player. I want to use it with deluxemenus to make very basic shop and it will probably need command like this: /ci take (item) (amount) (playername).
In reply to Forge_User_66689104:
There is no command to do that, but vanilla commands with complex nbt tags/filters may do the trick. Also, depending on what kind of shop you are making, custom containers might do the trick (unless there is really a shop owner that gets the traded items).