R3944Realms/Ambassador
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Adrian Bergqvist 2022-10-22 15:25:18 +02:00 committed by GitHub
parent d265847bee
commit cad0b9b73a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,30 +1,22 @@
# Ambassador
This is a Velocity plugin that makes it possible to host a modern forge server behind a Velocity proxy!
This is a Velocity plugin that makes it possible to host a modern Forge server behind a Velocity proxy!
Unlike other solutions, this plugin does not require any special modifications to the client. (The player doesn't need to do anything)
This plugin is right now in it's alpha stage and should not be used in production, use it at your own risk, you have been warned.
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.
2. Start the proxy, then close it.
3. Go to "plugins/ambassador" and open "forgeServer.toml"
4. In the "Forge Server" field, put the name of the forge server. The name must be the same as that you put in "Velocity.toml" config.
5. Now you are done on the proxy side!
### On the Forge server side:
1. Download and install "Ambassador-Forge" as a mod to your forge server. (Found at https://github.com/adde0109/Ambassador-Forge)
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. You are now ready to start the server and connect to it with Velocity!
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!
## Features
* Server Switching.
* Force forge clients to connect directly to forge server if mods don't allow vanilla.
* Connect to diffrent forge servers depending on client version.
## Planned features
* Ping Forwarding.
* Server switching.
* Server switching using kick to reset the client.
* Smart handshaking-data caching system to reduce load/network-traffic.
* Server switching using client mod: https://github.com/Just-Chaldea/Forge-Client-Reset-Packet