mirror of
https://github.com/ViaVersion/ViaFabricPlus.git
synced 2024-11-25 12:25:22 +01:00
95 lines
4.8 KiB
Markdown
95 lines
4.8 KiB
Markdown
# 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?
|
|
ViaFabricPlus implements ViaLegacy/ViaAprilFools clientside and adds a ton of fixes that improve the game experience, <br>
|
|
as does [MultiConnect](https://github.com/Earthcomputer/multiconnect) from Earthcomputer.
|
|
### Important: The focus on ViaFabricPlus is on client side fixes, so reporting bugs and contributing is welcome.
|
|
|
|
## 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:
|
|
| Part | Description |
|
|
|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| ViaFabricPlus | Core of the project, all fixes here are stable and have been tested many times |
|
|
| 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. |
|
|
|
|
## 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/FlorianMichael/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.
|
|
|
|
### Tip for developing Addons: the installAddons task automatically copies all built Addons to the run/mods folder of the main project
|
|
|
|
## Values
|
|
Values are optional settings that can turn fixes on and off, originally they were used for debugging<br>
|
|
|
|
|
|
## Addon-API
|
|
For ViaFabricPlus-Visual and other future addons an AddonAPI has been developed to make it easier to access ViaFabricPlus, <br>
|
|
to make a ViaFabricPlus addon you just have to implement the ViaFabricPlusAddon interface in your main class:
|
|
```java
|
|
package net.example;
|
|
|
|
import de.florianmichael.viafabricplus.ViaFabricPlusAddon;
|
|
|
|
public 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"
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
## Alternatives
|
|
- [ClientViaVersion](https://github.com/Gerrygames/ClientViaVersion): Discontinued 5zig plugin.
|
|
- [multiconnect](https://www.curseforge.com/minecraft/mc-mods/multiconnect): Fabric mod for connecting to older
|
|
versions: down to 1.11 (stable) and 1.8 (experimental).
|
|
- [ViaFabric](https://www.curseforge.com/minecraft/mc-mods/viafabric): Fork of ViaFabric porting it to Forge.
|
|
|
|
## 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**
|