mirror of
https://github.com/ViaVersion/ViaFabricPlus.git
synced 2024-11-16 10:55:39 +01:00
da73e8ba19
* Updated Via API usage * Thanks for not pushing this class IntelliJ * Updated Via API usage * Updated Via API usage * Updated MixinProtocolVersion * Moved auto detect to bottom of protocol list * Use sorted version list for GUIs * Fixed compile errors and startup * Fixed config saving and loading * Updated DEVELOPER_API file --------- Co-authored-by: RaphiMC <50594595+RaphiMC@users.noreply.github.com>
5.1 KiB
5.1 KiB
Developer API
ViaFabricPlus provides various events and APIs for developers to use. This page explains how to use them.
Include via Gradle/Maven
repositories {
maven {
name = "ViaVersion"
url = "https://repo.viaversion.com"
}
}
dependencies {
modImplementation("de.florianmichael:viafabricplus:x.x.x") // Get the latest version from releases
}
<repositories>
<repository>
<id>viaversion</id>
<url>https://repo.viaversion.com</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>de.florianmichael</groupId>
<artifactId>viafabricplus</artifactId>
<version>x.x.x</version> <!-- Get the latest version from releases -->
</dependency>
</dependencies>
Events
ViaFabricPlus events are using the Fabric Event API. You can register to them like this:
ChangeProtocolVersionCallback.EVENT.register((oldVersion, newVersion) -> {
System.out.println("Version changed to " + newVersion.getName());
});
ViaFabricPlus has 8 events at the moment
Callback class name | Description |
---|---|
ChangeProtocolVersionCallback | Called when the user changes the target version in the screen, or if you connect to a server for which a specific version has been selected, you disconnect, the event for the actual version is also called. |
DisconnectCallback | Called when the user disconnects from a server |
LoadCallback | Called at the earliest point ViaFabricPlus is injecting too |
LoadClassicProtocolExtensionCallback | Called when the classic server sends the protocol extensions (only in c0.30 CPE) |
PostGameLoadCallback | Called when Minecraft is finished with loading all its components |
PostViaVersionLoadCallback | Called when ViaVersion is loaded and ready to use |
RegisterSettingsCallback | Called after the default setting groups are loaded and before the setting config is loaded |
LoadSaveFilesCallback | Called before and after the save files are loaded |
Get and set the current protocol version
final ProtocolVersion version = ProtocolHack.getTargetVersion();
if (version == ProtocolVersion.v1_8) {
ProtocolHack.setTargetVersion(ProtocolVersion.v1_9);
}
Get a Minecraft ClientConnection by channel
final ClientConnection connection = channel.attr(ProtocolHack.CLIENT_CONNECTION_ATTRIBUTE_KEY).get();
Interact with UserConnection objects
// If ViaVersion is translating, this field will return the user connection of the client
final UserConnection userConnection = ProtocolHack.getPlayNetworkUserConnection();
// If you need a dummy user connection for testing, you can use this method
final UserConnection cursedDummy = ProtocolHack.createDummyUserConnection(ProtocolHack.NATIVE_VERSION, ProtocolVersion.v1_18_2);
// The cursedDummy field now contains all protocols from the native version to 1.18.2
ViaVersion internals
Add CustomPayload channels for versions below 1.13
In order to receive custom payloads with custom channels in versions below 1.13, you need to register them, that's what you do:
Protocol1_13To1_12_2.MAPPINGS.getChannelMappings().put("FML|HS", "fml:hs");
Check if an item exists in a specific version
final VersionRange range = ItemRegistryDiff.ITEM_DIFF.get(Items.WRITABLE_BOOK); // If an item does not appear in the item map, it has always existed
// The Range class then contains all versions in which the item occurs.
// https://github.com/ViaVersion/ViaLoader
if (ItemRegistryDiff.contains(Items.STONE, VersionRange.andOlder(ProtocolVersion.v1_8))) {
// Do something
}