FTB Tutorial Mod (Forge)

This modification serves as a tool for creating interactive learning materials within Minecraft. With its help, you can develop detailed instructions and guides for any mods or modpacks.

General Functionality Overview

In the game interface, there is a special "Tutorials" button that opens a list of all available learning programs when clicked:

Shows image with the "Tutorials" button interface

Shows image with the list of available tutorials

A feature of the system is lazy content loading from resource packs. For proper operation as part of a modpack, installation of the Resource Loader mod is required.

Creating Tutorials

Main Configuration File

The main configuration file index.json should be located along the specified path with the corresponding namespace of your mod or modpack. As an example, paths from FTB Academy are used:

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

Title and icon parameters are optional, as are descriptions for individual pages. Only the array of pages is mandatory, each of which must contain a list of layers. Currently, layers represent image paths, but future plans include adding capabilities for text instructions and pointers.

Tutorial Visibility Settings

To display a tutorial in the main interface, you need to create a visible.json file:

[
  "intro"
]

This file specifies the identifiers of all tutorials that should be available in the main learning menu.

Tutorial Launch Methods

Command Launch

Modpack developers can use the command:

/open_tutorial ftbacademy:intro @p

Programmatic Launch

Mod developers can integrate launch through the inter-mod communication system:

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

For the server part, a different message identifier is used.