Skip to content

Commit 41e88be

Browse files
committed
Add more examples and refine some information
1 parent 8b8f3ee commit 41e88be

File tree

1 file changed

+89
-1
lines changed

1 file changed

+89
-1
lines changed

wiki/customization/Masks.md

Lines changed: 89 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ render-mask: [
2929
* Each mask defines a shape in the world that will either be:
3030
* **Included** in the rendered map (default).
3131
* **Excluded** using the `subtract: true` property.
32-
* Masks are applied in **top-to-bottom order**.
32+
* Masks are applied in **top-to-bottom order**.
33+
This means masks that come later will **overrule** (take priority over) previous masks.
3334

3435
BlueMap automatically updates the rendered map when masks are changed, and deletes tiles outside the defined area.
3536
To fix any potential issues after changing masks, you can use: `/bluemap fix-edges <map>`
@@ -141,3 +142,90 @@ render-mask: [
141142
}
142143
]
143144
```
145+
146+
## More Examples
147+
148+
### Excluding a Secret Building
149+
150+
If you start with a mask that has `subtract: true`, bluemap will render everything except the defined mask-area.
151+
Like this you can for example exclude a secret building or area from the map:
152+
153+
```hocon
154+
render-mask: [
155+
{
156+
type: box
157+
subtract: true
158+
min-x: 100
159+
max-x: 200
160+
min-z: 100
161+
max-z: 200
162+
}
163+
]
164+
```
165+
166+
If you **additionally** have a world-border and want to limit your render as well, you can combine it like this:
167+
```hocon
168+
render-mask: [
169+
{ # first define the world-border as the main area that should be rendered
170+
type: box
171+
subtract: false
172+
min-x: -10000
173+
max-x: 10000
174+
min-z: -10000
175+
max-z: 10000
176+
}
177+
{ # then subtract your secret location that you don't want to render
178+
type: box
179+
subtract: true
180+
min-x: 100
181+
max-x: 200
182+
min-z: 100
183+
max-z: 200
184+
}
185+
]
186+
```
187+
188+
### A See-Through Nether Ceiling
189+
190+
Here is an alternative way how you can handle the nethers ceiling:
191+
```hocon
192+
render-mask: [
193+
{
194+
type: box
195+
subtract: true
196+
min-y: 127
197+
max-y: 127
198+
}
199+
]
200+
201+
render-edges: false
202+
```
203+
204+
### Remove the Nether Ceiling entirely
205+
206+
If you want to remove the nether-ceiling entirely, including everything that has been build on top of the nether,
207+
you can use either this config:
208+
209+
```hocon
210+
render-mask: [
211+
{
212+
max-y: 90
213+
}
214+
]
215+
```
216+
217+
or this config:
218+
219+
```hocon
220+
render-mask: [
221+
{
222+
subtract: true
223+
min-y: 91
224+
}
225+
]
226+
```
227+
228+
Both configs simply remove everything that is at `y: 91` or higher and render everything else.
229+
230+
Notice how `type: box` and `subtract: false` are omitted in these examples.
231+
We can do that since those are the default values of these mask properties.

0 commit comments

Comments
 (0)