fabric

API de tissu

Crochets indispensables pour le modding avec Fabric.

Fabric API est la bibliothèque des hooks essentiels et des mécanismes d'interopérabilité pour les mods Fabric. Les exemples incluent :

• Exposer des fonctionnalités utiles mais difficiles d'accès pour de nombreux mods tels que les particules, les biomes et les dimensions
• Ajout d'événements, de hooks et d'API pour améliorer l'interopérabilité entre les mods.
• Fonctionnalités essentielles telles que la synchronisation du registre et l'ajout d'informations aux rapports de plantage.
• Une API de rendu avancée conçue pour être compatible avec les mods d'optimisation et les mods de révision graphique.

Consultez également Fabric Loader, le chargeur de modules (principalement) indépendant de la version qui alimente Fabric. L'API Fabric est un mod comme tout autre mod Fabric qui nécessite l'installation de Fabric Loader.

Pour obtenir de l'aide et des discussions pour les développeurs et les utilisateurs, visitez le serveur Fabric Discord.

Utiliser l'API Fabric pour jouer avec les mods

Assurez-vous d’avoir d’abord installé Fabric Loader. Plus d’informations sur l’installation de Fabric Loader peuvent être trouvées ici.

Pour utiliser l'API Fabric, téléchargez-la depuis CurseForge, GitHub Releases ou Modrinth.

Le fichier jar téléchargé doit être placé dans votre dossier mods .

Utiliser l'API Fabric pour développer des mods

Pour configurer un environnement de développement Fabric, consultez l'exemple de mod Fabric et suivez les instructions qui s'y trouvent. L'exemple de mod dépend déjà de l'API Fabric.

Pour inclure l'API Fabric complète avec tous les modules de l'environnement de développement, ajoutez ce qui suit à votre bloc dependencies dans le script de construction Gradle :

DSL génial

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

Kotlin DSL

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

Alternativement, les modules de l'API Fabric peuvent être spécifiés individuellement, comme indiqué ci-dessous (en incluant le module jar dans votre mod jar) :

DSL génial

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

Kotlin DSL

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

Au lieu de coder en dur les constantes de version dans tout le script de construction, les propriétés Gradle peuvent être utilisées pour remplacer ces constantes. Les propriétés sont définies dans le fichier gradle.properties à la racine d'un projet. Plus d’informations sont disponibles ici.

Contribuer

Vous voyez quelque chose que l'API Fabric ne prend pas en charge, un bug ou quelque chose qui peut être utile ? Nous apprécions les contributions pour améliorer l’API Fabric. Assurez-vous de lire les directives de développement.

Modules

L'API Fabric est conçue pour être modulaire afin de faciliter la mise à jour. Cela présente également l’avantage de diviser la base de code en morceaux plus petits.

Chaque module contient son propre README.md * expliquant le but du module et des informations supplémentaires sur l'utilisation du module.

* Le README de chaque module est en cours d'élaboration ; tous les modules n'ont pas de README pour le moment