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 magepals678:
It is planned to be added someday, but not soon.
In reply to knokko:
Sorry for another question but would it be possible to make it so the editor can pull all .png's from a folder rather than doing it per file? That would save loads of time for mass amounts of items.
In reply to magepals678:
Ok, I could add that someday. In the meantime, you should make sure your editor is in the same folder or close to the folder with the images (the filechooser always starts in the folder with the editor, so this should speed things up).
Is it possible to add a feature of not changing the armor icon i have to edit it manualy.
and is it possible to hide the dyed flag?
it ruins the immersion.
I think i Half Fixed the issue.
In reply to Forge_User_88942435:
Which armor icon? The texture you see when you have it in your inventory?
Regarding the 'Dyed', you might be able to hide it using one of the item flags (try them all and hope that one helps). If not, I'm afraid you can't do anything about it (except not using leather)
In reply to knokko:
yes if im using leather armor recollors i dont need to change the model files only the collor and stats. and the leather will just work.
but for chainmail, iron, gold and diamond this could be applied too if you have your own textures and just want it craftable.
I do still have a little issue, i cant add playerheads anywhere.
Would it be possible to use a playerhead as a item, block or helmet trough your recepie creation?
im almost done compressing all vanilla materials into leather, and adding Emerald, Netherite, and End armor in 1.15.2
if you'dd like i can share it here it could save people a lot of time if they want more armors too.
In reply to Forge_User_88942435:
Player head custom items are on the list of stuff to do, but have little priority because few people asked for it.
And I am curious about the armors you are making, so please share them!
In reply to Forge_User_88942435:
Ok i think i finished my initial version 5 additional armor tiers 3 new tool and weapon tiers.
While keeping the original items avalible in the game and craftable.
no additional plugins required altough i suggest to add whither skulls, dragon skulls and end crystals to a shop you need to kill a lot of bosses to make the the last 3 tiers of armor.
Disclaimer: i did not have the time yet to test everything if i made a error. you might need to change it yourself or w8 till i tested all stats.
The texturepack and cis+cisb+txt
The Excel sheet i used to keep info in one screen
feel free to use copy steal this pack, i only ask you improve on it :P
im getting this error msg in the server and im lost.
could you please help.
i tried creating a basic item in 1.5.2 i have the 2 plugins it needed installed.
and i have made custom items by hand before so i should not have done something stupid.
[18:32:53 ERROR]: Failed to load the custom item set plugins\CustomItems\world.cis
java.lang.IllegalArgumentException: Unknown item set encoding: 5
at nl.knokko.customitems.plugin.set.ItemSet.<init>(ItemSet.java:105) ~[?:?]
at nl.knokko.customitems.plugin.CustomItemsPlugin.loadSet(CustomItemsPlugin.java:110) ~[?:?]
at nl.knokko.customitems.plugin.CustomItemsPlugin.loadSet(CustomItemsPlugin.java:164) ~[?:?]
at nl.knokko.customitems.plugin.CustomItemsPlugin.onEnable(CustomItemsPlugin.java:67) ~[?:?]
at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:263) ~[patched_1.15.2.jar:git-Paper-176]
at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader.java:337) ~[patched_1.15.2.jar:git-Paper-176]
at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:483) ~[patched_1.15.2.jar:git-Paper-176]
at org.bukkit.craftbukkit.v1_15_R1.CraftServer.enablePlugin(CraftServer.java:470) ~[patched_1.15.2.jar:git-Paper-176]
at org.bukkit.craftbukkit.v1_15_R1.CraftServer.enablePlugins(CraftServer.java:384) ~[patched_1.15.2.jar:git-Paper-176]
at net.minecraft.server.v1_15_R1.MinecraftServer.a(MinecraftServer.java:487) ~[patched_1.15.2.jar:git-Paper-176] at net.minecraft.server.v1_15_R1.DedicatedServer.init(DedicatedServer.java:298) ~[patched_1.15.2.jar:git-Paper-176]
at net.minecraft.server.v1_15_R1.MinecraftServer.run(MinecraftServer.java:890) ~[patched_1.15.2.jar:git-Paper-176]
at java.lang.Thread.run(Unknown Source) [?:1.8.0_251]
PS: in your third screenshot you show collored leather armor.
heres a fix for your issue with it.<overlay.
In reply to Forge_User_88942435:
It looks like your Custom Items plugin is out of date... Are you using the newest version?
In reply to TechWizzart:
Ohh god i did do something stupid, You're completely right i ruined your time sorry.
no errors it should be working now THANKS!
hello i was wondering if theres a way for projectiles to cast potion effects when it hits a target? if not then i definitely think itd be a cool thing to add if possible. im having a surprising amount of fun running around and hitting mobs with my custom wand, thank you for contributing to my happiness. i cant wait to hit my friends when theyre on the server. in a bit more seriousness though this is a really fun plugin!! im using it on a private server with a couple friends and i plan on making a lil wand shop in our witch town. ill definitely have to think of more custom things to make to add to our little world. im already forming evil plans to make ridiculous items to torment my friends with
In reply to oosooc:
First of all, I'm glad you like it and impressive you understood custom wands without any help ;)
Second, I wonder why I didn't think about potion effects on projectile impact...
I will add that someday, but don't know when yet. In the meantime, you can use custom bows with on-hit target effects (those effects will be given to players hit by its arrows)
In reply to knokko:
the tutorials helped a lot! that and a bit of trial and error was enough for me to figure out. i think itd also be pretty neat to add a lil swoosh sound effect to wands but i have no idea how possible that is so its only an idea. also i noticed that the wands make the hoe sound effect still when you hit dirt with it, in case thats something you havent noticed. its not a big deal for me but its just something to note! good luck on your plugin making journey!!
In reply to oosooc:
Adding a sound for wands should be possible, nice idea.
Preventing the hoe sound for grass and dirty is probably not possible, but you can work around it by using shears as internal item type instead of hoes (but... well... that will give you a similar problem with the shearing sound)
In reply to knokko:
Wouldnt it be possible to use "carrot on a stick" for this and just replace that sound.
the item is not used much anyway or a wooden hoe that no one crafts.
In reply to Forge_User_88942435:
The carrot on a stick had other undesired side effects, but I don't remember it exactly. Probably due to pig follow behavior...
it seems don't support custom block textures? will you support it? and the editor can't use chinese normally,could you fix it?
In reply to like_wind484:
Blocks are a future feature, but not there yet.
I will look into Chinese characters, never tried it...
In reply to knokko:
ok,thank u