Приветствую, друзья!

В этой лекции я расскажу, как создать первый предмет для твоего Minecraft мода и добавить его во вкладку из ванильного Minecraft. Мы пройдем все шаги: от создания классов до настройки необходимых файлов. Создадим обычный предмет без какой-либо специфичной логики.

Важно: В дальнейшем все «папки» я буду иногда называть пакетами, так как в Java именно так называются логические группировки классов, организованные в иерархическую структуру, аналогично файловой системе. (К resources это не относится)

Первым делом создаём пакет core в корневой папке проекта (та папка, которая имеет название айди вашего мода). В этом пакете располагается базовая логика инициализации, регистрации и настройки всех основных компонентов проекта. Именно здесь «запускается» наш мод — от него зависит, как будут работать все остальные части проекта.

Далее создаём пакет registry внутри core. В этом пакете будут находиться все классы, отвечающие за регистрацию различных игровых объектов, таких как:

• Предметы

• Блоки

• Эффекты

• Жидкости и т.д.

Суть в том, что вся регистрация компонентов происходит централизованно именно здесь, что помогает держать основной код мода (например, игровой процесс) отделённым от процесса инициализации.

Теперь перейдём к созданию класса регистрации предметов. Я придерживаюсь практики, когда в названии классов регистрации использую заглавные буквы, соответствующие названию проекта. Это позволяет сразу понять, к какому моду принадлежит данный класс.

• Если мод называется Redstone Revolution, я назову класс регистрации предметов RRItems.

• В моём лекционном проекте, который называется Rinova, класс регистрации предметов будет называться RItems. 

Для справки: многие мододелы, если название проекта короткое, используют имена вроде ExampleItems или ExampleBlocks. Лично мне удобнее применять систему с заглавными буквами, поскольку это помогает избежать путаницы. Кстати, изучая проект GregTech, я заметил, что автор использует похожий подход — например, GTItems, GTBlocks и GTBlockEntities.

И так, мы создали наш класс RItems...

Первым делом нам необходимо создать переменную ITEMS, через которую мы будем регистрировать наши предметы. Это делается с помощью класса DeferredRegister<Item>. Он помогает отложить регистрацию до нужного момента загрузки мода. 

• DeferredRegister<Item> — это «контейнер» для ваших предметов, в который вы будете добавлять новые объекты.

• ForgeRegistries.ITEMS — указывает, что регистрировать мы будем именно предметы.

• Rinova.MOD_ID — идентификатор вашего мода (например, "rinova"), необходимый для корректной регистрации. Он нужен для того, чтобы Forge знал, к какому моду принадлежит данный DeferredRegister.

Когда вы начинаете набирать слово DeferredRegister, ваша IDE (например, IntelliJ IDEA или Eclipse) должна показать список доступных классов. Вы можете нажать TAB для автодополнения или дважды щёлкнуть ЛКМ по имени класса — так все необходимые импорты добавятся автоматически:

Если вы вдруг скопировали код из git, то вам необходимо импортировать нужные классы, для этого наведитесь на то, что горит красным и нажмите Alt+Enter.

DeferredRegister<Item> — это специальный помощник в Forge моддинге для регистрации предметов (и не только), который делает этот процесс безопасным и упорядоченным.

Вы собираете все свои новые предметы в список, но регистрировать их в игру нужно в строго определённое время (во время загрузки мода). DeferredRegister позволяет вам «отложить» регистрацию до нужного момента, когда игра готова принять новые объекты.

• Deferred (отложенная регистрация): Вы создаёте список предметов, а Forge сам зарегистрирует их, когда наступит нужное время.

• Типизация <Item>: Указывает, что в этот DeferredRegister будут добавляться объекты типа Item.

• Удобство: Вам не нужно самостоятельно следить за моментом регистрации — всё происходит автоматически в рамках жизненного цикла загрузки мода.

Теперь мы начинаем регистрацию уже самого предмета. Делаем это мы через RegistryObject<Item>. (скрин переменной будет ниже).

На новой строке пишем:

• public — предмет доступен из других классов

• static — объект создаётся один раз при загрузке мода (в контексте Forge)

• final — переменная не может быть изменена после инициализации

Совет: В IntelliJ IDEA можно использовать шорткат psf + Tab для быстрого написания.

• Это контейнер для вашего предмета, который Forge будет использовать для регистрации

• <Item> в угловых скобках указываем тип объекта (в данном случае — обычный предмет)

• Рекомендуется использовать UPPER_SNAKE_CASE (капс и нижние подчёркивания вместо пробелов)
(пример: PINKYLITE_CRYSTAL)
В Java принято писать константы капсом.

• Название должно отражать функционал предмета для удобства разработки

Через знак равно начинаем присваивать значение. После через переменную ITEMS, которую мы создали обращаемся к методу register.

• Первый аргумент ("pinkylite_crystal") — уникальный ID предмета:

- Только строчные буквы и нижние подчёркивания (никаких пробелов и дефисов!)

- Рекомендуется использовать тот же ID, что и в названии переменной, но в snake_case (нижний регистр и нижние подчёркивания)

• Второй аргумент (() -> new Item(...)) — лямбда-выражение:

