Мод Vocation: создание интерактивных сообщений

Vocation — это инструмент для разработчиков модификаций и сборок, который позволяет добавлять в игру текстовые и озвученные сообщения с богатым функционалом взаимодействия.

Посмотрите демонстрацию

Этот проект был создан за один день во время трансляции и предлагает удобную систему для работы с внутриигровыми уведомлениями. демонстрационный урок из видео не входит в сборку мода — он служит лишь примером возможностей.

С чего начать

Установите Vocation на сервер и клиент, запустите игру один раз, чтобы создать папку vocation_data рядом с папками mods и config. Внутри неё создайте отдельную папку с произвольным названием для ваших данных. Если нужно добавлять звуковые файлы, поместите их в подпапку "audio".

Создайте JSON-файлы в основной папке — их количество не ограничено, и каждый может содержать несколько сообщений. Не забудьте, что JSON-файлы должны быть идентичными на клиенте и сервере, звуковые файлы для сервера не обязательны.

Формат сообщений

Каждый файл представляет собой массив JSON объектов:

[
    {
        "id": "(идентификатор сообщения)",
        "message": "(текст на экране)",
        "narrator": "(имя персонажа над текстом)",
        "time": "(время показа в тиках)",
        "voiceover": "(звуковой файл из папки audio, опционально)",
        "requirements": "(спрос ID сообщений, которые нужно просмотреть чтобы это отобразилось, опционально)",
        "triggers": "(события-триггеры, опционально)",
        "actions": "(действия при появлении сообщения, опционально)"
    }
]

Сообщение можно оставить пустым — тогда оно не будет показываться на экране, но всё равно засчитается как просмотренное и запустит указанные действия.

Триггеры

Если триггеры не указаны, для показа сообщений используется команда. Доступные варианты триггеров:

"triggers": [
    {
        "trigger": "message_seen",
        "key": "(ID проверяемого сообщения)"
    },
    {
        "trigger": "stat_above",
        "key": "(название статистики)",
        "value": "(минимальное значение)"
    },
    {
        "trigger": "item_pickup",
        "stack": "(формат предмета)"
    },
    {
        "trigger": "item_craft",
        "stack": "(формат предмета)"
    },
    {
        "trigger": "mob_kill",
        "key": "(название моба)"
    }
]

Действия

После триггера могут выполняться различные действия:

"actions": [
    {
        "action": "give_item",
        "stack": "(формат предмета)"
    },
    {
        "action": "run_command",
        "param": "(команда с /)"
    }
]

Формат предметов

Укажите предмет в следующей структуре:

"stack": {
    "id": "(ID предмета, например minecraft:log)",
    "metadata": "(опционально — метаданные)",
    "stackSize": "(размер стопки, опционально)",
    "nbt": "(JSON-объект с дополнительными данными, опционально)"
}

Команды

Мод включает несколько полезных команд для управления системой:

• /vocation-review — позволяет любому игроку повторно показать последнее просмотренное сообщение (без выполнения действий)
• /vocation-reload — перезагружает все конфигурационные файлы (только для администраторов)
• /vocation-clear <player> — очищает все данные Vocation у указанного игрока (для блоков команд и администраторов)
• /vocation-set-seen <player> <id> <true/false> — управляет статусом просмотра сообщения у игрока (для блоков команд и администраторов)
• /vocation-show <player> <id> [do-actions] — показывает конкретное сообщение указанному игроку (для блоков команд и администраторов)
• /vocation-check <player> <id> — проверяет, просмотрено ли сообщение (используется с компараторами)