Inner Core Mod Toolchain для Horizon это тулчейн, позволяющий вам эффективно разрабатывать и собирать модификации для мобильной игры Майнкрафт прямо с вашего компьютера.
Для корректной работы этот тулчейн требует:
- Python 3.7 или выше
- node.js 10.15.1 или выше (для TypeScript моддинга), также должен быть установлен
tsc(для этого запуститеnpm install -g tsc) - Android NDK версии r16b (для C++ моддинга), в противном случае он может быть установлен тулчейном когда это будет необходимо
- Java Development Kit 1.8 (для Java моддинга)
Обязательна установка лишь первого компонента, остальные могут быть установлены когда это будет необходимо.
Вы можете просто загрузить репозиторий, однако мы рекомендуем использовать именно скрипт установки. Он поможет вам установить все необходимые компоненты для более эффективного использования. Откройте терминал в папке, которая будет использована для установки тулчейна, и введите команду, следуя информации из интерактивной консоли.
python3 -c "from urllib import request; exec(request.urlopen('https://raw.githubusercontent.com/zheka2304/innercore-mod-toolchain/master/toolchain-setup.py').read().decode('utf-8'))"Либо же сохраните toolchain-setup.py для получения доступа к дополнительным опциям установки и импорта. Вызовите следующую команду для получения подробней.
python3 toolchain-setup.py --helpДля наилучшего опыта взаимодействия рекомендуется установить Visual Studio Code. Эта среда отлично подходит для разработки модов и может быть легко улучшена с помощью расширений и самого тулчейна. Этот репозиторий уже содержит все необходимые файлы для простого взаимодействия с помощью этого редактора.
Рекомендуется установить также следующие расширения:
- ESLint (Microsoft), TSLint уже устарел
- C/C++ Extension Pack (Microsoft)
- Extension Pack for Java (Microsoft)
Просто клонируйте или загрузите этот репозиторий и откройте toolchain.code-workspace, он содержит все что нужно для начала вашего пути! Используйте Ctrl+Shift+B для обращения ко всем доступным возможностям.
Большинство возможностей также внедрены и для работы с помощью IntelliJ IDEA. Используйте меню сборки для обращения к доступным скриптам или задействуйте консоль для получения дополнительной информации.
Тулчейн не требует установленного редактора, или уж тем более, среды, для разработки модов. Вы можете запускать скрипты сборки и настройки напрямую через консоль или открытием файлов, расположенных в папке toolchain/toolchain. Рекомендуем ознакомиться со скриптом toolchain/toolchain/python/task.py для получения подробностей.
Теперь тулчейн работает с проектами как с отдельными составляющими. Мы лишь упростили некоторые вещи для вас, разделив настройки тучлейна от основной сборки.
Используйте импорт, описанный ниже для простого копирования вашего проекта с make.json в обновленный тулчлейн, а если вам что-то не понравится, всегда можно вернуться к старому варианту. Попробуем?
Для начала первой сборки используйте таск Build или запустите ./build-all.bat или ./build-all.sh из консоли. Вам будет предложено выбрать проект, установить дополнительные компоненты и подключиться к устройству. Большинство из перечисленных операций больше вам не потребуются.
Существует три основных типа конфигураций для управления проектами, сборкой и самим тулчейном. Именно они описывают полный процесс сборки вашего проекта.
- make.json — для управления сборкой проектов
- toolchain.json — основная конфигурация тулчейна и базовые свойства для make.json
- template.json — шаблон для последующей генерации make.json
Подробное описание каждого из файлов можно найти в статье.
Для каждой из операций предусмотрены таски Import Project, New Project и Remove Project соответственно, а также команды ./import-project.bat, ./import-project.sh, ./new-project.bat, ./new-project.sh, ./remove-project.bat и ./remove-project.sh. Все операции сопровождаются взаимодействиями в консоли, а значит, и подробное описание каждой из них не требуется.
Используйте таск Select Project или команду ./select-project.bat или ./select-project.sh для открытия меню выборки. В случае если вам не удается найти свой проект, проверьте свойство projectLocations в вашем toolchain.json или импортируйте проект с помощью тулчейна.
Помимо этого, для Visual Studio Code предусмотрены таски Select Project by Active File, Build by Active File и подобные. Они по умолчанию скрыты из меню Ctrl+P > Tasks: Run Task, однако доступны из меню сборки Ctrl+Shift+B и могут быть отображены изменением .vscode/tasks.json вручную.
Запустите таск Check for Updates или команду ./update-toolchain.bat или ./update-toolchain.sh. Локальные компоненты и сам тулчейн будут перепроверены на наличие обновлений. При обновлении затрагивается лишь папка самого тулчейна, изменяются только файлы конфигураций и скрипты. Остальные файлы ни в коем случае не могут быть удалены, либо будут перемещены в копию с суффиксом .bak.
Компоненты могут быть установлены с помощью Integrity Components или команды ./component-integrity.bat или ./component-integrity.sh. Вы можете установить или обновить их в любое время с помощью этой же команды, удаление для компонентов не предусмотрено.
После завершения разработки следующим шагом станет публикация в браузере модов. Выполните таск Assemble Mod for Release или команду ./assemble-release.bat или ./assemble-release.sh. В корне папки будет создан архив <имя_папки>.icmod. Он уже полностью готов для публикации на сайт. Прочитайте статью для получения подробностей.
Вся документация доступна на https://docs.mineprogramming.org. Здесь можно найти информацию о доступных API, изучить основы моддинга и познакомиться с существующими проектами.
Немного устаревшей, но не менее полезной информации, можно найти на https://wiki.mineprogramming.org.
Да, и еще раз да! Форкните репозиторий себе, мы все будем рады новому функционалу. Разработка осуществляется на ветке develop, любые пулл реквесты вне этой ветки будут отклоняться.