update readme and clarify license

.github/workflows/.keep

@@ -0,0 +1 @@
+todo

LICENSE

@@ -1,14 +1,14 @@
 Adapted from The MIT License (MIT)
 
-Copyright (c) 2016-$today.year DaPorkchop_
+Copyright 2023 rfresh2
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy,
 modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
 is furnished to do so, subject to the following conditions:
 
 Any persons and/or organizations using this software must include the above copyright notice and this permission notice,
-provide sufficient credit to the original authors of the project (IE: DaPorkchop_), as well as provide a link to the original project.
+provide sufficient credit to the original authors of the project (IE: rfresh2), as well as provide a link to the original project.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS

LICENSE-Pork2b2tBot

@@ -0,0 +1,16 @@
+Adapted from The MIT License (MIT)
+
+Copyright 2023 DaPorkchop_
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy,
+modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following conditions:
+
+Any persons and/or organizations using this software must include the above copyright notice and this permission notice,
+provide sufficient credit to the original authors of the project (IE: DaPorkchop_), as well as provide a link to the original project.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,12 +1,12 @@
 # ZenithProxy
 
-Discord Server: ([ZProxy](https://discord.gg/mf9uUvuUCU), [rProxy](https://discord.gg/Gvyb4g6c34))
+Discord Server: [rfresh's dev server](https://discord.gg/nJZrSaRKtb)
 
-Minecraft 1.12.2 proxy/bot. Primarily for use on 2b2t.org.
+Minecraft 1.12.2 proxy/bot. Intended for use on 2b2t.org but will work on any server.
 
 The primary purpose is to Minecraft accounts always online and be securely shared by multiple people.
 
-This project also provides the data for the [2b2t.vc API](https://api.2b2t.vc) and [Discord Bot](https://bot.2b2t.vc).
+This project is also used to support the [2b2t.vc API](https://api.2b2t.vc) and [Discord Bot](https://bot.2b2t.vc).
 
 # What is a proxy?
 
@@ -43,22 +43,23 @@ player movements, spectator mode, discord chat relay, and more.
 * Advanced AntiAFK with pathing and gravity
 * 2b2t Queue Skip
   * Reconnects and skips the queue when the proxy is online for 6 hours (2b2t's max connection time)
-* AutoUpdater that automatically pulls and restarts the proxy at convenient times
+* Modules including AutoEat, AutoDisconnect, AutoReconnect, AutoRespawn, AutoTotem, KillAura, Spammer, AutoReply
 * Many, many, more features.
 
 # Getting Started
 
 ## Prerequisites
 
-1. Linux or Windows server. I recommend DigitalOcean `2 GB Memory / 1 AMD vCPU` in the NYC-1 region for
+1. Linux or Windows server. I recommend DigitalOcean's `1 GB Memory / 1 vCPU` in the NYC-1 region for
    minimal ping to 2b2t. 2b2t allows a maximum of 3 accounts concurrently connected per IP address.
-2. JDK17 and git installed. 
-  * JDK17's path must be set on the JAVA_HOME environment variable or create a gradle.properties file with `org.gradle.java.home=/path/to/jdk17`
+   [Free DigitalOcean $200 credit for new accounts](https://m.do.co/c/3a3a226e4936).
+2. JDK17+ and git installed. 
+  * JDK17+'s path must be set on the JAVA_HOME environment variable or create a gradle.properties file with `org.gradle.java.home=/path/to/jdk17`
 
 ## Setup
 
 1. `git clone [email protected]:rfresh2/ZenithProxy.git`
-2. Execute in CLI: `./start.sh` (Linux) or `./start.bat` (Windows). Close the instance with `CTRL-C`.
+2. Execute in CLI: `./start.sh` (Linux) or `.\start.bat` (Windows). Close the instance with `CTRL-C`.
 3. Edit `config.json`. Important sections:
   * `authentication` -> Input your Minecraft account details
     * You must disable 2FA on your Microsoft account and may need to approve the proxy's
@@ -81,9 +82,9 @@ player movements, spectator mode, discord chat relay, and more.
 
 ## Run
 
-* `./start.sh` (Linux) or `./start.bat` (Windows) or `./gradlew run` (Universal)
-* Type `help` in your terminal to get a list of available commands.
+* `./start.sh` (Linux) or `.\start.bat` (Windows) or `./gradlew run` (Universal)
 * The discord prefix is `.` by default. e.g. `.connect` or `.disconnect`.
+* Type `.help` in discord or `help` in the terminal to get a list of available commands.
 
 # Developers
 

src/main/java/com/zenith/util/Config.java

@@ -37,8 +37,7 @@ public enum AccountType {
     public static final class Client {
         public Extra extra = new Extra();
         public Server server = new Server();
-        // auto-connect proxy on process start
-        public boolean autoConnect = false;
+        public boolean autoConnect = false; // auto-connect proxy on process start
 
         public static final class Extra {
             public AntiAFK antiafk = new AntiAFK();
@@ -205,9 +204,9 @@ public static final class Spammer {
                 public long delayTicks = 200;
                 public boolean randomOrder = false;
                 public List<String> messages = asList(
-                        "/stats",
-                        "/stats",
-                        "/stats"
+                        "ZenithProxy on top!",
+                        "I just skipped queue thanks to ZenithProxy!",
+                        "I love undertimer slopper!"
                 );
             }
 
@@ -318,10 +317,9 @@ public static final class Discord {
         public String visualRangeMentionRoleId = "";
         public String prefix = ".";
         public boolean reportCoords = false;
-        // internal use for update command state persistence
         public boolean mentionRoleOnPrioUpdate = true;
         public boolean mentionRoleOnPrioBanUpdate = true;
-        public boolean isUpdating = false;
+        public boolean isUpdating = false; // internal use for update command state persistence
         public QueueWarning queueWarning = new QueueWarning();
         public ChatRelay chatRelay = new ChatRelay();