RTFM

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

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

После установки мода и первого запуска Minecraft рекомендуется заглянуть в файл конфигурации. В нём можно указать вкладки, которые будут отображаться в интерфейсе руководства — по сути, это обычные ссылки на определённые разделы вашей рукописи. В каталоге конфигураций также появится папка rtfm с файлом-примером, поясняющим процесс создания разделов. Принцип прост: пишите текст в формате Markdown, сохраняете файлы и связываете их через обычные ссылки.

Ещё один приятный бонус, который даёт хранение документации в Markdown-файлах — если вы ведёте разработку на GitHub или подобной платформе, получается дублирующая версия руководства, пригодная для открытия любым браузером.