Markdown Manual

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

Чтобы увидеть пример использования этой библиотеки, посмотрите на TIS-3D, который использует её для своего внутриигрового руководства. Для необходимой настройки в коде ознакомьтесь с классом Manuals. Для определения содержания руководства изучите директорию doc. Вкратце: зарегистрируйте новое руководство в реестре руководств, добавьте контент для нового руководства, зарегистрируйте предмет, чтобы сделать руководство доступным для игроков. Содержательные документы — это документы Markdown, которые могут содержать ссылки на другие документы. Изображения и блоки/предметы можно встраивать с использованием ссылок на изображения в стиле Markdown (например, ).

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