# Configuration

## Options

### Time

```yaml
options:
  # Time between broadcast and broadcast
  time: 300
```

This option is the time between broadcast and broadcast, the time is in seconds, 300 = 5 minutes

### Enable

```yaml
options:
  # Enable/disable all broadcasts
  enabled: true
```

Enable or disable all broadcast tasks

## Basic configuration

### Enable or disable

```yaml
broadcasts:
  broadcast1:
    # Enable/disable this broadcast
    enabled: true
```

This option enables or disables the placeholder, this can be useful in case you do not want to delete the broadcast but do not want it to appear

### Message

```yaml
broadcasts:
  broadcast1:
    # Broadcast message (supports colors &, HEX colors &#, and PlaceholderAPI)
    message:
      - "Test message"
      - "With multi-line"
```

Messages support multi-line, as well as PlaceholderAPI placeholders, HEX colors and '&' colors

## Advanced configuration

### Channel

```yaml
broadcasts:
  broadcast1:
    # The channel to send the broadcast
    channel: "staffchat"
```

Puedes configurar un canal para que el broadcast se envie por ese canal

{% hint style="warning" %}
Remember to have the channel properly configured in the channels.yml

Get more information here
{% endhint %}

### Permission

```yaml
broadcasts:
  broadcast1:
    # Permission to view the broadcast
    permission: "tchat.broadcast.view.broadcast1"
```

All users without this permission will not be able to see the broadcast message\
You can use any permission or set "none" to disable this function

## Actions

### Title

```yaml
broadcasts:
  broadcast1:
    actions:
      title:
        enabled: true
        title: "&#c03afeT&#a72cf8C&#8e1ff1h&#7411eba&#5b03e4t"
        subtitle: "&7The server is using &#c03afeT&#a72cf8C&#8e1ff1h&#7411eba&#5b03e4t"
```

* Enabled: Enable/disable title and subtitle
* Title: The text on the title
* Subtitle: The text on the subtitle

### Sound

```yaml
broadcasts:
  broadcast1:
    actions:
      sound:
        enabled: true
        sound: "ENTITY_VILLAGER_NO"
```

* Enabled: Enable/disable the sound
* Sound: The [sound](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html)

### Particles

```yaml
broadcasts:
  broadcast1:
    actions:
      particles:
        enabled: true
        particle: ANGRY_VILLAGER
        particles: 4
```

* Enabled: Enable/disable the particles
* Particle: The [particle](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Particle.html)
* Particles: The number of particles

### Action bar

```yaml
broadcasts:
  broadcast1:
    actions:
      actionbar:
        enabled: true
        bar: "&#c03afeT&#b333fbe&#a72cf8c&#9a25f4t&#8e1ff1.&#8118eeh&#7411ebo&#680ae7s&#5b03e4t"
```

* Enabled: Enable/disable the action bar
* Bar: The text of the action bar