fabric

Fabric-API

Unverzichtbare Haken zum Modding mit Fabric.

Fabric API ist die Bibliothek für wesentliche Hooks und Interoperabilitätsmechanismen für Fabric-Mods. Beispiele hierfür sind:

• Bereitstellung nützlicher, aber für viele Mods schwer zugänglicher Funktionen wie Partikel, Biome und Dimensionen
• Hinzufügen von Ereignissen, Hooks und APIs zur Verbesserung der Interoperabilität zwischen Mods.
• Wesentliche Funktionen wie die Registrierungssynchronisierung und das Hinzufügen von Informationen zu Absturzberichten.
• Eine erweiterte Rendering-API, die auf Kompatibilität mit Optimierungs-Mods und Grafiküberholungs-Mods ausgelegt ist.

Schauen Sie sich auch Fabric Loader an, den (größtenteils) versionenunabhängigen Mod-Loader, der Fabric antreibt. Fabric API ist ein Mod wie jeder andere Fabric-Mod, für den Fabric Loader installiert sein muss.

Für Support und Diskussionen für Entwickler und Benutzer besuchen Sie den Fabric Discord-Server.

Verwenden Sie die Fabric-API, um mit Mods zu spielen

Stellen Sie sicher, dass Sie zuerst den Stofflader installiert haben. Weitere Informationen zur Installation von Fabric Loader finden Sie hier.

Um die Fabric-API zu verwenden, laden Sie sie von CurseForge, GitHub Releases oder Modrinth herunter.

Die heruntergeladene JAR-Datei sollte in Ihrem mods Ordner abgelegt werden.

Verwenden der Fabric-API zum Entwickeln von Mods

Um eine Fabric-Entwicklungsumgebung einzurichten, schauen Sie sich den Fabric-Beispiel-Mod an und befolgen Sie die dortigen Anweisungen. Der Beispiel-Mod hängt bereits von der Fabric API ab.

Um die vollständige Fabric-API mit allen Modulen in der Entwicklungsumgebung einzuschließen, fügen Sie Folgendes zu Ihrem dependencies im Gradle-Buildscript hinzu:

Tolles DSL

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

Kotlin DSL

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

Alternativ können Module der Fabric API wie unten gezeigt einzeln angegeben werden (einschließlich Modul-JAR zu Ihrem Mod-JAR):

Tolles DSL

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

Anstatt Versionskonstanten im gesamten Build-Skript fest zu codieren, können Gradle-Eigenschaften verwendet werden, um diese Konstanten zu ersetzen. Eigenschaften werden in der Datei gradle.properties im Stammverzeichnis eines Projekts definiert. Weitere Informationen finden Sie hier.

Mitwirken

Sehen Sie etwas, das die Fabric-API nicht unterstützt, einen Fehler oder etwas, das nützlich sein könnte? Wir freuen uns über Beiträge zur Verbesserung der Fabric API. Lesen Sie unbedingt die Entwicklungsrichtlinien.

Module

Die Fabric-API ist modular aufgebaut, um die Aktualisierung zu erleichtern. Dies hat auch den Vorteil, dass die Codebasis in kleinere Teile aufgeteilt wird.

Jedes Modul enthält seine eigene README.md *, in der der Zweck des Moduls und zusätzliche Informationen zur Verwendung des Moduls erläutert werden.

* An der README-Datei für jedes Modul wird gearbeitet; Derzeit gibt es nicht für jedes Modul eine README-Datei