How to Use

General

This document is a work in progress as features are rapidly updating. Current use can be demonstrated within the controller python files and ran with the GUI.

RunescapeAI uses OpenCV image recognition and color based object detection to determine on screen locations of items and highlighted entities in RuneLite.

• It is crucial that the object plugins in RuneLite are configured properly or the bot will not be able to detect positions on screen (see setup)
• Any in game items that need to interact with the bot (ie pickup, drop, eat, combine) need to be configured in items.yaml (see setup)
• When selected multiple modes to run it is crucial that colors do not overlap between modes. Example:
  • If fishing and woodcutting make sure the highlighted trees and fishing spots are not the same color as the bot will not be able to distinguish between trees and fishing spots.

To run start and run RunescapeAI:

1. Launch RuneLite and login to your account
   • Ensure proper markers and colors are set for what you are doing (see setup)
   • Make sure the camera is vertical and zoomed out as much as possible (Hold up / Mouse scroll out)
2. Configure RunescapeAI options.yaml for the selected modes
   • Change the settings for the specific bot modes as required, settings are self-explanatory
3. Open a console inside the RunescapeAI folder and run command python main.py
   • RuneLite must be running prior as the name of this window will be used in the bot to find the RuneLite window
4. Select the bot modes and click run
   • If multiple bot modes are selected they will be cycled randomly
5. Stop the bot by:
   • Exiting the bot with hotkey: ctrl-c
   • Clicking stop
   • Closing the RunescapeAI window