MajestikButter / regolith

Bedrock Addons compiler pipeline.

Regolith

• Regolith is an Add-on Compiler for the Bedrock Edition of Minecraft.

⭐ Visit the Website! ⇗ ⭐

• Much like bridge. v2, Regolith introduces the concept of a "project folder", where your addons are written, including the RP, the BP, and any models, textures or configuration files. This single-folder-structure is great for version control, and allows you to keep your "source-of-truth" outside of com.mojang.

• In the simplest case, Regolith allows you to "compile" (copy) your RP and BP from the project folder, into the com.mojang folder. During the copy, Regolith will run a series of "filters" on the files, allowing you to programmatically transform them as they are copied into com.mojang. This allows you to transform your addon non-destructively, and to introduce new syntax into addons.

🎫 Value Preposition

• Fundamentally, Regolith is nothing new. Many tools like this exist, such as the bridge v2 plugin system, or even something like Gulp or SASS.

• The value preposition for Regolith is that it allows many tools, in many languages and pay-structures to work together in a single, unified compilation flow.

• Hobbiests can use the Standard Library ⇗, or write their own filters. Marketplace teams can write proprietary filters, or internal filters.

💻 Regolith Development

🎚 Setup:

1. Install Golang

• Installation and beginners guide ⇗.

2. Install Dependencies

• go get -u ./... to recursively install all dependencies.

3. Run

• Run with go run .\main.go

🏗 Building as a .exe:

• You can build either with GoReleaser, or natively

1. Install GoReleaser

• go install github.com/goreleaser/goreleaser@latest

2. Build

There are a few ways to build:

• ./scripts/build-local.sh (¯_(ツ)_/¯)
• go build (creates a .exe file)
• go install (installs to gopath)

🧪 Running Tests

• go test ./...