ViaFabric/README.md

116 lines
8.1 KiB
Markdown
Raw Normal View History

# ViaFabric
2019-12-12 14:23:43 +01:00
[![Travis Build Status](https://travis-ci.com/ViaVersion/ViaFabric.svg?branch=master)](https://travis-ci.com/ViaVersion/ViaFabric)
2020-03-24 14:44:08 +01:00
[![ViaVersion Discord](https://img.shields.io/badge/chat-on%20discord-blue.svg)](https://viaversion.com/discord)
2020-08-04 14:09:59 +02:00
[![CurseForge Downloads](http://cf.way2muchnoise.eu/full_391298_downloads.svg)](https://viaversion.com/fabric)
[![CurseForge Versions](http://cf.way2muchnoise.eu/versions/391298.svg)](https://viaversion.com/fabric)
2020-06-29 21:38:20 +02:00
<!-- ^ GitHub seems to not support Let's Encrypt certificates -->
2019-12-12 14:38:08 +01:00
2020-02-24 17:53:32 +01:00
**Client-side and server-side ViaVersion implementation for Fabric**
2020-02-24 17:54:20 +01:00
2020-02-24 17:58:32 +01:00
Allows the connection to/from different Minecraft versions on your Minecraft client/server (LAN worlds too)
2020-02-24 17:53:32 +01:00
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.
2020-03-14 11:08:34 +01:00
Note: ViaVersion is designed for Vanilla Minecraft servers. It probably will not work with modded registry entries or registry synchronization (fabric-registry-sync mod).
2020-03-14 11:07:45 +01:00
2020-03-14 11:08:34 +01:00
2020-07-12 21:39:13 +02:00
**1.14+ Dependencies:**
2020-07-21 18:49:05 +02:00
2020-08-11 18:57:06 +02:00
| Dependency | Download |
| ----------------------------------------- | ------------------------------------------------------------------------------------------ |
| (Bundled 3.2.0 release) ViaVersion 3.2.0+ | https://ci.viaversion.com/job/ViaVersion/ or https://ci.viaversion.com/job/ViaVersion-DEV/ |
2020-08-11 18:57:06 +02:00
| (Bundled) Cotton Client Commands | https://www.curseforge.com/minecraft/mc-mods/cotton-client-commands |
2020-08-14 17:57:21 +02:00
| (Optional) Fabric Command API v1/v0 | https://www.curseforge.com/minecraft/mc-mods/fabric-api |
2020-08-11 18:57:06 +02:00
| Fabric Resource Loader v0 | https://www.curseforge.com/minecraft/mc-mods/fabric-api |
2020-07-12 21:39:13 +02:00
**1.8.9 Dependencies:**
2020-07-21 18:49:05 +02:00
2020-08-11 18:57:06 +02:00
| Dependency | Download |
| ----------------------------------------- | ------------------------------------------------------------------------------------------ |
| (Bundled 3.2.0 release) ViaVersion 3.2.0+ | https://ci.viaversion.com/job/ViaVersion/ or https://ci.viaversion.com/job/ViaVersion-DEV/ |
2020-08-14 17:57:21 +02:00
| (Optional) Fabric Commands v0 | https://www.curseforge.com/minecraft/mc-mods/legacy-fabric-api |
2020-08-11 18:57:06 +02:00
| Fabric Resource Loader v0 | https://www.curseforge.com/minecraft/mc-mods/legacy-fabric-api |
2020-03-14 11:08:34 +01:00
2020-08-05 12:51:08 +02:00
With [ViaVersion](https://viaversion.com):
2020-02-24 17:53:32 +01:00
- your server can accept newer versions
- your client can connect to older versions
2020-02-24 17:54:20 +01:00
Adding [ViaBackwards](https://viaversion.com/backwards) (and optionally [ViaRewind](https://viaversion.com/rewind)):
2020-02-24 17:53:32 +01:00
- your server can accept older versions
- your client can connect to newer versions
2020-02-24 17:58:32 +01:00
**How can I install ViaBackwards/ViaRewind?:**
- Just drop them into mods folder. Make sure you are using versions compatible with the ViaVersion version you are using.
- There are reposts on CurseForge:
- https://www.curseforge.com/minecraft/mc-mods/viabackwards
- https://www.curseforge.com/minecraft/mc-mods/viarewind
**What versions can ViaVersion, ViaBackwards and ViaRewind translate?:**
2020-07-26 18:29:20 +02:00
- Server-side:
[![Graph with ViaVersion supported versions](https://i.imgur.com/0u20Y2u.png)](https://viaversion.com)
2020-08-07 14:00:04 +02:00
2020-07-26 18:29:20 +02:00
- Client-side:
| Your Client | 1.8.x | 1.9.x | 1.10-1.14.4 | 1.15.x | 1.16.x |
2020-08-07 14:00:04 +02:00
| ----------- | ----- | ----- | ----------- | ------ | ------ |
| 1.8.9 | ✓ | ⏪ | ⟲ | ⟲ | ⟲ |
2020-08-14 17:57:21 +02:00
| 1.14.x | ✓ | ✓ | ✓ | ⟲ | ⟲ |
| 1.15.x | ✓ | ✓ | ✓ | ✓ | ⟲ |
2020-08-14 20:50:13 +02:00
| 1.16.x | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-08-04 14:34:36 +02:00
2020-08-05 12:51:08 +02:00
✓ = [ViaVersion](https://viaversion.com) ⟲ = [ViaBackwards](https://viaversion.com/backwards) ⏪ = [ViaRewind](https://viaversion.com/rewind)
2020-08-05 12:51:08 +02:00
**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
2020-07-09 21:04:54 +02:00
**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))
**Configuration**:
- ViaVersion configuration is available at ``.minecraft/config/viafabric/viaversion.yml``
- ViaFabric configuration is at ``.minecraft/config/viafabric/viafabric.yml``
**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.
- [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.
- [ViaVersion](https://viaversion.com): ViaVersion can run as a plugin for BungeeCord, CraftBukkit, SpongeCommon and Velocity servers.
**How can I disable client-side ViaFabric?:**
- You can disable it in the menu or by setting global protocol version to -1 (this will keep per-server translations still enabled)
**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.
- 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``
**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
2020-08-11 18:57:06 +02:00
- (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
2020-02-24 17:58:32 +01:00
## 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**