FTB Tutorial Mod (Forge)

Данная модификация представляет собой инструмент для создания интерактивных обучающих материалов внутри Minecraft. С её помощью вы можете разрабатывать подробные инструкции и гайды для любых модов или модпаков.

Общий обзор функциональности

В игровом интерфейсе доступна специальная кнопка "Обучение", при нажатии на которую открывается список всех доступных обучающих программ:

Показывается изображение с интерфейсом кнопки "Обучение"

Показывается изображение со списком доступных туториалов

Особенностью системы является отложенная загрузка контента из ресурспаков. Для корректной работы в составе модпака потребуется установка мода Resource Loader.

Создание туториалов

Основной файл конфигурации

Основной конфигурационный файл index.json должен располагаться по указанному пути с соответствующим пространством имён вашего мода или модпака. В качестве примера используются пути из FTB Academy:

{
    "title": "The Introduction Tutorial",
    "icon": "item:minecraft:beacon",
    "pages": [
        {
            "description": "Refined Storage",
            "layers": [
                "0.png"
            ]
        },
        {
            "description": "Welcome Banner",
            "layers": [
                "ftbacademy:welcome.png"
            ]
        }
    ]
}

Параметры заголовка и иконки являются необязательными, как и описания для отдельных страниц. Обязательным является только массив страниц, каждая из которых должна содержать список слоёв. В настоящее время слоями выступают пути к изображениям, но в будущем планируется добавить возможности для текстовых инструкций и указателей.

Настройка видимости туториалов

Для отображения туториала в основном интерфейсе необходимо создать файл visible.json:

[
  "intro"
]

В этом файле указываются идентификаторы всех туториалов, которые должны быть доступны в главном меню обучения.

Методы запуска туториалов

Командный запуск

Разработчики модпаков могут использовать команду:

/open_tutorial ftbacademy:intro @p

Программный запуск

Разработчики модов могут интегрировать запуск через систему межмодового взаимодействия:

FMLInterModComms.sendRuntimeMessage(modInstance, "ftbtutorialmod", "open", "ftbacademy:intro");

Для серверной части используется другой идентификатор сообщения.