# AuroraCollections

**AuroraCollections** is a Minecraft plugin developed for PaperMC (and its forks like Purpur and Pufferfish). You can check out the source code on [GitHub](https://github.com/AuroraNetworkStudios/AuroraCollections) and download it for free on Modrinth. On the official [Website](https://auroramc.gg/downloads/auroracollections) you can download dev builds.

## Overview

**AuroraCollections** provides a system that tracks how many items player have gathered throughout their gameplay in you server and displays it in GUI menus with informative statistics, levels and leaderboards. Very similar to Hypixel Skyblock collections.

A Collection defines how many items are collected by the player from one or more item types (configurable). These items can be vanilla Minecraft items or other plugins items. The only condition is that the player needs to get the item in a "natural" way. For example, if the block is not natural (placed by a player), then breaking it won't increase collection statistics.

You can give rewards for your players for every collection level up. You can also give rewards based on the total completion of a category. The plugin will provide rewards (configured by you) to the players when they level up. To some degree, for certain reward types (like permissions or stats from other plugins) it can also automatically correct the rewards for players if you change your config later on (eg.: you get the new permissions which wasn't in the config before or your bonus stats like health/strength from other plugins will recalculate).

You can define interval-based `level matchers` with priorities and custom rewards for certain levels. This means you can have different rewards for every 1, every 5, every 10, and every X level, depending on how you configure the plugin. You can also customize rewards for just specific levels. In addition to all these, you can also use global level matchers, so you don't have to repeat your config in every collections config file. You can also define inheritance between level matchers to help reducing your config size even more.

The plugin features fully customizable GUI menus for nearly everything.

Multiple other plugin items are supported and more will come in the future.


---

# Agent Instructions: 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://docs.auroramc.gg/auroracollections/auroracollections.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.
