Project Intelligence Мод для Minecraft 1.12.2, 1.16.5

Ласкаво просимо до Project Intelligence! він же "PI"

Мета цього проєкту — створити справді універсальний мод для документації, використовуючи силу спільноти Minecraft.

То як це працюватиме? Для початку, будь-який розробник мода може додати документацію для свого мода до PI. Проблема в тому, що розробники модів — зайняті люди, тож більшість із них не матимуть часу писати документацію для якогось випадкового мода документації, як-от PI, і, на мою думку, це головна проблема більшості наявних модів документації. Вони потребують прямої підтримки з боку модерів. PI прагне розв'язати цю проблему, уможлививши для будь-кого зі спільноти долучитися, написавши документацію для різних модів за допомогою відносно простого вбудованого редактора. Потім вони можуть надіслати свою документацію через pull request, і якщо вона пройде перевірку, її буде додано до онлайн-репозиторію.

Усе, що робить PI, є відкритим кодом і повністю прозорим. Уся документація зберігається у своєму початковому вигляді на github. Потім її збирає сервер jenkins і завантажує на вебсервер, яким керує covers1624, де PI може до неї отримати доступ. Усе, що використовує PI, походить із цього сервера, включно з усіма зображеннями, використаними в документації. Жодних запитів не робиться до серверів поза pi.brandon3055.com. Єдиний можливий виняток — документація збірок, про яку ви можете прочитати нижче.

Редагування: наведене вище твердження стане правдивим, коли covers завершить pi bot, який автоматично забезпечуватиме, щоб усі зображення, використані в pi, розміщувалися на нашому сервері. До того часу деяка документація може містити зображення, розміщені на imgur.com або іншому подібному сайті хостингу.

Функції: (Очікуйте, що цей список зростатиме в міру розвитку PI)

Високоналаштовуваний інтерфейс користувача. Увесь інтерфейс користувача PI є високоналаштовуваним користувачем. Наразі PI має лише 2 стандартні набори стилів, але більше буде додано в майбутньому. І користувачі мають можливість зберігати власні налаштовані набори. Примітка: якщо ви створили набір, який, на вашу думку, був би гарним доповненням до стандартних наборів, не соромтеся опублікувати його на github.

Інтеграція з JEI. PI має повну підтримку рецептів JEI, тобто будь-який рецепт, який підтримується JEI, можна відобразити в документації PI.

Пов'язування вмісту та "Explain This". Це дає змогу пов'язувати предмети, блоки або сутності зі сторінками документації. Це працює разом із функцією під назвою "Explain This", яка дає змогу відкривати пов'язані сторінки документації, просто натискаючи призначену клавішу, коли ви дивитеся на об'єкт у світі або коли наводите курсор на предмет в інвентарі.

Пов'язування документації з Gui. Наразі ця функція потребує підтримки з боку модів (хоча в майбутньому це може змінитися). Ця функція дає змогу розробникам модів пов'язувати конкретні сторінки документації з gui у своєму моді. Тоді Pi додасть кнопку "info" до підтримуваних gui, яка відкриватиме мінівікно pi всередині gui зі сторінками, пов'язаними з цим gui.

Підтримка локалізації мов

Вбудований редактор. Редактор документації pi ще потребує доопрацювання, але вже зараз він забезпечує всю базову функціональність, потрібну для написання та підтримки документації.

Підтримка кількох версій модів. Це важлива функція під час написання документації для модів, що постійно змінюються. Ця функція дає змогу оновлювати документацію, коли мод щось змінює, не порушуючи сумісності з попередніми версіями мода.

Документація збірок. Це функція, додана для розробників модпаків. Вона дає змогу писати документацію, ідентичну документації модів, за винятком того, що вона не прив'язана до конкретного мода і зберігається локально в конфігурації збірки, тобто її можна постачати разом із модпаком. Варто зазначити, що, на відміну від документації модів, я не контролюю хостинг зображень, використаних у документації збірок. Розробник збірки має сам розміщувати їх на сайті, як-от imgur.com, або на власному приватному сервері хостингу зображень.

Долучення: ви можете знайти всю потрібну інформацію щодо долучення у власній внутрішньоігровій документації PI.

Зверніть увагу, що серверна система, яка уможливить легке керування документацією, створеною користувачами, ще розробляється covers1624. Я маю можливість вручну приймати документацію, але раджу зачекати, поки covers завершить серверну частину.

Редагування: подумавши ще раз, covers трохи зайнятий іншими проєктами, тож наразі це доведеться залишити ручним процесом.