- Это "фабрика", которая создаст объект предмета, когда Forge будет готов. 

- Простыми словами: "Отложенное создание" чтобы избежать ошибок при загрузке. 

• Здесь настраиваются свойства предмета:

- Максимальный размер стопки

- Прочность (для инструментов)

- Горение в лаве

• Для обычного предмета оставляем пустым — new Item.Properties()

• "pinkylite-crystal" (дефисы вместо подчёркиваний)

• Пропуск RegistryObject<> (без этого предмет не зарегистрируется)

• Использование new Item() напрямую (без лямбда-выражения).

Так же мы можем написать для удобства отдельный метод Java для такого типа предметов, чтобы можно было просто писать id и всё.

Грубо говоря мы создали "функцию" (в java - это методы), которая в закулисье принимает строку, создаёт предмет и возращает уже зарегистрированный предмет. Обьяснять подробно не буду, это уже принципы Java.

Для того, чтобы зарегистрировать наш класс RItems, необходимо создать специальный метод, который будет регистрировать наш созданный класс в главном классе, выглядит он следующим образом:

Метод register нужен для того, чтобы зарегистрировать ITEMS в системе событий (IEventBus). IEventBus — это механизм, который позволяет объектам подписываться на события и реагировать на них.

Теперь переходим в главный класс и регистрируем наш класс RItems внутри конструктора RinovaMod():

Передаём переменную eventBus в метод register. Таким образом наш мод видит существование класса RItems и регистрирует предметы.

Для отображения предмета в игре необходимо создать два JSON-файла: один для модели предмета (отображение текстурки), а второй для его перевода (язык предмета). Иначе это будет фиолетово черная текстура с названием айди предмета.

Строгое соблюдение структуры папок и их названий критически важно. Даже незначительная ошибка в названии (регистр, опечатка) приведёт к некорректной работе мода.  

• Папка resources.

- Корневая директория ресурсов мода (src/main/resources).

• Папка assets.

- Содержит все ресурсы мода: текстуры, модели, локализацию, звуки и т.д.

• Внутри папки с ID мода (rinova):

- textures

Хранит PNG-текстуры элементов игры.

- models

Содержит JSON-файлы, определяющие 3D-модели и их привязку к текстурам.

- lang

Включает JSON-файлы локализации, где задаются названия предметов на разных языках.

Далее переносим текстуру нашего предмета. Оно должно быть размером 16x16 пикселей (либо любой другой размер, но главное соотношение 1:1) и сохранено в формате PNG в пакет textures/item. Название текстуры должно быть - айди_предмета.png:

Текстуры можно создавать в любой удобной для вас программе (Photoshop и т.д.). Я создаю в Aseprite:

Для начала займемся созданием json модели текстуры (папка models). Далее ПКМ по папке item, наводимся на New -> File и прописываем айди_предмета.json. К примеру у меня это будет pinkylite_crystal.json:

Открываем файл и пишем следующую запись:

В этом JSON-файле мы определяем модель предмета для нашего мода. Мы указываем, что наш предмет должен основываться на стандартной 2D-модели item/generated, которая отвечает за отображение иконок в инвентаре и на руке. Затем, в разделе textures, мы назначаем основную текстуру для этого предмета через ключ layer0. Ссылка rinova:item/pinkylite_crystal указывает на файл текстуры, который расположен в папке assets/rinova/textures/item/. 

В папке lang создаём два файла:

• en_us.json - Базовый язык - английский, без него не будет переводов на другие языки)

• ru_ru.json - Русский язык, автоматически предмет переводится, когда ставим в майнкрафте из списка языков "Русский язык"

В этом файле будет находиться название предмета для отображения в игре. Местоположение файлов:

Как создавать перевод предметам:

item - предмет

rinova - айди мода

pinkylite_crystal - айди предмета.

Через двоеточие в ковычках указываем название. Не ошибитесь в знаках!

Русский язык точно такая же запись, но уже другой язык.

Чтобы добавить созданный предмет во вкладку ингредиентов Minecraft (или любую другую стандартную вкладку), необходимо выполнить следующие шаги:

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

Внутри метода addCreative необходимо:

• Получить ключ текущей вкладки с помощью метода event.getTabKey().

• Сравнить полученный ключ с нужной вкладкой, например, CreativeModeTabs.INGREDIENTS.

Если проверка на соответствие вкладки прошла успешно, добавьте предмет в эту вкладку с помощью метода event.accept().

Примечание: Вместо CreativeModeTabs.INGREDIENTS можно указать любую другую вкладку. Для этого после написания CreativeModeTabs. нажмите точку (.), и среда разработки подскажет доступные варианты вкладок.  

Полная запись выглядит следующим образом:

Необходима так же запись modEventBus.addListener(this::addCreative) там же, где мы регистрировали предметы, чтобы мод заметил изменение.

Теперь запускаем игру, для этого справа есть панель и находим runClient:

После заходим в мир, находим нашу вкладку и вуаля, предмет готов

В следующем посте будет написана инструкция как создать свою вкладку креатива!

Весь написанный код:
https://github.com/ringoway/Rinova/pull/2/commits/2f1a9d44f7fbd6f8b5e3b8166928bea9b894a271