KubeJS Wiki with Full Version

[MikihinaSann]

Your wiki was last updated 153 days ago. I would like to know when you will finish the Docs or in how many days it will be updated? Or what plans do you have for the future?

[ChiefArug]

The wiki was last committed to yesterday (abed77d).
The ETA for when it is done is the heat death of the universe, because KubeJS, like minecraft, is ever evolving and needs new documentation for new updates.

[MikihinaSann]

The wiki was last committed to yesterday (abed77d). The ETA for when it is done is the heat death of the universe, because KubeJS, like minecraft, is ever evolving and needs new documentation for new updates.

can i ask? https://kubejs.com/wiki/events/ServerEvents have any update? or it have fully complete in old version?

[denisJaved]

The wiki was last committed to yesterday (abed77d). The ETA for when it is done is the heat death of the universe, because KubeJS, like minecraft, is ever evolving and needs new documentation for new updates.

can i ask? https://kubejs.com/wiki/events/ServerEvents have any update? or it have fully complete in old version?

I cannot predict which PR and when they will be merged. By right now I'm starting to work on updated in events section.
You can see this changes even before PR is merged by visiting https://kubejs.com/wiki/preview/65

If PR won't be merged in long enough time I'd probably put my docs somewhere at StoryAnvil's wiki. I wil comment here if I'd do that

[RenPT23]

last updated 365 days ago ☠️ bro i just wanna know how to use ServerEvents.tick

[MundM2007]

How to use ServerEvents.tick:

ServerEvents.tick(event => {
  //Write any code here, for available methods see probejs, e.g. event.server to access more methods that have to do with the MC Server
})

[G4PLS]

Is there anything on this?
Because I feel like over 50% of the wiki is not finished at all.

I think a big step-up would be if we would know what is stored in an event like its done here: https://kubejs.com/wiki/events/ServerEvents/basicCommand
There the actual fields available are listed

It would also be nice to know what is stored in an Entity. When taking the link above event.player just says "Player Entity" but what exactly does that mean, what can I do with the Player Entity? Does it have functions, fields or other things?
If its just wrapping something it would be nice to have a link to the actual implementation so I can look up whats inside

As another example:

ItemEvents.rightClicked(event => {
    const player = event.player;
    const item = event.item;

    if (item.id === 'minecraft:firework_rocket' && player.isFallFlying()) {
        event.cancel();
    }
})

In the wiki I can see:

• There is a function called rightClicked which probably gets called when you right click with an item

Well thats it, dont really know anything else about the actual event as the page is not yet written.

I know its a lot and it keeps changing with minecraft updates but using the wiki currently is more guess work and google than actually using the wiki to look up how things work

[KonSola5]

It would also be nice to know what is stored in an Entity. When taking the link above event.player just says "Player Entity" but what exactly does that mean, what can I do with the Player Entity? Does it have functions, fields or other things?

The thing is - documenting KubeJS is hard, as in order to document KubeJS, you have to document hundreds of vanilla methods and dozens of commonly used Java classes in scripts.

You can preview my PR containing changes which aim to remedy this:
https://kubejs.com/wiki/preview/88
https://kubejs.com/wiki/concepts/entity/Entity

And you can see that already a lot of methods are documented, but these aren't nearly all the methods I'd deem "usable by scripters"

[G4PLS]

The thing is - documenting KubeJS is hard, as in order to document KubeJS, you have to document hundreds of vanilla methods and dozens of commonly used Java classes in scripts.

For me the biggest thing arent even the Java Classes etc, its the base structure like Events.

I know that its hard but I feel like that things like the Events should be doable as the event itself only contains so much entries. See the ItemEvents where the event itself just contains the player and the item.
Just knowing that it contains those two would be a huge step.

Just having a small example to functions would also help a lot.
Just as an example for removing a recipe (I know you can find this under Tutorials but why not add it to the actual remove page of ServerEvents.recipes as this is where I would expect it):

ServerEvents.recipes(event => {
    event.remove({output: "minecraft:iron_ingot"});
}```

Now I know to remove a recipe I call the remove method on the event. Now you add info for the overloads that are possible and the wiki already got A LOT better.

[KonSola5]

That is indeed a good point, though I will still work on documenting basic Minecraft types first as those are commonly used in scripts, and events currently have non-zero documentation.
Things like:
⁨Item⁩, ⁨ItemStack⁩, ⁨Ingredient⁩, ⁨SizedIngredient⁩,
Fluid, FluidStack, FluidIngredient, SizedFluidIngredient,
⁨Entity⁩, ⁨LivingEntity⁩, ⁨Player⁩, ⁨ServerPlayer⁩,
⁨Level⁩, ⁨ServerLevel⁩, Component (text components), DataComponentMap (data components)
NBT stuff like Tag, CompoundTag, etc.
⁨List⁩, ⁨Map⁩ (which encompasses most Java lists and maps)
All of these are exposed via events to KubeJS scripters.