2.0.0

README.md

@@ -20,6 +20,32 @@ If you have any questions, please join our [Discord](https://discord.gg/zaGrfqFE
 
 If you enjoy my open source work and would like to support me, consider buying me a coffee! Your support helps me stay caffeinated and motivated to keep improving and creating awesome projects.
 
+## Quest Helper Integration
+
+The integrated Quest Helper works together with other plugins to give a nice unified experience while questing.
+
+### Not Enough Runes
+
+If you have the [Not Enough Runes](https://runelite.net/plugin-hub/show/not-enough-runes) plugin installed, you can
+right-click item requirements and click `Go to NER...` to look that item up in Not Enough Runes.
+
+![Not Enough Runes context menu](./images/not-enough-runes-01.png)
+
+### Shortest Path
+
+If you have the [Shortest Path](https://runelite.net/plugin-hub/show/shortest-path) plugin installed, you can enable the
+the "Use 'Shortest Path' plugin" in the Quest Helper config.
+
+![](./images/shortest-path-01.png)
+
+Next time you start a quest, the Shortest Path plugin will help you take the shortest path to the destination.
+
+![Shortest Path path overlay example](./images/shortest-path-02.png)
+
+You can configure what teleportation methods, or the aesthetic of the path in the Shortest Path config.
+
+## Help and discussion
+
 [![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-donate-yellow)](https://www.paypal.com/paypalme/MicrobotBE?country.x=BE)
 
 

runelite-client/pom.xml

@@ -41,7 +41,7 @@
 		<git.commit.id.abbrev>nogit</git.commit.id.abbrev>
 		<git.dirty>false</git.dirty>
 		<shade.skip>false</shade.skip>
-		<microbot.version>1.9.9.1</microbot.version>
+		<microbot.version>2.0.0</microbot.version>
 		<microbot.commit.sha>nogit</microbot.commit.sha>
 	</properties>
 

runelite-client/src/main/java/net/runelite/client/RuneLite.java

@@ -43,7 +43,10 @@
 import net.runelite.client.eventbus.EventBus;
 import net.runelite.client.externalplugins.ExternalPluginManager;
 import net.runelite.client.plugins.PluginManager;
+import net.runelite.client.plugins.microbot.Microbot;
 import net.runelite.client.plugins.microbot.externalplugins.MicrobotPluginManager;
+import net.runelite.client.proxy.ProxyChecker;
+import net.runelite.client.proxy.ProxyConfiguration;
 import net.runelite.client.rs.ClientLoader;
 import net.runelite.client.ui.ClientUI;
 import net.runelite.client.ui.FatalErrorDialog;
@@ -76,8 +79,6 @@
 import java.io.IOException;
 import java.lang.management.ManagementFactory;
 import java.lang.management.RuntimeMXBean;
-import java.net.Authenticator;
-import java.net.PasswordAuthentication;
 import java.net.URI;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
@@ -186,9 +187,8 @@ public static void main(String[] args) throws Exception {
 		parser.accepts("noupdate", "Skips the launcher update");
 		parser.accepts("clean-randomdat", "Clean random dat file");
 
-        final ArgumentAcceptingOptionSpec<String> proxyInfo = parser.accepts("proxy", "Use a proxy server for your runelite session")
+        final ArgumentAcceptingOptionSpec<String> proxyInfo = parser.accepts("proxy", "Use a specified proxy. Format: scheme://user:pass@host:port")
                 .withRequiredArg().ofType(String.class);
-        parser.accepts("proxy-type", "The Type of proxy: HTTP or SOCKS").withRequiredArg().ofType(String.class);
         final ArgumentAcceptingOptionSpec<File> sessionfile = parser.accepts("sessionfile", "Use a specified session file")
                 .withRequiredArg()
                 .withValuesConvertedBy(new ConfigFileConverter())
@@ -249,46 +249,7 @@ public static void main(String[] args) throws Exception {
 			}
 		}
 
-        //More information about java proxies can be found here
-        //https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html
-        //usage: -proxy=IP:PORT:USER:PASS -proxytype=SOCKS
-        //OR
-        //usage: -proxy=IP:PORT:USER:PASS -proxytype=HTTP
-        if (options.has("proxy")) {
-            String[] proxy = options.valueOf(proxyInfo).split(":");
-            boolean httpProxy = false;
-            boolean socksProxy = true; //default we take socks proxy
-            if (options.has("proxy-type")) {
-                socksProxy = options.valueOf("proxy-type").toString().equalsIgnoreCase("SOCKS");
-                httpProxy = options.valueOf("proxy-type").toString().equalsIgnoreCase("HTTP");
-            }
-
-            ClientUI.proxyMessage = (socksProxy ? "SOCKS" : "HTTP") + " Proxy with address " + options.valueOf(proxyInfo);
-
-            if (httpProxy && proxy.length >= 2) {
-                System.setProperty("http.proxyHost", proxy[0]);
-                System.setProperty("http.proxyPort", proxy[1]);
-            } else if (socksProxy && proxy.length >= 2) {
-                System.setProperty("socksProxyHost", proxy[0]);
-                System.setProperty("socksProxyPort", proxy[1]);
-            }
-
-            if (socksProxy && proxy.length >= 4) {
-                System.setProperty("java.net.socks.username", proxy[2]);
-                System.setProperty("java.net.socks.password", proxy[3]);
-
-                final String user = proxy[2];
-                final char[] pass = proxy[3].toCharArray();
-
-                Authenticator.setDefault(new Authenticator() {
-                    private final PasswordAuthentication auth = new PasswordAuthentication(user, pass);
-
-                    protected PasswordAuthentication getPasswordAuthentication() {
-                        return auth;
-                    }
-                });
-            }
-        }
+		ProxyConfiguration.setupProxy(options, proxyInfo);
 
         Thread.setDefaultUncaughtExceptionHandler((thread, throwable) ->
         {
@@ -302,6 +263,19 @@ protected PasswordAuthentication getPasswordAuthentication() {
 		RuneLiteAPI.CLIENT = okHttpClient;
 
 		SplashScreen.init();
+
+		SplashScreen.stage(0, "Setting up proxy", "Testing proxy address...");
+
+		if (options.has(proxyInfo)) {
+			String ip = ProxyChecker.getDetectedIp(okHttpClient);
+			if (ip.isEmpty()) {
+				Microbot.showMessage("Failed to detect external IP address, check your proxy settings. \n\n Make sure to use the format scheme://user:pass@host:port");
+				System.exit(1);
+			}
+
+			ClientUI.proxyMessage = " - Proxy enabled (detected IP " + ip + ")";
+		}
+
 		SplashScreen.stage(0, "Preparing RuneScape", "");
 
 		try
@@ -458,6 +432,9 @@ public void start() throws Exception
 		// Load user configuration
 		configManager.load();
 
+		// Initialize MicrobotPluginManager after configManager is loaded
+		microbotPluginManager.init();
+
 		// Update check requires ConfigManager to be ready before it runs
 		Updater updater = injector.getInstance(Updater.class);
 		updater.update(); // will exit if an update is in progress
@@ -492,6 +469,7 @@ public void start() throws Exception
 		eventBus.register(clientUI);
 		eventBus.register(pluginManager);
 		eventBus.register(externalPluginManager);
+		eventBus.register(microbotPluginManager);
 		eventBus.register(overlayManager);
 		eventBus.register(configManager);
 		eventBus.register(discordService);

runelite-client/src/main/java/net/runelite/client/RuneLiteDebug.java

@@ -42,8 +42,10 @@
 import net.runelite.client.eventbus.EventBus;
 import net.runelite.client.externalplugins.ExternalPluginManager;
 import net.runelite.client.plugins.PluginManager;
+import net.runelite.client.plugins.microbot.Microbot;
 import net.runelite.client.plugins.microbot.MicrobotClientLoader;
 import net.runelite.client.plugins.microbot.externalplugins.MicrobotPluginManager;
+import net.runelite.client.proxy.ProxyChecker;
 import net.runelite.client.ui.ClientUI;
 import net.runelite.client.ui.FatalErrorDialog;
 import net.runelite.client.ui.SplashScreen;
@@ -73,8 +75,6 @@
 import java.io.IOException;
 import java.lang.management.ManagementFactory;
 import java.lang.management.RuntimeMXBean;
-import java.net.Authenticator;
-import java.net.PasswordAuthentication;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -174,7 +174,6 @@ public static void main(String[] args) throws Exception {
 
         final ArgumentAcceptingOptionSpec<String> proxyInfo = parser.accepts("proxy", "Use a proxy server for your runelite session")
                 .withRequiredArg().ofType(String.class);
-        parser.accepts("proxy-type", "The Type of proxy: HTTP or SOCKS").withRequiredArg().ofType(String.class);
         final ArgumentAcceptingOptionSpec<File> sessionfile = parser.accepts("sessionfile", "Use a specified session file")
                 .withRequiredArg()
                 .withValuesConvertedBy(new ConfigFileConverter())
@@ -208,47 +207,6 @@ public static void main(String[] args) throws Exception {
             logger.setLevel(Level.DEBUG);
         }
 
-        //More information about java proxies can be found here
-        //https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html
-        //usage: -proxy=IP:PORT:USER:PASS -proxytype=SOCKS
-        //OR
-        //usage: -proxy=IP:PORT:USER:PASS -proxytype=HTTP
-        if (options.has("proxy")) {
-            String[] proxy = options.valueOf(proxyInfo).split(":");
-            boolean httpProxy = false;
-            boolean socksProxy = true; //default we take socks proxy
-            if (options.has("proxy-type")) {
-                socksProxy = options.valueOf("proxy-type").toString().equalsIgnoreCase("SOCKS");
-                httpProxy = options.valueOf("proxy-type").toString().equalsIgnoreCase("HTTP");
-            }
-
-            ClientUI.proxyMessage = (socksProxy ? "SOCKS" : "HTTP") + " Proxy with address " + options.valueOf(proxyInfo);
-
-            if (httpProxy && proxy.length >= 2) {
-                System.setProperty("http.proxyHost", proxy[0]);
-                System.setProperty("http.proxyPort", proxy[1]);
-            } else if (socksProxy && proxy.length >= 2) {
-                System.setProperty("socksProxyHost", proxy[0]);
-                System.setProperty("socksProxyPort", proxy[1]);
-            }
-
-            if (socksProxy && proxy.length >= 4) {
-                System.setProperty("java.net.socks.username", proxy[2]);
-                System.setProperty("java.net.socks.password", proxy[3]);
-
-                final String user = proxy[2];
-                final char[] pass = proxy[3].toCharArray();
-
-                Authenticator.setDefault(new Authenticator() {
-                    private final PasswordAuthentication auth = new PasswordAuthentication(user, pass);
-
-                    protected PasswordAuthentication getPasswordAuthentication() {
-                        return auth;
-                    }
-                });
-            }
-        }
-
         Thread.setDefaultUncaughtExceptionHandler((thread, throwable) ->
         {
             log.error("Uncaught exception:", throwable);
@@ -262,6 +220,17 @@ protected PasswordAuthentication getPasswordAuthentication() {
         RuneLiteAPI.CLIENT = okHttpClient;
 
         SplashScreen.init();
+
+        if (options.has(proxyInfo)) {
+            String ip = ProxyChecker.getDetectedIp(okHttpClient);
+            if (ip.isEmpty()) {
+                Microbot.showMessage("Failed to detect external IP address, check your proxy settings. \n\n Make sure to use the format scheme://user:pass@host:port");
+                System.exit(1);
+            }
+
+            ClientUI.proxyMessage = " - Proxy enabled (detected IP " + ip + ")";
+        }
+
         SplashScreen.stage(0, "Retrieving client", "");
 
         try {
@@ -364,6 +333,9 @@ public void start() throws Exception {
         // Load user configuration
         configManager.load();
 
+		// Initialize MicrobotPluginManager after configManager is loaded
+		microbotPluginManager.init();
+
         // Update check requires ConfigManager to be ready before it runs
         Updater updater = injector.getInstance(Updater.class);
         updater.update(); // will exit if an update is in progress
@@ -390,6 +362,7 @@ public void start() throws Exception {
         eventBus.register(clientUI);
         eventBus.register(pluginManager);
         eventBus.register(externalPluginManager);
+		eventBus.register(microbotPluginManager);
         eventBus.register(overlayManager);
         eventBus.register(configManager);
         eventBus.register(discordService);
@@ -403,7 +376,7 @@ public void start() throws Exception {
 
         clientUI.show();
 
-        pluginManager.loadRuneliteCorePlugins();
+        pluginManager.loadCoreRunelitePlugins();
 
         microbotPluginManager.loadCorePlugins(pluginsToDebug);
 

runelite-client/src/main/java/net/runelite/client/plugins/PluginManager.java

@@ -215,58 +215,48 @@ public void startPlugins() {
         }
     }
 
-    public void loadCorePlugins() throws IOException, PluginInstantiationException {
-        SplashScreen.stage(.59, null, "Loading plugins");
+    /**
+     * Loads core RuneLite plugins, excluding any Microbot-related plugins.
+     * This method filters out plugins from the microbot package hierarchy.
+     */
+    public void loadCoreRunelitePlugins() throws IOException, PluginInstantiationException {
+        SplashScreen.stage(.59, null, "Loading core RuneLite plugins");
         ClassPath classPath = ClassPath.from(getClass().getClassLoader());
 
         List<Class<?>> plugins = classPath.getTopLevelClassesRecursive(PLUGIN_PACKAGE).stream()
                 .map(ClassInfo::load)
+                .filter(clazz -> !isMicrobotRelatedClass(clazz))
                 .collect(Collectors.toList());
 
         loadPlugins(plugins, (loaded, total) ->
-                SplashScreen.stage(.60, .70, null, "Loading plugins", loaded, total, false));
+                SplashScreen.stage(.60, .70, null, "Loading core RuneLite plugins", loaded, total, false));
     }
 
     /**
-     * This excludes any microbot plugin
+     * Determines if a class is related to Microbot and should be excluded from core RuneLite plugin loading.
      *
-     * @throws IOException
-     * @throws PluginInstantiationException
+     * @param clazz the class to check
+     * @return true if the class is Microbot-related and should be filtered out
      */
-    public void loadRuneliteCorePlugins() throws IOException, PluginInstantiationException {
+    private static boolean isMicrobotRelatedClass(Class<?> clazz) {
+        if (clazz == null || clazz.getPackage() == null) {
+            return false;
+        }
+
+        String packageName = clazz.getPackage().getName();
+
+        return packageName.startsWith(PLUGIN_PACKAGE + ".microbot");
+    }
+
+    public void loadCorePlugins() throws IOException, PluginInstantiationException {
         SplashScreen.stage(.59, null, "Loading plugins");
         ClassPath classPath = ClassPath.from(getClass().getClassLoader());
 
-        List<Class<?>> microbotPlugins = new ArrayList<>();
-        List<Class<?>> otherPlugins = new ArrayList<>();
-
-        for (ClassInfo classInfo : classPath.getTopLevelClassesRecursive(PLUGIN_PACKAGE)) {
-
-            Class<?> clazz = classInfo.load();
-            String pkg = clazz.getPackageName().toLowerCase();
-
-
-            /**
-             * TODO: Over time these should be moved into a core folder within the microbot plugins folder
-             * This way we can easily detect any core plugins required to run microbot
-             */
-            if (pkg.contains(".microbot") && (
-                    pkg.contains(".util")
-                            || pkg.contains(".ui")
-                            || pkg.endsWith("microbot")
-                            || pkg.contains(".shortestpath")
-                            || pkg.contains(".rs2cachedebugger")
-                            || pkg.contains("pluginscheduler")
-                            || pkg.contains("inventorysetups"))) {
-                microbotPlugins.add(clazz);
-            } else if (!pkg.contains("microbot")) {
-                otherPlugins.add(clazz);
-            }
-        }
-
-        otherPlugins.addAll(microbotPlugins);
+        List<Class<?>> plugins = classPath.getTopLevelClassesRecursive(PLUGIN_PACKAGE).stream()
+                .map(ClassInfo::load)
+                .collect(Collectors.toList());
 
-        loadPlugins(otherPlugins, (loaded, total) ->
+        loadPlugins(plugins, (loaded, total) ->
                 SplashScreen.stage(.60, .70, null, "Loading plugins", loaded, total, false));
     }