Архитектурный API для кроссплатформенных модов

Обсудить проект можно в нашем Discord!

Это промежуточный API, призванный упростить разработку модов для нескольких платформ одновременно.

Что такое Architectury API?

Architectury API — это прослойка, которая абстрагирует вызовы к API Fabric и Forge. Оба загрузчика имеют разные реализации одних и тех же концепций, и этот API призван их унифицировать.

Проект активно развивается и регулярно обновляется, добавляя новые события и возможности. На данный момент он включает:

• Более 90 событий (event hooks).
• Абстракцию для сетевого взаимодействия.
• Абстракцию для вызовов, специфичных для загрузчика.
• Абстракцию для игровых реестров.
• Удобную аннотацию @ExpectPlatform (работает только со статическими методами).

Обязательно ли использовать этот API?

Важно понимать разницу между двумя компонентами экосистемы Architectury:

1. Architectury Plugin — это Gradle-плагин, который и делает возможной саму кроссплатформенную разработку.
2. Architectury API — это необязательная библиотека, которую можно использовать в проектах, созданных с помощью плагина.

Вы можете создать кроссплатформенный мод, используя только плагин, без подключения этого API.

Преимущества подхода

• Открытый исходный код.
• Меньше шаблонного кода для поддержки нескольких платформ.

С чего начать разработку?

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

• Architectury Loom: https://github.com/architectury/architectury-loom (форк Fabric Loom с поддержкой мультиплатформенной разработки).
• Gradle Plugin: https://github.com/architectury/architectury-plugin (включает Architectury Injectables для работы аннотации @ExpectPlatform).
• Шаблоны модов (рекомендуется): https://github.com/architectury/architectury-templates (набор готовых шаблонов для быстрого старта).
• Пример мода (устарел): https://github.com/architectury/architectury-example-mod (используйте вместо него шаблоны).

Как работает @ExpectPlatform?

Аннотация @ExpectPlatform — ключевой инструмент для указания платформенно-специфичной реализации метода. В общем коде вы объявляете метод с этой аннотацией, а его реализация предоставляется в отдельных модулях для Forge и Fabric.

Благодарности

В некоторых старых версиях эта библиотека включала в себя проект typetools. Его лицензию можно найти здесь.