Markdown Manual

Markdown Manual - это библиотечный мод для Minecraft, который решает одну из вечных проблем мододелов: как понятно объяснить игроку, что делает твой мод. Вместо того чтобы писать кривые гайды на форумах или лепить нечитаемые интерфейсы, разработчики могут добавить прямо в игру полноценный мануал на основе обычных Markdown-файлов.

В чем суть

По сути, это библиотека. Сама по себе она ничего не даёт игроку - никаких новых блоков, предметов или механик. Но если автор мода её подключил, в игре появляется удобное руководство по этому моду. Открываешь книжку - и там всё расписано: как работает, какие рецепты, какие нюансы.

• Минимум кода для разработчика - просто кладёшь Markdown-документ в нужную папку
• Стандартный Markdown с ссылками на другие страницы, картинками, вставкой блоков и предметов
• Гибкая стилизация - можно оставить базовый вид, а можно переделать под свою тему или даже встроить в существующий UI

Как это работает на практике

Разработчик регистрирует новый мануал через специальный реестр (для этого есть класс Manuals с примерами кода). Потом добавляет контент в виде Markdown-файлов, и привязывает к ним предмет - например, книжку. Игрок кликает по предмету - открывается мануал.

Прикольно то, что ссылки внутри документа работают как навигация по страницам руководства. Если хочешь показать игроку конкретный блок или предмет из своего мода - в Markdown это делается через специальные ссылки (как картинки, только с указанием блоков/предметов).

Например, TIS-3D - мод, который использует эту библиотеку для своего игрового руководства. Всё наглядно, прямо в игре, без гугл-доков и вики.

Для кого это

Если ты мододел и хочешь, чтобы игроки не блуждали в догадках - Markdown Manual отличный вариант. Игроку не придётся выходить из Майнкрафта и читать гайды на сторонних сайтах. Всё встроено прямо в интерфейс игры.

А если игрок не хочет забивать голову документацией - просто ставишь мод, который использует эту библиотеку, и спокойно играешь. Мануал всегда под рукой, если что-то непонятно.