In this wiki you will find simple guides to make your own mods compatible with Copper Overhaul, or if you want to, make an addon for it.

How to make an armor set of your mod conductive

• Making an armor set conductive so players can get magnetized while using it is really easy. All you have to do is tag every armor piece with the "forge:metallic" tag.

How to make a block conductive

• If you want to make conduits from a block from your mod (or any other), it is as simple as the armor. The only difference is that you have to tag the block(s) with the "forge:conductor" tag.

Making your blocks lockable

• This is experimental, and only blocks that have entity blocks enabled (ex. Chests, shulkers, any container) should be added to avoid bugs. Copper Locks use 2 layers of protection, the first one is via the mod, which cancels all interaction with the player, and the second one is the vanilla "Lock" tag, which makes the inheritation process easier. So only blocks that are compatible with the vanilla lock tag will work as they should. Though most blocks shouldn't have issues.

To make them lockable, you just simply have to add them to the tag "copperoverhaul:lockable". This may be done through a mod or a datapack.

Integrating armor mechanics

Creating the texture

• If you want to create a texture for your item quickly, you can use the Photoshop template included in this repository.

Note that this template is designed for vanilla-like textures. You might need to edit it if you use a different style.

Enabling the lightning mechanics

Creating the upgraded chestplate item

• Make a new armorset with only a chestplate.

Enabling the mechanics

• Add it to the "copperoverhaul:lightning_armor" tag. Copper Overhaul will handle the hard part for you.

Defining the maximum energy.

• Define a number NBT tag (double) named "maxEnergy" which will define the max energy stored in the armor (in kW).

It is recommended to use a gamerule or a configurable variable for this value, so players/server admins may customize it if they want to.

Adding Copper Overhaul as a dependency (Optional)

• Optionally you can add Copper Overhaul as a dependency to avoid confusion. For that you would need to edit your mods.toml file and add Copper Overhaul as dependency.

In case you are using MCreator to make the addon, you can use the "External APIs" option.

Making the energy values visible in item lore

• The energy values are handled via NBT tags. You can add them into your UpgradedArmorItem.java file inside the chestplate class.

If you are using MCreator you will need to lock the code of the armorset and replace the pregenerated code with this one.