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

# getting-started

Welcome to the **PrimeEnchants** documentation. PrimeEnchants is a powerful, modern, and highly optimized custom enchantment plugin designed for Paper 1.21.1 and beyond.

## 🌟 Key Features

* **100+ Custom Enchantments**: Unique effects for weapons, armor, tools, and even Elytra/Tridents.
* **1.21 Ready**: Built-in support for the **Mace** and modern 1.21 components like `glint_override`.
* **"True Pulse" Cooldowns**: Intelligent cooldown system that throttles messages and confirms activation before starting timers.
* **Action Bar HUD**: Real-time feedback on your active cooldowns with "Ready!" flashes.
* **Blacksmith Forge**: A Gacha-style rolling system for obtaining enchantments.
* **Anomaly Events**: Server-wide events where players fight for legendary loot.
* **Vanilla Integration**: Full support for Anvils, Grindstones (with XP returns), and Villager trading.
* **Highly Configurable**: Every enchantment, message, and GUI element can be tuned to your server's needs.
* **Folia Support**: Engineered for high-performance multithreaded environments.

## 🚀 Getting Started

To get started, follow our [Installation Guide](/yowsef-development-docs/untitled/getting-started/installation.md) and check out the [Commands](/yowsef-development-docs/untitled/getting-started/commands.md) to begin exploring the world of PrimeEnchants.


---

# 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://yowsef-development.gitbook.io/yowsef-development-docs/untitled/getting-started.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.