ViaFabric/README.md

152 lines
7.8 KiB
Markdown
Raw Normal View History

# 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)
2021-05-16 21:39:47 +02:00
[![CurseForge Downloads](http://cf.way2muchnoise.eu/full_viafabric_downloads.svg)](https://viaversion.com/fabric)
[![CurseForge Versions](http://cf.way2muchnoise.eu/versions/viafabric.svg)](https://viaversion.com/fabric)
2022-05-29 21:00:08 +02:00
[![Download on Modrinth](https://img.shields.io/badge/download-modrinth-green)](https://modrinth.com/mod/viafabric)
2021-05-16 21:39:47 +02:00
<!-- ^ GitHub seems to not like this https -->
2021-05-16 21:39:47 +02: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
2022-05-29 21:00:08 +02:00
This mod can be installed on 1.8.9, 1.14.4, 1.15.2, 1.16.5, 1.17.1, 1.18.2 with Fabric Loader.
2020-03-14 11:08:34 +01:00
2021-05-16 21:39:47 +02:00
## Dependencies
2020-03-14 11:08:34 +01:00
| Dependency | Download |
|-----------------------------------------------|----------------------------------------------------------------|
| (Bundled) ViaVersion | https://viaversion.com/ |
| (Bundled) Cotton Client Commands (MC 1.14-15) | https://jitpack.io/#TinfoilMC/ClientCommands |
| Fabric API (MC 1.14+) | https://www.curseforge.com/minecraft/mc-mods/fabric-api |
2022-01-26 13:05:18 +01:00
| Legacy Fabric API (MC 1.8.9) | https://www.curseforge.com/minecraft/mc-mods/legacy-fabric-api |
2021-05-16 21:39:47 +02: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:08:34 +01:00
2021-04-22 22:34:38 +02:00
## ViaVersion
2021-05-16 21:39:47 +02: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.
2021-04-24 17:14:03 +02:00
- CurseForge links:
[ViaBackwards](https://www.curseforge.com/minecraft/mc-mods/viabackwards)
[ViaRewind](https://www.curseforge.com/minecraft/mc-mods/viarewind)
2021-05-16 21:39:47 +02:00
### What versions can ViaVersion, ViaBackwards and ViaRewind translate?:
2021-04-24 17:14:03 +02:00
- **With [ViaVersion](https://viaversion.com)**:
Your server can accept newer versions. Your client can connect to older versions.
2021-04-24 17:14:03 +02:00
- **Adding [ViaBackwards](https://viaversion.com/backwards) (and
optionally [ViaRewind](https://viaversion.com/rewind))**:
Your server can accept older versions. Your client can connect to newer versions.
2021-04-24 17:14:03 +02:00
2021-04-22 22:34:38 +02:00
- Server-side: See https://viaversion.com/
2020-08-07 14:00:04 +02:00
2020-07-26 18:29:20 +02:00
- Client-side:
| | 1.8.x | 1.9.x | 1.10-1.14.4 | 1.15.x | 1.16.x | 1.17.x | 1.18.x | 1.19.x |
|---------------|-------|-------|-------------|--------|--------|--------|--------|--------|
| 1.8.9 client | ✓ | ⏪ | ⏪ | ⏪ | ⏪ | ⏪ | ⏪ | ⏪ |
| 1.14.x client | ✓ | ✓ | ✓ | ⟲ | ⟲ | ⟲ | ⟲ | ⟲ |
| 1.15.x client | ✓ | ✓ | ✓ | ✓ | ⟲ | ⟲ | ⟲ | ⟲ |
| 1.16.x client | ✓ | ✓ | ✓ | ✓ | ✓ | ⟲ | ⟲ | ⟲ |
| 1.17.x client | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ⟲ | ⟲ |
| 1.18.x client | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ⟲ |
| 1.19.x client | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
✓ = [ViaVersion](https://viaversion.com) ⟲ = [ViaBackwards](https://viaversion.com/backwards) ⏪
= [ViaRewind](https://viaversion.com/rewind)
2021-05-16 21:39:47 +02:00
### Can ViaVersion, ViaBackwards and ViaRewind support snapshots?:
2020-07-09 21:04:54 +02:00
- Check https://ci.viaversion.com/ for development builds with snapshot support
2021-08-08 17:48:14 +02:00
2021-04-22 22:34:38 +02:00
## Alternatives
2021-05-16 21:39:47 +02:00
### Client-side:
2021-08-08 17:48:14 +02:00
- [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).
2021-05-16 21:39:47 +02:00
- [ViaForge](https://www.curseforge.com/minecraft/mc-mods/viaforge): Fork of ViaFabric porting it to Forge.
- [ViaFabricPlus](https://www.curseforge.com/minecraft/mc-mods/viafabricplus): Fabric ViaVersion/ViaLegacy/ViaAprilFools implementation with clientside fixes
2021-05-16 21:39:47 +02:00
### Server-side:
2021-08-08 17:48:14 +02:00
- [ProtocolSupport](https://protocol.support/): Bukkit plugin for older client versions (down to 1.4.7).
- [ViaVersion](https://viaversion.com): Plugin for BungeeCord, CraftBukkit, SpongeCommon and Velocity servers.
2021-05-16 21:39:47 +02:00
### Standalone proxy:
- [DirtMultiversion](https://github.com/DirtPowered/DirtMultiversion): Proxy allowing to connect down to Beta 1.3 with
newer Minecraft client versions.
2021-06-15 13:40:19 +02:00
- [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.
2023-01-22 20:04:33 +01:00
- [ViaProxy](https://github.com/RaphiMC/ViaProxy): Standalone ViaVersion proxy with ViaBackward, ViaRewind and ViaLegacy,
allowing you to connect to a wide range of versions (down to classic versions) with your modern client (1.7.2+). Supports online mode.
2021-05-16 21:39:47 +02:00
### Cool things to try:
- [Geyser](https://geysermc.org/): Plugins, Fabric mod and a standalone proxy for allowing Bedrock Edition on Java
Edition servers.
- [PolyMc](https://github.com/TheEpicBlock/PolyMc): Fabric mods which translates modded items and blocks, allowing
vanilla to connect using resource packs.
2021-04-22 22:34:38 +02:00
## Commands
2021-05-16 21:39:47 +02:00
### Commands:
2021-04-22 22:34:38 +02:00
- 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))
## Configs
2021-05-16 21:39:47 +02:00
### Configuration:
2021-04-22 22:34:38 +02:00
- ViaVersion configuration is available at ``.minecraft/config/viafabric/viaversion.yml``
- ViaFabric configuration is at ``.minecraft/config/viafabric/viafabric.yml``
2021-05-16 21:39:47 +02:00
### 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 detection?:
- For using globally, set the protocol to AUTO or -2. For using in a specific
server: ``ddns.example.com._v-2.viafabric``
- The protocol detector will try to ping with the client native protocol version, differently than multiconnect which
uses -1 version, which may detect the native server version.
2021-05-16 21:39:47 +02:00
### How can I set the version for specific servers?:
- Append ._v(VERSION).viafabric.
- Examples: ``minigame.example.com._v1_8.viafabric``, ``native.example.com._v-1.viafabric``
, ``auto.example.com._v-2.viafabric``
2021-04-22 22:34:38 +02:00
## multiconnect
2022-05-29 21:00:08 +02:00
### Does it work with multiconnect at same time on client?:
2021-01-31 11:02:30 +01:00
- Yes, ViaFabric can be used with multiconnect. ViaFabric will send to its version auto detector the closest non-beta
supported version. (multiconnect beta-supported versions are currently < 1.11))
2021-05-09 15:40:42 +02:00
### Differences with multiconnect:
2021-01-31 11:02:30 +01:00
| | ViaVersion | multiconnect |
|------------------------|-----------------------------------|-----------------------------------------------|
| Designed for | servers | clients |
| Can be installed on | multiple client/server versions | latest client version |
| Objectives | simply implement ViaVersion | version support with fixes to version changes |
| How does it work? | modifying packets at network code | modifying client code more deeply |
| Triggering anti-cheats | very likely | less likely |
2021-01-31 11:02:30 +01:00
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**