Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misc velocity doc changes #422

Merged
merged 5 commits into from
Jun 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions config/footer.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@ const footer: Footer = {
label: "Forums",
href: "https://forums.papermc.io",
},
{
label: "IRC",
href: "https://webchat.esper.net/?channels=paper",
},
],
},
{
Expand Down
2 changes: 1 addition & 1 deletion config/sidebar.waterfall.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const waterfall: SidebarsConfig = {
type: "doc",
id: "README",
},
items: ["configuration", "getting-started"],
items: ["getting-started", "configuration"],
},
],
};
Expand Down
6 changes: 0 additions & 6 deletions docs/misc/contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,6 @@ description: There are many ways to contact us, see here for more information.

The PaperMC project handles most communication via Discord. Use the following invite: https://discord.gg/papermc

## IRC

Some of our Discord channels are bridged to IRC.

- [#paper on irc.esper.net](https://webchat.esper.net/?channels=paper)

## Forums

Reach out for support, or contact us on our forums.
Expand Down
3 changes: 2 additions & 1 deletion docs/velocity/admin/getting-started/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,8 @@ minigames = "127.0.0.1:30068"

# In what order we should try servers when a player logs in or is kicked from a server.
try = [
"lobby"
"lobby",
"factions"
]
```

Expand Down
6 changes: 3 additions & 3 deletions docs/velocity/admin/getting-started/forwarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ forwarding instead.

:::

To use modern forwarding with any supported server implementation, set the `player-info-forwarding`
To use modern forwarding with any supported server implementation, set the `player-info-forwarding-mode`
setting in `velocity.toml` to `modern`. Then, you need to ensure your server is properly configured
to use Velocity forwarding.

Expand Down Expand Up @@ -91,13 +91,13 @@ server implementations. It has excellent compatibility (supporting versions as o
released in 2013) and will work with Forge if you also install SpongeForge 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` setting
If you must use BungeeCord-compatible forwarding, simply set your `player-info-forwarding-mode` setting
in `velocity.toml` to `legacy`. You will also need to make sure your server can accept the forwarded
player data sent by Velocity.

To add some security, particularly for proxies hosted on shared hosting, Velocity optionally
supports the [BungeeGuard](https://www.spigotmc.org/resources/bungeeguard.79601/) plugin. To use it,
set the `player-info-forwarding` setting in `velocity.toml` to `bungeeguard`, then add the value in
set the `player-info-forwarding-mode` setting in `velocity.toml` to `bungeeguard`, then add the value in
the `forwarding.secret` file to the token section in the BungeeGuard configuration.

### Configuring legacy forwarding for Spigot / Paper
Expand Down
1 change: 0 additions & 1 deletion docs/velocity/admin/reference/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ Velocity uses a number of open-source libraries:
| [Gson](https://github.com/google/gson) | [Google](https://github.com/google) | [Apache License 2.0](https://github.com/google/gson/blob/master/LICENSE) |
| [Netty](https://github.com/netty/netty) | [Netty Project](https://netty.io) | [Apache License 2.0](https://github.com/netty/netty/blob/4.1/LICENSE.txt) |
| [libdeflate](https://github.com/ebiggers/libdeflate) | [Eric Biggers](https://github.com/ebiggers) | [MIT License](https://github.com/ebiggers/libdeflate/blob/master/COPYING) |
| [text](https://github.com/KyoriPowered/text) | [KyoriPowered](https://github.com/KyoriPowered) | [MIT License](https://github.com/KyoriPowered/text/blob/master/license.txt) |
| [adventure](https://github.com/KyoriPowered/adventure) | [KyoriPowered](https://github.com/KyoriPowered) | [MIT License](https://github.com/KyoriPowered/adventure/blob/main/4/license.txt) |
| [Brigadier](https://github.com/Mojang/brigadier) | [Mojang](https://www.minecraft.net) | [MIT License](https://github.com/Mojang/brigadier/blob/master/LICENSE) |
| [event](https://github.com/KyoriPowered/event) | [KyoriPowered](https://github.com/KyoriPowered) | [MIT License](https://github.com/KyoriPowered/event/blob/master/license.txt) |
Expand Down
2 changes: 1 addition & 1 deletion docs/waterfall/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ configuration.

## Getting a proxy JAR

Paper provides runnable proxy JARs directly from our [downloads page](https://papermc.io/downloads#Waterfall).
Paper provides runnable proxy JARs directly from our [downloads page](https://papermc.io/downloads/waterfall).

Click on the build number to download a file.

Expand Down