Skip to content

Commit ca46b52

Browse files
committed
Updated the documentation.
1 parent 263bedb commit ca46b52

File tree

6 files changed

+15
-25
lines changed

6 files changed

+15
-25
lines changed

docs/docs/guide/configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Example config, with many options explained:
7676
// Export target defines where your files will be exported
7777
"export": {
7878
"target": "development",
79+
"build": "standard",
7980
"readOnly": false
8081
}
8182
}

docs/docs/guide/create-a-filter.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ At this point, you need to edit your `config.json` so that `giant_mobs` is regis
4848
],
4949
"export": {
5050
"target": "development",
51+
"build": "standard",
5152
"readOnly": true
5253
}
5354
}

docs/docs/guide/export-targets.md

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ These are the export targets that Regolith offers.
2929

3030
## Development
3131

32-
The development export target will place the compiled packs into your `com.mojang` `development_*_packs` folders.
32+
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).
3333

3434
```json
3535
"export": {
36-
"target": "development"
36+
"target": "development",
37+
"build": "standard" // or "preview" or "education"
3738
}
3839
```
3940

@@ -42,6 +43,7 @@ Optionally, you can use `rpName` and `bpName` to specify the names of the folder
4243
```json
4344
"export": {
4445
"target": "development",
46+
"build": "standard",
4547
"rpName": "'my_rp'",
4648
"bpName": "'my_bp'"
4749
}
@@ -91,13 +93,14 @@ The exact export target doesn't support using `rpName` and `bpName`. The `rpPath
9193

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

94-
You need to use *either* `worldName` or `worldPath` to select the world. `worldPath` supports environment variables by using the `%VARIABLE_NAME%` syntax.
96+
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`.
9597

9698
Example:
9799

98100
```json
99101
"export": {
100102
"target": "world",
103+
"build": "standard",
101104
"worldName": "..." // This
102105
// "worldPath": "..." // OR this
103106
}
@@ -114,26 +117,6 @@ Optionally, you can use `rpName` and `bpName` to specify the names of the folder
114117
}
115118
```
116119

117-
118-
## Preview
119-
120-
The development export target will place the compiled packs into your **(minecraft preview)** `com.mojang` `development_*_packs` folder.
121-
122-
```json
123-
"export": {
124-
"target": "preview"
125-
}
126-
```
127-
128-
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.
129-
```json
130-
"export": {
131-
"target": "preview",
132-
"rpName": "'my_rp'",
133-
"bpName": "'my_bp'"
134-
}
135-
```
136-
137120
# The `rpName` and `bpName` expressions
138121

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

docs/docs/guide/getting-started.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Next, open up `config.json`. We will be configuring a few fields here, for your
5151
"filters": [],
5252
"export": {
5353
"target": "development",
54+
"build": "standard",
5455
"readOnly": false
5556
}
5657
}
@@ -115,7 +116,8 @@ You should adjust the default profile in `config.json` to look like this:
115116
"default": {
116117
"export": {
117118
"readOnly": false,
118-
"target": "development"
119+
"target": "development",
120+
"build": "standard"
119121
},
120122
"filters": [
121123
{

docs/docs/guide/installing-filters.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ After installing, the filter will appear inside of `filter_definitions` of `conf
4949
"default": {
5050
"export": {
5151
"readOnly": false,
52-
"target": "development"
52+
"target": "development",
53+
"build": "standard"
5354
},
5455
"filters": [
5556
{

docs/docs/guide/profiles.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Here is an example `config.json` with a second profile called `package`.
4040
],
4141
"export": {
4242
"target": "development",
43+
"build": "standard"
4344
}
4445
},
4546

@@ -50,6 +51,7 @@ Here is an example `config.json` with a second profile called `package`.
5051
],
5152
"export": {
5253
"target": "development",
54+
"build": "standard"
5355
}
5456
}
5557
},

0 commit comments

Comments
 (0)