Allows the connection of newer clients to older server versions for Minecraft servers.
Go to file
2024-12-10 11:30:03 +01:00
.github [ci skip] Update bug report template 2024-12-09 11:22:22 +01:00
.idea Update API license headers and scope 2024-01-12 10:21:45 +01:00
api Sword blocking: consumables for 1.21.4+, back to shields for 1.20.5-1.21.3 (#4299) 2024-12-09 11:08:51 +01:00
build-logic Address Gradle deprecation warnings 2024-11-17 13:43:10 +01:00
bukkit Make pick item provider Folia-compatible 2024-12-09 15:47:42 +01:00
bukkit-legacy Rename remaining packages in bukkit modules to new format (#4074) 2024-08-05 09:48:01 +02:00
common Handle supported/primary items in registry data 2024-12-10 11:30:03 +01:00
fabric Update required ViaFabric version, don't require fabric-loader (#4174) 2024-10-10 12:26:32 +02:00
gradle [ci skip] Update bug report template 2024-12-09 11:22:22 +01:00
licenses Update license headers 2024-01-01 12:39:45 +01:00
sponge/src/main/resources Define as Sponge plugin for ViaSponge (#4163) 2024-10-02 10:41:59 +02:00
universal Define as Sponge plugin for ViaSponge (#4163) 2024-10-02 10:41:59 +02:00
velocity Pre-size most allocated byte buffers 2024-11-04 21:27:09 +01:00
.editorconfig Use enhanced switches in more places (#4043) 2024-07-24 14:32:36 +02:00
.gitignore Add URL of ViaProxy to runViaProxy task (#4215) 2024-10-30 09:39:15 +01:00
build.gradle.kts Address Gradle deprecation warnings 2024-11-17 13:43:10 +01:00
gradle.properties Bump version to 5.2.1-SNAPSHOT 2024-12-06 17:03:29 +01:00
gradlew Update Gradle wrapper 2024-07-14 21:31:38 +02:00
gradlew.bat Update Gradle wrapper 2024-07-14 21:31:38 +02:00
LICENSE Split parts of common into api; We are now GPL, api is MIT 2021-03-24 14:02:37 +01:00
README.md Add snapshot support section to README 2024-12-04 20:42:40 +01:00
settings.gradle.kts Define as Sponge plugin for ViaSponge (#4163) 2024-10-02 10:41:59 +02:00

ViaVersion

Latest Release Build Status Discord

Allows the connection of higher client versions to lower server versions - it works on any platform you can think of.

The base ViaVersion jar runs on Paper and Velocity. We also have projects integrating ViaVersion to run on Fabric, Forge, Bungee, Sponge, or as a standalone proxy to join from basically any client version on any server version from the past decade. See HERE for an overview of the different Via* projects.

Note that ViaVersion will be able to run best on either Paper servers or through ViaFabricPlus due to having direct access to client/server state and more extensive API.

Supported Versions:

Table (https://i.imgur.com/zrQTcf0.png)

User Docs: https://docs.viaversion.com/display/VIAVERSION/

Snapshot support

ViaVersion will only be released a few days after a Minecraft update unless the protocol changes of the update were trivial. If you want early-access, usually days or even weeks before the final release, you can subscribe to either:

  • GitHub Sponsors (preferred option. Use the /verify command on this Discord after), or alternatively
  • Patreon (see the highest tier and make sure to link Patreon to your Discord account under Settings->Connections) This also includes access to a private repository with the code, which will be pushed to the public repository after the given delay on a Minecraft update.

Releases/Dev Builds

You can find official releases in the following places:

Dev builds for all of our projects are on our Jenkins server:

ViaVersion as a Dependency

JavaDocs: https://jd.viaversion.com

Maven:

<repository>
    <id>viaversion-repo</id>
    <url>https://repo.viaversion.com</url>
</repository>
<dependency>
    <groupId>com.viaversion</groupId>
    <artifactId>viaversion-api</artifactId>
    <version>[5.0.0,6.0.0)</version>
    <scope>provided</scope>
</dependency>

Gradle:

repositories {
    maven("https://repo.viaversion.com")
}

dependencies {
    compileOnly("com.viaversion:viaversion-api:VERSION") // Replace the version
}

If you need access to the existing protocol or platform implementations, use the parent artifact viaversion. Please note the differences in licensing.

Note: If you want to make your own platform implementation of ViaVersion (and additional addons), you can use the ViaLoader project.

Building

After cloning this repository, build the project with Gradle by running ./gradlew build and take the created jar out of the build/libs directory.

You need JDK 17 or newer to build ViaVersion.

Mapping Files

Mapping files are generated and managed in our Mappings repository. The generated mapping output is stored here.

Resources

License

The entirety of the API directory is licensed under the MIT License; see licenses/MIT.md for details.

Everything else, unless explicitly stated otherwise, is licensed under the GNU General Public License v3, including the end-product as a whole; see licenses/GPL.md for details.

Special thanks to all our Contributors.