> 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/animations.md).

# Animations

## General

Animations are defined in `data/animations.yml`. Each animation is a named sequence of frames that cycles automatically based on an interval, in ticks. Reference any animation from a supported text field using its key.

```yaml
animations:
  rainbow:
    interval: 5
    mode: RANDOM
    frames:
      - "<red>"
      - "<gold>"
      - "<yellow>"
      - "<green>"
      - "<aqua>"
      - "<light_purple>"

  loading_dots:
    interval: 10
    mode: LOOP
    frames:
      - "Loading"
      - "Loading."
      - "Loading.."
      - "Loading..."
```

## Configuration

### Fields

| Field      | Description                                                                                                                                                      |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `interval` | Ticks between frame changes. 20 ticks = 1 second.                                                                                                                |
| `frames`   | Ordered text frames the animation cycles through, looping from the end back to the start.                                                                        |
| `mode`     | Controls how frames are played. `LOOP` repeats from the beginning, `PING_PONG` reverses direction at each end, and `RANDOM` picks a random frame every interval. |

### Syntax

Reference an animation anywhere animated text is supported using:

```
<anim:key>
<anim:key:LOOPS>
<a:key>              # shorthand
<a:key:LOOPS>
```

```yaml
success: "<gold>Selling: <anim:auction_wave></gold>"
```

`LOOPS` is an optional parameter that limits the animation to that many full cycles before it freezes on its final frame.


---

# 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/animations.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.