KubeJS Getting Started

English | 中文

Getting Started

Requirements

• Skill Atlas for your Minecraft version.
• KubeJS for the same Minecraft version, plus everything KubeJS itself requires (Rhino; on 1.20.1 also Architectury).

Nothing else is needed. The integration ships inside the Skill Atlas JAR and turns on only when KubeJS is loaded.

Install Skill Atlas and KubeJS on both the server and the clients:

• Server scripts (kubejs/server_scripts) need KubeJS on the server.
• Dynamic cost quotes, script tooltip lines and navigation requests need the integration on the client as well.
• A client that has KubeJS can still join a server without it, and the other way round. The integration's network channel is optional, so a missing side never blocks the connection. Only the script features are unavailable in that case.

Script entry points

Name	Side	Folder
SkillAtlasEvents	Server event group	kubejs/server_scripts
SkillAtlas	Server global binding	kubejs/server_scripts
SkillAtlasClientEvents	Client event group	kubejs/client_scripts
SkillAtlasClient	Client global binding	kubejs/client_scripts

Server-side calls must run on the server main thread and only work on online players. Do not call them directly from async HTTP callbacks; switch back to the server thread with the scheduler of your KubeJS version first. Client calls must run on the game main thread.

Do not keep a SkillAtlas.player(player) helper across logouts or server reloads.

IDs

• Node, category and pool IDs: 1–64 characters, lowercase letters, digits, _, . and -. No colon.
• Choice group IDs follow the same rule.
• Item, attribute and effect IDs use namespaces, e.g. minecraft:diamond.
• Custom condition, reward and acquisition type IDs must have a namespace, e.g. pack:quest_gate.

Attribute IDs follow the target Minecraft version. For example, maximum health is minecraft:generic.max_health on 1.20.1 and 1.21.1, and minecraft:max_health on 26.1.2.

Migrating from the standalone addon

1. Remove the old skill_atlas_kubejs JAR from mods on the server and on every client.
2. Update Skill Atlas.
3. Keep your scripts. The bindings, event names and saved skill_atlas_kubejs sidecar data are unchanged.

If the old addon is still installed, Skill Atlas detects it, disables the built-in integration and logs a warning, so the two are never active at the same time. Remove the old JAR to switch to the built-in version.