sticktothescript / srl-rs3

SRL is a scripting library that provides an API for creating scripts in Simba for the game RuneScape.

SRL-RS3

This project is still a work in progress. You should expect that scripts break between updates.

Overview

SRL is a scripting library that provides an API for creating scripts in Simba for the game RuneScape. SRL is written in a Pascal-like scripting language using the Lape interpreter and the Simba IDE.

Everything you need to know about SRL and Simba can be found on the SRL Forums or in the Discord.

Setup

In order to start using this library:

1. Download the latest release of Simba from ollydev/Simba
2. Using the Simba Package Manager, download the latest release of this repo (Note: There will be no releases until the library is functional. Until then, select the master option)).

All required plugins are included in the repo already.

Broken Functions

Below is a list of broken interface functions:

• Action Bar
  • clear
  • getAbilityCooldown (Partially functional)
• Lobby
  • getCurrentTab
  • openTab
• Loot Screen
  • All Functions
• Main Screen
  • SetZoom
  • isPlayerAnimating
• Metrics
  • All Functions
• Minimap
  • getDots
  • isFlagPresent
  • enableRest
  • getRunEnergy
  • isRunEnabled
• Stats
  • All Functions

Untested Functions

Below is a list of interface functions that I have not had the opportunity to test yet:

• Beast of Burden
• Collect Box
• Conversation Box
• Deposit Box
• Hero Screen
• Pin Screen
• Power Screen
• Production
• Progress Screen
• Target Info
• Tool Screen
• Trade Screen
• Worlds

Troubleshooting

Duplicate declaration "Tesseract_Create"

When attempting to compile or run a script and you encounter Duplicate declaration "Tesseract_Create", simply remove any instance of {$i Tesseract/Tesseract.simba} from your script.

This is because Tesseract.simba is already included in the library.

srl-rs3's Issues

Working on this?

How can I help with this? I can't promise to spend a lot of time on this, but I would definitely like to help!