TreasureCoCaseReloaded

Первый запуск

При запуске на новом сервере плагин будет требовать активировать себя через консольную команду tccrauth [ЛОГИН] [ПАРОЛЬ]. Повторяю: команда консольная, а значит ввести её можно только в консоли сервера. После ввода данной команды плагин совершит некую магию, и решит - активировать себя или нет. В случае успешной активации вы получите запущенный плагин и уведомление от бота (если вы активировали его в сообществе ВКонтакте).

Изменение адреса сервера

При авторизации плагин получает токен, который играет роль идентификатора сервера в системе. Этот токен хранится в файле storage.ejs. Если запустить плагин на другом IP адресе не удаляя этот файл, то вам в ВК придёт уведомление о том, что была произведена попытка включения с неизвестного IP адреса, и будет предложено обновить IP адрес сохранённого в системе сервера на новый. Если же вы хотите добавить ещё один сервер, не изменяя адрес существующего, то необходимо ввести консольную команду авторизации о которой говорилось ранее. Стоит отметить, что на один аккаунт можно добавить не более пяти серверов. Чтобы расширить этот лимит напишите в сообщения сообщества ВКонтакте.

Консольные команды

Базовые команды

Команды взаимодействия с точками открытия

Команды обслуживания

Краткое вступление

Коробка - это основная единица плагина. В его настройках задаётся работа самого главного механизма - аниматора. Добавить больше нечего, смотрим дальше.
Стоит отметить, что все аниматоры при своём первом запуске генерируют файлы (демонстрационные коробки или что-то ещё), чтобы вы могли изучить все возможные настройки. Заново сгенерировать эти файлы можно через команду /tccr generateResources.

Ключи

Ключ используется как дополнительная единица при открытии коробки. Если в настройках коробки включена опция useKeys, то такую коробку уже нельзя открыть без определённого количества ключей withdrawalAmount. Если у игрока имеется несколько различных ключей, которые могут открыть выбранную им коробку, то откроется меню выбора ключа.
Конфигурационные файлы ключей находятся в папке keys.

name: '&2Примерный ключ'           ## Название ключа
item: TRIPWIRE_HOOK                ## Предмет ключа
description:                       ## Описание
- '&6Ключ для открытия коробки'
canOpen:                           ## Список коробок, которые могут быть открыты этим ключом
- ciexanex

Конфигурация коробки

Все конфигурационные файлы коробок находятся в папке boxes.

options:
  name: '&aДемонстрационная коробка'        ## Название коробки
  description:                              ## Описание коробки
    - '&6Красивейшее &aописание &eкоробки'
  item: WEB                                 ## Предмет
  emptyItem: BEDROCK                        ## Предмет, который отображается, когда у игрока нет таких коробок
  animator: ...                             ## Алиас используемого аниматора
  useKeys: false                            ## Если true, коробку можно будет открыть только с помощью ключей
  withdrawalAmount: 1                       ## Количество ключей, которое необходимо потратить на открытие этой коробки
  advanced:                                 ## Уникальные параметры аниматора
    ...
onOpenActions:                              ## Список исполнителей, которые вызываются при открытии коробки
  - sound --play ENTITY_ENDERMAN_TELEPORT
  - particle --play EXPLOSION_LARGE
  - message --broadcast -t Игрок %username% открывает демонстрационную коробку
onAwardActions:                             ## Список исполнителей, которые вызываются при получении любого приза
  - sound --play BLOCK_ANVIL_LAND
endActions:                                 ## Список исполнителей, которые вызываются при завершении анимации открытия
  - sound --play ENTITY_GENERIC_EXPLODE
  - particle --play EXPLOSION_LARGE
awards:                                   ## Призы
  demo:                                   ## Уникальное название приза
    rare: true                            ## Если true, предмет голограммы будет зачарован
    phantom: true                         ## Если true, приз никогда не будет получен кем-либо, но
                                          ##                   может быть отображён некоторыми аниматорами
    skip-permission: tccrawards.hasdemo    ## Если игрок имеет это право, он не сможет получить этот приз.
                                          ##        Приз станет, так сказать, фантомным для этого игрока.
    chance: 40                            ## Шанс приза
    hologramText: '&eДемо'                ## Текст голограммы
    hologramItem: GLASS                   ## Предмет голограммы
    actions:                              ## Список исполнителей, которые вызываются при получении приза
      - execute -c give %username% glass 1
      - message --broadcast -t Игрок %username% что-то выбил

