From 5a28ececd22516d6f8b92a0bf58a5d1efbbc43fd Mon Sep 17 00:00:00 2001
From: ColdDev <colddev@pm.me>
Date: Sun, 23 Oct 2022 22:01:57 +0100
Subject: [PATCH] chore(readme): add IP ban section

---
 README.md                     | 10 +++++++++-
 src/main/resources/config.yml |  5 ++++-
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d95dd4b..fc25dc6 100644
--- a/README.md
+++ b/README.md
@@ -8,4 +8,12 @@ Uranium is a moderation utility built for Eaglercraft 1.8 servers. **THIS PLUGIN
 - Restart, **not reload**, your server
 - Modify the configuration file located in `plugins/Uranium/config.yml` to your liking
 - ????
-- Profit
\ No newline at end of file
+- Profit
+
+## IP Banning
+
+Since Eaglercraft uses a different protocol, getting IP addresses via Bukkit's normal methods is not possible. For this reason, Uranium utilizes plugin messaging.
+
+Additionally, IP banning is done at the Bungee level, which means that you need to modify your EaglerBungee config for this portion of the plugin to work as expected.
+
+You will need to modify `accept_bukkit_console_command_packets` in your Bungee configuration, and set it to `true`. This is to allow IP banning from in-game.
\ No newline at end of file
diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml
index 69cd08f..fc6ce68 100644
--- a/src/main/resources/config.yml
+++ b/src/main/resources/config.yml
@@ -32,4 +32,7 @@ suspicious-domains:
   # a suspicious domain is detected?
   enable-webhook: false
   # Provide your Discord webhook URL here.
-  webhook-url: ''
\ No newline at end of file
+  webhook-url: ''
+
+# Should we override the regular /banip, /ipban & /ban-ip commands with Uranium's version?
+override-ipban: true
\ No newline at end of file