Skip to content

KubeJS Tutorial - 1.20.1 ​

This is a KubeJS 1.20.1 content collection, including tutorials and projects.

Gu-meng

Gu-meng

Primary maintainer of the original docs

PickAID

PickAID

Main maintenance team for third-party docs

Direct link to this project on

Project source on

Project source on (content submissions are not supported on GitHub)

Project

About Writing Docs ​

Writing Requirements ​

  1. File and folder names should start with an uppercase letter.
  2. Every new file must be added to SUMMARY.
  3. Keep each document focused on a clear topic; avoid jumping between unrelated points.
  4. Keep wording simple and easy to understand. If a technical term needs a long explanation, put it in the Digression section.

About the Documentation Folders ​

  • KubeJS-Basics: Stores basic KubeJS content.
  • KubeJSAdvanced: Stores advanced KubeJS content.
  • KubeJSAddon: Stores KubeJS addon/integration mod content.
  • Digression: Stores useful topics outside of direct KubeJS code.
  • Texture: Stores assets resource content.
  • KubeJSProjects: Stores community project examples (folder path matches the contributor).
  • imgs: Stores images used in docs; paths map to where they are used (use absolute paths).
  • Code: Stores shared code.
    • Projects contains project example code.
    • This contains files used in tutorials.
    • You can also create your own category folders; folder names should match document names.

Documentation Rules ​

  • Tables in docs use three markers: -, ~, and ?. Here, - means none, ~ means to be edited, and ? means unknown.
  • Images must use absolute paths.

Open Source ​

This project follows . You may redistribute and use it, but please include the corresponding reference document link. You may not use this project content for commercial purposes.