Добро пожаловать в Project Intelligence! (сокращенно "PI")
Цель этого проекта — создать по-настоящему универсальную документацию для модификаций, используя возможности сообщества Minecraft.
Как это работает? Любой разработчик модификаций может добавить документацию для своего мода в PI. Проблема в том, что разработчики часто заняты, и у них нет времени писать документацию для сторонних проектов. PI решает эту проблему, позволяя любому участнику сообщества вносить вклад через встроенный редактор. Пользователи могут отправить документацию через запрос на включение (pull request), и после проверки она будет добавлена в онлайн-репозиторий.
Вся деятельность PI является открытой и прозрачной. Документация хранится в исходном виде на GitHub, собирается сервером Jenkins и размещается на веб-сервере (pi.brandon3055.com). PI использует исключительно ресурсы с этого сервера, включая изображения для документации.
Основные возможности:
Настраиваемый интерфейс
Интерфейс PI обладает высокой степенью кастомизации. Доступны предустановленные стили, а пользователи могут создавать и сохранять собственные конфигурации.
Интеграция с JEI
Поддерживает отображение рецептов из JEI в документации.
Связывание контента и функция "Explain This"
Позволяет связывать предметы, блоки или сущности со страницами документации. Функция "Explain This" открывает связанную документацию по нажатию сочетания клавиш при наведении на объект в мире или в инвентаре.
Привязка документации к интерфейсам
Разработчики модов могут привязывать страницы документации к своим графическим интерфейсам. PI добавляет кнопку "Информация", открывающую окно с документацией внутри интерфейса мода.
Поддержка локализации
Встроенный редактор
Предоставляет базовые функции для создания и редактирования документации.
Поддержка нескольких версий модов
Позволяет обновлять документацию для новых версий модов без потери совместимости со старыми.
Документация для сборок (Pack Doc)
Предназначена для создателей сборок. Документация не привязана к конкретному моду, хранится локально в конфигах сборки и может распространяться с ней. Изображения размещаются разработчиком сборки (например, через imgur.com).
Участие в разработке:
Инструкции по внесению вклада доступны во внутриигровой документации PI.
