RSB
A runelite extension bot api
A bot api to automate the game Old School Runescape (OSRS) using the RuneLite third party client. RuneLite is an open-source third party client and despite their claims to take steps to prevent or reduce the ease of botting via removing the deobfuscator, one can still make a bot with their api with some effort.
While certainly it would be easier to create one using a deobfuscator and their api it reduces the amount of effort needed to maintain our code by depending on their large number of contributers to keep it up to date and for this project to focus on its own goal.
This API requires minimal modification of the RuneLite api and very little understanding to compile after. Once one has set up the RuneLite api in their IDE (IntelliJ is their recommended IDE) they may then proceed to drag and drop the rsb folder into runelite-client->src->main->java->net.runelite.client Now the bot is completely set up.
To run you'll need to modify your program arguments to the following depending on how you wish it to run:
--bot This will run the bot with all of its interface and features activated
--bot-runelite This runs the bot in a pseudo-bot mode, it uses the runelite interface and runs any bot code placed in rsb/botLauncher/RuneLiteTestFeatures.java It's excellent for testing scripts or verifying functionality of features.
--runelite This runs the bot in runelite stock form. It has no additions and behaves normally.
--ea This enables assertations, it should never be used with either bot mode. It does need to be enabled for base runelite to use --developer-mode
--developer-mode Enables the developer features in runelite stock and runelite bot modes. It does nothing in bot mode as it lacks the runelite interface and plugins to utilize it.
VM args: -debug Activates debug log messages
After entering the program arguements you wish to enable (one mode only --runelite/--bot-runelite/--bot) it is ready to run.
To make and test scripts look at the corresponding wiki pages.
IF THE BOT FAILS TO START TEST THE RUNELITE RUN ARGUMENT IT IS LIKELY AN ISSUE WITH THE RUNELITE MAVEN BUILD Check their wiki for info on how to fix the install