Upstream/ViaFabricPlus

Fork 0

mirror of https://github.com/ViaVersion/ViaFabricPlus.git synced 2024-11-02 08:59:31 +01:00

FlorianMichael c94421bfd0

Update documentation folder

2023-11-27 22:02:41 +01:00

9.1 KiB

Raw Blame History

ViaFabricPlus

Fabric mod to connect to EVERY Minecraft server version (Release, Beta, Alpha, Classic, Snapshots, Bedrock) with QoL fixes to the gameplay

Why another protocol translator?

ViaFabricPlus is a deep integration of ViaVersion on the Fabric platform, it implements many changes that can't be fixed on protocol level (old animations, old movement/swimming, collisions and general rendering changes). At the time of writing, VFP is the only protocol translation platform for the client with which you can play on all Minecraft multiplayer versions with many QoL features and get the feel of the old versions.

Supported Server versions

Release (1.0.0 - 1.20.3 snapshot)
Beta (b1.0 - b1.8.1)
Alpha (a1.0.15 - a1.2.6)
Classic (c0.0.15 - c0.30 including CPE)
Snapshots (3D Shareware, 20w14infinite, Combat Test 8C)
Bedrock (1.20.0)

For users

Detailed instructions for use are available here

If you encounter any issues, please report them on the issue tracker or on the ViaVersion Discord

Known incompatibilities

Breaks

Conflicts

DashLoader (*) - Font rendering related fixes aren't working
Armor Skin (*) - Beta HUD changes aren't working

Feature list

Click to open

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, ViaAprilFools, ViaLegacy and ViaBedrock to make it more legit (Metadata fixes, broken packets, edge-cases)
Visual and screen related changes (newer Command Block features, GameMode selection, ...)
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, ...)

For developers and translators

Contributions in the form of pull requests are always welcome, here are some guidelines for contributing to the project.

A detailed TODO list can be found at the class header of this file.

Dependencies

For compiling only! You do not need to install these!

Click to get a list of all dependencies

Dependency	Download
Fabric API	https://github.com/fabricMC/fabric
Fabric Loader	https://github.com/fabricMC/fabric-loader
Classic4J	https://github.com/FlorianMichael/Classic4J
ViaVersion	https://github.com/ViaVersion/ViaVersion
ViaBackwards	https://github.com/ViaVersion/ViaBackwards
ViaLoader	https://github.com/ViaVersion/ViaLoader
ViaLegacy	https://github.com/ViaVersion/ViaLegacy
ViaAprilFools	https://github.com/ViaVersion/ViaAprilFools
ViaBedrock	https://github.com/RaphiMC/ViaBedrock
MinecraftAuth	https://github.com/RaphiMC/MinecraftAuth
Netty-transport-RakNet	https://github.com/CloudburstMC/Network/tree/develop
Reflect	https://github.com/Lenni0451/Reflect
MixinExtras	https://github.com/LlamaLad7/MixinExtras

Setting up a Workspace

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

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

Include via Gradle/Maven

repositories {
    maven { 
        name = "ViaVersion"
        url = "https://repo.viaversion.com"
    }
}

dependencies {
    implementation ("de.florianmichael:viafabricplus:2.9.5") { // Get the latest version from releases
        transitive = false
    }
}

<repositories>
    <repository>
        <id>viaversion</id>
        <url>https://repo.viaversion.com</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>de.florianmichael</groupId>
        <artifactId>viafabricplus</artifactId>
        <version>2.9.5</version> <!-- Get the latest version from releases -->
    </dependency>
</dependencies>

To learn more about the API and about addons, you can simply click here

Disclaimer

It cannot be guaranteed that this mod is allowed on specific servers as it can possibly cause problems with anti-cheat plugins.
(USE ONLY WITH CAUTION!)

9.1 KiB Raw Blame History