updated README

README.md

@@ -1,10 +1,28 @@
 # ViaFabricPlus
 Clientside ViaVersion, ViaLegacy and ViaAprilFools implementation with clientside fixes for Fabric
+### This project has nothing to do with the original ViaFabric and is therefore also not compact
+
+## Contact
+If you encounter any issues, please report them on the
+[issue tracker](https://github.com/FlorianMichael/ViaFabricPlus/issues).  
+If you just want to talk or need help with ViaFabricPlus feel free to join my
+[Discord](https://discord.gg/BwWhCHUKDf).
 
 ## Why?
-Originally ViaFabricPlus was not a standalone project but a part of my Minecraft Utility Mod, <br>
+ViaFabricPlus implements ViaLegacy/ViaAprilFools clientside and adds a ton of fixes that improve the game experience, <br>
-since this is no longer existent I am now developing the Protocol Translation part as a standalone mod, <br>
+as does [MultiConnect](https://github.com/Earthcomputer/multiconnect) from Earthcomputer.
-and now: ViaFabricPlus is here
+
+## Dependencies
+
+| Dependency     | Download                                                   |
+|----------------|------------------------------------------------------------|
+| 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/RaphiMC/ViaLegacy                       |
+| ViaAprilFools  | https://github.com/RaphiMC/ViaAprilFools                   |
+| MC-Structs     | https://github.com/Lenni0451/MCStructs                     |
+| ViaLoadingBase | https://github.com/FlorianMichael/ViaLoadingBase           |
 
 ## Project structure
 ViaFabricPlus splits into two major parts:
@@ -14,12 +32,46 @@ ViaFabricPlus splits into two major parts:
 | ViaFabricPlus-Visual    | Addon for the core, it adds only visual changes between the versions like old textures, <br>optional and not necessary for the gameplay, but recommended.                                                                              |
 
 ## Values
-Values are optional settings that can turn fixes on and off, originally they were used for debugging, the Values GUI works like this: <br>
+Values are optional settings that can turn fixes on and off, originally they were used for debugging<br>
-Left mouse click activates/deactivates a Value, right mouse click activates a Sync Mode in which the Value is activated or deactivated depending on the version it belongs to.
 ![](/image/values.png)
 
-## Contact
+## Addon-API
-If you encounter any issues, please report them on the
+For ViaFabricPlus-Visual and other future addons an AddonAPI has been developed to make it easier to access ViaFabricPlus, <br>
-[issue tracker](https://github.com/FlorianMichael/ViaFabricPlus/issues).  
+to make a ViaFabricPlus addon you just have to implement the ViaFabricPlusAddon interface in your main class:
-If you just want to talk or need help with ViaFabricPlus feel free to join my
+```java
-[Discord](https://discord.gg/BwWhCHUKDf).
+package net.example;
+
+import de.florianmichael.viafabricplus.ViaFabricPlusAddon;
+
+public static class ViaFabricPlusExampleAddon implements ViaFabricPlusAddon {
+    
+    @Override
+    public void onPreLoad() {
+        // called directly after Via* is initialized
+    }
+    
+    @Override
+    public void onPostLoad() {
+        // called after Minecraft is initialized
+    }
+    
+    @Override
+    public void onChangeVersion(ComparableProtocolVersion protocolVersion) {
+        // called when the user changes the target version in the gui
+    }
+}
+```
+To load the addon you have to specify the addon main class as entrypoint in your *fabric.mod.json*:
+```json
+{
+  "entrypoints": {
+    "viafabricplus": [
+      "net.example.ViaFabricPlusExampleAddon"
+    ]
+  }
+}
+```
+
+## WARNING
+**I cannot guarantee that this mod is allowed on every (or even any) server. This mod may cause problems with anti cheat
+plugins. USE AT OWN RISK**