Upstream/ViaFabricPlus
1
0
Fork 0
mirror of https://github.com/ViaVersion/ViaFabricPlus.git synced 2024-11-04 09:19:33 +01:00
Code Issues Packages Projects Releases Wiki Activity
e2ed24fdb7
ViaFabricPlus/README.md
FlorianMichael e2ed24fdb7 updated README
2023-03-20 21:20:43 +01:00

14 KiB
Raw Blame History

ViaFabricPlus


Clientside ViaVersion, ViaLegacy, ViaBedrock and ViaAprilFools implementation with clientside fixes for Fabric

This project has nothing to do with the original ViaFabric and is therefore also not compact

Why?

ViaFabricPlus is supposed to be an alternative to multiconnect that offers more compactness and more clientside improvements, as ViaFabricPlus implements all Via platforms (ViaVersion, ViaBackwards, ViaLegacy, ViaAprilFools, ViaBedrock) and adds tons of clientside fixes and QoL improvements like old rendering for all platforms.

Issues and Contributions

If you encounter any issues, please report them on the issue tracker.
Contributions in the form of pull requests are always welcome, please just stick to my code style and make sure your code is easy to update and compatible with other mods.

Translations

Translations for other languages are always welcome, in ~/resources/assets/viafabricplus/lang you can find all translations, if you know a language well, feel free to make a PR and add translations for that language

Currently supported languages:

  • English

Compatibility

ViaFabricPlus is structured to interfere with mods as little as possible. It should work fine with most if not all mods and modpacks.

Known incompatibilities:

Basic Features

  • ViaVersion implementation
  • ViaBackwards implementation
  • ViaLegacy implementation
  • ViaAprilFools implementation
  • ViaBedrock implementation
  • BetaCraft implementation for MP Pass

Clientside related Fixes

  • Bounding boxes for all versions
  • Entity interaction and movement related packet fixes
  • Sync and async mouse/keyboard handling in <= 1.12.2
  • Mining speeds and item attributes
  • Filter item creative tabs for only available items
  • Combat system in <= 1.8
  • Tons of modifications to ViaVersion to make it more legit (Metadata fixes, broken packets, edge-cases)
  • Visual and screen related changes (newer Command Block features, GameMode selection, ...)
  • ViaAprilFools and ViaLegacy extensions to make it more legit
  • Chat signatures (secure login) for all versions (1.19.0, 1.19.1, 1.19.2)
  • Address parsing for all minecraft versions
  • PackFormats and HTTP Header for all resource pack versions
  • Raytrace related fixes in <= 1.8
  • Implementing HUD changes for <= b1.7.3
  • Chat lengths of all versions
  • Implementing non-sequenced block placement in <= 1.18.2
  • Animation related fixes (1.7 Sneaking, c0.30 walking animation, ...)
  • Fixed clientside packet handling (1.16.5 transactions, 1.19.0 tablist, ...)

TODO

  • ClassiCube implementation for MP Pass
  • BetaCraft server list screen
  • More extensions for Classic Protocol Extensions protocol
  • Window click interactions in <= 1.16.5

Backports

Basically there are no backports, the last version of ViaFabricPlus that supported a specific Minecraft version is also the last one that exists for that Minecraft version.
However, if a version between two Minecraft versions is too unstable, I will definitely make backports, you can find them only on modrinth/curseforge,
they do not have their own releases, current backports (named after their branch):

Dependencies

Dependency Download
Fabric API https://github.com/fabricMC/fabric
ViaVersion https://github.com/ViaVersion/ViaVersion
ViaBackwards https://github.com/ViaVersion/ViaBackwards
Snake YAML https://mvnrepository.com/artifact/org.yaml/snakeyaml/1.33
ViaLegacy https://github.com/RaphiMC/ViaLegacy
ViaAprilFools https://github.com/RaphiMC/ViaAprilFools
ViaBedrock https://github.com/RaphiMC/ViaBedrock
MC-Structs https://github.com/Lenni0451/MCStructs
Reflect https://github.com/Lenni0451/Reflect
ViaLoadingBase https://github.com/FlorianMichael/ViaLoadingBase
Netty-transport-RakNet https://github.com/CloudburstMC/Network/tree/develop

Setting up a Workspace

ViaFabricPlus uses Gradle, to make sure that it is installed properly you can check Gradle's website.

  1. Clone the repository using git clone https://github.com/FlorianMichael/ViaFabricPlus.
  2. CD into the local repository.
  3. Run ./gradlew genSources.
  4. Open the folder as a Gradle project in your preferred IDE.
  5. Run the mod.

Settings and GUI

In the multiplayer screen you will find the ViaFabricPlus button in the upper left corner by default, it is the main button,
click on it, and you will see the Protocol selection, there you can choose the Minecraft version you want to connect to,
in the upper left corner you can go to the Settings.

