diff --git a/README.md b/README.md new file mode 100644 index 0000000..d47bca0 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# e4mc + +## Download + +https://www.curseforge.com/minecraft/mc-mods/e4mc + +https://modrinth.com/mod/e4mc + +## How it works + +1. e4mc_minecraft connects to wss://ingress.e4mc.link, which then is routed to the closest relay server. +2. The relay server assigns the host a domain. +3. When a player connects to an e4mc-managed domain, the relay server looks up the domain in the handshake packet and starts relaying the connection to the corresponding host via the initial websocket connection. +4. The relay server is intentionally oblivious of how the Minecraft protocol works other than the format of the handshake packet, and does not modify any packets to or from the host. \ No newline at end of file