Added backport readme
This commit is contained in:
EnZaXD
GitHub
parent
887f17afde
commit
b6d742d0f4
142
README.md
142
README.md
|
|
@ -1,141 +1 @@
|
|||
<div align="center">
|
||||
<img src="https://raw.githubusercontent.com/ViaVersion/ViaFabricPlus/main/src/main/resources/assets/viafabricplus/icon.png" width="150">
|
||||
<h1>ViaFabricPlus</h1>
|
||||
<a href="https://fabricmc.net"><img src="https://img.shields.io/badge/Mod%20Loader-Fabric-lightyellow?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsTAAALEwEAmpwYAAAFHGlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4gPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNS42LWMxNDIgNzkuMTYwOTI0LCAyMDE3LzA3LzEzLTAxOjA2OjM5ICAgICAgICAiPiA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtbG5zOmRjPSJodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyIgeG1sbnM6cGhvdG9zaG9wPSJodHRwOi8vbnMuYWRvYmUuY29tL3Bob3Rvc2hvcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RFdnQ9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZUV2ZW50IyIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ0MgMjAxOCAoV2luZG93cykiIHhtcDpDcmVhdGVEYXRlPSIyMDE4LTEyLTE2VDE2OjU0OjE3LTA4OjAwIiB4bXA6TW9kaWZ5RGF0ZT0iMjAxOS0wNy0yOFQyMToxNzo0OC0wNzowMCIgeG1wOk1ldGFkYXRhRGF0ZT0iMjAxOS0wNy0yOFQyMToxNzo0OC0wNzowMCIgZGM6Zm9ybWF0PSJpbWFnZS9wbmciIHBob3Rvc2hvcDpDb2xvck1vZGU9IjMiIHBob3Rvc2hvcDpJQ0NQcm9maWxlPSJzUkdCIElFQzYxOTY2LTIuMSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDowZWRiMWMyYy1mZjhjLWU0NDEtOTMxZi00OTVkNGYxNGM3NjAiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6MGVkYjFjMmMtZmY4Yy1lNDQxLTkzMWYtNDk1ZDRmMTRjNzYwIiB4bXBNTTpPcmlnaW5hbERvY3VtZW50SUQ9InhtcC5kaWQ6MGVkYjFjMmMtZmY4Yy1lNDQxLTkzMWYtNDk1ZDRmMTRjNzYwIj4gPHhtcE1NOkhpc3Rvcnk+IDxyZGY6U2VxPiA8cmRmOmxpIHN0RXZ0OmFjdGlvbj0iY3JlYXRlZCIgc3RFdnQ6aW5zdGFuY2VJRD0ieG1wLmlpZDowZWRiMWMyYy1mZjhjLWU0NDEtOTMxZi00OTVkNGYxNGM3NjAiIHN0RXZ0OndoZW49IjIwMTgtMTItMTZUMTY6NTQ6MTctMDg6MDAiIHN0RXZ0OnNvZnR3YXJlQWdlbnQ9IkFkb2JlIFBob3Rvc2hvcCBDQyAyMDE4IChXaW5kb3dzKSIvPiA8L3JkZjpTZXE+IDwveG1wTU06SGlzdG9yeT4gPC9yZGY6RGVzY3JpcHRpb24+IDwvcmRmOlJERj4gPC94OnhtcG1ldGE+IDw/eHBhY2tldCBlbmQ9InIiPz4/HiGMAAAAtUlEQVRYw+XXrQqAMBQF4D2P2eBL+QIG8RnEJFaNBjEum+0+zMQLtwwv+wV3ZzhhMDgfJ0wUSinxZUQWgKos1JP/AbD4OneIDyQPwCFniA+EJ4CaXm4TxAXCC0BNHgLhAdAnx9hC8PwGSRtAFVMQjF7cNTWED8B1cgwW20yfJgAvrssAsZ1cB3g/xckAxr6FmCDU5N6f488BrpCQ4rQBJkiMYh4ACmLzwOQF0CExinkCsvw7vgGikl+OotaKRwAAAABJRU5ErkJggg=="></a>
|
||||
<img src="https://img.shields.io/badge/Enviroment-Client-purple">
|
||||
<a href="https://discord.gg/viaversion"><img src="https://img.shields.io/discord/316206679014244363?color=0098DB&label=Discord&logo=discord&logoColor=0098DB"></a> <br />
|
||||
<a href="https://modrinth.com/mod/viafabricplus"><img src="https://img.shields.io/badge/dynamic/json?color=158000&label=downloads&prefix=+%20&query=downloads&url=https://api.modrinth.com/v2/project/rIC2XJV4&logo=modrinth"></a>
|
||||
<a href="https://curseforge.com/minecraft/mc-mods/viafabricplus"><img src="https://cf.way2muchnoise.eu/full_830604_downloads.svg"></a>
|
||||
<a href="https://github.com/ViaVersion/ViaFabricPlus/actions/workflows/build.yml"><img src="https://github.com/ViaVersion/ViaFabricPlus/actions/workflows/build.yml/badge.svg?branch=main"></a>
|
||||
|
||||
#### Fabric mod to connect to EVERY Minecraft server version (Release, Beta, Alpha, Classic, Snapshots, Bedrock) with QoL fixes to the gameplay
|
||||
</div>
|
||||
|
||||
# Why another protocol translator?
|
||||
ViaFabricPlus is intended to replace [multiconnect](https://github.com/Earthcomputer/multiconnect), and it also promises more compactness and stability. ViaFabricPlus can do everything multiconnect could do, but supports more Minecraft versions (listed below) and has more protocol changes implemented.
|
||||
### Supported Server versions
|
||||
- Release (1.0.0 - 1.20.2)
|
||||
- Beta (b1.0 - b1.8.1)
|
||||
- Alpha (a1.0.15 - a1.2.6)
|
||||
- Classic (c0.0.15 - c0.30 including [CPE](https://wiki.vg/Classic_Protocol_Extension))
|
||||
- Snapshots (3D Shareware, 20w14infinite, Combat Test 8C)
|
||||
- Bedrock (1.20.30)
|
||||
|
||||
### If you want to talk with me, feel free to join my [Discord](https://discord.gg/BwWhCHUKDf)
|
||||
|
||||
# For users
|
||||
### Detailed instructions for use are available [here](.github/USAGE.md)
|
||||
### If you encounter any issues, please report them on the [issue tracker](https://github.com/ViaVersion/ViaFabricPlus/issues) or on the ViaVersion [Discord](https://discord.gg/viaversion)
|
||||
|
||||
## Known incompatibilities
|
||||
### Breaks
|
||||
- ***[ViaFabric (*)](https://github.com/ViaVersion/ViaFabric)***
|
||||
- ***[krypton (<= 0.2.2)](https://github.com/astei/krypton)***
|
||||
- ***[MemoryLeakFix (<= 1.1.0)](https://github.com/fxmorin/MemoryLeakFix)***
|
||||
|
||||
### Conflicts
|
||||
- ***[DashLoader (*)](https://github.com/alphaqu/DashLoader/tree/fabric-1.20)*** - Font rendering related fixes aren't working
|
||||
- ***[Armor Skin (*)](https://github.com/IzzyDotExe/ArmorSkin)*** - Beta HUD changes aren't working
|
||||
|
||||
## List of all clientside related fixes and TODO
|
||||
<details>
|
||||
<summary>Click to open</summary>
|
||||
|
||||
- [x] Bounding boxes for all versions
|
||||
- [x] Entity interaction and movement related packet fixes
|
||||
- [x] Sync and async mouse/keyboard handling in <= 1.12.2
|
||||
- [x] Mining speeds and item attributes
|
||||
- [x] Filter item creative tabs for only available items
|
||||
- [x] Combat system in <= 1.8
|
||||
- [x] Tons of modifications to ViaVersion, ViaAprilFools, ViaLegacy and ViaBedrock to make it more legit (Metadata fixes, broken packets, edge-cases)
|
||||
- [x] Visual and screen related changes (newer Command Block features, GameMode selection, ...)
|
||||
- [x] Chat signatures (secure login) for all versions (1.19.0, 1.19.1, 1.19.2)
|
||||
- [x] Address parsing for all Minecraft versions
|
||||
- [x] PackFormats and HTTP Header for all resource pack versions
|
||||
- [x] Raytrace related fixes in <= 1.8
|
||||
- [x] Implementing HUD changes for <= b1.7.3
|
||||
- [x] Chat lengths of all versions
|
||||
- [x] Implementing non-sequenced block placement in <= 1.18.2
|
||||
- [x] Animation related fixes (1.7 Sneaking, c0.30 walking animation, ...)
|
||||
- [x] Fixed clientside packet handling (1.16.5 transactions, 1.19.0 tablist, ...)
|
||||
</details>
|
||||
|
||||
A detailed TODO List can be found at the class header of [this](https://github.com/ViaVersion/ViaFabricPlus/blob/main/src/main/java/de/florianmichael/viafabricplus/ViaFabricPlus.java) file
|
||||
|
||||
# For developers and translators
|
||||
Contributions in the form of pull requests are always welcome, please just stick to my code style and make sure your code is easy to update and compatible with other mods.
|
||||
|
||||
### Translations
|
||||
Translations for other languages are always welcome, in **~/resources/assets/viafabricplus/lang** you can find all translations, <br>
|
||||
if you know a language well, feel free to make a PR and add translations for that language <br>
|
||||
|
||||
### Dependencies
|
||||
For compiling only! **You do not need to install these!**
|
||||
<details>
|
||||
<summary>Click to get a list of all dependencies</summary>
|
||||
|
||||
| Dependency | Download |
|
||||
|------------------------|------------------------------------------------------------|
|
||||
| Fabric API | https://github.com/fabricMC/fabric |
|
||||
| ViaVersion | https://github.com/ViaVersion/ViaVersion |
|
||||
| ViaBackwards | https://github.com/ViaVersion/ViaBackwards |
|
||||
| Snake YAML | https://mvnrepository.com/artifact/org.yaml/snakeyaml/1.33 |
|
||||
| ViaLegacy | https://github.com/ViaVersion/ViaLegacy |
|
||||
| ViaAprilFools | https://github.com/ViaVersion/ViaAprilFools |
|
||||
| ViaBedrock | https://github.com/ViaVersion/ViaBedrock |
|
||||
| MC-Structs | https://github.com/Lenni0451/MCStructs |
|
||||
| MinecraftAuth | https://github.com/RaphiMC/MinecraftAuth |
|
||||
| Reflect | https://github.com/Lenni0451/Reflect |
|
||||
| ViaLoader | https://github.com/ViaVersion/ViaLoader |
|
||||
| Netty-transport-RakNet | https://github.com/CloudburstMC/Network/tree/develop |
|
||||
| Classic4J | https://github.com/FlorianMichael/Classic4J |
|
||||
| MixinExtras | https://github.com/LlamaLad7/MixinExtras |
|
||||
</details>
|
||||
|
||||
### Setting up a Workspace
|
||||
ViaFabricPlus uses Gradle, to make sure that it is installed properly you can check [Gradle's website](https://gradle.org/install/).
|
||||
1. Clone the repository using `git clone https://github.com/ViaVersion/ViaFabricPlus`.
|
||||
2. CD into the local repository.
|
||||
3. Run `./gradlew genSources`.
|
||||
4. Open the folder as a Gradle project in your preferred IDE.
|
||||
5. Run the mod.
|
||||
|
||||
### Include via Gradle/Maven
|
||||
```groovy
|
||||
repositories {
|
||||
maven {
|
||||
name = "ViaVersion"
|
||||
url = "https://repo.viaversion.com"
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation ("de.florianmichael:viafabricplus:2.8.7") { // Get the latest version from releases
|
||||
transitive = false
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```xml
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>viaversion</id>
|
||||
<url>https://repo.viaversion.com</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>de.florianmichael</groupId>
|
||||
<artifactId>viafabricplus</artifactId>
|
||||
<version>2.8.7</version> <!-- Get the latest version from releases -->
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
|
||||
### To learn more about the API and about addons, you can simply click [here](.github/DEVELOPER_API.md)
|
||||
|
||||
## Disclaimer
|
||||
|
||||
It cannot be guaranteed that this mod is allowed on specific servers as it can possibly cause problems with anti-cheat plugins.\
|
||||
***(USE ONLY WITH CAUTION!)***
|
||||
This is a backport of the actual mod to Minecraft version 1.20.1, this backport no longer gets updates and is not supported, for more information please switch to the main branch
|
||||
|
|
|
|||
Loading…
Reference in New Issue