> For the complete documentation index, see [llms.txt](https://wiki.auraplugins.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.auraplugins.eu/getting-started/installation.md).

# Installation

{% hint style="info" %}
**Before you start**, make sure your server runs **Paper or Spigot 1.21+** with **Java 21**. Paper is recommended. **Folia** is supported out of the box.
{% endhint %}

## Step 1 — Install the plugin

1. Download `AuraSounds-x.y.z.jar`.
2. Drop it into your server's `plugins/` folder.
3. Restart the server (a restart is cleaner than `/reload` for a first install).

On first start, AuraSounds creates its folder with a default configuration and two example sounds:

```
plugins/AuraSounds/
├── config.yml            # global settings (check interval, defaults, prefix)
├── messages.yml          # every player-facing message (MiniMessage format)
├── sounds/               # one YAML file per sound — this is where the magic happens
│   ├── marais_nuit.yml   # example: night swamp ambience
│   └── taverne.yml       # example: tavern music
├── scenes/               # sounds grouped into scenes (see the Scenes guide)
└── exports/              # exported scenes, shareable between servers
```

## Step 2 — Check it loaded

Look at your console for the AuraSounds startup message, then run in game:

```
/aurasounds list
```

You should see the two example sounds. If the command is unknown, the plugin did not load — check the console for errors ([Troubleshooting](/help/troubleshooting.md) can help).

## Step 3 — Optional dependencies

AuraSounds works completely standalone, but it integrates with these plugins **if** they are installed. No configuration needed — hooks are detected automatically:

| Plugin             | What it unlocks                                                     |
| ------------------ | ------------------------------------------------------------------- |
| **WorldGuard**     | Zone music bound to your regions, and the `region` condition        |
| **PlaceholderAPI** | The `placeholder` condition (react to any placeholder value)        |
| **ItemsAdder**     | Play sounds from your ItemsAdder resource pack (`itemsadder:` keys) |
| **Nexo**           | Play sounds from your Nexo pack (`nexo:` keys)                      |

{% hint style="success" %}
That's it — you're installed. Head to the [Quick Start](/getting-started/quick-start.md) to create your first sound in five minutes.
{% 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, and the optional `goal` query parameter:

```
GET https://wiki.auraplugins.eu/getting-started/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
