Update README

This commit is contained in:
Nassim Jahnke 2023-08-11 21:06:10 +10:00
parent 7e53f55509
commit 0050872950

View File

@ -1,61 +1,49 @@
# ViaVersion - Spigot, Sponge, BungeeCord, Velocity # ViaVersion
[![Latest Release](https://img.shields.io/github/v/release/ViaVersion/ViaVersion)](https://viaversion.com) [![Latest Release](https://img.shields.io/github/v/release/ViaVersion/ViaVersion)](https://viaversion.com)
[![Build Status](https://github.com/ViaVersion/ViaVersion/actions/workflows/gradle.yml/badge.svg?branch=master)](https://github.com/ViaVersion/ViaVersion/actions) [![Build Status](https://github.com/ViaVersion/ViaVersion/actions/workflows/gradle.yml/badge.svg?branch=master)](https://github.com/ViaVersion/ViaVersion/actions)
[![Discord](https://img.shields.io/badge/chat-on%20discord-blue.svg)](https://viaversion.com/discord) [![Discord](https://img.shields.io/badge/chat-on%20discord-blue.svg)](https://viaversion.com/discord)
**Allows the connection of higher client versions to lower server versions** **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: Supported Versions:
![Table (https://i.imgur.com/sTrVnC2.png)](https://i.imgur.com/sTrVnC2.png) ![Table (https://i.imgur.com/sTrVnC2.png)](https://i.imgur.com/sTrVnC2.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/ **User Docs:** https://docs.viaversion.com/display/VIAVERSION/
Sources Releases/Dev Builds
-------- --------
**[OpenNBT](https://github.com/ViaVersion/OpenNBT)** You can find official releases in the following places:
**[Via Mappings Generator](https://github.com/ViaVersion/Mappings)** - **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
**[Mojang mappings](https://minecraft.fandom.com/wiki/Obfuscation_map)** (Thank you, Mojang, very cool) Dev builds for **all** of our projects are on our Jenkins server:
**[wiki.vg](https://wiki.vg)** (Used for historic information regarding packet structure, we also contribute back) - **Jenkins**: https://ci.viaversion.com
**[Burger](https://github.com/Pokechu22/Burger)** (See [PAaaS](https://github.com/Matsv/Paaas))
Releases / Dev Builds
--------
You can find official releases here:
https://www.spigotmc.org/resources/viaversion.19254/history
ViaVersion as a Dependency
---------- ----------
You can find official dev builds here:
**Jenkins:** https://ci.viaversion.com
**JavaDocs:** https://jd.viaversion.com **JavaDocs:** https://jd.viaversion.com
**Maven Repository:** **Maven:**
```xml ```xml
<repository> <repository>
<id>viaversion-repo</id> <id>viaversion-repo</id>
<url>https://repo.viaversion.com</url> <url>https://repo.viaversion.com</url>
</repository> </repository>
``` ```
**API-artifact:**
```xml ```xml
<dependency> <dependency>
<groupId>com.viaversion</groupId> <groupId>com.viaversion</groupId>
<artifactId>viaversion-api</artifactId> <artifactId>viaversion-api</artifactId>
@ -64,7 +52,17 @@ You can find official dev builds here:
</dependency> </dependency>
``` ```
Replace the version depending on your needs. **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`. If you need access to the existing protocol or platform implementations, use the parent artifact `viaversion`.
Please note the [differences in licensing](#license). Please note the [differences in licensing](#license).
@ -73,8 +71,7 @@ Please note the [differences in licensing](#license).
Building Building
-------- --------
After cloning this repository, build the project with Gradle by running `./gradlew build` and take the created jar out After cloning this repository, build the project with Gradle by running `./gradlew build` and take the created jar out
of of the `build/libs` directory.
the `build/libs` directory.
Mapping Files Mapping Files
@ -82,13 +79,21 @@ Mapping Files
Mapping files are generated and managed in our [Mappings repository](https://github.com/ViaVersion/Mappings). 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.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)
- **[Burger](https://github.com/Pokechu22/Burger)** (See [PAaaS](https://github.com/Matsv/Paaas))
License License
-------- --------
The entirety of the [API directory](api) (including the legacy API directory) is licensed under the MIT 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 see [licenses/MIT.md](licenses/MIT.md) for
details. details.
Everything else, unless explicitly stated otherwise, is licensed under the GNU General Public License, including the end Everything else, unless explicitly stated otherwise, is licensed under the GNU General Public License v3, including the
product as a whole; see [licenses/GPL.md](licenses/GPL.md) for details. 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). Special thanks to all our [Contributors](https://github.com/ViaVersion/ViaVersion/graphs/contributors).