From 9c26cb56130beed64d8aa80e17e26f7094f12765 Mon Sep 17 00:00:00 2001 From: Adrian <68704415+4drian3d@users.noreply.github.com> Date: Mon, 26 Feb 2024 13:11:58 -0500 Subject: [PATCH] Updated Velocity compatibility documentation with Forge (#311) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matouš Kučera --- docs/velocity/admin/getting-started/README.mdx | 2 +- docs/velocity/admin/getting-started/faq.mdx | 16 ++++++++++++++-- .../velocity/admin/getting-started/forwarding.md | 7 ++++++- .../admin/getting-started/why-velocity.md | 7 +++---- docs/velocity/admin/reference/comparison.md | 2 +- .../admin/reference/server-compatibility.mdx | 12 ++++++++---- 6 files changed, 33 insertions(+), 13 deletions(-) diff --git a/docs/velocity/admin/getting-started/README.mdx b/docs/velocity/admin/getting-started/README.mdx index 10a2f7764..fe03c8c1c 100644 --- a/docs/velocity/admin/getting-started/README.mdx +++ b/docs/velocity/admin/getting-started/README.mdx @@ -67,7 +67,7 @@ the output in the next section. Here's a sample of what you'll see once we've started the proxy: ```log -[05:41:13 INFO]: Booting up Velocity 3.1.2-SNAPSHOT (git-b2800087-b112)... +[05:41:13 INFO]: Booting up Velocity 3.3.0-SNAPSHOT (git-74c932e5-b363)... [05:41:13 INFO]: Loading localizations... [05:41:13 INFO]: Connections will use epoll channels, libdeflate (Linux aarch64) compression, OpenSSL (Linux aarch64) ciphers [05:41:13 INFO]: Loading plugins... diff --git a/docs/velocity/admin/getting-started/faq.mdx b/docs/velocity/admin/getting-started/faq.mdx index 8e8c1e5aa..32459d098 100644 --- a/docs/velocity/admin/getting-started/faq.mdx +++ b/docs/velocity/admin/getting-started/faq.mdx @@ -14,8 +14,8 @@ Velocity 3.3.x requires Java or above. ## Where can I find Velocity plugins? -A good source for finding plugins compatible with Velocity would be our -[forums](https://forums.papermc.io/forums/velocity-plugin-releases/). +A good source for finding plugins compatible with Velocity would be our plugin repository +[Hangar](https://hangar.papermc.io/?page=0&platform=VELOCITY). ## Does Velocity support plugins developed for BungeeCord or Waterfall? @@ -105,3 +105,15 @@ First, double-check that you properly set up DNS records pointing to your proxy you have selected. Forced hosts are _not_ compatible with SRV records, so if you are relying on SRV records to direct the player to the proxy, you will need to find a way to get the proxy running on the default Minecraft port, 25565. + +### Plugins unable to modify messages or commands + +``` +A plugin tried to cancel a signed chat message. This is no longer possible in 1.19.1 and newer. Disconnecting player +``` + +Starting with Minecraft 1.19.1, Mojang implemented a new chat system that encrypts each message with +the signed key that each player has. Velocity does not yet have full support for cancelling or modifying +this type of messages and commands, so you can install the [SignedVelocity](https://hangar.papermc.io/4drian3d/SignedVelocity) plugin, +which will allow the message or command to be transmitted to your server, which, upon receiving it on the server, +will apply the result computed in Velocity. diff --git a/docs/velocity/admin/getting-started/forwarding.md b/docs/velocity/admin/getting-started/forwarding.md index 2f41d84f8..e6f0ede3c 100644 --- a/docs/velocity/admin/getting-started/forwarding.md +++ b/docs/velocity/admin/getting-started/forwarding.md @@ -32,7 +32,7 @@ impersonating your Velocity proxy. However, it is only available for Minecraft 1 :::caution -Modern forwarding is incompatible with Minecraft versions below 1.13, Minecraft Forge, and the +Modern forwarding is incompatible with Minecraft versions below 1.13 and the ProtocolSupport plugin. If you use any of these, you will need to use legacy BungeeCord-compatible forwarding instead. @@ -69,6 +69,11 @@ If you are using Paper 1.18.2 or lower, you will find these options as `settings A mod called [FabricProxy-Lite](https://modrinth.com/mod/fabricproxy-lite) allows you to use Velocity modern forwarding with a modded server using Fabric. +## Configuring modern forwarding for Forge + +A mod called [ProxyCompatibleForge](https://modrinth.com/mod/proxy-compatible-forge) allows you to use +Velocity modern forwarding with a modded server using Forge 1.16.5 or higher. + ## Configuring legacy BungeeCord-compatible forwarding :::danger diff --git a/docs/velocity/admin/getting-started/why-velocity.md b/docs/velocity/admin/getting-started/why-velocity.md index 6eef39792..14698ee69 100644 --- a/docs/velocity/admin/getting-started/why-velocity.md +++ b/docs/velocity/admin/getting-started/why-velocity.md @@ -84,7 +84,6 @@ Unlike certain platforms which only provide lip service to the modding community hostile to them), Velocity embraces the richness of the platform Minecraft provides. As just a small example, we have a Fabric mod that [helps bridge the gap between Velocity itself and mods that extend the Minecraft protocol](https://www.curseforge.com/minecraft/mc-mods/crossstitch) -and feature full Forge support for 1.7 through 1.12.2, with support for newer versions in -development. Velocity also supports emerging standard libraries in the community such as Kyori's -[Adventure](https://github.com/KyoriPowered/adventure) library. We collaborate with the Minecraft -modding community. +and feature full Forge support for 1.7 through 1.12.2 and 1.20.2 or higher. Velocity also supports emerging +standard libraries in the community such as Kyori's [Adventure](https://github.com/KyoriPowered/adventure) library. +We collaborate with the Minecraft modding community. diff --git a/docs/velocity/admin/reference/comparison.md b/docs/velocity/admin/reference/comparison.md index a901e6866..92a712841 100644 --- a/docs/velocity/admin/reference/comparison.md +++ b/docs/velocity/admin/reference/comparison.md @@ -33,7 +33,7 @@ This is a quick overview of the differences between Velocity and other popular p \* _The Velocity API does not support plugins made for BungeeCord/Waterfall, but [Snap](https://hangar.papermc.io/Phoenix616/Snap) can be installed for experimental support. Snap is not maintained by, or affiliated with, the Velocity project._ -\** _Full Forge support for 1.7 through 1.12.2, with support for newer versions in development._ +\** _Full Forge support for 1.7 through 1.12.2 and 1.20.2 or higher._ ## BungeeCord and derivatives diff --git a/docs/velocity/admin/reference/server-compatibility.mdx b/docs/velocity/admin/reference/server-compatibility.mdx index b26a9ec86..796fd2460 100644 --- a/docs/velocity/admin/reference/server-compatibility.mdx +++ b/docs/velocity/admin/reference/server-compatibility.mdx @@ -47,7 +47,7 @@ or lower, you must use legacy BungeeCord-style forwarding. ### SpongeVanilla -SpongeVanilla is compatible with legacy BungeeCord-style forwarding. Our Sponge support largely +SpongeVanilla is compatible with legacy BungeeCord-style and modern forwarding. Our Sponge support largely focuses on Forge compatibility, see below for more information. ## Modded setups @@ -65,9 +65,13 @@ by the Velocity project. ### Minecraft Forge (1.13 and above) -**Minecraft Forge for Minecraft 1.13 and later is not compatible with Velocity** due to changes made -in the handshake protocol that are difficult for proxies to adapt to. Support is currently a work in -progress, but there is no set time for support to be available. +Velocity as of version 3.3.0 supports Forge servers of versions higher than 1.20.2. +Support for intermediate versions between 1.13 and 1.20.1 is not planned, however, +you can use the [Ambassador](https://modrinth.com/plugin/ambassador) plugin to support these versions. + +To add modern forwarding support to Forge, you must install the [ProxyCompatibleForge](https://modrinth.com/mod/proxy-compatible-forge) +or [SpongeForge](https://spongepowered.org/downloads/spongeforge) mod corresponding to your server version. +*Note that SpongeForge is currently in an experimental phase of its Forge support for 1.20.4 versions*. ### Minecraft Forge (1.7.2-1.12.2)