> For the complete documentation index, see [llms.txt](https://edseries-plugins.gitbook.io/p/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edseries-plugins.gitbook.io/p/pinnagiveaways/getting-started/configuration.md).

# Configuration

Everything is in `plugins/PinnaGiveaways/config.yml`, `messages.yml` and the menus in `guis/`. Apply changes with `/giveaway reload` (only `storage:` and `animation.render-threads` need a restart).

## config.yml sections

| Section                              | What it holds                                                                               | Page                                                   |
| ------------------------------------ | ------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| `gui`                                | Whether `/giveaway` opens the giveaways menu, its file id, the click cooldown of every menu | [Menus](/p/pinnagiveaways/features/menus.md)           |
| `exempt-permission`, `entries`       | Who is left out, extra entries by permission                                                | [Giveaways](/p/pinnagiveaways/features/giveaways.md)   |
| `announce-at`, `start-delay-seconds` | Countdown announcements, the wait after a restart                                           | [Giveaways](/p/pinnagiveaways/features/giveaways.md)   |
| `winner-title`, `winner-title-times` | The title the winner sees and how long it stays                                             | [Giveaways](/p/pinnagiveaways/features/giveaways.md)   |
| `save-interval-seconds`              | How often timers and the queue are saved (also on every change)                             | [Storage](/p/pinnagiveaways/features/storage.md)       |
| `numbers`                            | Suffixes (k, M, B...), decimals and separators of every amount                              | below                                                  |
| `currencies`                         | Every currency rewards and sponsorships can use                                             | [Currencies](/p/pinnagiveaways/features/currencies.md) |
| `giveaways`                          | The giveaways themselves                                                                    | [Giveaways](/p/pinnagiveaways/features/giveaways.md)   |
| `sponsor`                            | Sponsored giveaways and their stage animation                                               | [Sponsored](/p/pinnagiveaways/features/sponsored.md)   |
| `animation`                          | The reel: placement, size, timing, layout, colours, texts, effects, sounds                  | [Animation](/p/pinnagiveaways/features/animation.md)   |
| `storage`                            | YAML or MySQL                                                                               | [Storage](/p/pinnagiveaways/features/storage.md)       |

## Numbers

```yaml
numbers:
  suffixes: ['k', 'M', 'B', 'T', 'Q', 'Qi', 'Sx', 'Sp', 'Oc', 'No', 'Dc']
  short-decimals: 2
  grouping-separator: ','
  decimal-separator: '.'
```

Amounts are shown grouped (`{amount}` = 1,250,000) or short (`{amount-short}` = 1.25M). Players and configs can type amounts as `2500`, `2,500`, `2.5k`, `1.2M` or `1e6`; the suffixes are the ones listed here, in any case. Amounts are exact big numbers, so prison economies past 1e30 work.

## messages.yml

Every chat line, title and menu word. `&` codes, `&#RRGGBB`, `<#RRGGBB>` and `<gradient:#RRGGBB:#RRGGBB>text</gradient>` work everywhere; a list is sent as several lines; `''` turns a message off. `{prefix}` is replaced by `prefix:`, and `time-units:` sets the letters of every time shown (`2h 4m`).

## Texts on the reel

The texts drawn in the 3D scene (title, prize line, pointers, winner labels...) are in `config.yml` under `animation.texts` and `sponsor.animation.texts`.
