From fd4f873c9cbf30c66820bbafefbfe8f815976a8a Mon Sep 17 00:00:00 2001
From: onyx-and-iris <code@onyxandiris.online>
Date: Sat, 27 Jan 2024 14:49:08 +0000
Subject: [PATCH] readme initial commit

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..346fd3d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Q3 Rcon Proxy
+
+A modification of [lilproxy][lilproxy_url] that forwards only Q3 rcon/query packets. Useful for separating the rcon port from the game server port.
+
+### Use
+
+Run one or multiple rcon proxies by setting an environment variable `Q3RCON_PROXY`
+
+for example:
+
+```bash
+export Q3RCON_PROXY="20000:28960;20001:28961;20002:28962"
+```
+
+This would run 3 proxy servers listening on ports `20000`, `20001` and `20002` that redirect rcon requests to game servers on ports `28960`, `28961` and `28962` respectively.
+
+### Why
+
+Avoid sending plaintext rcon requests (that include the password) to public ports. Instead send them to whitelisted ports.
+
+Gives you the option to disable remote rcon entirely and have the server accept requests only from localhost.
+
+### Special Thanks
+
+[Dylan][user_link] For writing this proxy.
+
+[lilproxy_url]: https://github.com/dgparker/lilproxy
+[user_link]: https://github.com/dgparker