Project Intelligence [1.12.2] / Моды на Майнкрафт /

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

Так как это будет работать? Для начала любой разработчик мода может добавить документацию для своего мода в PI. Проблема заключается в том, что разработчики модов заняты, поэтому у большинства из них нет времени на написание документации для некоторых случайных модов документации, таких как PI, и это, по моему мнению, является основной проблемой для большинства существующих модов документации.

Они должны напрямую поддерживаться моддерами. PI стремится решить эту проблему, предоставив возможность любому члeну сообщества внести свой вклад, написав документацию для различных модов с использованием относительно простого встроенного редактора. Затем они могут представить свою документацию с помощью запроса на извлечение и, если он пройдет проверку, он будет добавлен в онлайн-хранилище.

Все, что делает PI, является открытым исходным кодом и полностью прозрачным. Вся документация хранится в необработанном виде на github. Затем он создается сервером jenkins и загружается на веб-сервер, управляемый cover1624, где к нему может обращаться PI. Все, что использует PI, исходит от этого сервера, включая все изображения, используемые в документации. Никаких запросов не делается ни к каким серверам за пределами pi.brandon3055.com. Единственным возможным исключением является пакетная документация, о которой вы можете прочитать ниже.

Особенности: (Ожидайте, что этот список будет расти по мере развития PI),

Настраиваемый пользовательский интерфейс
Весь пользовательский интерфейс PI настраивается пользователем. В настоящее время в PI есть только 2 предустановки стиля по умолчанию, но в будущем будет добавлено еще больше. Кроме того, пользователи имеют возможность сохранять свои собственные предустановки. Примечание: если вы создали предустановку, которая, по вашему мнению, станет хорошим дополнением к предустановкам по умолчанию, не стесняйтесь размещать их на github.
Интеграция с JEI
PI имеет полную поддержку рецептов JEI, а это означает, что любой рецепт, поддерживаемый JEI, может быть отображен в документации PI.
Связывание контента
Это позволяет вам связывать элементы, блоки или сущности со страницами документации. Это работает с функцией под названием «Объяснить», которая позволяет открывать связанные страницы с документацией, просто нажимая связку клавиш при просмотре объекта в мире или при наведении указателя мыши на предмет в инвентаре.

Ссылка на документацию для

в Gui. Для этой функции в настоящее время требуются моды для ее поддержки (хотя это может измениться в будущем). Эта функция позволяет разработчикам модов связывать конкретные страницы документации с графическими интерфейсами в их моде. Затем Pi добавит информационную кнопку к поддерживаемым графическим интерфейсам, которая откроет мини-окно Pi внутри графического интерфейса, содержащее страницы, связанные с графическим интерфейсом.

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

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

Эта функция добавлена для разработчиков пакетов модов. Это позволяет вам писать документацию, идентичную документации мода, за исключением того, что она не привязана к конкретному моду, и она хранится локально в конфигурации пакета, что означает, что она может быть поставлена с пакетом мода. Стоит отметить, что в отличие от документации модов, автор не контролирую размещение изображений, используемых в документации пакета. Разработчик пакета может разместить их на таком сайте, как imgur.com, или на собственном частном сервере размещения изображений.