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

Merge pull request #4 from klutzies/update-readme

Browse Source 
Update README.md
This commit is contained in:
Adrian Bergqvist 2022-09-29 09:06:01 +02:00 committed by GitHub
commit 3101cf89cc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,6 +1,6 @@
# Ambassador # 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) Unlike other solutions, this plugin does not require any special modifications to the client. (The player doesn't need to do anything)
@ -9,21 +9,21 @@ This plugin is right now in its alpha stage and should not be used in production
### On the Velocity proxy side: ### On the Velocity proxy side:
1. Download and install this plugin to your proxy. 1. Download and install this plugin to your proxy.
2. Start the proxy, then close it. 2. Start the proxy, then close it.
3. Go to "plugins/ambassador" and open "forgeServer.toml" 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.toml" config. 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! 5. Now you are done on the proxy side!
### On the Forge server 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. 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. 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. 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! 5. You are now ready to start the server and connect to it with Velocity!
## Features ## Features
* Server Switching. * Server Switching.
* Force forge clients to connect directly to forge server if mods don't allow vanilla. * Force Forge clients to connect directly to Forge server if mods don't allow vanilla.
* Connect to diffrent forge servers depending on client version. * Connect to diffrent Forge servers depending on client version.
## Planned features ## Planned features
* Ping Forwarding. * Ping Forwarding.