Project Intelligence

Добро пожаловать в Project Intelligence, также известный как "PI"!

Основная цель этого проекта — создание по-настоящему универсального мода для документации, используя возможности сообщества Minecraft.

Как это работает? Любой разработчик модификаций может добавить документацию для своего мода в PI. Однако разработчики часто заняты и не всегда находят время для написания документации. Именно эту проблему решает PI — теперь любой участник сообщества может внести свой вклад, создавая документацию для различных модов с помощью встроенного редактора. После проверки материалы добавляются в онлайн-репозиторий.

Весь функционал PI является открытым и полностью прозрачным. Вся документация хранится в исходном виде на GitHub, собирается сервером Jenkins и загружается на веб-сервер, откуда доступна для PI. Все используемые изображения также размещаются на этом сервере. Исключение составляет документация для сборок, о которой подробнее рассказано ниже.

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

Настраиваемый интерфейс
Интерфейс PI полностью настраивается под пользователя. Доступны несколько стилей по умолчанию, а также возможность создания собственных пресетов.

Интеграция с JEI
PI полностью поддерживает рецепты из JEI, что позволяет отображать их в документации.

Связывание контента и функция "Объяснить это"
Вы можете связывать предметы, блоки или сущности со страницами документации. Функция "Объяснить это" позволяет открывать связанные страницы, нажав комбинацию клавиш при взгляде на объект в мире или при наведении курсора на предмет в инвентаре.

Привязка документации к интерфейсам
Разработчики модов могут связывать страницы документации с интерфейсами своих модификаций. PI добавит кнопку "Информация" в поддерживаемые интерфейсы, открывающую окно с соответствующей документацией.

Поддержка локализации
Полная поддержка перевода на разные языки.

Встроенный редактор
Редактор предоставляет все необходимые функции для создания и редактирования документации.

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

Документация для сборок
Специальная функция для разработчиков модпаков. Позволяет создавать документацию, аналогичную модовой, но не привязанную к конкретному моду и хранящуюся локально в конфигурациях сборки. В отличие от модовой документации, изображения для сборок размещаются разработчиками самостоятельно.

Участие в разработке:
Вся необходимая информация для внесения вклада в документацию PI доступна в самой игре. В настоящее время процесс добавления материалов осуществляется вручную.