From 567725d996889d49842f409accb1fed135a89bf8 Mon Sep 17 00:00:00 2001 From: Nassim Jahnke Date: Fri, 11 Aug 2023 21:36:20 +1000 Subject: [PATCH] Update README --- README.md | 37 ++++++++++++++++++++++++------------- 1 file changed, 24 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 2751fe51..5a453e67 100644 --- a/README.md +++ b/README.md @@ -4,40 +4,51 @@ [![Build Status](https://github.com/ViaVersion/ViaBackwards/actions/workflows/gradle.yml/badge.svg?branch=master)](https://github.com/ViaVersion/ViaBackwards/actions) [![Discord](https://img.shields.io/badge/chat-on%20discord-blue.svg)](https://viaversion.com/discord) -**Allows older Minecraft client versions to connect to newer server versions** +**Allows older Minecraft client versions to connect to newer server versions.** + +Requires [ViaVersion](https://hangar.papermc.io/ViaVersion/ViaVersion) to be installed.. Supported Versions - -**Green** = ViaVersion\ -**Purple** = ViaBackwards addition +As a plugin, ViaBackwards runs on servers on releases 1.10-latest. Versions from the dev branch will also support the +latest snapshot. You can also use ViaBackwards in ViaFabric or ViaFabricPlus. -![supported_versions](https://i.imgur.com/KpLsMHj.png) +See [HERE](https://github.com/ViaVersion) for an overview of the different Via* projects. -Releases / Dev Builds +Releases/Dev Builds - -**Requires [ViaVersion](https://hangar.papermc.io/ViaVersion/ViaVersion) to be installed** +You can find releases in the following places: -**Dev builds:** https://ci.viaversion.com/view/ViaBackwards/ +- **Hangar (for our plugins)**: https://hangar.papermc.io/ViaVersion/ViaBackwards +- **Modrinth (for our mods)**: https://modrinth.com/mod/viabackwards +- **GitHub**: https://github.com/ViaVersion/ViaBackwards/releases -**Hangar page:** https://hangar.papermc.io/ViaVersion/ViaBackwards +Dev builds for **all** of our projects are on our Jenkins server: + +- **Jenkins**: https://ci.viaversion.com/view/ViaBackwards/ Known issues - -* Custom 1.17+ min_y and height world values are not and will (most likely) never be supported => Clients older than 1.17 will not be able to see or interact with blocks below y=0 and above y=255 -* < 1.17 clients on 1.17+ servers might experience inventory desyncs on certain inventory click actions + +* 1.17+ min_y and height world values that are not 0/256 **are not supported**. Clients older than + 1.17 will not be able to see or interact with blocks below y=0 and above y=255 +* <1.17 clients on 1.17+ servers might experience inventory desyncs on certain inventory click actions * Sound mappings are incomplete ([see here](https://github.com/ViaVersion/ViaBackwards/issues/326)) Other Links - **Maven:** https://repo.viaversion.com -**Issue tracker:** https://github.com/ViaVersion/ViaBackwards/issues - **List of contributors:** https://github.com/ViaVersion/ViaBackwards/graphs/contributors +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. + License - -This project is licensed under the [GNU General Public License](LICENSE). +This project is licensed under the [GNU General Public License Version 3](LICENSE). Special Thanks -