Skip to content

Documentation Skeleton #1

@ThePansmith

Description

@ThePansmith

This issue will serve as a "skeleton" of what the documentation plans to look like, along with some minor notes for what each page would have.
Of course, nothing is final (feel free to leave suggestions), but this is a good starting point for those looking to contribute.

If you wish to start work on a page, please create a draft PR.

Introduction
  • Introduction landing page

  • Getting started

    • Introduction and Installation
    • Your First Scripts
    • Tags
    • Your First Mechanic
      • Demonstrate that KubeJS does more than recipes, and can check and act upon other events types.
      • Conditional statements
      • Show example(s) of running a command as well
  • Saving time

    • Regex and KubeJS
      • Touch on the basics of regex, and it's various applications in KubeJS
      • Link to an offsite regex resource for those wanting more info on everything regex can do
      • Mention regex groups
    • Loops and Functions
      • Maybe mention recipe schemas here, go into detail later.
      • Maybe merge this one with the above article?
    • Helpful Mods
      • Mods helpful to a packdev for saving time, such as ProbeJS and AlmostUnified.
      • Maybe mention some of the (modid)JS mods, but also mention that most of their behaviors can also be done via eventcustom and schemas.
  • KubeJS and Datapacking

    • Custom Recipes
      • event.custom can be used to add recipes to (nearly) every mod
        • No need for addon mods or manual JSON files
        • Talk about recipe schemas
    • JsonIO
      • KubeJS can write JSON files
      • Useful when combined with functions
      • Mention high and low priority data
    • Loading Data with KubeJS
      • Other datapack data goes in minecraft\kubejs\data
      • Same idea for resources
      • Maybe mention loottables?
  • Advanced Functions

    • Attribute Modification
      • Just go into the basics — the rest will be covered by the rest of the docs
    • Reflection
  • Finishing touches

    • Changing Window Title and Icon
    • Localization
      • KubeJS' role in it, Weblate/etc
Events - [ ] BlockBuilder - [ ] ItemBuilder - [ ] FluidBuilder - [ ] The other recipe types - [ ] ( Other stuff)
Examples Some useful examples. If an article you are writing could benefit from one of these, feel free to use it there

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions