-
Notifications
You must be signed in to change notification settings - Fork 0
Documentation
Shane Bee edited this page May 3, 2026
·
6 revisions
Due to the nature of how elements are registered in SKR, and the lack of Skript's syntax annotations, SKR has a built in Json Doc generator.
Tools such as the SkriptHubDocsTool will not generate docs for elements registered with SKR.
SKR's doc generation will generate docs to match SkriptHubs format.
This is simply how you generate docs.
They'll be spit out into your plugins data folder.
JsonDocGenerator gen = new JsonDocGenerator(PluginInstance, RegistrationInstance);
gen.generateDocs();Easiest way to generate is by creating a new command.
As showcased on the setup page, here is a simple way to create a doc generation command in your plugin's onEnable method.
registerCommand("my-addon", (source, args) -> {
if (args.length == 1 && args[0].equalsIgnoreCase("docs")) {
JsonDocGenerator gen = new JsonDocGenerator(MyAddon.this, MyAddon.this.registration);
gen.generateDocs();
}
});