GuideME

Данный проект предоставляет основу для создания руководств к вашим модам и сборкам модов. Используя технологию, лежащую в основе справочника Applied Energistics 2, вы можете писать свои руководства на простом Markdown, одновременно встраивая 3D-сцены непосредственно из файлов структур.

Возможности для игроков

Руководства, созданные на основе GuideME, предлагают игрокам:

• Плавную прокрутку содержимого
• Удобное расположение текста с продвинутым механизмом форматирования, поддерживающим перетекание и встроенные элементы
• Интерактивные 3D-сцены с аннотациями, наглядно демонстрирующие концепции вашего мода
• Перекрестные ссылки между темами и быструю информацию во всплывающих подсказках
• Отображение рецептов прямо в руководстве в стиле JEI
• Возможность быстро перейти к соответствующей странице руководства, зажав клавишу G в любой подсказке к предмету

Возможности для разработчиков

Для создателей модов доступен богатый API для расширения функциональности:

• Добавление пользовательских встроенных или блочных тегов в Markdown с использованием собственной системы виджетов
• Расширенный рендеринг рецептов для отображения ваших пользовательских рецептов в руководстве
• Использование пользовательского front-matter в Markdown для легкого добавления произвольной информации на страницы руководства
• Применение пользовательских индексов для быстрого поиска страниц по заданным атрибутам
• Возможность для ресурс-паков или дополнений добавлять собственный контент в ваше руководство

Пример использования

Ниже приведен пример страницы из руководства AE2 (исходный код):

---
навигация:
  родитель: ae2-mechanics/ae2-mechanics-index.md
  заголовок: Каналы
  иконка: контроллер
---

# Каналы

ME Сети Applied Energistics 2 требуют
Каналы для поддержки устройств, которые используют сетевое хранилище или другие сетевые
сервисы. Представьте каналы как USB-кабели ко всем вашим устройствам. У компьютера есть ограниченное количество USB-портов, и он может поддерживать
только определенное количество подключенных устройств. Большинство механизмов, полноразмерных устройств и стандартных кабелей могут передавать
до 8 каналов. Вы можете представить полноразмерные устройства и стандартные кабели как пучок из 8 "канальных проводов". Однако плотные кабели могут поддерживать до
32 каналов. Единственные другие устройства, способные передавать 32 канала, это <ItemLink id="me_p2p_tunnel" />
и Квантовый сетевой мост. Каждый раз, когда устройство использует канал, представьте, что вы вытаскиваете USB "провод" из
пучка, что очевидно означает, что этот "провод" недоступен дальше по линии.

<GameScene zoom="7" interactive={true}>
  <ImportStructure src="../assets/assemblies/channel_demonstration_1.snbt" />
</GameScene>