From 59e168f3bbfdc9271e6022206e906e3d3653b7d6 Mon Sep 17 00:00:00 2001
From: adde0109 <52883522+adde0109@users.noreply.github.com>
Date: Sat, 4 Jun 2022 19:49:52 +0200
Subject: [PATCH] Create README.md

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..99f61f9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# 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 it's alpha stage and should not be used on an actual server, 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)
+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!
+
+## Limitations
+* You can't switch servers when connecting with a forge client, yet...
+* This plugin can't yet distinguish between forge and vanilla clients, so you either one must use forced hosts or other means.
+* 
+
+## Planned features
+* Ping Forwarding
+* Distinguish between forge and vanilla client, and connect to the most suitalbe server. (Like VersionConnector)
+* Server switching using kick to reset the client.
+* Smart handshaking-data caching system to reduce load/network-traffic.