> For the complete documentation index, see [llms.txt](https://maraudical.gitbook.io/status-effects-framework/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://maraudical.gitbook.io/status-effects-framework/2.0.0/overview.md).

# Overview

<figure><picture><source srcset="/files/JwOSAxKmHAcRQl7SoYSp" media="(prefers-color-scheme: dark)"><img src="/files/8hSleGJCQPrJX4jDY4dP" alt="" width="188"></picture><figcaption></figcaption></figure>

## Welcome to the Status Effect Framework

Status Effect Framework is a framework for implementing status effects into any game. It is easy to use, and fully customizable.

<figure><img src="/files/MlRgtwfd1XlVVw1DrbaD" alt="" width="270"><figcaption></figcaption></figure>

## Want to jump right in?

For a quick tutorial on how to setup the framework for your game look at:

{% content-ref url="/pages/dJKVWSbyqUFXDjvuTO5M" %}
[Setup](/status-effects-framework/2.0.0/setup.md)
{% endcontent-ref %}

## Want to deep dive?

For more information about the various tools at your disposal take a look at:

{% content-ref url="/pages/mbyUiW9I5TIMIcCpjZiK" %}
[Type Specifics](/status-effects-framework/2.0.0/type-specifics/classes.md)
{% endcontent-ref %}