Конфигурация процессора сессии

"Процессор сессии" по смыслу можно приравнять к "движку сессии". Процессор контроллирует работу сессии (анимации), и для осуществления этого процесса ему нужен специальный набор параметров. Ниже представлен список этих параметров.

Как уже описано ранее, эти параметры, или, точнее, их большинство, настраивает сам аниматор. Из всех представленных параметров вам разрешается трогать только последние пять. Ниже представлен пример того, как вообще эти параметры можно настраивать:

options:
  ...
processor:
  pushInDistance: 5            ## Вталкиваем игрока если он дальше 5 блоков от центра
  pushInForce: 0.5             ## Вталкиваем с такой силой
  pushOutDistance: 2.5         ## Отталкиваем нечисть в радиусе 2.5 блоков от центра
  pushOutForce: 0.5            ## Отталкиваем с такой силой
onOpenActions:
  ...
...

В представленном примере мы выясняем, что для того, чтобы игрок был в безопасности, он должен стоять в самом центре. Да, отталкивание не работает на игрока, который открывает.

Компоненты-аниматоры

Исполнители

Список исполнителей может расширяться компонентами-исполнителями. Курсивом обозначены необязательные параметры.

Общие параметры для всех исполнителей

Примеры

Коробку открывает игрок Вася.

Сообщение всем игрокам, кроме Васи

message --broadcast --skip-user -t Игрок %username% выбил помидорку в демо-коробке. Ты сможешь добиться того же, %playername%, если будешь слушаться родителей.

Сообщение только Васе

message -t Вы только что выбили помидорку, %username%!

Выполняем команду через консоль

execute -c say Ля, что ты творишь, %username%?

Текст в экран Васи

title -f Молодец, %username%, ты выбил помидор -s Может быть, попробуешь ещё раз?

Текст в экран всем игрокам, кроме Васи

title --broadcast --skip-user -f Игрок %username% выбил помидор -s Хочешь так же, %playername%? Не хочешь.

Текст в экран Васи с настраиваемыми параметрами отображения, без второй строки

title -f Ого, как долго оно появляется --fade-in 80 --stay 60 --fade-out 10

Рандомно бьём молниями в радиусе 8 блоков 6 раз и с паузой в 5 тиков

thunderbolt --scatter 8 --executions 6 --exec-delay 5

Спавним 6 партиклов и задерживаем выполнение следующего исполнителя на 10 тиков

particle --play LAVA -a 6 --pause 10

Проигрываем короткий набор звуков и при этом не задерживаем вызов следующих исполнителей

sound --play BLOCK_NOTE_BLOCK_BIT --dnw
sound --play BLOCK_NOTE_BLOCK_BELL --delay 5 --dnw
sound --play BLOCK_NOTE_BLOCK_BASS --delay 10 --dnw

Взрываем фейрверк со своими цветами (2 примера)

firework --shape BALL_LARGE --flicker -c 255,0,0 -c 0,0,255
firework --shape BALL -c RED -c BLUE -c GREEN

Компоненты-исполнители

Призы

Приз - это то, что получает игрок во время процесса открытия любой коробки. Исполнители приза затормаживают появление её голограммы на [КОЛИЧЕСТВО ИСПОЛНИТЕЛЕЙ ПРИЗА] тиков. Этот "закон" справедлив только если не применены задерживающие параметры (--exec-delay, --delay, --pause) в исполнителях. Если в хотя бы одном из исполнителей прописан один из задерживающих параметров, количество тиков, через которое появится голограмма, увеличивается. Если во ВСЕХ исполнителях приза указан параметр --dnw, голограмма приза появится практически моментально, раньше завершения выполнения исполнителей.

