Skip to content

Commit

Permalink
chore: Update forwarding docs (#503)
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelask authored Dec 7, 2024
1 parent 48e45d0 commit d799b54
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
9 changes: 7 additions & 2 deletions docs/velocity/admin/getting-started/forwarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ 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.
Velocity modern forwarding with a modded server using Forge 1.14 or higher.

## Configuring legacy BungeeCord-compatible forwarding

Expand All @@ -88,7 +88,7 @@ options to secure your server so that nothing aside from the proxy can connect t
`legacy` forwarding is the player information forwarding protocol that is used by BungeeCord when
enabling IP forwarding from BungeeCord. Due to this, it is ubiquitous and well-supported by most
server implementations. It has excellent compatibility (supporting versions as old as 1.7.2,
released in 2013) and will work with Forge if you also install SpongeForge on your modded server and
released in 2013) and will work with Forge if you also install SpongeForge/BungeeForge on your modded server and
configure it correctly. However, it is not secure.

If you must use BungeeCord-compatible forwarding, simply set your `player-info-forwarding-mode` setting
Expand All @@ -111,6 +111,11 @@ To configure Sponge to understand the data forwarded from Velocity, you will nee
first, set `modules.bungeecord` to `true` and `bungeecord.ip-forwarding` to `true` in your
`config/sponge/global.conf` file, and then restart your Sponge server.

### Configuring legacy forwarding for Forge

To configure Forge to understand the data forwarded from Velocity, you will need to stop the server
first, download your correct [BungeeForge](https://github.com/caunt/BungeeForge/releases) version and place the mod into the mods folder, and then restart your Forge server.

### Configuring legacy forwarding for Fabric

:::caution
Expand Down
2 changes: 1 addition & 1 deletion docs/velocity/admin/reference/server-compatibility.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ or [SpongeForge](https://spongepowered.org/downloads/spongeforge) mod correspond

Minecraft Forge for Minecraft 1.7.2-1.12.2 is fully compatible with Velocity, as we make special
provisions to synchronize client state with each server. However, we **strongly** recommend the use
of SpongeForge, as it allows you to use legacy BungeeCord player info forwarding and generally
of SpongeForge or BungeeForge, as it allows you to use legacy BungeeCord player info forwarding and generally
improves proxy support in general.

Velocity does not support Forge-Bukkit hybrids - they have caused several issues, and the design of
Expand Down

0 comments on commit d799b54

Please sign in to comment.