fabric

API de tela

Ganchos esenciales para modificar con Fabric.

Fabric API es la biblioteca para enlaces esenciales y mecanismos de interoperabilidad para mods de Fabric. Los ejemplos incluyen:

• Exponer una funcionalidad que es útil pero de difícil acceso para muchas modificaciones, como partículas, biomas y dimensiones.
• Agregar eventos, enlaces y API para mejorar la interoperabilidad entre mods.
• Funciones esenciales como la sincronización del registro y la adición de información a los informes de fallos.
• Una API de renderizado avanzada diseñada para ser compatible con modificaciones de optimización y modificaciones de revisión de gráficos.

Consulte también Fabric Loader, el cargador de mods (en su mayoría) independiente de la versión que impulsa Fabric. Fabric API es un mod como cualquier otro mod de Fabric que requiere la instalación de Fabric Loader.

Para obtener soporte y debates tanto para desarrolladores como para usuarios, visite el servidor Fabric Discord.

Usando Fabric API para jugar con mods

Primero asegúrese de haber instalado el cargador de tela. Puede encontrar más información sobre la instalación de Fabric Loader aquí.

Para utilizar Fabric API, descárguela de CurseForge, GitHub Releases o Modrinth.

El archivo jar descargado debe colocarse en su carpeta mods .

Usando Fabric API para desarrollar mods

Para configurar un entorno de desarrollo de Fabric, consulte el mod de ejemplo de Fabric y siga las instrucciones allí. El mod de ejemplo ya depende de Fabric API.

Para incluir la API de Fabric completa con todos los módulos en el entorno de desarrollo, agregue lo siguiente a su bloque de dependencies en el script de compilación de Gradle:

DSL maravilloso

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

DSL de Kotlin

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

Alternativamente, los módulos de Fabric API se pueden especificar individualmente como se muestra a continuación (incluido el módulo jar en su mod jar):

DSL maravilloso

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

En lugar de codificar constantes de versión en todo el script de compilación, se pueden usar propiedades de Gradle para reemplazar estas constantes. Las propiedades se definen en el archivo gradle.properties en la raíz de un proyecto. Más información está disponible aquí.

Contribuyendo

¿Ves algo que Fabric API no admite, un error o algo que pueda ser útil? Agradecemos contribuciones para mejorar Fabric API. Asegúrese de leer las pautas de desarrollo.

Módulos

Fabric API está diseñada para ser modular para facilitar la actualización. Esto también tiene la ventaja de dividir el código base en fragmentos más pequeños.

Cada módulo contiene su propio README.md * que explica el propósito del módulo e información adicional sobre su uso.

* Se está trabajando en el README de cada módulo; no todos los módulos tienen un README en este momento