GuideNH

Введение

GuideNH — это внутриигровой фреймворк для руководств и документации, портированный и расширенный на основе GuideME и Sisuo. Он в основном используется для предоставления руководств, обучающих материалов и информационных страниц для других модов или модпаков. Поддерживает написание содержимого страниц прямо в Markdown и отображение его в игре в виде системы руководств с навигацией, поиском, переходами по страницам, отображением рецептов и интерактивными сценами. Этот мод также можно использовать для внутриигровой документации, и он расширяет оригинальный фреймворк дополнительными runtime-тегами, возможностями представления сцен и расширяемыми API.

Основные возможности

Для игроков

• Обеспечивает плавный интерфейс чтения в игре с прокруткой
• Поддерживает многостраничные руководства, гиперссылки и навигацию между страницами
• Поддерживает навигацию с помощью клавиш; проиндексированные предметы можно открыть напрямую нажатием «G»
• Поддерживает демонстрации в стиле Create «мышление/исследование» для пошагового показа структур, процессов и операций
• Поддерживает интерактивные 3D-сцены с аннотациями, позволяя наглядно визуализировать блоки, сущности и структуры
• Поддерживает отображение рецептов, информации об использовании, подсказок, изображений и формул на страницах
• Поддерживает многоязычные страницы, позволяя использовать несколько языков в одной системе руководств

Для разработчиков

• Написание страниц руководств с использованием Markdown, с frontmatter для навигации и метаданных
• Расширение встроенного и блочного содержимого с помощью пользовательской системы тегов
• Встраивание рецептов, иконок предметов, интерактивных сцен, подсказок, подсказок клавиш и многого другого
• Поддерживает расширенное содержимое, такое как диаграммы Mermaid, формулы LaTeX, графики и блоки кода
• Поддерживает пользовательскую индексацию для быстрого поиска по предмету, категории или другим атрибутам
• Позволяет добавлять страницы и содержимое через ресурспаки или плагины
• Предоставляет богатые API расширения для интеграции пользовательских отображений рецептов, систем индексации и специальной логики рендеринга