README.md

@@ -1,58 +1,14 @@
-# Minecraft bot stress tester
-🤖 A simple open source app written in Java used for stress testing Minecraft servers with bots (fake players).  
-💥 It can be also used to test plugins or minigames.  
-✔️ The MC version of the bots is 1.20 (supports 1.20.x).  
-For older MC versions please look in the [releases](https://github.com/crpmax/mc-bots/releases " releases").
+# Minecraft Bot Stress Tester
+A simple app used to stress test Minecraft servers by loading in fake players (bots).
 
-## 🆒 Features
-- ✅ Connect as many bots as you want
-- ✅ Use SOCKS4 or SOCKS5 proxies from file or URL
-- ✅ Receive colored or noncolored chat
-- ✅ Set connection delay
-- ✅ Set messages or commands on join
-- ✅ Generate random or real looking nicknames or load from file
-- ✅ Online (premium) account support with login using Microsoft OAuth - only for migrated accounts  
-- ✅ Control all or selected bots
+This is a fork of the [**original**](https://github.com/crpmax/mc-bots) with a big re-write to the codebase, along with a built in plugin that can be directly used on the server.
 
-## 📖 Usage
-Minimal Java version: 8  
-Use of pre-compiled jar from [releases](https://github.com/crpmax/mc-bots/releases " releases"):  
-`java -jar mc-bots.jar -s <server address> [arguments]`  
-When running, you can write a chat message to the terminal to send it by all bots.
+# Usage:
+There are two different ways you can use this, either as a standalone app run from a console, or by adding it to your server and running as a plugin.
 
-## 🧪 Example
-`java -jar mc-bots-1.2.6.jar -s 192.168.0.189:25565 -p BOT_ -d 4000 5000 -c 30 -r`  
-This will connect 30 bots to server at 192.168.0.189:25565 with delay 4000-5000 ms and will use real-looking nicknames prefixed with BOT_
+To use as a standalone app, see the [**standalone wiki**](https://github.com/ShaneBeee/mc-bots/wiki/Standalone)
 
-<img src="https://imgur.com/XWcckas.png" title="Connected bots" width="350px"/>
-<img src="https://imgur.com/CvJq1Io.gif" title="Sending chat message by bots" width="350px"/>
+To use as a plugin on your server, see [**plugin wiki**](https://github.com/ShaneBeee/mc-bots/wiki/Plugin)
 
-
-## ⚡ Options
-`-c <count>` The count of bots to connect, default is 1  
-`-d <min> <max>` Set the minimum and maximum connection delay range in ms, default is 4000-5000  
-`-j <message>` Messages or commands to send on join, separated by `&&`, does not work with `-m` or `-x` option  
-`-p <prefix>` Custom bot nickname prefix eg. `BOT_`  
-`-r` Generate real looking nicknames instead of random ones  
-`-n` Do not use color in terminal - useful when the terminal does not support it  
-`-m` Minimal run - do not use any listeners, will not receive chat, useful for large amounts of bots  
-`-x` The most minimal run - No listeners, no control, no chat - useful for large amounts of bots for better performance  
-`-t <type>` Set proxy type - SOCKS4 or SOCKS5  
-`-l <path>` Set proxy list file  
-`-g` Try to simulate gravity by falling down  
-`-o` Use online (premium) account (login with Microsoft OAuth)  
-`-ar <delay>` Set auto-respawn delay (default is 100 ms, set to -1 to disable)  
-`--nicks <file>` Set nicknames file  
-
-
-## Commands
-Commands can be typed to the console. They are prefixed with `.` or `!`.
-Without the prefix it will be sent as a chat message!  
-`.list` or `.ls` - list all connected bots  
-`.control <nick>` or `.ctrl <nick>` - select one or multiple bots to control  
-`.exit <limit>` or `.leave <limit>` - disconnect all or specified number of bots   
-
-## ⚠ DISCLAIMER
-**This app is made for educational and testing purposes only.  
-This app can be used like spambots.  
-I am not responsible for any abuse.**
+# Requirements:
+- Java 17+