GuideME

GuideME - это основа для создания гайдбуков к вашим модам или сборкам модов. Технология взята из Applied Energistics 2, но теперь доступна каждому: пишите руководства в простом Markdown, а прямо из структуры файлов подгружайте 3D-сцены. Никаких сложных редакторов - только текст и воображение.

Что получает игрок?

• Плавный скроллинг - никаких тормозов при чтении.
• Продвинутый движок текста: контент по центру, перетекание абзацев, встроенные элементы.
• Интерактивные 3D-сцены с аннотациями - наглядно показывают, как работает тот или иной механизм.
• Перекрёстные ссылки между темами, всплывающие подсказки при наведении.
• Рецепты прямо в гайде (стиль JEI).
• Быстрый переход на нужную страницу по кнопке G - зажми G на предмете и откроется соответствующее описание.

Что даёт разработчику?

GuideME - это не просто готовый гайдбук, а расширяемая платформа с API:

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

Пример страницы

Вот как выглядит одна из страниц из гайдбука Applied Energistics 2:

---
navigation:
  parent: ae2-mechanics/ae2-mechanics-index.md
  title: Channels
  icon: controller
---

# Channels

Applied Energistics 2's ME Networks require
Channels to support devices which use networked storage, or other network
services. Think of channels like USB cables to all your devices. A computer only has so many USB ports and can only support
so many devices connected to it. Most machines, full-block devices, and standard cables can only pass through
up to 8 channels. You can think of full-block devices and standard cables as a bundle of 8 "channel wires". However, dense cables can support up
to 32 channels. The only other devices capable of transmitting 32 are <ItemLink id="me_p2p_tunnel" />
and the Quantum Network Bridge. Each time a device uses up a channel, imagine pulling off a usb "wire" from
the bundle, which obviously means that "wire" isn't available further down the line.

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

Зачем это нужно?

Если ты делаешь мод для Майнкрафт или собираешь модпак - рано или поздно встанет вопрос документации. GuideME решает его раз и навсегда: вместо разрозненных гайдов на форумах получаешь встроенный гайдбук, который всегда под рукой. А 3D-сцены помогают визуализировать сложные механики - например, работу каналов или крафт цепочек.

Мод совместим с Fabric и Forge, работает на Minecraft 1.18-1.21 (проверь актуальную версию на странице загрузки). Подходит как для одиночной игры, так и для серверов - гайдбук не нагружает мир.

Скачайте GuideME и начните собирать документацию, которую игроки полюбят. ГайдМи - это просто, понятно и красиво.