# Aurora

> Base library for all Aurora plugins.

# Download

You can get the plugin from [PixelEast](https://pixeleast.com/product/aurora) or from [Modrinth](https://modrinth.com/plugin/auroralib). Prefer PixelEast for faster updates and dev builds.

# Requirements

- A PaperMC server (or a fork like Purpur/Pufferfish) running **Minecraft 26.2 or newer**. Folia is marked as supported as well.
- **Java 25** or newer.
- Optional: [PlaceholderAPI](https://modrinth.com/plugin/placeholderapi) for placeholders, and an economy plugin (see [Economy providers](../aurora/economy-providers.md)) for money actions and requirements.

# Overview

You can view the available admin commands and permissions here:

[Commands](../aurora/commands.md)

[Permissions](../aurora/permissions.md)

Since this is mainly a library, there is a very minimalistic config, you can configure.

[Main config](../aurora/main-config.md)

There is a built in Command dispatcher and you will use it a lot in other plugins, to execute commands as rewards for example. It can execute as console, as player, it can just parse a placeholders or set user meta data value. It can also send formatted messages and can do many other things.

[Command dispatcher](../aurora/command-dispatcher.md)

Since version 1.6.0 there is a full GUI framework inside AuroraLib to help you create a ton of customizable gui menus with ease.

[Custom menus](../aurora/custom-menus.md)

To better understand how these custom menus (and general Aurora menus in other plugins) work you should also check out how to configure menu items and requirements.

[Item config](../aurora/item-config.md) 

[Custom menus requirements](../aurora/custom-menus-requirements.md) 

To configure per player localization, see:

[Per player localization](../aurora/per-player-localization.md)

Other Aurora plugins can put item rewards into a paginated stash, which players can claim any time:

[Item stash](../aurora/item-stash.md)

Supported economy plugins and PlaceholderAPI placeholders:

[Economy providers](../aurora/economy-providers.md)

[Placeholders](../aurora/placeholders.md)