Example KubeJS Addon

1.21.1 NeoForge

Basically just a quick mod template for KubeJS Addon Mods. I got annoyed setting up new mods for Kube so often, so thats why I made it. Yeah, I'll add more versions later. If you're looking to learn how to make a KubeJS Addon, well you're not really in the right place, but I'll help you with the basics.

• Uses ModDevGradle - 1.0.17
• MC Version 1.21 - NeoForge 21.1.12 🔨️
• Kube Version - 7.0-build.131 🟪️

Basic how-to

1. Download the Mod

• You can use this repo's Template feature to make a new repo for yourself, or you can clone it using your terminal:

git clone --branch minecraftversion https://github.com/FooterManDev/ExampleKubeJSAddon

minecraftversion being 1.20.1, 1.20.4, 1.21, etc, plus modloader. This repo has 1.20.1, 1.20.4 and 1.21.1 branches.

Alternatively if you use an IDE that supports generating projects from templates, you can clone it that way.

After cloning, you can remove the .git directory from the mod to initialize your own Github repository.

2. Open with your favorite Integrated Development Environment (IDE)

• For IntelliJ IDEA, open the cloned mod folder, and IDEA should automatically generate run configurations. Alternatively you can run gradle task runClient to start the game.
• For VSCode, you have to open the cloned mod folder, I am unsure if runs are automatically generated or require manual creation. You can run gradle task runClient to start the game.
• For Eclipse... yeah I have no idea.

For newbies

I assume you have come across my repo to make a quick addon mod for Kube. Here's how KubeJS integration is set-up:
In this mod, there is a class here: ExampleKubeJSPlugin
This is the Plugin class. There you will apply your KubeJS integrations. I will eventually make a Wiki for working with KubeJS in a Mod. I do not recommend reading KubeJS's README, due to it being outdated past 1.19.
You have to register your Plugin to Kube, otherwise nothing will happen. To do this, get your Plugin Class's full path (For example, com.example.exampleaddon.kubejs.ExampleKubeJSPlugin), and add it to the kubejs.plugins.txt file.

Common issues!

Plugin doesn't register with Kube?
If you're unsure if your Plugin is not registering with Kube, you can go to the run directory, and open Kube's startup.log, located at /logs/kubejs/. If your Plugin doesn't show up there, it didn't register. A common reason for this, is you used slashes (/) when adding your plugin to kubejs.plugins.txt. This doesn't work, use periods (.) instead.
If that's not the issue, check the console in your IDE for errors.

---

Alright, now go play with KubeJS.