Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
retr0cube committed Nov 15, 2021
1 parent 97df704 commit 06ef74f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
<h1 align="center">Regolith</h1>

![Image](https://bedrock-oss.github.io/regolith/assets/images/logo.png)

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

<p align="center">
<bold>
⭐ <link href="https://bedrock-oss.github.io/regolith/">Visit the Website!</link> ⭐</bold>
⭐ <a href="https://bedrock-oss.github.io/regolith/">Visit the Website!</a> ⭐</bold>
</p>

- 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.
- 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

Expand Down

0 comments on commit 06ef74f

Please sign in to comment.