Updated TODO list and README

This commit is contained in:
FlorianMichael 2023-08-04 22:38:01 +02:00
parent 76f58bd392
commit 3e930e7b69
No known key found for this signature in database
GPG Key ID: C2FB87E71C425126
2 changed files with 19 additions and 14 deletions

View File

@ -24,7 +24,7 @@ ViaFabricPlus is intended to replace [multiconnect](https://github.com/Earthcomp
### 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 [here](.github/USAGE.md)
### 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
@ -32,7 +32,7 @@ ViaFabricPlus is intended to replace [multiconnect](https://github.com/Earthcomp
- ***[krypton (<= 0.2.2)](https://github.com/astei/krypton)***
- ***[MemoryLeakFix (<= 1.1.0)](https://github.com/astei/krypton)***
## List of all clientside related fixes
## List of all clientside related fixes and TODO
<details>
<summary>Click to open</summary>
@ -55,6 +55,8 @@ ViaFabricPlus is intended to replace [multiconnect](https://github.com/Earthcomp
- [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.
@ -77,10 +79,12 @@ For compiling only! **You do not need to install these!**
| 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
@ -101,7 +105,7 @@ repositories {
}
dependencies {
implementation "de.florianmichael:viafabricplus:2.7.3" // Get latest version from releases
implementation "de.florianmichael:viafabricplus:2.8.2" // Get latest version from releases
}
```
@ -117,14 +121,13 @@ dependencies {
<dependency>
<groupId>de.florianmichael</groupId>
<artifactId>viafabricplus</artifactId>
<version>2.7.3</version> <!-- Get latest version from releases -->
<version>2.8.2</version> <!-- Get 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.\

View File

@ -40,15 +40,17 @@ import org.apache.logging.log4j.Logger;
import java.io.File;
/**
* TODO | Port
* - TakeItemEntityPacket isEmpty case
* <p>
* TODO | Protocol translation
* - Cobwebs in <= b1.7.3 are broken
* - Window interactions in <= 1.16.5 are unlegit
* - Entity hitboxes and eye heights has changed
* - Crafting Recipes are missing in ViaVersion
/*
* TODO | ViaFabricPlus
* - Check if relevant for protocol translation: TakeItemEntityPacket isEmpty case (1.20 -> 1.20.1 change)
* - Cobwebs in <= b1.7.3 are broken (movement has been changed)
* - Window interactions in <= 1.16.5 has changed and can be detected by the server
* - Entity hit boxes and eye heights has changed in almost all versions
* - Crafting Recipes are missing in ViaVersion (see https://github.com/ViaVersion/ViaFabricPlus/issues/60)
* - Various movement related changes (see https://github.com/ViaVersion/ViaFabricPlus/issues/189 and https://github.com/ViaVersion/ViaFabricPlus/issues/195)
* - Most CTS protocol features aren't supported (see https://github.com/ViaVersion/ViaFabricPlus/issues/181)
* - Most CPE features aren't implemented correctly (see https://github.com/ViaVersion/ViaFabricPlus/issues/152)
* - Bedrock scaffolding should be added as soon as ViaBedrock supports block placement (see https://github.com/ViaVersion/ViaFabricPlus/issues/204)
*/
public class ViaFabricPlus {
public final static Gson GSON = new GsonBuilder().setPrettyPrinting().create();