Основные крючки для моддинга с помощью Fabric.
Fabric API — это библиотека основных хуков и механизмов взаимодействия для модов Fabric. Примеры включают в себя:
Также обратите внимание на Fabric Loader, (в основном) независимый от версии загрузчик модов, который поддерживает Fabric. Fabric API — это мод, как и любой другой мод Fabric, который требует установки Fabric Loader.
Для поддержки и обсуждения как для разработчиков, так и для пользователей посетите сервер Fabric Discord.
Сначала убедитесь, что вы установили загрузчик ткани. Дополнительную информацию об установке Fabric Loader можно найти здесь.
Чтобы использовать Fabric API, загрузите его с CurseForge, GitHub Releases или Modrinth.
Загруженный jar-файл следует поместить в папку mods
.
Чтобы настроить среду разработки Fabric, ознакомьтесь с примером мода Fabric и следуйте его инструкциям. Пример мода уже зависит от Fabric API.
Чтобы включить полный API Fabric во все модули в среде разработки, добавьте следующее в блок dependencies
в скрипте сборки gradle:
modImplementation " net.fabricmc.fabric-api:fabric-api:FABRIC_API_VERSION "
modImplementation( " net.fabricmc.fabric-api:fabric-api:FABRIC_API_VERSION " )
Альтернативно, модули из Fabric API можно указать индивидуально, как показано ниже (включая jar модуля в ваш mod jar):
// Make a collection of all api modules we wish to use
Set< String > apiModules = [
" fabric-api-base " ,
" fabric-command-api-v1 " ,
" fabric-lifecycle-events-v1 " ,
" fabric-networking-api-v1 "
]
// Add each module as a dependency
apiModules . forEach {
include(modImplementation(fabricApi . module(it, FABRIC_API_VERSION )))
}
// Make a set of all api modules we wish to use
setOf (
" fabric-api-base " ,
" fabric-command-api-v1 " ,
" fabric-lifecycle-events-v1 " ,
" fabric-networking-api-v1 "
).forEach {
// Add each module as a dependency
modImplementation(fabricApi.module(it, FABRIC_API_VERSION ))
}
Вместо жестко закодированных констант версии во всем сценарии сборки для замены этих констант можно использовать свойства Gradle. Свойства определяются в файле gradle.properties
в корне проекта. Более подробная информация доступна здесь.
Видите что-то, что Fabric API не поддерживает, ошибку или что-то, что может быть полезно? Мы приветствуем вклад в улучшение API Fabric. Обязательно прочтите рекомендации по разработке.
API Fabric разработан как модульный для упрощения обновления. Преимущество этого также заключается в разделении базы кода на более мелкие фрагменты.
Каждый модуль содержит собственный README.md
*, объясняющий назначение модуля и дополнительную информацию по его использованию.
* README для каждого модуля находится в стадии разработки; на данный момент не у каждого модуля есть README