Updated the documentation.

Bedrock-OSS · Aug 21, 2024 · ca46b52 · ca46b52
1 parent 263bedb
commit ca46b52
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 25 deletions.
diff --git a/docs/docs/guide/configuration.md b/docs/docs/guide/configuration.md
@@ -76,6 +76,7 @@ Example config, with many options explained:
         // Export target defines where your files will be exported
         "export": {
           "target": "development",
+          "build": "standard",
           "readOnly": false
         }
       }

diff --git a/docs/docs/guide/create-a-filter.md b/docs/docs/guide/create-a-filter.md
@@ -48,6 +48,7 @@ At this point, you need to edit your `config.json` so that `giant_mobs` is regis
         ],
         "export": {
           "target": "development",
+          "build": "standard",
           "readOnly": true
         }
       }

diff --git a/docs/docs/guide/export-targets.md b/docs/docs/guide/export-targets.md
@@ -29,11 +29,12 @@ These are the export targets that Regolith offers.
 
 ## Development
 
-The development export target will place the compiled packs into your `com.mojang` `development_*_packs` folders.
+The development export target will place the compiled packs into your `com.mojang` `development_*_packs` folders of the specified Minecraft build (standard, preview or education endition).
 
 ```json
 "export": {
-    "target": "development"
+    "target": "development",
+    "build": "standard" // or "preview" or "education"
 }
 ```
 
@@ -42,6 +43,7 @@ Optionally, you can use `rpName` and `bpName` to specify the names of the folder
 ```json
 "export": {
     "target": "development",
+    "build": "standard",
     "rpName": "'my_rp'",
     "bpName": "'my_bp'"
 }
@@ -91,13 +93,14 @@ The exact export target doesn't support using `rpName` and `bpName`. The `rpPath
 
 The World export target will place the compiled files into a specific world. This is useful for teams that prefer working in-world, as opposed to in the development pack folders.
 
-You need to use *either* `worldName` or `worldPath` to select the world. `worldPath` supports environment variables by using the `%VARIABLE_NAME%` syntax.
+You need to use *either* `worldName` or `worldPath` to select the world. `worldPath` supports environment variables by using the `%VARIABLE_NAME%` syntax. If you use `worldName`, you have to specify the Minecraft build you're using - `standard`, `preview` or `education`.
 
 Example:
 
 ```json
 "export": {
     "target": "world",
+    "build": "standard",
     "worldName": "..."  // This
     // "worldPath": "..."   // OR this
 }
@@ -114,26 +117,6 @@ Optionally, you can use `rpName` and `bpName` to specify the names of the folder
 }
 ```
 
-
-## Preview
-
-The development export target will place the compiled packs into your **(minecraft preview)** `com.mojang` `development_*_packs` folder.
-
-```json
-"export": {
-    "target": "preview"
-}
-```
-
-Optionally, you can use `rpName` and `bpName` to specify the names of the folders that will be created in the `development_*_packs` folders. You can read more about these options at the end of this page of the documentation.
-```json
-"export": {
-    "target": "preview",
-    "rpName": "'my_rp'",
-    "bpName": "'my_bp'"
-}
-```
-
 # The `rpName` and `bpName` expressions
 
 The `rpName` and `bpName` are expressions evaulated using the [go-simple-eval](https://github.com/stirante/go-simple-eval/) library. They let you specify the names of the folders of the exported packs in some of the export targets.

diff --git a/docs/docs/guide/getting-started.md b/docs/docs/guide/getting-started.md
@@ -51,6 +51,7 @@ Next, open up `config.json`. We will be configuring a few fields here, for your
         "filters": [],
         "export": {
           "target": "development",
+          "build": "standard",
           "readOnly": false
         }
       }
@@ -115,7 +116,8 @@ You should adjust the default profile in `config.json` to look like this:
 "default": {
   "export": {
     "readOnly": false,
-    "target": "development"
+    "target": "development",
+    "build": "standard"
   },
   "filters": [
     {

diff --git a/docs/docs/guide/installing-filters.md b/docs/docs/guide/installing-filters.md
@@ -49,7 +49,8 @@ After installing, the filter will appear inside of `filter_definitions` of `conf
 "default": {
   "export": {
     "readOnly": false,
-    "target": "development"
+    "target": "development",
+    "build": "standard"
   },
   "filters": [
     {

diff --git a/docs/docs/guide/profiles.md b/docs/docs/guide/profiles.md
@@ -40,6 +40,7 @@ Here is an example `config.json` with a second profile called `package`.
         ],
         "export": {
           "target": "development",
+          "build": "standard"
         }
       },
 
@@ -50,6 +51,7 @@ Here is an example `config.json` with a second profile called `package`.
         ],
         "export": {
           "target": "development",
+          "build": "standard"
         }
       }
     },