Settings are optional settings that can turn fixes on and off, originally they were used for debugging

Bedrock edition

Keep in mind that the Java -> Bedrock support is still in beta phase, and therefore many things are not implemented
yet and there is no guarantee that everything will work as it should.

To log in to a Bedrock account you can press the button "Click to set account for Bedrock edition" in the settings,
then you can log in via device login, the account logged in there will be stored in ~/ViaFabricPlus/bedrock.account.

Classic stuff

Custom protocol extensions

ViaFabricPlus implements new Classic Extensions into the CPE protocol of ViaLegacy which are rather client side.

  • WeatherType extension (version 1)

Protocol commands

To better control the Classic Protocol, there are a few clientside commands, the command prefix is /v:

  • /vhelp - Displays all commands, available from: c0.28-c0.30
  • /vsettime <Time (Long)> - Changes the Clientside World Time, available from: c0.28-c0.30
  • /vlistextensions - Displays all classic protocol extensions, available in: c0.30 CPE

Addons

There is no real addon base, to create addons you can simply use the event system, which uses Fabric's Event-API.

public class ViaFabricPlusExampleAddon implements ClientModInitializer {

  @Override
  public void onInitializeClient() {
    ChangeProtocolVersionCallback.EVENT.register(protocolVersion -> {
      System.out.println("Version changed to " + protocolVersion.getName());
    });
  }
}

ViaFabricPlus has 7 events at the moment:

Callback class name Description
ChangeProtocolVersionCallback Called when the user changes the target version in the screen
FinishMinecraftLoadCallback Called when Minecraft is finished with loading all its components
FinishViaLoadingBaseStartupCallback Called when ViaLoadingBase and Via* is loaded and ready to use
InitializeSettingsCallback Called after the default setting groups are loaded and before the setting config is loaded
LoadClassicProtocolExtensionCallback Called when the classic server sends the protocol extensions (only in c0.30 CPE)
PreLoadCallback Called before everything (Pre-pre load)
SkipIdlePacketCallback Called as soon as the idle packet is skipped in the <= 1.8

General API

Get the release version of an material:

final ProtocolRange range = ItemReleaseVersionDefinition.INSTANCE.getItemMap().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. 
// You can find out how the Range class works in the ViaLoadingBase README.
// https://github.com/FlorianMichael/ViaLoadingBase

Creating own settings for the settings screen:

public class ExampleSettingGroup extends SettingGroup {
    public final static ExampleSettingGroup INSTANCE = new ExampleSettingGroup();
    
    public final BooleanSetting test = new BooleanSetting("Test", false);
    
    public ExampleSettingGroup() {
        super("Example");
    }
}

and then you register the setting group in your onLoad method:

PreLoadCallback.EVENT.register(() -> {
    ViaFabricPlus.INSTANCE.getSettingsSystem().addGroup(ExampleSettingGroup.INSTANCE);
});

Implementing classic protocol commands:

public class ExampleCommand implements ICommand {

    @Override
    public String name() {
        return "example";
    }

    @Override
    public String description() {
        return null;
    }

    @Override
    public void execute(String[] args) {
    }
}

and then you register the command in your onLoad method:

PreLoadCallback.EVENT.register(() -> {
    ClassicProtocolCommands.commands.add(new ExampleCommand());
});

Implementing custom classic protocol extensions:

public class ExampleExtensionSupport implements ClientModInitializer {

  public static ClientboundPacketsc0_30cpe EXT_CLICK_DISTANCE;

  @Override
  public void onInitializeClient() {
    PreLoadCallback.EVENT.register(() -> {
      CustomClassicProtocolExtensions.allowExtension(ClassicProtocolExtension.CLICK_DISTANCE); // Register extension as supported

      EXT_CLICK_DISTANCE = CustomClassicProtocolExtensions.createNewPacket(ClassicProtocolExtension.CLICK_DISTANCE, 0x12, (user, buf) -> buf.readShort());
    });

    FinishViaLoadingBaseStartupCallback.EVENT.register(() -> {
      Via.getManager().getProtocolManager().getProtocol(Protocolc0_30toc0_30cpe.class).registerClientbound(EXT_CLICK_DISTANCE, null, new PacketHandlers() {
        @Override
        protected void register() {
          handler(wrapper -> {
            wrapper.cancel();
            final short distance = wrapper.read(Type.SHORT);
            // Do your stuff...
          });
        }
      }, true);
    });
  }
}

Alternatives

  • ClientViaVersion: Discontinued 5zig plugin.
  • multiconnect: Fabric mod for connecting to older versions: down to 1.11 (stable) and 1.8 (experimental).
  • ViaFabric: Client-side and server-side ViaVersion implementation for Fabric

⚠️ WARNING ⚠️

I cannot guarantee that this mod is allowed on every (or even any) server. This mod may cause problems with anti cheat plugins. USE AT OWN RISK