> For the complete documentation index, see [llms.txt](https://sweenus987.gitbook.io/color-mask/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sweenus987.gitbook.io/color-mask/readme.md).

# Welcome

This is the official documentation for the Color Mask plugin available on [Fab](https://www.fab.com/listings/6b839f20-436c-421c-829e-1679aadb15ea).

Color Mask is a plugin that creates up to 4 masks at a time based on the color and tuning you choose. You can then use this mask to create any kind of post-process effect you can think like a nior effect with up to 4 colors remaining.

It's recommended that you at least understand how to set up post-process effects.

Be sure to keep an eye on the [Changelog](/color-mask/other/changelog.md) for any changes or updates.

{% hint style="warning" %}
The plugin officially only supports the deferred rendering pipeline, this limitation may not change. This is based on whether the Scene View Extension, which this plugin uses, gets called in the renderer.
{% endhint %}

Current plugin version is 1.0.0 an supports the following major versions.

<table data-full-width="false"><thead><tr><th align="center">Engine Version</th><th align="center">Supported</th></tr></thead><tbody><tr><td align="center">5.0</td><td align="center">❌</td></tr><tr><td align="center">5.1</td><td align="center">❌</td></tr><tr><td align="center">5.2</td><td align="center">❌</td></tr><tr><td align="center">5.3</td><td align="center">❌</td></tr><tr><td align="center">5.4</td><td align="center">❌</td></tr><tr><td align="center">5.5</td><td align="center">❌</td></tr><tr><td align="center">5.6</td><td align="center">❌</td></tr><tr><td align="center">5.7</td><td align="center">✔️</td></tr><tr><td align="center">5.8</td><td align="center">✔️</td></tr></tbody></table>

### Jump right in

<table data-view="cards"><thead><tr><th align="center"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>Installation</strong></td><td></td><td></td><td><a href="/pages/3wl0rwurHx3BEv0wuIUr">/pages/3wl0rwurHx3BEv0wuIUr</a></td></tr><tr><td align="center"><strong>Quickstart</strong></td><td></td><td></td><td><a href="/pages/9RPdyiuHwzFT3VuJblFV">/pages/9RPdyiuHwzFT3VuJblFV</a></td></tr><tr><td align="center">Changelog</td><td></td><td></td><td><a href="/pages/aXsksCxdZrZEsvEgkOe7">/pages/aXsksCxdZrZEsvEgkOe7</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://sweenus987.gitbook.io/color-mask/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
