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

# Introduction

Welcome to the official documentation of **MendingCore** — a modern, modular foundation for developing high-performance Minecraft plugins for **Paper** and **Velocity**.

***

## 🌟 What is MendingCore?

MendingCore helps developers create clean, maintainable, and feature-rich Minecraft plugins with ease. It provides ready-to-use systems that reduce boilerplate and accelerate development.

Whether you're building complex GUIs or streamlining item handling, MendingCore offers essential tools to help you stay focused on logic rather than low-level implementation.

***

## 🧰 Core Capabilities

Here’s a glimpse of what MendingCore enables:

* 🧱 **Modular Plugin Structure** — Build scalable and organized plugins from the ground up.
* ⚡ **Intuitive GUI Framework** — Quickly design and manage inventory-based user interfaces.
* 🧠 **Smart Inventory Actions** — Handle user interactions with flexible and dynamic slots.
* 🎨 **Item & Skull Builders** — Simplify item creation with readable builder utilities.
* 📚 **Built-in Pagination** — Easily display large item collections in GUIs.
* 🔌 **Extendable APIs** — Seamlessly integrate or extend functionality to match your needs.

You’ll find details on each of these components in the Developer Guide.

***

## 📚 Documentation Overview

This documentation is structured into three main sections:

### 🧭 Introduction

* [Getting Started](/docs/core/getting-started.md)
* [Plugin Philosophy](https://github.com/mending-dev/MendingCore/blob/main/docs/philosophy.md)

### ⚙️ Admin Guide

* [Installation](https://github.com/mending-dev/MendingCore/blob/main/docs/admin/installation.md)
* [Configuration](https://github.com/mending-dev/MendingCore/blob/main/docs/admin/configuration.md)

### 🛠️ Developer Guide

* [GUI System](https://github.com/mending-dev/MendingCore/blob/main/docs/dev/gui/gui.md)
  * [Creating a GUI](https://github.com/mending-dev/MendingCore/blob/main/docs/dev/gui/creating-gui.md)
  * [GuiIcon](https://github.com/mending-dev/MendingCore/blob/main/docs/dev/gui/gui-icon.md)
  * [PaginationManager](https://github.com/mending-dev/MendingCore/blob/main/docs/dev/gui/pagination.md)
  * [ActionSlotManager](https://github.com/mending-dev/MendingCore/blob/main/docs/dev/gui/action-slots.md)
* [ItemBuilder](https://github.com/mending-dev/MendingCore/blob/main/docs/dev/items/itembuilder.md)
* [SkullBuilder](https://github.com/mending-dev/MendingCore/blob/main/docs/dev/items/skullbuilder.md)
* [Events](https://github.com/mending-dev/MendingCore/blob/main/docs/dev/events.md)
* [Best Practices](https://github.com/mending-dev/MendingCore/blob/main/docs/dev/best-practices.md)

***

## 🤝 Contributing

Found a bug or want to improve this project? Feel free to contribute by submitting issues, opening pull requests, or discussing ideas on GitHub.

***

> This documentation is a living resource and will grow alongside the project. Check back often for updates and new examples.