Style Mask Helper

Style Mask Helper adds a variety of "mask" entities that change certain aspects of the level's visuals for just a specified area, and optionally smoothly fade them!

This mod currently contains:

• Styleground Masks

• Lighting Masks

• Color Grade Masks

• Bloom Masks

Style Mask Helper also features the following styleground-related features:

• Styleground lighting, by simply adding the renderlighting tag to your styleground

• Single-mode Heat Wave styleground effect, to use a hot or cold heatwave regardless of core mode

• Styleground Mask tilesets, by adding a styleMaskHelper_maskTag attribute to your tileset xml definition set to the same as what you'd put in the "Tag" field of a styleground mask.

This works by rendering the stylegrounds below each tile, as part of the tileset, which means that:

• This works best when used with a tileset that has straight edges to prevent the stylegrounds appearing to leak out, and transparency wherever they should be visible.

• The stylegrounds will render at the same depth as the tileset, and as a result are also affected by lighting.

Styleground Masks

To mask a styleground, give it a tag with the mask_ prefix, and use the same tag (without the prefix) inside the styleground mask options. For example, if you give a styleground the mask_stars tag, you'll want to put stars as the "Tag" option for your styleground mask.

Stylegrounds with a mask_ tag will not be visible outside of a styleground mask!

Custom Fade

All masks can be given an image for their shape instead of just a rectangle using the "Custom" fade mode by placing an image inside the Gameplay/fademasks graphics folder, and setting the "Custom Fade" option to the image's path (relative to the fademasks folder, and excluding the file extension).

The image should only consist of transparency and white, where the white is where your mask will render. The image will be stretched to fit your mask, so make sure you have the sizes right!

The mod comes with a few default fade masks you can use, so check those for examples.

This mod is maintained by the Communal Helper organization. For bug reports or feature requests, go to our issues page or check out our Discord. More detailed documentation can be found on the original GItHub.