ViaVersion/README.md

95 lines
2.8 KiB
Markdown
Raw Normal View History

2020-08-11 19:06:38 +02:00
# ViaVersion - Spigot, Sponge, BungeeCord, Velocity
2020-08-11 19:06:38 +02:00
[![Latest Release](https://img.shields.io/github/v/release/ViaVersion/ViaVersion)](https://viaversion.com)
2021-04-05 13:32:15 +02:00
[![Build Status](https://github.com/ViaVersion/ViaVersion/actions/workflows/gradle.yml/badge.svg?branch=master)](https://github.com/ViaVersion/ViaVersion/actions)
2017-05-22 16:49:42 +02:00
[![Discord](https://img.shields.io/badge/chat-on%20discord-blue.svg)](https://viaversion.com/discord)
2016-08-21 16:52:59 +02:00
2016-07-01 18:13:01 +02:00
**Allows the connection of higher client versions to lower server versions**
2016-02-29 00:04:59 +01:00
2016-11-13 15:04:56 +01:00
Supported Versions:
2023-06-11 13:02:25 +02:00
![Table (https://i.imgur.com/sTrVnC2.png)](https://i.imgur.com/sTrVnC2.png)
2016-11-13 15:04:56 +01:00
2020-09-21 19:07:29 +02:00
On Paper you may also use ProtocolSupport, but ensure you have the right build for your server version.
2016-07-01 18:13:01 +02:00
**User Docs:** https://docs.viaversion.com/display/VIAVERSION/
2016-03-27 22:50:49 +02:00
2023-03-04 19:43:08 +01:00
Sources
2016-03-27 22:50:49 +02:00
--------
2023-03-04 19:43:08 +01:00
**[OpenNBT](https://github.com/ViaVersion/OpenNBT)**
**[Via Mappings Generator](https://github.com/ViaVersion/Mappings)**
**[Mojang mappings](https://minecraft.fandom.com/wiki/Obfuscation_map)** (Thank you, Mojang, very cool)
**[wiki.vg](https://wiki.vg)** (Used for historic information regarding packet structure, we also contribute back)
2016-03-27 22:50:49 +02:00
**[Burger](https://github.com/Pokechu22/Burger)** (See [PAaaS](https://github.com/Matsv/Paaas))
2016-03-27 22:50:49 +02:00
2016-08-21 16:52:59 +02:00
2023-03-04 19:43:08 +01:00
Releases / Dev Builds
2016-03-27 22:50:49 +02:00
--------
You can find official releases here:
https://www.spigotmc.org/resources/viaversion.19254/history
----------
2016-05-27 19:05:46 +02:00
You can find official dev builds here:
2016-03-27 22:50:49 +02:00
2016-05-27 19:05:46 +02:00
**Jenkins:** https://ci.viaversion.com
2016-03-27 22:50:49 +02:00
2016-05-27 19:05:46 +02:00
**JavaDocs:** https://jd.viaversion.com
2016-03-18 22:25:41 +01:00
**Maven Repository:**
2023-05-29 16:54:45 +02:00
```xml
2023-05-29 16:54:45 +02:00
<repository>
<id>viaversion-repo</id>
<url>https://repo.viaversion.com</url>
</repository>
```
**API-artifact:**
2023-05-29 16:54:45 +02:00
```xml
2023-05-29 16:54:45 +02:00
<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](#license).
2016-03-29 16:36:21 +02:00
2023-03-04 19:43:08 +01:00
Building
2021-02-25 10:21:11 +01:00
--------
2023-05-29 16:54:45 +02:00
After cloning this repository, build the project with Gradle by running `./gradlew build` and take the created jar out
of
the `build/libs` directory.
2021-02-25 10:21:11 +01:00
2023-03-04 19:43:08 +01:00
Mapping Files
--------------
Mapping files are generated and managed in our [Mappings repository](https://github.com/ViaVersion/Mappings).
License
2016-02-29 00:18:33 +01:00
--------
2023-05-29 16:54:45 +02:00
The entirety of the [API directory](api) (including the legacy API directory) is licensed under the MIT License;
see [licenses/MIT.md](licenses/MIT.md) for
details.
2016-02-29 00:04:59 +01:00
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](licenses/GPL.md) for details.
Special thanks to all our [Contributors](https://github.com/ViaVersion/ViaVersion/graphs/contributors).