> For the complete documentation index, see [llms.txt](https://wiki.vortexdevelopment.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.vortexdevelopment.net/projects/vortexgens.md).

# VortexGens

## 🌟 Overview

Welcome to the official documentation for **VortexGens**. VortexGens is a high-performance, feature-rich generator plugin designed for modern Minecraft servers. It allows players to place, upgrade, and stack generators to create efficient resource production systems.

***

#### ✨ Core Features

* **⚡ High Performance**: Built with optimization in mind to handle hundreds of active generators without impacting server TPS.
* **📦 Advanced Stacking**: Save space by stacking multiple generators of the same type and level on a single block.
* **🔼 Intuitive Upgrades**: A modern GUI-based upgrade system that scales costs based on stack size.
* **🖼️ Visual Excellence**: Support for custom holograms and custom blocks (via Oraxen).
* **👥 Group Limits**: Integrated with LuckPerms to limit how many generators players can place based on their rank.
* **🔌 Robust API**: A comprehensive developer API for deep integration and custom logic.

***

#### 🚀 Quick Start Guide

Ready to get started? Follow these three simple steps to set up your first generator:

1. **Installation**: Drop the `VortexGens.jar` and its dependencies (VortexCore) into your `plugins` folder and restart the server.
2. **Configuration**: Fine-tune your settings in `config.yml` and define your generator types.
3. **In-Game**: Use `/gens give <player> <generator>` to give yourself a generator and place it on the ground!

{% hint style="success" %}
**VortexGens** is now ready for use! Check out the other pages in this wiki for detailed guides on commands, configuration, and API usage.
{% endhint %}

***

#### 🔗 Essential Links

* **Discord Support**: [Join our Discord](https://dc.vortexdevelopment.net)
* **Plugin Repository**: [Browse Artifacts](https://repo.vortexdevelopment.net/repository)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://wiki.vortexdevelopment.net/projects/vortexgens.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.