Options

Looking into Options.yml

Season duration

Range of days, while module is active.

Options:
  Season:
    StartDateTime: "01.12.2023 00:00" #The datetime when the season starts.
    GapDateTime: "24.12.2023 00:00" #The datetime when the sending mode is turned to reading mode.
    EndDateTime: "31.12.2023 23:59" #The datetime when the season ends.

Before and after this season, players won't be able to interact with Figure.

MailBox

When player wants to send a surprise to his friennd, he needs to create MailBox.

Capacity of MailBoxes is limited.

Options:
  MailBox:
    Capacity:
      Default: 9

Extend capacity

By permissions, you can extend capacity of MailBoxes for player.

Simply create KEY and assign it value.

Options:
  MailBox:
    Capacity:
      Extension:
        PRINCE: 3
        KING: 9

Default + Extension = Total Capacity

Example

Extension with key VIP_GOLD extends capacity by 5. In configuration file, it will look like this:

Options:
  MailBox:
    Capacity:
      Extension:
        VIP_GOLD: 5

Player with permission ChristmasMail.MailBox.Capacity.VIP_GOLD can create 14 MailBoxes. (9 as Default + 5 by extension)

At applying more permissions on the player, only permission with highest value will be used!

Vulgarism filter

Christmas time is about peace and calm, why to send inappropriate messages in wishes?

To handle vulgarisms in wishes, you need to put inappropriate words into specific file. One word has to be on separated line.

If file InappropriateBehaviour.txt does not exist, please create one in ChristmasMail folder.

Restriction

You can disable performing some actions while using the resource.

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

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

Options:
  Restriction:
    World: []

Figure (Elf)

Via Figure, players are able to open Christmas Mail. Elf 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.

Warning at placing the Figure. Figure copies your locations and also facing direction!

To place Assistant type: /ChristmasMail Figure Place

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

To link Elf with the nearest Armor Stand in your range type: /ChristmasMail Figure Link

Mode

List of modes mentioned above:

• NONE

• ARMOR_STAND

• PLAYER

• HOLOGRAM

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.

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