> 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/reference/developer-api.md).

# Developer API

AuraSounds exposes a small, focused API for other plugins.

## Getting started

Add AuraSounds as a dependency of your plugin:

```yaml
# plugin.yml
softdepend: [AuraSounds]
```

```java
import com.artyfw.aura.sounds.api.AuraSoundsAPI;
```

## Custom conditions

The flagship extension point: register your **own condition types**, usable in any sound file like the built-in ones.

```java
// Register a condition — here, "is the player in combat?" backed by your combat plugin
AuraSoundsAPI.registerCondition("in-combat", node -> {
    boolean expected = node.getBoolean(true);
    return (player) -> MyCombatPlugin.isInCombat(player) == expected;
});
```

Server owners can then write:

```yaml
# plugins/AuraSounds/sounds/battle_drums.yml
conditions:
  in-combat: true
```

The factory receives the YAML node of the condition (so your condition can take simple values, lists or full sections) and returns a per-player predicate. Evaluation happens on the main thread at the configured check interval — keep predicates cheap, cache anything expensive on your side.

## Ideas

* `in-combat`, `boss-fight-phase: 2` — combat plugins
* `quest-active: dragon_hunt` — quest plugins
* `job-level` operators — job/skill plugins
* `season: winter` — season plugins

If your plugin exposes state via PlaceholderAPI, server owners can already reach it with the built-in [`placeholder` condition](/guides/conditions.md#the-placeholder-condition) — a dedicated condition is simply cleaner and faster.


---

# 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/reference/developer-api.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.