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 bellcocoa:
What exactly do you mean by:
The plugin should work using Spigot 1.14.x. Do any errors show up in the console?
In reply to bellcocoa:
I think what you mean is that you have very little choice of items as 'Internal item type'. The 'Internal item type' must be a tool (a technical restriction). It won't have much effect though since you can choose your own texture and you can configure most properties yourself.
Regarding blocks, they are currently not supported, so you can't add custom blocks currently.
This is a great looking plugin, but I followed the tutorial and it doesn't work. Could someone help me out? (using 1.14.4)
In reply to Enderwoopie:
I will need more info than just "doesn't work". Please answer (all) the following questions:
-What do you see when using /plugins ?
-What do you see when using /customitems list ?
-Any errors in the console?
-Is there any message in the console confirming that the plug-in even loaded?
hey man i love you plugin but the editor is missing some items as far as i know, the phantom membrane and the turtle items are missing so no recipes with those :v try to updatet hat when you can i woulkd be very greatful but i just love your plugin <3 keep on
In reply to Forge_User_70247725:
Currently, the plug-in only has the items of minecraft 1.12 (it was designed for that minecraft version). The later items will be added soon if I have more time (otherwise it will take longer)
This plugin is great and works perfectly for my server, but is it possible to use a 3D texture for my custom items?
In reply to Forge_User_95362066:
Until now, I didn't even know 3d textures existed, so I don't think you can.
All you can do now is supplying an item model (as a single .json file) and an item texture (as a single .png file). If that is all you need, you are good to go.
I am planning to look into it, but I don't know if and when I will add support for it.
this plugin looks great but I can not use it because I am in 1.13.2. Can you put the 1.13.2 plugin thanks
Sincerely borender
In reply to Forge_User_13103582:
It looks like you can use it in minecraft 1.13 by using the Knokko Core for minecraft 1.14. This plug-in itself works at least for minecraft 1.12 and 1.14, but it also seems to work for some other versions like 1.13.
When using the editor, you should use 'Export for 1.14' instead of just 'Export' because minecraft 1.13 shares resourcepack format with minecraft 1.14.
But please test carefully if everything you need works because I haven't tested for minecraft 1.13 myself (I don't have time to test for every single version).
Hi. I'm having troubles with your plugin. Ok I currently made
a full set of emerald tools and armor. The emerald sword works however the tools don't work and aren't craftable and were exported for both versions either version didn't work. Im currently using your latest up to date knokkocore and plugin. Nothing seems to work the cis files are all the CustomItems folder and I have combined all texture packs and they don't work. The code seems to be same in the json all the files are in their place and everything seems to be fine in the texture pack. How do I fix this? If you would like you can add me on discord and I can show you my screen.
In reply to samthe9yearold:
If I read your post, it looks like you created multiple item sets (one for each item?). You generally should have 1 item set per server (I must admit I have not been clear about it and you are not the first one to encounter this). You should add all items in the same item set and put the single .cis file into the plugins/CustomItems folder.
In case I misunderstood and you only have 1 item set, please add me on discord, I'm knokko#7163.
In reply to knokko:
Question. How do you put all cis files into one single cis file?
In reply to knokko:
In reply to knokko:
Oooh I see what I did wrong now. How do I fix this?
So wait I can't create multiple item sets?
What if I also want a bedrock sword?
Would I just have to make it in the same item set?
In reply to samthe9yearold:
You should add everything to the same item set indeed, so just add your bedrock sword to the emerald sword set.
To fix your current emerald set, the easiest way is probably to just add them all to the set with your emerald sword. Here, I assume that you only have 5 items at the moment, which will probably only take several minutes to fix.
If you have really many items, you could also wait because an item set combiner is somewhat high on the priority list of new things to add. (It would be good for re-usability of item sets.)
By the way, you won't have to combine resourcepacks again because the editor will do it for you once you have everything in the same item set.
In reply to knokko:
Alright I did everything you asked it still didn't work. None of the recipes work now not even the emerald sword one.
Hello!
I have a question, hopefully you've got the answer to it.
I'm using your plugin in an Aternos server at the moment and I'd like to ask if the items I make will be seen by the plugin even if they were in the Aternos server while the items I created on my PC. Not sure how it works. I feel super dumb atm.
EDIT: and if there's ever a small chance, will you create an item creator inside the game? This question might seem absolutely moronic but I have high hopes for your plugin. Best wishes!
In reply to asijuu:
It looks like you would like the item set on the server to update when you save changes to the item set on your pc using the editor. This would require both the item set on the server to update dynamically as well as the server resourcepack. Updating the item set on the server dynamically could be done, but is a little complex.
However, I'm afraid it will be much harder to update the server resourcepack like that (this is not handled by the plug-in directly). Also, all players on your server would have to update their resourcepack in game, which could be quite annoying (they can't do anything for several seconds).
Personally, I don't know that much about server resourcepacks, so I can't implement quickly. I might implement this in the future, but other things have more priority.
With this plugin you make all my dreams true, the editor is easy to use, and easy to apply in the server, I only have a problem with it, I know that the design is not too important, but I think that if the editor have less colors, and a font a little bit small, will increase a lot the experience of use it.
Thanks for the plugin.
In reply to Forge_User_07974258:
Designing menus properly takes surprisingly much time and there are surprisingly many menus in the editor (when I start counting, it quickly adds up). So it would take too much time to improve the design of all menus (especially designing where to put everything). Especially since that same time could be used to implement the next features (currently custom damage reduction for armor, mob & block drops, shields and item models).
Luckily, the colors and fonts are defined in a small number of files, so they can quite easily and quickly be changed. Do you have any suggestions which colors to change and to what? And where the font sizes should be decreased? (Or are there menus in particular that need attention?)