Налаштування кейсів

Кейси у DonateCase — це головний елемент плагіна, через який гравці можуть отримувати призи.
У цьому розділі розглянемо, як налаштовувати кейси, їхній вигляд та список винагород.

---

Створення першого кейсу

Після завантаження, в директорії DonateCase/cases вже є стандартний кейс з назвою default, його ми і почнемо редагувати.

Структура

В директорії кейсу ми можемо побачити ось таку структуру:

Загальні налаштування

Поглянемо на файл settings.yml

type

Тип вашого кейсу для реєстрації в регістру
Не використовуйте пробіли, бажано в нижньому регістрі
Повинен бути ідентичним, інші кейси не можуть мати такий самий тип

note

Якщо тип кейсу не задано, буде використано назву директорії

type: default

default-menu

Стандартне меню для відкриття за допомогою кліка правої кнопки миші по блоку кейса

default-menu: default_menu

note

Якщо стандартне меню не задано, буде використано будь-яке з доступних

animation

Анімація, що буде програватись після відкриття кейсу
Доступні параметри: SHAPE, FIREWORK, RAINLY, WHEEL, RANDOM, POP, SELECT
Налаштування анімацій
Попередній перегляд анімацій

animation: WHEEL

animation-settings

Локальне налаштування анімації
Для налаштування потрібно скопіювати всі параметри анімації з Animations.yml в цю секцію

info

Якщо закоментувати/видалити цей параметр, налаштування анімації будуть глобальними

animation-settings:
  Type: FULL
  ItemSlot: HEAD
  SmallArmorStand: true
  ItemsCount: 6
  Shuffle: true
  CircleRadius: 2
  # Facing: UP
  StartPosition:
    x: 0.5
    y: -0.5
    z: 0.5
  Flame:
    Enabled: true
    Particle: FLAME
  Scroll:
    Count: 1
    Time: 150
    EaseAmount: 2.5
    Sound: UI_BUTTON_CLICK
    Volume: 10
    Pitch: 1

hologram

Налаштування голограми над блоком кейсу
Використовує драйвер, що задано в цьому параметрі
Для FancyHolograms доступні розширені параметри

hologram:
  enabled: true
  height: 1.5
  range: 8
  message:
    - '&6DonateCase'

Параметр	Опис
enabled	Перемикає увімкненість голограми
height	Висота над блоком
range	Діапазон видимості (лише для CMI та DecentHolograms)
message	Вміст голограми

open-type

Тип відкриття кейсу
Доступні параметри: GUI - відкриття через меню, BLOCK - негайне відкриття після кліку ПКМ по блоку кейса

open-type: GUI

no-key-actions

Дії, що відтворюються, якщо в гравця немає ключів від кейсу

no-key-actions:
  - "[message] &cYou don't have keys for this case. You can buy them here >>> &6www.jodex.xyz"
  - "[sound] ENTITY_ENDERMAN_TELEPORT"

history-data-size

Розмір історії відкриттів кейсу
Видаліть або встановіть 0, якщо хочете відключити історію

history-data-size: 10

cooldown-before-animation

Затримка перед програванням анімації відкриття
Задається в тіках (20 тіків = 1 секунда)

tip

Корисно, якщо ви відтворюєте додаткові дії за допомогою DCEventManager перед початком анімації

cooldown-before-animation: 0

level-groups

Локальні налаштування рівнів для груп
Те саме, що було описано для глобальної конфігурації

info

Повністю видаліть цю секцію, якщо хочете використовувати глобальні налаштування

level-groups:
  ultra: 6
  legend: 5
  deluxe: 4
  premium: 3
  vipplus: 2
  vip: 1
  default: 0

display-name

Відображуване ім'я кейсу, частіше для заповнювачів (placeholders)

display-name: "&6Donate&7-&fCase"

custom-data (необов'язково)

Довільні дані для використання аддонами
Будь-який аддон може зчитувати параметри з цієї секції для власних потреб
Наприклад, DCWebHook використовує це для відображення назв кейсів у Discord

custom-data:
  webhook-name: "Донат Кейс"

tip

Ключі та значення можуть бути будь-якими — кожен аддон зчитує лише ті, що йому потрібні

Створення інших кейсів

Для того, щоб створити ще один кейс зі своїми окремими налаштуваннями та призами, достатньо скопіювати директорію стандартного кейсу default, переіментувати її наприклад в donate, відкрити файл налаштувань settings.yml та відредагувати параметр type.

Структура директорій буде приблизно такою: