> For the complete documentation index, see [llms.txt](https://airdevelopment.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://airdevelopment.gitbook.io/docs/global-features/messages.md).

# Messages

## General

* Set a message to `""` to completely hide it from the player.
* Messages natively support full MiniMessage formatting for colors, gradients, hover/click events, etc. (<https://webui.advntr.dev/>)
* Messages can support single or multiple lines.
* External placeholders are resolved if PlaceholderAPI is installed.

## Configuration

### References

References are named string constants defined once at the top of each lang file and expanded inline using `<ref:name>` wherever they appear in messages.

```
<ref:key>
<r:key>      # shorthand
```

```yaml
reload: "<ref:prefix> <green>Configuration reloaded successfully."
```

### Tags

Allow you to trigger specific components directly within a text string. These can be used in any message field across the lang files.

<figure><img src="/files/2Qx99YuEyk82JhTYIXun" alt=""><figcaption><p>Example using all the tags on the same message.</p></figcaption></figure>

{% tabs %}
{% tab title="<sound>" %}
Plays a specific sound to the player (e.g., `<sound:block.note_block.bit:1:2>`).

```yaml
<sound:NAME:VOL:PITCH>
```

{% endtab %}

{% tab title="<actionbar>" %}
Displays the specified text in the player's action bar.

```yaml
<actionbar:'TEXT'>
```

{% endtab %}

{% tab title="<title>" %}
Shows a main title with timing values (in ticks; 20 ticks = 1s).

```yaml
<title:'TEXT':fadeIn:stay:fadeOut>
```

{% endtab %}

{% tab title="<subtitle>" %}
Shows a subtitle (inherits timings from the last `<title>` tag).

```yaml
<subtitle:'TEXT'>
```

{% endtab %}

{% tab title="<bossbar>" %}
Displays a boss bar with the specified values.

```yaml
<bossbar:'TEXT':duration:color:overlay:progress:countdown>
```

{% hint style="info" %}
Parameters:

* `TEXT`: The message content displayed above the bar.
* `duration`: How long to display the bar in ticks.
* `color`: The visual color of the bar. (`RED`, `BLUE`, `GREEN`, `YELLOW`, `PURPLE`, `WHITE`, `PINK`)
* `overlay`: Determines the segment style of the bar. (`PROGRESS`, `NOTCHED_6`, `NOTCHED_10`, `NOTCHED_12`, `NOTCHED_20`)
* `progress`: The initial fill level of the bar. (`0.0` to `1.0`)
* `countdown`: If `true`, the bar visually drains to 0 over the duration.
  {% endhint %}
  {% endtab %}
  {% endtabs %}


---

# 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://airdevelopment.gitbook.io/docs/global-features/messages.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.