Частота выпадания приза зависит от присвоенного ему шанса. Приз никогда никем не сможет быть выбит если он имеет положительный параметр phantom.
Так же можно сделать приз фантомным в автоматическом режиме с помощью параметра skippermission. В исполнителях приза пропишите команду выдачи какого-то права, которое так же будет вписано в параметре skippermission, и тогда игрок сможет выбить такой приз всего один раз.
Можно использовать эту возможность для того, чтобы, к примеру, по несколько раз не выпадал какой-то гаджет или титул.

Что это?

Что это, спрашиваешь? Это блок, который находится на земле или в воздухе. На него ещё можно нажать и что-то произойдёт: откроется меню выбора или сразу откроется какая-то коробка.
Все изменения точек открытия рекомендуется осуществлять только через специальные команды, о которых говорилось ранее.

Конфигурация

Конфигурационные файлы точек открытия находятся в папке points.

{
  "location": "world,x,y,z",        ## Локация
  "selector": "INVENTORY",          ## Селектор
  "hologramType": "NORMAL",         ## Тип голограммы
  "hologramLines": [                ## Содержимое голограммы
    "t:§cТочка открытия",
    "i:CHEST",
    "t:§cНажми на блок"
  ],
  "hologramHeight": 3.0,            ## Высота голограммы над блоком точки открытия
  "block": "CHEST -f NORTH",        ## Блок
  "available": [],                  ## Список доступных для открытия коробок
  "showOnlyAvailable": false,       ## Содержит значение, присвоенное командой /tccr points showOnlyAvailable
  "effectorKit": [],                ## Эффекторы
  "params": {}                      ## Уникальные параметры
}

Селекторы

Селектор - это способ представления коробок и ключей игроку. По умолчанию работает селектор-меню (INVENTORY), в котором отображаются и коробки и ключи. Но так же присутствует два дополнительных селектора: селектор-книга (BOOK) и голографический селектор (HOLOGRAPHIC).

item:             ## Голограмма элемента
  - 't:%coloredName%'
  - 'i:%item%'
  - 't:%amount%'
empty:            ## Голограмма предмета "ничего"
  - 't:&cУ вас ничего нет'
  - 'i:BARRIER'
guidance:         ## Настройка наведения (вывод текста на экран при наведении)
  fade-in: 1
  stay: 40
  fade-out: 5
  title: ''
  subtitle: '&aНажмите ЛКМ, чтобы открыть'

Голограммы

Типов голограмм присутствует всего 3, но установить вы можете только 2, потому что третий тип автоматически устанавливается при включении голографического селектора. По умолчанию отображается общая голограмма (NORMAL). Чтобы можно было отображать переменные плагина или PlaceholderAPI, нужна индивидуальная голограмма (INDIVIDUAL).
Переменные индивидуальной голограммы можно вписать прямо через команду /tccr points setLine. Формат переменных PlaceholderAPI такой, какой и должен быть: %...%. У плагина присутствует только одна переменная: ${amount_ЮНИТ} - отображает количество указанных юнитов у игрока.

Эффекторы

Эффекторы предназначены для косметического преображения точки открытия. Обычный и скучный блок сундука можно превратить в произведение искусства (слишком громко сказано; такого достичь не выйдет). Параллельно на точку открытия может действовать бесконечное количество эффекторов, но не стоит забывать, что может получиться некрасивое месиво, которое просадит TPS вашего сервера до нежелательных показателей.
Ниже представлен список всех доступных эффекторов:

Параметры

Параметры нужны для более точной настройки работы точки открытия и подключённых к ней компонентов (на точку открытия могут воздействовать не только эффекторы). Ниже представлены все встроенные параметры точек открытия:

Меню в инвентарях

В вашем распоряжении находятся три меню-инвентаря:
- меню выбора, где могут отображаться и коробки и ключи - all_selection
- меню выбора ключа (когда у игрока несколько ключей для одной коробки) - key_selection
- меню подтверждения открытия - confirmation
Ниже представлено содержимое конфигурации меню-инвентарей:

invgui.yml

