Allows custom content like armors and items to be added to Minecraft servers in a server-sided way, so that clients don't need to add client side mods (only a resource pack).
Very experimental and new, lacking many features.
The current dev branch (0.8.0) is still missing some features/has regressions compared to v0.7.2, which will be fixed before the full launch.
Add the release jar as a plugin on your server, and as a dependency for your new plugin (see below for more info).
Recently, the plugin has been re-written to only support Paper. Along with this, the modding system has been completely rewritten. Mods for v0.7.x and v0.8.x are not compatible in any way.
If you are still using Spigot, or are using older Paper versions that don't support the component API, you can use the 0.7.x versions. Note that 0.7.x versions are not supported and will not receive bug fixes.
| Platform | Minecraft Version | NetherReactor Version |
|---|---|---|
| Spigot | 1.18.2+ | v0.7.2 |
| Paper | 1.18.2-1.21.3 | v0.7.2 |
| Paper | 1.21.4+ | v0.8.0 |
I'm working on replacing this with a wiki. The guide below was written for v0.7.x.
Javadoc (for an outdated version, sometime around v0.5.x)
Currently, items can either be a regular item, a consumable, or a custom armor piece (custom armor covered in the next section).
For a regular item, extend the ModdedItem class and create a default constructor with a namespace, item id, material, and display name:
(Example for an item named TinSword)
public ModdedItemTinSword()
{
super("ultraswords", "tin_sword", Material.IRON_SWORD, "Tin Sword");
}Optionally, you can put an integer argument after the display name argument to add that number as custom model data for the item.
If you wish to make your custom item a consumable, the code is similar, but you need to extend ModdedConsumable and override the onConsume(PlayerItemConsumeEvent event) method
@Override
public void onConsume(PlayerItemConsumeEvent event)
{
Player player = event.getPlayer();
player.addPotionEffect(new PotionEffect(INCREASE_DAMAGE, 60, 0), true);
}Just as with regular items, custom consumables can also have a custom model data argument.
Custom tools and weapons do not have a class, so custom durability and damage does not exist However, you can "create" damage by using events
@Override
public void onAttack(EntityDamageByEntityEvent event)
{
event.setDamage(...);
}Custom armor is a bit more complex to set up. To begin, create your armor piece item classes. These should inherit from ModdedArmorPiece. Next, for each armor piece, create an ArmorChoice object. The constructor takes in an array of ModdedArmorPiece objects. An empty array means that no armor pieces are accepted for that slot while a null array means that all wearables are accepted. Finally, create a subclass of ModdedArmorSet and pass in an ArmorChoice array beginning with the helmet object and ending with your boots object. If you wish, you can override the public void onTick(Player player) method to do things like give resistance to wearers of the set.
NOTE: if your armor set does not require some slots, put those slots as null in your ModdedArmorPiece array.
To register your custom items and armor sets, the NetherReactor#registerMod method can be used. This method takes a Mod object. Its constructor takes in a namespace, display name, and an API version. The Version class has two constructors: int major, int minor, int patch, String releaseData or int major, int minor, int patch, which uses "release" as the releaseData.
Registration example (with the steel armor set from above):
import me.mythicalflame.netherreactor.content.Mod;
import me.mythicalflame.netherreactor.utilities.Version;
...
Mod mod = new Mod("morearmors", "More Armors!", new Version(0, 7, 0));
mod.
registerItem(new ModdedItemSteelHelmet());
mod.
registerItem(new ModdedItemSteelChestplate());
mod.
registerItem(new ModdedItemSteelLeggings());
mod.
registerItem(new ModdedItemSteelBoots());
mod.
registerArmor(new ModdedArmorSetSteelSet());
NetherReactor.
registerMod(mod);Dev version, migration to paper and API rewrite
Custom block support and world generation stuff
Custom entities