Skip to content
Gubna-TechPublic

About

Free, open-source AutoHotkey framework and script-building toolkit for RuneScape 3 EoC, built to make creating powerful automation and quality-of-life tools faster, easier, and more flexible.

Topics

Resources

Stars

42 stars

Watchers

2 watching

Forks

Repository files navigation

LLARS

Local Library of Automated Routines and Scripts

LLARS Logo AutoHotkey Logo

Download LLARS

Join the LLARS Discord


What is LLARS?

LLARS is a free and open-source AutoHotkey framework and script-building toolkit for RuneScape 3 (RS3/EoC) and Old School RuneScape (OSRS). Its included scripts are for RS3; the LLARS framework and Script Generator can also be used to create and run OSRS-specific scripts.

It provides a shared framework, Creator API, reusable functions, configuration system, GUI tools, and supporting libraries for creating and running LLARS-compatible scripts.

LLARS is designed for both:

  • Script Users — Configure and run existing LLARS-compatible scripts.
  • Script Creators — Build, maintain, and expand automation using the LLARS framework.

Table of Contents


Important Note for Script Use

Script Configuration

You do not need to make changes to the script itself.

Normal script configuration should be performed through the LLARS GUI, the root LLARS Config.ini, and any script-local Config.ini provided for that activity. Some scripts do not require a local Config.ini.

The included scripts are designed for RuneScape 3 (RS3/EoC) only. LLARS recognizes Old School RuneScape (OSRS) through the official client and RuneLite, and creators can use its framework and Script Generator to build OSRS scripts. No ready-made OSRS scripts are included.

Make sure to use these scripts only with the appropriate version of the game and understand the risks and responsibilities associated with game automation.

Before using LLARS, please read the LLARS Usage & Safety Tip.

The project disclaimer is included at the bottom of that file.


LLARS Documentation

LLARS includes documentation for both first-time users and script creators.

Setup Guide

Before setting up or running a script, please read the LLARS - Setup Guide included with the project.

The LLARS Setup Guide is the primary guide for learning how to:

  • Set up LLARS and its scripts
  • Configure a script through the LLARS GUI
  • Configure hotkeys, coordinates, and colors
  • Understand the root LLARS configuration and script-local Config.ini files when a script provides one
  • Understand required and optional settings
  • Run scripts correctly
  • Understand timer and run-count settings
  • Pause, resume, and stop scripts
  • Troubleshoot common setup problems
  • Keep your RuneScape layout configured correctly for the script

The Setup Guide is written for first-time users and provides the information needed to set up and use LLARS scripts without requiring users to modify the script itself.

Script Creator Documentation

LLARS is built around a shared framework and Creator API used by the scripts in this repository.

Script creators who want to create or update LLARS-compatible scripts should read:

These are the recommended resources for LLARS v2.x and newer scripts. They cover the current Creator API, framework behavior, reusable components, templates, and copy/paste patterns used throughout the project.

Config.ini Instructions

When setting up a script for the first time, read its Information text and, if the script folder includes one, its Config.ini.

A script-local Config.ini may contain important instructions and information specific to that activity. Some scripts do not need a local Config.ini because their behavior is driven by shared LLARS settings or by the script itself.

Pay close attention to the instructions and comments above each section.

They may explain how a setting works or exactly what should be selected when configuring it through the LLARS GUI.

Different scripts can require different configurations—or no script-local configuration at all—so do not assume that the settings or instructions from one script apply to another.

When a supported activity has both versions, Script Selector offers Normal and Menu Entry Swapper variants. Normal scripts remain under Scripts; Menu Entry Swapper variants are kept separately under Scripts - Menu Entry Swapper and rely on the bank interaction to load the last preset instead of pressing a Bank Preset hotkey. The Selector uses the shorter - MES suffix for these alternate entries while the type filter keeps the full Menu Entry Swapper family name. Use the Selector's type filter to show either family.

For normal setup, use the LLARS GUI whenever possible rather than manually editing configuration files.

Configuration Backup & Restore

LLARS includes the existing backup and restore tools under the Backup folder. They protect the shared LLARS Config.ini and script-local Config.ini files, and the same backup tool is used automatically before an LLARS update download begins.


Requirements

Requirement Version / Information
Operating System Windows
AutoHotkey v1.1.37.02
Game clients RuneScape 3 (RS3/EoC); Old School RuneScape (official client or RuneLite). Included scripts: RS3 only.
Script Format Uncompiled .ahk scripts

LLARS is built for AutoHotkey v1, and the scripts are provided in an uncompiled format.

If you haven't installed AutoHotkey yet, download the required v1.1.37.02 release from the official AutoHotkey website.

Download AutoHotkey v1.1.37.02

AutoHotkey Version

LLARS is built for AutoHotkey v1.1.37.02.

AutoHotkey v2 is not a drop-in replacement for AutoHotkey v1 scripts.

Input backend

LLARS recommends AutoHotInterception (AHI) for mouse and keyboard input. The AHI runtime and Interception installer are bundled with LLARS, and a clean installation is offered automatically when AHI is not present. Installation requires an Administrator prompt and one Windows restart.

Standard AutoHotkey remains available as a fallback under Information > Input Settings. Input Settings shows the configured backend, active input route, AHI driver/device routes, last mouse/keyboard transport, startup timing, and fallback state. It also provides a non-invasive Test AHI health check plus the existing enable/repair and uninstall controls.


Support

For questions, setup help, script support, or information about the LLARS framework, join Gubna's Script Support Discord Server.

Discord Contact: Gubna
Formerly Gubna#0001

Join the Discord Server

About

Free, open-source AutoHotkey framework and script-building toolkit for RuneScape 3 EoC, built to make creating powerful automation and quality-of-life tools faster, easier, and more flexible.

Topics

Resources

Stars

42 stars

Watchers

2 watching

Forks

Releases

Contributors

Languages