From 6b3ba9c88a6e293ec8b6abc4c8600f2419b510ac Mon Sep 17 00:00:00 2001 From: Adrian Bergqvist <52883522+adde0109@users.noreply.github.com> Date: Wed, 22 Feb 2023 22:20:19 +0100 Subject: [PATCH] Revised README.md --- README.md | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 027806c..97d7bf0 100644 --- a/README.md +++ b/README.md @@ -4,22 +4,15 @@ This is a Velocity plugin that makes it possible to host a modern Forge server b Unlike other solutions, this plugin does not require any special modifications to the backend server nor the client. (The player doesn't need to do anything) -This plugin is right now in its alpha stage and should not be used in production, use it at your own risk, you have been warned. ## How to get started: ### On the Velocity proxy side: 1. Download and install this plugin to your proxy. - -### On the Forge server side (Only required if you want modern forwarding): -1. Download and install "Ambassador-Forge" as a mod to your Forge server. (Found at https://github.com/adde0109/Ambassador-Forge) -2. Start the server. -3. If you wish to use modern forwarding, close the server and open "ambassador-common.toml" in the config folder and put your forwarding secret in the "forwardingSecret" field. -4. In "server.properties" make sure online-mode is set to false. -5. You are now ready to start the server and connect to it with Velocity! +2. After starting the server, configure the plugin it to your liking using the config file found in the folder "Ambassador". +3. If you want to use modern forwarding you can use this mod on the Forge server: https://github.com/adde0109/Proxy-Compatible-Forge ## Features -* Server switching. -* Server switching using kick to reset the client. -* Server switching using client mod: https://github.com/Just-Chaldea/Forge-Client-Reset-Packet +* Server switching using kick to reset the client with configureble message and switch timeout. +* Server switching using client mod for instant server switching: https://github.com/Just-Chaldea/Forge-Client-Reset-Packet -### Discord +## Discord https://discord.gg/Vusz9pBNyJ