GuideME

РуководствоME

Этот проект предлагает основу для вашего руководства по модам или модпакам. Основанный на технологии, лежащей в основе руководства Applied Energistics 2s, он позволяет вам писать руководство в простом Markdown, встраивая при этом трехмерные сцены прямо из структурных файлов.

Для игроков руководства на базе GuideME предлагают:

• Плавная прокрутка
• Контент находится на переднем плане и в центре, а усовершенствованный механизм компоновки текста поддерживает перекомпоновку и встроенные элементы.
• Интерактивные 3D-сцены с аннотациями, интуитивно иллюстрирующие концепции вашего мода.
• Перекрестные ссылки между темами и быстрая информация во всплывающих подсказках по ссылкам.
• Показ inline-рецептов в вашем путеводителе "JEI-Style"
• Предлагает возможность «удерживать G» для быстрого перехода к соответствующей странице путеводителя во всплывающей подсказке к любому элементу.

Для моддеров он предлагает богатый API расширяемости, позволяющий:

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

Пример

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

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

# Channels

Applied Energistics 2's [ME Networks](me-network-connections.md) require
Channels to support [devices](../ae2-mechanics/devices.md) 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](../items-blocks-machines/cables.md#dense-cable) 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](../items-blocks-machines/quantum_bridge.md). 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>