mirror of
https://github.com/ViaVersion/ViaVersion.git
synced 2024-11-14 06:08:11 +01:00
75db1a7cdf
Bump Java target to 17, clean up using its new language features Remove unnecessary checked exception throwing Remove deprecated code
102 lines
3.3 KiB
Markdown
102 lines
3.3 KiB
Markdown
# ViaVersion
|
|
|
|
[](https://viaversion.com)
|
|
[](https://github.com/ViaVersion/ViaVersion/actions)
|
|
[](https://viaversion.com/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, Velocity, Bungee, and Sponge. We also have projects integrating ViaVersion to run
|
|
on Fabric, Forge, or as a standalone proxy to join from basically any client version on any server version from the
|
|
past decade. **See [HERE](https://github.com/ViaVersion) for an overview of the different Via\* projects.**
|
|
|
|
Supported Versions:
|
|
|
|
|
|
|
|
**User Docs:** https://docs.viaversion.com/display/VIAVERSION/
|
|
|
|
Releases/Dev Builds
|
|
--------
|
|
You can find official releases in the following places:
|
|
|
|
- **Hangar (for our plugins)**: https://hangar.papermc.io/ViaVersion/ViaVersion
|
|
- **Modrinth (for our mods)**: https://modrinth.com/mod/viaversion
|
|
- **GitHub**: https://github.com/ViaVersion/ViaVersion/releases
|
|
|
|
Dev builds for **all** of our projects are on our Jenkins server:
|
|
|
|
- **Jenkins**: https://ci.viaversion.com
|
|
|
|
ViaVersion as a Dependency
|
|
----------
|
|
|
|
**JavaDocs:** https://jd.viaversion.com
|
|
|
|
**Maven:**
|
|
|
|
```xml
|
|
<repository>
|
|
<id>viaversion-repo</id>
|
|
<url>https://repo.viaversion.com</url>
|
|
</repository>
|
|
```
|
|
|
|
```xml
|
|
<dependency>
|
|
<groupId>com.viaversion</groupId>
|
|
<artifactId>viaversion-api</artifactId>
|
|
<version>[4.0.0,5.0.0)</version>
|
|
<scope>provided</scope>
|
|
</dependency>
|
|
```
|
|
|
|
**Gradle:**
|
|
|
|
```kotlin
|
|
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](#license).
|
|
|
|
|
|
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](https://github.com/ViaVersion/Mappings).
|
|
|
|
|
|
Resources
|
|
--------
|
|
|
|
- **[Via Mappings Generator](https://github.com/ViaVersion/Mappings)**
|
|
- **[Mojang mappings](https://minecraft.wiki/w/Obfuscation_map)** (Thank you, Mojang, very cool)
|
|
- **[wiki.vg](https://wiki.vg)** (Used for historic information regarding packet structure, we also contribute back)
|
|
- **[Burger](https://github.com/Pokechu22/Burger)** (See [PAaaS](https://github.com/Matsv/Paaas))
|
|
|
|
License
|
|
--------
|
|
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.
|
|
|
|
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](licenses/GPL.md) for details.
|
|
|
|
Special thanks to all our [Contributors](https://github.com/ViaVersion/ViaVersion/graphs/contributors).
|