ViaVersion/README.md
2023-03-04 19:43:08 +01:00

2.8 KiB

ViaVersion - Spigot, Sponge, BungeeCord, Velocity

Latest Release Build Status Discord

Allows the connection of higher client versions to lower server versions

Supported Versions:

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

On Paper you may also use ProtocolSupport, but ensure you have the right build for your server version.

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

Sources

OpenNBT

Via Mappings Generator

Mojang mappings (Thank you, Mojang, very cool)

wiki.vg (Used for historic information regarding packet structure, we also contribute back)

Burger (See PAaaS)

Releases / Dev Builds

You can find official releases here:

https://www.spigotmc.org/resources/viaversion.19254/history


You can find official dev builds here:

Jenkins: https://ci.viaversion.com

JavaDocs: https://jd.viaversion.com

Maven Repository:

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

API-artifact:

<dependency>
    <groupId>com.viaversion</groupId>
    <artifactId>viaversion-api</artifactId>
    <version>[4.0.0,5.0.0)</version>
    <scope>provided</scope>
</dependency>

Replace the version depending on your needs.

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

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.

Mapping Files

Mapping files are generated and managed in our Mappings repository.

License

The entirety of the API directory (including the legacy 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, including the end product as a whole; see licenses/GPL.md for details.

Special thanks to all our Contributors.