# Options

## Season duration

Range of days, while module is active.

```yaml
Options:
  Season:
    StartDateTime: "01.12.2023 00:00" #The datetime when the season starts.
    GapDateTime: "24.12.2023 00:00" #The datetime when the rude behaviour is changed to polite.
    EndDateTime: "31.12.2023 23:59" #The datetime when the season ends.
```

{% hint style="warning" %}
Before and after this season, players won't be able to interact with Figure.
{% endhint %}

## Sound

Sounds make the game more attractive. Currently played at various situations while interacting with figure.

#### Actions, when the Sounds are played.

* Rude Behaviour - Sound played when the player interact with figure while Grinch is rude.
* Create Loot - Sound played to player when Grinch steals rewards.

List of latest sounds are available at <https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html>

```yaml
Options:
  Sound: #Sounds valid for 1.12.X.
    Behaviour:
      Rude: "ENTITY_SHULKER_AMBIENT"
    Loot:
      Creation: "ENTITY_EVOCATION_ILLAGER_PREPARE_WOLOLO"
```

## Loot

Default percentage to steal the reward.

```yaml
Options:
  Loot:
    DefaultProbability: 25.0 #Percentage ratio. Allowed range <O;100>
```

## Restriction

You can disable performing some actions while using the resource.

```yaml
Options:
  Restriction:
    World:
      - world_the_end
      - world_nether
      - SomeAnotherRestrictedWrold
```

If you want to allow all worlds, you need to set **Empty Collections(`[]`)** here!

```yaml
Options:
  Restriction:
    World: []
```

## Figure (Grinch)

Via **Figure**, players are able to open Grinch's chamber of stolen rewards. Grinch also displays current status of the season.

System offers pre-defined **Armor Stand**, with clothes and head. All values can be changed in the configuration file. System also supports **NPC**, you can aslo equip it with armor or items.

{% hint style="warning" %}
Warning at placing the Figure. Grinch copies your locations and also facing direction!
{% endhint %}

{% hint style="info" %}
To place Assistant type: `/Grinch Figure Place`
{% endhint %}

If you have own Armor Stand, you can link it with Advent Figure. It only creates Holograms above the Armor Stand.

{% hint style="info" %}
To link Grinch with the nearest Armor Stand in your range type: `/Grinch Figure Link`
{% endhint %}

### Mode

List of modes mentioned above:

* NONE
* ARMOR\_STAND
* PLAYER
* HOLOGRAM

```yaml
Options:
  Figure:
    Mode: "ARMOR_STAND"
```

### Particle

Particles are spawning around the spawned Figure. You can keep them active or disable them. Also you can change Effect, Color, Speed and Amount.

```yaml
Options:
  Figure:
    Particle:
      Active: true
      TickDelay: 13 #How fast particles are spawned. (20 ticks = 1 second)
      Data:
        Effect: SPELL_WITCH
        Amount: 35
        Speed: 1.0 #Optional, Default 1.0
        Color: "255:255:255" #Optional, Default White
        Offest: #Optional, Offset from Figures's location. (Vector)
          X: .5
          Y: .5
          Z: .5
```