KubeJS Offline Documentation

KubeJS Offline is a mod that dumps all class data at runtime into a single html file using a single command - /kubejs_offline.

To provide dynamic javadoc-like documentation for use with KubeJS scripts.

The reason we can't just use the javadoc tool itself is because every user who makes a modpack uses different mods, and javadoc is intended for use with the source code of the mod itself.

Therefor we need to generate this information at runtime.

When you execute the KubeJS Offline command, a scan of the Java runtime is performed to find what classes exist at that time. This is important as mods might provide new event classes and possibly new methods to existing Minecraft classes.

After the mod has searched what classes exist and are available at that time, it then proceeds to compress that data down into a json object.

This data is then used to create an HTML page which then runs dependency-less JavaScript to generate simple html content.

You can then open the file in any modern web browser. No file hosting or additional installations required!

Can't remember the name of that event? What was it again? Something about food? Was it a player event? Or an Item Event?

Well, using the Global Bindings section on the homepage, simply expanding the list, and search for the event.

Just like that, ItemEvents.foodEaten is found.