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

# Introduction

**Tea Framework** is a progressive *modding framework* and *library* for [tModLoader](https://github.com/tModLoader/tModLoader).

{% hint style="warning" %}
Tea Framework is still a work-in-progress, expect the documentation to evolve over time.

Once a release comes out, no breaking changes will be made. If required, we will only mark members as obsolete.
{% endhint %}

### Installation

To learn how to install and use Tea Framework in your mod, see [here](/tea-framework/installation.md).

{% hint style="danger" %}
Tea Framework is a **commitment**. We not only expect you to have a solid grasp on C# and tModLoader, but also expect that you want to stay with Tea Framework. Tea Framework abstracts various components of tModLoader, so moving away from it may prove time-consuming.
{% endhint %}

### Understanding Service Providers and Singleton Lifetimes

Tea Framework's entire API is founded around the idea of a service provider that belongs to a `Terraria.ModLoader.Mod` instance. View the rundown [here](/tea-framework/features/service-providers.md).

### Understanding the Reworked Load Cycle

Tea Framework overhauls how mod loading works for your mods, view the details [here](/tea-framework/features/load-steps.md).

### Features

~~For a general feature rundown, please view the~~ [~~README~~](https://github.com/rejuvena/tea-framework#readme) ~~over at~~ [~~rejuvena/tea-framework~~](https://github.com/rejuvena/tea-framework)~~.~~ Feature documentation is a work-in-progress.

### Utilities

Utility documentation is a work-in-progress.


---

# 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://tomat.gitbook.io/tea-framework/introduction.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.