> For the complete documentation index, see [llms.txt](https://tchat.tect.host/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tchat.tect.host/auto-broadcast/configuration.md).

# Configuration

## General

```yml
modules:
  # This module sends messages via chat (or performs actions) every few seconds
  #
  # Auto broadcast module loaded from modules/autobroadcast.yml
  auto-broadcast: true
```

* modules.auto-broadcast: Enable/disable the module

***

## Module

#### Options

```yml
options:
  # Seconds between each broadcast entry
  time: 300
```

* options.time: The seconds between each broadcast

#### Broadcast

```yml
broadcasts:
  broadcast1:
    message:
      - "<dark_gray><strikethrough>                              </strikethrough>"
      - "<gradient:#c03afe:#5b03e4><bold>✦ TChat5 ✦</bold></gradient>"
      - "<gray>Welcome back, <white>%player_name%</white></gray>"
      - "<gray>This server is powered by</gray> <gradient:#c03afe:#a72cf8:#8e1ff1:#7411eb:#5b03e4><bold>TChat</bold></gradient>"
      - "<dark_gray><strikethrough>                              </strikethrough>"
    channel: "global"
    permission: "tchat.broadcast.view.broadcast1"
    actions: []
```

* message: The message to be sent via chat, compatible with MiniMessage, legacy colors, PlaceholderAPI, and %center%
* channel: (optional) The channel through which the message will be sent
* permission: (optional) Permission to view the message
* actions: (optional) The actions that will be performed when the message is sent