Skip to content

Commit 7505791

Browse files
updated setup guide
1 parent f65511c commit 7505791

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ If you encounter any issues, please report them on the
1010
If you just want to talk or need help with ViaLoadingBase feel free to join my
1111
[Discord](https://discord.gg/BwWhCHUKDf).
1212

13-
## Projects where this is used:
13+
## Projects implementing ViaLoadingBase
1414
1. [ViaForge](https://github.com/FlorianMichael/ViaForge): Clientside ViaVersion for Forge
15-
2. [ViaFabricPlus](https://github.com/FlorianMichael/ViaFabricPlus): Clientside ViaVersion, ViaLegacy, ViaBedrock and ViaAprilFools implementation with clientside fixes for Fabric
15+
2. [ViaFabricPlus](https://github.com/FlorianMichael/ViaFabricPlus): Fabric mod to connect to EVERY Minecraft server version (Release, Beta, Alpha, Classic, Snapshots, Bedrock) with QoL fixes to the gameplay
1616

1717
## Add this to your own project
1818
build.gradle
@@ -30,8 +30,15 @@ dependencies {
3030
implementation "com.viaversion:viaversion:4.7.0-23w13a-SNAPSHOT"
3131
implementation "com.viaversion:viabackwards:4.7.0-23w13a-SNAPSHOT"
3232
implementation "com.viaversion:viarewind-core:2.0.4-SNAPSHOT"
33+
implementation "org.yaml:snakeyaml:2.0"
3334
34-
implementation "com.github.FlorianMichael:ViaLoadingBase:a660bf00d5" // https://jitpack.io/#FlorianMichael/ViaLoadingBase
35+
implementation "com.github.FlorianMichael:ViaLoadingBase:4.4.8" // https://jitpack.io/#FlorianMichael/ViaLoadingBase
36+
37+
// You also need Netty, Guava and Log4j in your class path, but they should be there if your project is based on Minecraft.
38+
implementation "org.yaml:snakeyaml:2.0"
39+
implementation "com.google.guava:guava:31.1-jre"
40+
implementation "io.netty:netty-all:5.0.0.Alpha2"
41+
implementation "org.apache.logging.log4j:log4j-core:2.19.0"
3542
}
3643
```
3744

@@ -43,7 +50,7 @@ A `1.8.x` Minecraft client for example would need `ViaVersion + ViaBackwards + V
4350
A `1.12.x` Minecraft client for example would need `ViaVersion + ViaBackwards`. <br>
4451
A `1.19.x` Minecraft client, for example, would need `ViaVersion`. <br>
4552

46-
## Example implementation:
53+
## Example implementation
4754
```java
4855
public void init() { // Basic code to load all platforms which are in the class path
4956
ViaLoadingBase.ViaLoadingBaseBuilder.
@@ -91,7 +98,7 @@ ViaLoadingBase will use the provided handler names in the VLB Pipeline in order
9198

9299
### For a mcp based implementation you can have a look at the code in [ViaForge](https://github.com/FlorianMichael/ViaForge)
93100

94-
## API examples:
101+
## API examples
95102
ViaLoadingBase also offers a system to compare the target version with other versions:
96103
```java
97104
if (ViaLoadingBase.getInstance().getTargetVersion().isOlderThan(ProtocolVersion.v1_8)) {
@@ -126,8 +133,7 @@ if (allVersionsAbove1_8.contains(ProtocolVersion.v1_10)) {
126133
```
127134
The class also has a toString() method that automatically formats the range
128135

129-
## How to load platforms:
130-
136+
## How to load platforms
131137
```java
132138
public class ExampleImplementation {
133139

0 commit comments

Comments
 (0)