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

# Welcome!

## Welcome to UIFramework

This is a tutorial for how to add custom items and abilities easily! By using UIFramework all of the annoying stuff is handled for you. Custom items will have automatic updates upon inventory clicks if you change item stats, abilities, or even lore. All recipes will be handled automatically by UIFramework too, so users can customize, remove, and add recipes for your items in-game very easily.

<figure><img src="https://i.imgur.com/kIy33wu.png" alt=""><figcaption></figcaption></figure>

## Want to jump right in?

Quickstart gives you a quick setup on how to add your custom items in just a few lines of code.

{% content-ref url="/pages/jXX9fvZ8SBkeNP46tdvj" %}
[Quick Start](/uiframework-api/quick-start.md)
{% endcontent-ref %}

## Want to deep dive?

Check out this page to see some examples of what's possible with UIFramework and how easy it is to add!

{% content-ref url="/pages/UyhAsWDwLIe6LNJpiu61" %}
[Items](/uiframework-api/advanced/items.md)
{% endcontent-ref %}