Skip to content
DauntlessStudio edited this page Apr 17, 2024 · 10 revisions

Bedrock-Development Wiki

This wiki provides in-depth documentation for the bedrock developments package. It focuses on two main sections, the CLI and the API.

CLI

The CLI can be used via npx or by installing the package globally with npm i bedrock-devlopments -g. It provides quick access to many API features, such as quickly creating entities, items, worlds, or large edits to entity files.

Generally the CLI is either used to create files from a template (using reasonable defaults and placeholder assets), or to make uniform changes that would be tedious by hand (i.e. adding a new component group or property to every entity).

API

The API can be used for more advanced automation. If you need to create a custom dialogue scene for every entity that has the "npc" family type with unique buttons and text, the API provides all the tools needed to accomplish that.

When working with the API you'll either modify existing files, a process that involves using getFiles, passing those files as a parameter to your Minecraft Type class, making whatever edits are needed, then writing the files back with setFiles. Or you'll be creating new files, in which case you can create a Minecraft Type class from a template, make your changes, then write the files with setFiles.

Clone this wiki locally