Skip to content

Setup

Jump to bottom
LordChunder edited this page Dec 30, 2022 · 1 revision

This assumes a fresh RuneLite install

Download and unzip RunescapeAI from: https://github.com/LordChunder/RunescapeAI/archive/refs/heads/master.zip

  1. Install Python 3.8 or higher https://www.python.org/downloads/

  2. Install RunescapeAI dependencies requirements.txt

    • Open a console inside the root RunescapeAI folder.
    • run $ pip install -r requirements.txt

  3. IMPORTANT: Make sure your monitor scaling is at 100% or RunescapeAI will not be able to detect properly.

    1. Right click and go to Display Settings
    2. Make sure Change the size of text, apps and other items is set at 100%
    3. Make sure your monitor resolution is at least 1920x1080px
      • display_settings_help* display_settings_selection

  4. Configure RuneLite

    • Ensure MorgHTTPClient is installed and enabled https://runelite.net/plugin-hub/show/morghttpclient
      • Ensure the port is configured properly in both the plugin and config.yaml
    • Enable hold shift to drop items with in game settings.
    • Enable the Object Markers,Ground Markers,Ground Items and NPC Indicators to allow in game object highlighting and ensure colors are visible and unique
      • The colors will be used with the bots object detection.
      • IMPORTANT: Ensure proper contrast between other in game colors to avoid faulty detection. This does not include items in the HUD as this screen area is excluded.
      • Set outline thickness to 3 for better detection
      • Good colors are (BGR): Red (0, 0, 225), Blue (225,0,0), Light Blue (225,225,0), Amber (225,225,0)
      • Other plugins such as Fishing could be used instead for highlighting the required object, though these 4 plugins cover all the cases and allow changes to the highlight width for better detection
    • Adjust Runescape display settings
      • Set display brightness to max
      • Make sure game client layout is ResizableModern Layout *

  5. Configure RunescapeAI's config.yaml

    • Open config.yaml in a text editor.
    • Enter your OSRS username and password. This is used to automatically log out and login during the break period.
    • Configure the colors used for object detection under detect_colors:
      • Format: [[B_low,R_low,G_low],[B_high,R_high,G_high]]
      • IMPORTANT: Do not remove or edit the object_name: this will cause the program to crash. Only edit the color range value.
      • The high range BRG values should equal the BRG value set in RuneLite for that color. The low value is used to determine the threshold for that colors detection.
      • If not cycling multiple bot modes it is okay for colors to overlap if they are not part of the same mode.
    • By default image_paths should contain the correct paths. If you edit the location of the menu images, update their path here.

  6. OPTIONAL: Configure RunescapeAI's items.yaml

    • Open config.yaml in a text editor.
    • Configure icon_path: to the path of the icons folder
    • To configure the items that RunescapeAI can interact/detect edit items:
      • Format: item_id: image_file_name
      • Use Snipping Tool or any other method to obtain an image of the item. Ensure the background is plain and preferably the OSRS inventory background.
      • To find the id for OSRS items visit: https://www.osrsbox.com/tools/item-search/

Botting or using macros is against the rules of OSRS and may result in a ban. This bot does its best to remain unpredictable and random to avoid detection. To minimize your chances of being banned avoid using the bot for extended periods and cycle through different modes. This bot is to be used at your own risk under the assumption that your account may be banned.

Clone this wiki locally