> For the complete documentation index, see [llms.txt](https://maraudical.gitbook.io/status-effect-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-effect-framework/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/N6MMnsJweHp1fRZOySb1" alt=""><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-effect-framework/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-effect-framework/type-specifics/classes.md)
{% endcontent-ref %}


---

# 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:

```
GET https://maraudical.gitbook.io/status-effect-framework/overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.