fabric

API de malha

Ganchos essenciais para modding com Fabric.

Fabric API é a biblioteca para ganchos essenciais e mecanismos de interoperabilidade para mods Fabric. Os exemplos incluem:

• Expondo funcionalidades que são úteis, mas difíceis de acessar para muitos mods, como partículas, biomas e dimensões
• Adicionando eventos, ganchos e APIs para melhorar a interoperabilidade entre mods.
• Recursos essenciais, como sincronização de registro e adição de informações a relatórios de falhas.
• Uma API de renderização avançada projetada para compatibilidade com mods de otimização e mods de revisão gráfica.

Confira também o Fabric Loader, o carregador de mod (principalmente) independente de versão que alimenta o Fabric. Fabric API é um mod como qualquer outro mod do Fabric que requer a instalação do Fabric Loader.

Para suporte e discussão para desenvolvedores e usuários, visite o servidor Fabric Discord.

Usando a API Fabric para brincar com mods

Certifique-se de ter instalado o carregador de malha primeiro. Mais informações sobre a instalação do Fabric Loader podem ser encontradas aqui.

Para usar a API Fabric, baixe-a em CurseForge, GitHub Releases ou Modrinth.

O arquivo jar baixado deve ser colocado na pasta mods .

Usando a API Fabric para desenvolver mods

Para configurar um ambiente de desenvolvimento do Fabric, verifique o mod de exemplo do Fabric e siga as instruções nele. O mod de exemplo já depende da API Fabric.

Para incluir a API Fabric completa com todos os módulos no ambiente de desenvolvimento, adicione o seguinte ao seu bloco dependencies no buildscript gradle:

DSL bacana

modImplementation " net.fabricmc.fabric-api:fabric-api:FABRIC_API_VERSION "

DSL Kotlin

modImplementation( " net.fabricmc.fabric-api:fabric-api:FABRIC_API_VERSION " )

Como alternativa, os módulos da API do Fabric podem ser especificados individualmente conforme mostrado abaixo (incluindo o jar do módulo no jar do mod):

DSL bacana

 // 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 )))
}

DSL Kotlin

 // 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 ))
}

Em vez de codificar constantes de versão em todo o script de construção, as propriedades Gradle podem ser usadas para substituir essas constantes. As propriedades são definidas no arquivo gradle.properties na raiz de um projeto. Mais informações estão disponíveis aqui.

Contribuindo

Viu algo que a API do Fabric não suporta, um bug ou algo que pode ser útil? Aceitamos contribuições para melhorar a API do Fabric. Certifique-se de ler as diretrizes de desenvolvimento.

Módulos

A API do Fabric foi projetada para ser modular para facilitar a atualização. Isso também tem a vantagem de dividir a base de código em partes menores.

Cada módulo contém seu próprio README.md * explicando a finalidade do módulo e informações adicionais sobre como usá-lo.

* O README de cada módulo está sendo trabalhado; nem todo módulo tem um README no momento