Guides

Guides are the recipes and dictionary of the engine. Recipes solve one concrete problem each; reference pages list the exact names of things. Read the page for the task you are doing and follow the steps. You do not need to read them in order.

Recipes

Registration

• Add an item: register a new item with a texture.
• Add a block: register a block with properties.
• Add a recipe: shaped, shapeless, or smelting recipes.
• Add a sound: a sound with a subtitle and range.
• Add a particle: a keyframed particle effect.
• Add a command: register your own / command.

World

• Create an area: define a spatial zone with enter and leave modules.
• Set a waypoint: place a persistent marker.
• Gate content with stages: block items, mobs, and recipes behind progression.
• Run a dialogue: start a dialogue tree from a command or event.
• Add screen effects: apply a post-processing effect.
• Build a game session: start and stop a session on world load.

Editor

• Use the explorer: browse server files and game resources.
• Validate your scripts: find Groovy errors before executing.
• Use the code editor: autocomplete, colorizers, and tabs.
• Themes and shortcuts: change the look and bind hotkeys.

Packaging

• Generate data: produce JSON from your bundle scripts.
• Run a dedicated server: load bundles on a server.
• Reload in game: pick up script changes without restarting.
• Distribute a bundle: hand your bundle to other players.

Lookups

Getting oriented

• Glossary: plain-language definitions of every term the docs use.
• Bundle metadata: every field in *.bundles.toml.
• Entrypoint lifecycle: the BundleEntrypoint interface and the load events.

Builders

• ItemBuilder: register items.
• BlockBuilder: register blocks.
• RecipeBuilder: shaped, shapeless, and smelting recipes.
• SoundBuilder: register sounds.
• ParticleBuilder: register particle effects.

Events

• BundleEvents: registration-time events.
• PlayerEvents: player actions such as joining, ticking, and breaking blocks.
• BlockEvents: block-level events.
• StageEvents: stage adding and added.
• CommandEvents: register commands.

Everything else

• Managers: the managers you reach through Common, such as getAreaManager().
• Engine commands: the /engine command suite.
• Config: the Common, Startup, Client, and Server config options.
• Editor panels: editor panels and default hotkeys.