This is an old revision of the document!
Table of Contents
Настройка среды разработки
Необходимо перед началом
- Java Development Kit (JDK) для Java 8 (рекомендуем) или новее https://adoptopenjdk.net/
- Любая среда разработки Java, например Intellij IDEA или Eclipse. Однако, Вы также можете использовать любые текстовые редакторы, вроде Visual Studio Code.
Первые шаги
Существует два основных способа создать мод для Minecraft, используя Fabric. Вы можете либо вручную скачать fabric-example-mod и установить его самостоятельно, или же воспользоваться автоматическим инструментарием.
Ручное управление
- Скопируйте начальные файлы fabric-example-mod (или версию для Kotlin, если вы хотите использовать Kotlin), за исключением файлов
LICENSE
иREADME.md
, так как они нужны только для самого шаблона и не обязательны для Вашего мода. - Отредактируйте
gradle.properties
:- Установите полям
archives_base_name
иmaven_group
Ваши предпочтитаемые значения. - Не забудьте обновить поля версий Minecraft, маппингов и Loader, - все из них Вы можете узнать на этом сайте - чтобы они совпадали с теми, что Вы хотите.
- Добавьте в
build.gradle
иные зависимости, которые Вы планируете использовать. - Импортируйте файл
build.gradle
в Вашу среду разработки. Вы можете взглянуть на секцию, соответствующую Вашей среде, ниже. - Счастливой разработки!
Вы можете сгенерировать исходники Minecraft ради справки (так как IDEA умеет декомпилировать, это полезно только для поиска по исходному коду):
Запустите задачу Gradle genSources
. Если в Вашей среде разработки нет интеграции с Gradle, то запустите следующую команду в терминале: ./gradlew genSources
IntelliJ IDEA
Если вы используете IntelliJ IDEA от JetBrains, пожалуйста, выполните следующие действия:
- В главном меню IDEA, выберите 'Import Project' (или File → Open… если у вас уже есть открытый проект).
- Выберите файл build.gradle проекта, чтобы импортировать его.
- После того как Gradle закончит настройку, закройте проект (File → Close Project) и снова откройте, чтобы исправить неверное отображение конфигураций запуска.
- (Если конфигурации запуска по-прежнему не отображаются, попробуйте повторно импортировать проект Gradle с вкладки Gradle в IDEA.)
Необязательно, но рекомендуется: По умолчанию IntelliJ делегирует Gradle создание проекта. Это не нужно для Fabric и вызывает более длительное время сборки и связанные с горячей заменой странности, среди прочих проблем. Чтобы исправить это используйте встроенный компилятор:
- Откройте диалоговое окно 'Gradle Settings' на вкладке Gradle.
- Измените поля 'Build and run using' и 'Run tests using' на 'IntelliJ IDEA'.
- Перейдите в File → Project Structure → Project и установите 'Project compiler output' на
$PROJECT_DIR$/out
.
К сожалению, в настоящее время невозможно установить значение IDE по умолчанию для параметров 'Build and run using' и 'Run tests using', поэтому эти шаги должны повторяться для каждого нового проекта.
ПРИМЕЧАНИЕ: Не запускайте ./gradlew idea
, так как это портит gradle и нарушает среду разработки.
Eclipse
Если вы используете Eclipse и хотите, чтобы IDE запускала конфигурации, вы можете запустить gradlew eclipse
.
Visual Studio Code
Если вы используете VSCode от Microsoft, пожалуйста, следуйте этим инструкциям
MinecraftDev IntelliJ IDEA Plugin
Если вы используете IntelliJ IDEA, вы можете использовать плагин MinecraftDev. Этот плагин добавляет поддержку автоматического создания проектов Fabric, а также некоторых функций, связанных с mixin, таких как проверки, генерация accessors/shadow полей и копирование целевых ссылок Mixin (дескрипторов JVM). Плагин можно найти в репозитории плагинов IntelliJ, таким образом, вы можете установить его с помощью внутреннего браузера плагинов IntelliJ, перейдя в File → Settings → Plugins, затем перейдите на вкладку Marketplace и выполните поиск по слову Minecraft.
Generator
Если вы не можете использовать плагин MinecraftDev или fabric-example-mod, вы также можете использовать GeneratorFabricMod от ExtraCrafTX, удобный инструмент для автоматического создания новых модов Fabric из шаблона. Выполните следующие действия:
- Скачайте последнюю версию GeneratorFabricMod здесь и извлеките его.
- Создайте новый каталог, затем запустите там командную строку и введите
path/to/GeneratorFabricMod/bin/GeneratorFabricMod
. - После того как он получите свои зависимости, следуйте инструкциям и введите необходимую информацию.
- Теперь все готово, просто откройте папку проекта в вашей IDE.
Приступая к работе
Попробуйте добавить предмет или блок. Также посетите Применение изменений без перезапуска Minecraft.
Совет
- Хотя Fabric API не является строго необходимым для разработки модов, его основная цель-обеспечить кросс-совместимость, где этого не делает игровой движок, и поэтому он настоятельно рекомендуется! Даже некоторые учебники в вики неявно требуют Fabric API.
- Иногда при разработке fabric-loom (нашего плагина Gradle build plugin) могут возникать проблемы, требующие сброса файлов кэша. Это можно сделать, запустив
gradlew cleanloom
. Запускgradlew --stop
также может помочь с несколькими редкими проблемами. - Не стесняйтесь задавать вопросы! Мы здесь, чтобы помочь вам и работать с вами, чтобы сделать ваш мод мечты реальностью.
Диагностика
Отсутствующие звуки
Иногда при импорте проекта Gradle в IDE ресурсы могут загружаться неправильно. В этом случае запустите задачу downloadAssets
вручную - либо с помощью встроенного меню IDE, либо просто запустив gradlew downloadAssets
.