32 lines
1.6 KiB
Markdown
32 lines
1.6 KiB
Markdown
# Ambassador
|
|
|
|
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 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 "ambassador.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's "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)
|
|
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!
|
|
|
|
## 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 using kick to reset the client.
|
|
* Smart handshaking-data caching system to reduce load/network-traffic.
|