From 396db40877525fa214292104b88cb8397b9a0334 Mon Sep 17 00:00:00 2001 From: creeper123123321 <7974274+creeper123123321@users.noreply.github.com> Date: Sun, 27 Dec 2020 13:28:48 -0300 Subject: [PATCH] update readme --- README.md | 53 ++++++++++++++++++++++++++++------------ compile_push_branches.sh | 3 ++- 2 files changed, 39 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 5ef75a8..b062ad3 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,11 @@ Allows the connection to/from different Minecraft versions on your Minecraft client/server (LAN worlds too) -This mod can be installed on 1.8.9 (in `mc-1.8` branch), 1.14.x/1.15.x (in `mc-1.14-1.15` branch) and 1.16.x/snapshots (in `mc-1.16` branch) with Fabric Loader. Check the Minecraft version in file name when downloading from CurseForge/GitHub Releases. +This mod can be installed on 1.8.9, 1.14.x, 1.15.x, 1.16.x and 1.17 snapshots (in separate branches) with Fabric Loader. +Check the Minecraft version in file name when downloading from CurseForge/GitHub Releases. -Note: ViaVersion is designed for Vanilla Minecraft servers. It probably will not work with modded registry entries or registry synchronization (fabric-registry-sync mod). +Note: ViaVersion is designed for Vanilla Minecraft servers. It probably will not work with modded registry entries +or registry synchronization (fabric-registry-sync mod). **1.14+ Dependencies:** @@ -67,11 +69,14 @@ Adding [ViaBackwards](https://viaversion.com/backwards) (and optionally [ViaRewi **Can ViaVersion, ViaBackwards and ViaRewind support snapshots?:** -- Check https://ci.viaversion.com/job/ViaVersion-DEV/, https://ci.viaversion.com/job/ViaBackwards-DEV/ and https://ci.viaversion.com/job/ViaRewind-DEV/ for development builds with snapshot support +- Check https://ci.viaversion.com/job/ViaVersion-DEV/, https://ci.viaversion.com/job/ViaBackwards-DEV/ and + https://ci.viaversion.com/job/ViaRewind-DEV/ for development builds with snapshot support **Commands**: -- There're 3 server-side alias ``/viaversion``, ``/vvfabric`` and ``/viaver``, and a client-side command ``/viafabricclient`` for Minecraft 1.14+ (OP permission level 3 is required for these commands, received by [Entity Status Packet](https://wiki.vg/Entity_statuses#Player)) +- There're 3 server-side alias ``/viaversion``, ``/vvfabric`` and ``/viaver``, and a client-side command + ``/viafabricclient`` for Minecraft 1.14+ (OP permission level 3 is required for these commands, received + by [Entity Status Packet](https://wiki.vg/Entity_statuses#Player)) **Configuration**: @@ -80,12 +85,20 @@ Adding [ViaBackwards](https://viaversion.com/backwards) (and optionally [ViaRewi **Alternatives/similar mods/proxies/plugins:** -- [ClientViaVersion](https://github.com/Gerrygames/ClientViaVersion): This discontinued client-side plugin for The 5zig Mod implemented ViaVersion, ViaBackwards and ViaRewind for 1.7.10, 1.8.9, 1.12 and 1.12.2 clients, allowing them to connect to 1.7-1.12.2 servers. It also had a protocol translation for 1.7 servers, which there's an updated version at https://github.com/KennyTV/ViaVersion/tree/hack (unsupported). -- [DirtMultiversion](https://github.com/DirtPowered/DirtMultiversion): Proxy allowing to connect down to Beta 1.3 with newer Minecraft client versions (currently). -- [multiconnect](https://www.curseforge.com/minecraft/mc-mods/multiconnect): This client-side Fabric mod does also accept older protocols and fixes some differences between versions, which ViaFabric doesn't. Currently, it goes down to 1.11 (stable) and 1.9.2 (experimental). (2020-10-16) (Supports only latest Minecraft client version) -- [Protocol4](https://www.minecraftforum.net/forums/mapping-and-modding-java-edition/minecraft-mods/2299203-protocol4-1-0-2-allows-1-7-10-clients-to-connect): This LiteLoader client-side mod allows your 1.7.10 client to connect to 1.7.x servers. +- [ClientViaVersion](https://github.com/Gerrygames/ClientViaVersion): This discontinued client-side plugin for The 5zig + Mod implemented ViaVersion, ViaBackwards and ViaRewind for 1.7.10, 1.8.9, 1.12 and 1.12.2 clients, allowing them to + connect to 1.7-1.12.2 servers. It also had a protocol translation for 1.7 servers, which there's an updated version + at https://github.com/KennyTV/ViaVersion/tree/hack (unsupported). +- [DirtMultiversion](https://github.com/DirtPowered/DirtMultiversion): Proxy allowing to connect down to Beta 1.3 + with newer Minecraft client versions (currently). +- [multiconnect](https://www.curseforge.com/minecraft/mc-mods/multiconnect): This client-side Fabric mod does also + accept older protocols and fixes some differences between versions, which ViaFabric doesn't. Currently, it goes + down to 1.11 (stable) and 1.9 (experimental). (2020-10-16) (Supports only latest Minecraft client version) +- [Protocol4](https://www.minecraftforum.net/forums/mapping-and-modding-java-edition/minecraft-mods/2299203-protocol4-1-0-2-allows-1-7-10-clients-to-connect): + This LiteLoader client-side mod allows your 1.7.10 client to connect to 1.7.x servers. - [ProtocolSupport](https://protocol.support/): This Bukkit plugin allows clients to connect from older versions (down to 1.4.7). -- [VIAaaS](https://github.com/ViaVersion/VIAaaS): Standalone ViaVersion proxy with ViaBackwards and ViaRewind, allowing you to connect without a mod installed on your client. Supports online mode. +- [VIAaaS](https://github.com/ViaVersion/VIAaaS): Standalone ViaVersion proxy with ViaBackwards and ViaRewind, allowing + you to connect without a mod installed on your client. Supports online mode. - [ViaVersion](https://viaversion.com): ViaVersion can run as a plugin for BungeeCord, CraftBukkit, SpongeCommon and Velocity servers. @@ -95,21 +108,29 @@ Adding [ViaBackwards](https://viaversion.com/backwards) (and optionally [ViaRewi **How to use protocol auto detector?:** - For using globally, set the protocol to AUTO or -2. For using in a specific server: ddns.example.com._v-2.viafabric -- The protocol auto detector will try to ping with the client native protocol version so if you have ViaVersion or similar in the server it will use the translator, differently than multiconnect which uses -1 version, which may get the native server version. +- The protocol auto detector will try to ping with the client native protocol version so if you have ViaVersion or + similar in the server it will use the translator, differently than multiconnect which uses -1 version, + which may get the native server version. - It may hold your handshake for up to 10 seconds. - The results are cached for 100 seconds. **How can I set the version for specific servers?:** -- Append ._v(VERSION).viafabric. Example: ``minigame.example.com._v1_8.viafabric``, ``native.example.com._v-1.viafabric`` +- Append ._v(VERSION).viafabric. Example: ``minigame.example.com._v1_8.viafabric``, ``native.example.com._v-1.viafabric``, ``auto.example.com._v-2.viafabric`` **Does it work with multiconnect at same time on client?:** -- Yes, ViaFabric can be used with multiconnect. ViaFabric will send to their version auto detector their closest supported version. (multiconnect beta-supported versions (currently 1.10 and 1.9) aren't used) -- Example of setups: -- (1.8 server) <-> (disabled ViaFabric) <-> (auto detected 1.8 server - multiconnect) = doesn't work because multiconnect doesn't support it -- (1.8 server) <-> (forced 1.8 - ViaFabric - suggests 1.11) <-> (detected 1.11 server - multiconnect) = works, ViaVersion translating 1.8 -> 1.11 and multiconnect accepting 1.11 -- (1.8 server) <-> (forced 1.8 - ViaFabric - detected 1.12.2 client) <-> (forced 1.12.2 server - multiconnect) = works, ViaVersion translating 1.8 -> 1.12.2 and multiconnect accepting 1.12.2 +- Yes, ViaFabric can be used with multiconnect. ViaFabric will send to their version auto detector their closest + supported version. (multiconnect beta-supported versions (currently < 1.11) aren't used) +- Example of configurations: +- (1.8 server) <-> (disabled ViaFabric) <-> (auto-detected 1.8 server - multiconnect) = doesn't work because + multiconnect doesn't support it +- (1.8 server) <-> (detected 1.8 - ViaFabric - suggests 1.11) <-> (detected 1.11 server - multiconnect) = works, + ViaVersion is translating 1.8 -> 1.11 and multiconnect is accepting 1.11 +- (1.8 server) <-> (forced 1.8 - ViaFabric - suggests 1.11) <-> (detected 1.11 server - multiconnect) = works, ViaVersion + is translating 1.8 -> 1.11 and multiconnect is accepting 1.11 +- (1.8 server) <-> (forced 1.8 - ViaFabric - detected 1.12.2 client) <-> (forced 1.12.2 server - multiconnect) = works, + ViaVersion is translating 1.8 -> 1.12.2 and multiconnect is accepting 1.12.2 ## 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** diff --git a/compile_push_branches.sh b/compile_push_branches.sh index ad10fc7..32c6168 100755 --- a/compile_push_branches.sh +++ b/compile_push_branches.sh @@ -3,4 +3,5 @@ git checkout mc-1.8 && ./gradlew clean build \ && git checkout mc-1.14 && ./gradlew clean build \ && git checkout mc-1.15 && ./gradlew clean build \ && git checkout mc-1.16 && ./gradlew clean build \ -&& git push origin mc-1.8 mc-1.14 mc-1.15 mc-1.16 \ No newline at end of file +&& git checkout mc-1.17 && ./gradlew clean build \ +&& git push origin mc-1.8 mc-1.14 mc-1.15 mc-1.16 mc-1.17 \ No newline at end of file