Upstream/ViaFabricPlus
1
0
Fork 0
mirror of https://github.com/ViaVersion/ViaFabricPlus.git synced 2024-11-15 10:45:35 +01:00
Code Issues Packages Projects Releases Wiki Activity

moved USAGE to own file

Browse Source
This commit is contained in:
FlorianMichael 2023-03-22 15:00:00 +01:00
parent 6f428e906f
commit 08056c3ee8
5 changed files with 32 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
.github/USAGE.md vendored Normal file
View File

@ -0,0 +1,25 @@
## Settings and GUI
In the multiplayer screen you will find the ViaFabricPlus button in the upper left corner by default, it is the main button, <br>
click on it, and you will see the Protocol selection, there you can choose the Minecraft version you want to connect to, <br>
in the upper left corner you can go to the Settings.
![](images/multiplayer.png)
![](images/protocol.png)
In the Add/Edit Server screen there is a button where you can select a specific version for this server, when you ping or connect to this server, <br>
ViaFabricPlus will use the version set there, the versions are stored in the servers.dat too
![](images/force.png)
If you don't want to specify a specific version anymore, you can simply press the button and select **"Cancel and reset"**.
### Settings are optional settings that can turn fixes on and off, originally they were used for debugging<br>
![](images/settings.png)
## Bedrock edition
Keep in mind that the Java -> Bedrock support is still in beta phase, and therefore many things are not implemented <br>
yet and there is no guarantee that everything will work as it should.
![](images/bedrock.png)
To log in to a Bedrock account you can press the button **"Click to set account for Bedrock edition"** in the settings, <br>
then you can log in via device login, the account logged in there will be stored in **~/ViaFabricPlus/bedrock.account**.

30
README.md
View File

@ -54,8 +54,8 @@ ViaFabricPlus uses Gradle, to make sure that it is installed properly you can ch
## To learn more about the API and about addons, you can simply click [here](.github/DEVELOPER_API.md)
# For users
If you encounter any issues, please report them on the
[issue tracker](https://github.com/FlorianMichael/ViaFabricPlus/issues).
## To learn more about how to use this mod, you can simply click [here](.github/USAGE.md)
### If you encounter any issues, please report them on the [issue tracker](https://github.com/FlorianMichael/ViaFabricPlus/issues).
## Compatibility
ViaFabricPlus is structured to interfere with mods as little as possible.
@ -104,32 +104,6 @@ However, if a version between two Minecraft versions is too unstable, I will def
they do not have their own releases, current backports (named after their branch):
- [1.19.3](https://modrinth.com/mod/viafabricplus/version/0.0.0)
## Settings and GUI
In the multiplayer screen you will find the ViaFabricPlus button in the upper left corner by default, it is the main button, <br>
click on it, and you will see the Protocol selection, there you can choose the Minecraft version you want to connect to, <br>
in the upper left corner you can go to the Settings.
![](/.github/images/multiplayer.png)
![](/.github/images/protocol.png)
In the Add/Edit Server screen there is a button where you can select a specific version for this server, when you ping or connect to this server, <br>
ViaFabricPlus will use the version set there, the versions are stored in the servers.dat too
![](/.github/images/force.png)
If you don't want to specify a specific version anymore, you can simply press the button and select **"Cancel and reset"**.
### Settings are optional settings that can turn fixes on and off, originally they were used for debugging<br>
![](/.github/images/settings.png)
## Bedrock edition
Keep in mind that the Java -> Bedrock support is still in beta phase, and therefore many things are not implemented <br>
yet and there is no guarantee that everything will work as it should.
![](/.github/images/bedrock.png)
To log in to a Bedrock account you can press the button **"Click to set account for Bedrock edition"** in the settings, <br>
then you can log in via device login, the account logged in there will be stored in **~/ViaFabricPlus/bedrock.account**.
## Classic stuff
### Custom protocol extensions
ViaFabricPlus implements new Classic Extensions into the CPE protocol of ViaLegacy which are rather client side. <br>

2
src/main/java/de/florianmichael/viafabricplus/definition/ServerAddressReplacement.java → src/main/java/de/florianmichael/viafabricplus/definition/TileServerAddress.java
View File

@ -25,7 +25,7 @@ import net.minecraft.client.network.ServerAddress;
import net.raphimc.viabedrock.api.BedrockProtocolVersion;
import net.raphimc.vialegacy.api.LegacyProtocolVersion;
public class ServerAddressReplacement {
public class TileServerAddress {
private final static ProtocolRange SRV_RANGE = new ProtocolRange(ProtocolVersion.v1_16_4, LegacyProtocolVersion.r1_3_1tor1_3_2);
public static ServerAddress parse(final ComparableProtocolVersion version, String address) {

4
src/main/java/de/florianmichael/viafabricplus/injection/mixin/fixes/minecraft/screen/MixinMultiplayerScreen.java
View File

@ -17,7 +17,7 @@
*/
package de.florianmichael.viafabricplus.injection.mixin.fixes.minecraft.screen;
import de.florianmichael.viafabricplus.definition.ServerAddressReplacement;
import de.florianmichael.viafabricplus.definition.TileServerAddress;
import de.florianmichael.viafabricplus.injection.access.IServerInfo;
import net.minecraft.client.gui.screen.multiplayer.MultiplayerScreen;
import net.minecraft.client.network.ServerAddress;
@ -42,6 +42,6 @@ public class MixinMultiplayerScreen {
@Redirect(method = "connect(Lnet/minecraft/client/network/ServerInfo;)V", at = @At(value = "INVOKE", target = "Lnet/minecraft/client/network/ServerAddress;parse(Ljava/lang/String;)Lnet/minecraft/client/network/ServerAddress;"))
public ServerAddress doOwnParse(String address) {
return ServerAddressReplacement.parse(((IServerInfo) viafabricplus_lastConnect).viafabricplus_forcedVersion(), address);
return TileServerAddress.parse(((IServerInfo) viafabricplus_lastConnect).viafabricplus_forcedVersion(), address);
}
}

4
src/main/java/de/florianmichael/viafabricplus/injection/mixin/fixes/minecraft/screen/MixinMultiplayerServerListPinger.java
View File

@ -17,7 +17,7 @@
*/
package de.florianmichael.viafabricplus.injection.mixin.fixes.minecraft.screen;
import de.florianmichael.viafabricplus.definition.ServerAddressReplacement;
import de.florianmichael.viafabricplus.definition.TileServerAddress;
import de.florianmichael.viafabricplus.injection.access.IServerInfo;
import net.minecraft.client.network.MultiplayerServerListPinger;
import net.minecraft.client.network.ServerAddress;
@ -42,6 +42,6 @@ public class MixinMultiplayerServerListPinger {
@Redirect(method = "add", at = @At(value = "INVOKE", target = "Lnet/minecraft/client/network/ServerAddress;parse(Ljava/lang/String;)Lnet/minecraft/client/network/ServerAddress;"))
public ServerAddress doOwnParse(String address) {
return ServerAddressReplacement.parse(((IServerInfo) viafabricplus_lastConnect).viafabricplus_forcedVersion(), address);
return TileServerAddress.parse(((IServerInfo) viafabricplus_lastConnect).viafabricplus_forcedVersion(), address);
}
}