KubeJS Offline Documentation: Your Local Guide to KubeJS Events, Types, and Properties
If you’ve ever scripted a modpack with KubeJS and thought, “I know an event exists for this… but what’s it called, and what data does it expose?”, you’re not alone. KubeJS is powerful across modern Minecraft versions, but its flexibility can turn into tab-hunting: events, contexts, properties, and type hints scattered across wikis, GitHub pages, and memory. That’s exactly the pain KubeJS Offline Documentation is built to solve.
Instead of forcing you online every time you need a method name or a field type, this mod generates a single offline HTML file containing type-related data you can reference while you craft scripts, tweak mechanics, and iterate on your pack. Think of it as a locally generated “encyclopedia” for your KubeJS environment—fast to search, easy to keep nearby, and tailored to the exact loader/version you’re playing.
What the Mod Actually Generates (and Why It Matters)
KubeJS Offline Documentation aims to centralize the information scripters repeatedly need: event lists, event classes, and the properties available on each event. In practice, that means fewer trial-and-error reload cycles and less guessing when you’re handling gameplay changes like custom recipes, loot tables, tags, block interactions, or player-triggered mechanics.
Because Minecraft modded ecosystems differ by loader and version, the mod’s “offline file” approach is especially useful when switching between Forge and Fabric, or when maintaining multiple packs across 1.18.2, 1.19.2, and 1.20.1. The data you see reflects the environment you generated it from, which helps avoid those frustrating moments where a property exists in one setup but not another.
Key advantages for pack dev and scripting workflows
- Single-file reference: One HTML document you can keep open while editing scripts.
- Event discovery: Browse events instead of relying on half-remembered names.
- Property clarity: See what an event exposes before you write logic around it.
- Version awareness: Cleaner transitions between Minecraft updates and loaders.
Getting Started In-Game: Generating the Offline HTML
Setup is refreshingly straightforward. Load into a single-player world (creative is fine if you’re just testing), then run the command that kicks off the documentation generation. Once completed, the mod outputs the HTML file into your KubeJS folder structure automatically, so you don’t need to craft a datapack, add extra configs, or install a separate documentation tool.
Steps to generate your documentation
- Enter a single-player world: Any world works; a fresh test world is often easiest.
- Run the command: Use /kubejsoffline to begin generating the docs.
- Find the output file: The HTML appears in /kubejs/documentation after a successful run.
- Open it quickly: When generation finishes, you can use the chat link to open the file.
After that, it becomes part of your normal dev loop: edit scripts, reload KubeJS, test mechanics, and keep the offline HTML open for quick lookups. It’s the same “keep your recipe viewer open” habit many players use with JEI/REI—just applied to scripting knowledge.
Using the Offline Docs Like a Pro
The real win is how the offline file changes your decision-making while scripting. When you’re designing progression gates, server rules, or custom automation, the difference between a smooth implementation and a broken one is often a single property name or an unexpected type. Having a searchable, locally generated list of events and their available data helps you write confidently.
Common ways scripters put it to work
- Recipe and crafting overhauls: Validate event contexts while adding shaped, shapeless, or custom machine recipes.
- Loot tuning: Confirm what loot-related events expose before you rewrite chest tables or mob drops.
- Block and item mechanics: Quickly check interaction events when building custom tools or block behaviors.
- Debugging: Compare what you expect an event to contain versus what it actually provides.
Loader and Version Notes: Forge vs Fabric, 1.18.2 to 1.20.1
KubeJS modpacks often live through multiple Minecraft updates, and the scripting surface can shift as dependencies change. KubeJS Offline Documentation is designed with that reality in mind: generate docs for the specific instance you’re running, and you’ll get the right set of events and types for that environment. If you maintain separate profiles for Forge and Fabric (or for different biomes-and-worldgen-focused packs), generate a fresh HTML per profile so your reference stays accurate.
Also, treat the offline HTML as a snapshot: if you update mods, swap loaders, or jump versions, regenerate. It’s a quick operation compared to the time you’ll save avoiding mismatched event data.
Troubleshooting and Practical Tips
If something feels off—missing entries, outdated-looking data, or an event you expected not appearing—the simplest fix is usually to regenerate after confirming you’re in the correct world and instance. Keep an eye on whether you’re testing in the same profile as your real pack, since different mod lists can affect what types and integrations show up.
- Regenerate after updates: New mod versions can change events and exposed properties.
- Use a dedicated test world: Faster iteration when experimenting with scripts and mechanics.
- Keep docs with your project notes: The HTML pairs well with changelogs and script folders.
Conclusion: A Small Utility That Speeds Up Every Script
KubeJS Offline Documentation doesn’t try to replace your editor, your logs, or your in-game testing—it simply removes the constant friction of “where do I find the right event and property list?” By generating a single HTML reference tailored to your exact Minecraft version and loader, it helps you script faster, debug smarter, and spend more time polishing gameplay instead of hunting definitions. If KubeJS is part of your modded toolkit, having a reliable offline reference can quietly become one of the most impactful quality-of-life upgrades in your entire workflow.
--- **Update Jul 4, 2026:** Added 1 file for version 1.21.1, 1.21 (NeoForge).