all_selection:                 ## Инвентарь выбора коробки. Отображает коробки (и ключи, если разрешено)
  title: '&8Меню выбора'       ## Название меню
  stackItems: true             ## Если true, будет отображено количество коробок/ключей
                               ##                       с лимитом отображаемого количества в 64 шт.
  displayKeys: true            ## Если true, в меню, помимо коробок, будут отображены ключи
  historyDisplayMode: AWARD    ## Способ отображения истории. AWARD - предмет голограммы приза, HEAD - голова игрока
  simpleHistoryTime: false     ## Упрощение времени в истории
                               ##   ("2 часа 32 минуты 8 секунд" преобразуется в "2 часа")
  dynamic: true                ## Динамический режим отрисовки содержимого. Если true, плагин
                               ##     заполняет динамические слоты коробками и ключами игрока
  schematic:                   ## Схема инвентаря
    - b b b b Q b b b b
    - b a a a a a a a b
    - b a a a X a a a b
    - b a a a a a a a b
    - b b b b N b b b b
    - H H H H H H H H H
  ## Зарезервированные буквы:
  ## a - динамический слот
  ## s - слот "пропуск"
  ## X - слот для предмета "ничего" (отображается только в динамическом режиме)
  ## H - слот истории
  items:                       ## Буквы и их роль
    Q:
      item: WRITABLE_BOOK
      name: '&eКакая-то книженция'
      desc:
        - '&7Описание книженции'
    N:
      item: COMPASS
      name: '&eИстория открытий'
      desc:
        - '&7Ниже отображена история'
        - '&7выбитых игроками призов.'
    b:
      item: BLACK_STAINED_GLASS_PANE
      name: ''
      desc: []
    X:
      item: BARRIER
      name: '&cУ вас ничего нет.'
      desc:
        - '&cУ вас нет ни коробок, ни ключей.'
        - '&cВам нечего открывать.'
key_selection:        ## Меню выбора ключа
  title: '&8Меню выбора ключа'
  stackItems: true
  schematic:
    - b b b b Q b b b b
    - b a a a a a a a b
    - b b b b b b b b b
  ## Зарезервированные буквы:
  ## a - динамический слот для ключей
  ## s - слот "пропуск"
  items:
    Q:
      item: COMPASS
      name: '&eВыберите ключ'
      desc:
        - '&7Выберите ключ, с помощью'
        - '&7которого будете открывать'
        - '&7выбранную коробку.'
    b:
      item: BLACK_STAINED_GLASS_PANE
      name: ''
      desc: []
confirmation:         ## Меню подтверждения открытия
  enabled: true       ## Если true, плагин будет спрашивать у игрока на самом деле ли он хочет открыть коробку
  title: '&8Подтверждение'
  schematic:
    - s s s s Q s s s s
    - s s s s s s s s s
    - s A A A s D D D s
    - s A A A s D D D s
    - s A A A s D D D s
    - s s s s s s s s s
  ## Зарезервированные буквы:
  ## A - слот подтверждения
  ## D - слот отказа
  ## s - слот "пропуск"
  items:
    Q:
      item: COMPASS
      name: '&eПодтвердите открытие коробки'
      desc:
        - '&7Нажмите на &aзелёное&7 стекло,'
        - '&7если подтверждаете открытие.'
        - ''
        - '&7Если же вы передумали,'
        - '&7нажмите на &cкрасное&7 стекло.'
    A:
      item: LIME_STAINED_GLASS_PANE
      name: '&a&lДА'
      desc: []
    D:
      item: RED_STAINED_GLASS_PANE
      name: '&c&lНЕТ'
      desc: []
    b:
      item: BLACK_STAINED_GLASS_PANE
      name: ''
      desc: []

all_selection:
  ...
  dynamic: false
  schematic:
    - b b b b Q b b b b
    - b a a a a a a a b
    - b a a F a G a a b
    - b a a a a a a a b
    - b b b b N b b b b
    - H H H H H H H H H
  items:
    ...
    F: ciexanex
    G: *название другой коробки*

Меню-книга

Меню-книга была введена в обновлении 1.1 и используется только точками открытия. Ниже представлено скучное содержимое конфигурации такого меню:

bookgui.yml

box_selection:
  content:              ## Содержимое книги
    - '&2Выберите:'
    - ''
    - '%dynamicRow%'    ## Строка для коробки
    - '%dynamicRow%'
    - '%dynamicRow%'
    - '%dynamicRow%'
    - '%dynamicRow%'
    - '%dynamicRow%'