# Carols

## Module

If you are using this resource because of other features and Carols are not used, you can to disable this module and increase performance of the server.

```yaml
Options:
  Carol:
    Active: true #false, if module is not used
```

## Season duration

Range of days, while module is active.

```yaml
Options:
  Carol:
    Season:
      DateFormat: "dd.MM.yyyy HH:mm"
      StartDateTime: "27.11.2022 00:00" #The datetime when the season starts.
      EndDateTime: "31.12.2022 23:59" #The datetime when the season ends.
```

## NoteBlockAPI

By integration of [`NoteBlockAPI`](https://www.spigotmc.org/resources/noteblockapi.19287/) allows to play much more Christmas carols as before.

### How to use?

Simply, put **.nbs** file into `Carol` folder.

{% hint style="info" %}
To make own order of carols, rename them in format `XX-<NameOfCarol>.nbs`. E.g. `01-JingleBells.nbs`, `02-HolyNight.nbs`.
{% endhint %}

### [List of carols](https://drive.google.com/drive/u/1/folders/1hW2lUFu2Dw35V-yR7VLkOkymjCnkhXGk)

### Without NoteBlockAPI

By not using `NoteBlockAPI`, only **JingleBells** carol is played to players during the advent season.

## Range

Specifies how far is able to hear carol from selected point.

{% hint style="info" %}
Distance is **count** of blocks from point.
{% endhint %}

```yaml
Options:
  Carol:
    Range: 5
```

## Mode

List of modes mentioned above:

* `AROUND_POINT` - Carol is played around one location. Suitable for SpawnPoint.

{% hint style="warning" %}
There is required to set location using command `/Carol Spawner Location Set`
{% endhint %}

* `AROUND_SANTA` - Carol is played around Santa's Figure.
* `AROUND_ELF` - Carol is played around Elf's Figure.
* `AROUND_ASSISTANT` - Carol is played around Assistant's Figure.
* `AROUND_GRINCH` - Carol is played around Grinch's Figure.
* `WHOLE_WORLD` - Carol is played in the whole world. (Variable `World` at Options file.)

```yaml
Options:
  Carol:
    World: "world_name"
```