> 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/installation.md).

# installation

Installing PrimeEnchants is a straightforward process. Ensure your server meets the requirements before beginning.

## 📋 Requirements

* **Server Version**: Paper 1.21.1 or higher (Folia is also supported).
* **Java Version**: Java 21 or higher.
* **Dependencies**:
  * [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) (Optional, for HUD and stats placeholders).
  * [WorldGuard](https://dev.bukkit.org/projects/worldguard) (Optional, for region-based blocking).
  * [Vault](https://www.spigotmc.org/resources/vault.3431/) (Optional, for Blacksmith Forge economy).

## 🚀 Step-by-Step Setup

1. **Download**: Download the `PrimeEnchants.jar` from the distribution source.
2. **Upload**: Place the JAR file into your server's `plugins/` folder.
3. **Restart**: Start or restart your server to generate the default configuration files.
4. **Configure**: Tune the `config.yml` and `enchants.yml` to your liking.
5. **Reload**: Run `/enchants reload` to apply any changes made to the configuration.

{% hint style="warning" %}
PrimeEnchants uses ProGuard obfuscation to ensure stability and protection. If you encounter issues during the initial plugin load on Paper (Remapper errors), ensure you are using the latest version of Paper 1.21.1.
{% endhint %}


---

# 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/installation.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.