This post teaches you how to install and properly setup Simba to work with Old School Runescape.

Introduction

Simba is the open source program that we use to write, compile, and run all of the code used in the Runescape scripts found on the forum. This means that if you plan to write your own script or one that has been posted on the site, you will need to make sure Simba is installed correctly as well as the proper include (more on this later) to be able to have the script compile and run. The language used in Simba is called Lape.

Now that you have a bit of an understanding of Simba, let's get started.

Setting up

Before we jump into it, you should know about the different types of includes that we have on the forums. In the case you do not already know, an include or library is a collection of code that is already written in such a way to allow the programmer to accomplish a specific task with ease by giving the programmer a collection of methods/functions/procedures to use. Below you will find the different types of includes that are available for OldS chool Runescape. Each is linked to their development threads or Github pages, as well as some tutorials to help you make up your mind on which one you feel is best for you. For this tutorial, I will show you how to install the Old School Runesape SRL-OSR library.

After downloading the installer, run it and install to your computer. It is recommended that you install to the default location since there is a lower possibility that Simba cannot find the Java installation folder.

NOTE: You may be a little confused as to why we are needing to install Java since Runescape does not completely depend on it anymore. The primary reason we do this is that we use a program known as S.M.A.R.T. which is a virtual environment that runs the Java version of Runescape and allows you to have multiple bots running concurrently. We do this in the case that you want to be able to use S.M.A.R.T. but it is not always necessary. You can read here for more information about how to run multiple instances without S.M.A.R.T.

Note: There should now be two folders named "C:/Simba/Includes/SRL" and "C:/Simba/Includes/RSWalker".

Restart Simba and paste the following program into Simba:

Simba Code:

program new;{$define SMART}//If not using SMART, then comment this line out{$I SRL/OSR.simba}{$I RSWalker/Walker.simba}

begin clearDebug(); srl.Setup([]);end.

Compile the program by selecting Script->Compile or by pressing Control Key + F9. After a couple of seconds you should see the output:

Code:

Compiled successfully in XXXX ms.

Since we now know that there are no errors in the code, we can run it by selecting Script->Run, by pressing F9, or by pressing the Green Play Button in the toolbar. This will cause SMART to load and will terminate the program. In the debug section in Simba, you should see:

Code:

Successfully executed.

How to install/setup Simba 1.3 for Old School Runescape

Simba 1.3 has been updated to include more features and make writing and editing scripts a bit easier. This update currently only works with the OSR Include. If you are interested in trying it out, you can follow the steps to setting it up below.

Download Simba 1.3 from here and place it in the directory "C:\Simba 1.3".

Open up Simba and open the Package Manager by clicking the icon.

In the Packages window, press the Add button and paste the following link and hit 'OK'

program new;{$define SMART}//If not using SMART, then comment this line out{$I SRL/OSR.simba}{$I RSWalker/Walker.simba}

begin clearDebug(); srl.Setup([]);end.

Compile the program by selecting Script->Compile or by pressing Control Key + F9. After a couple of seconds you should see the output:

Code:

Compiled successfully in XXXX ms.

Since we now know that there are no errors in the code, we can run it by selecting Script->Run, by pressing F9, or by pressing the Green Play Button in the toolbar. This will cause SMART to load and will terminate the program. In the debug section in Simba, you should see:

Congratulations! We are almost done! All we have to do now is worry about making sure our in-game interfaces are setup correctly. Each version of Runescape has to be setup a little differently, so be sure to pay close attention.

Open up the in-game settings after you have logged in on your account and set brightness to max and set zoom to max.

Then click on the Advanced Options button and enable Roof-removal.

Not needed but recommended you also enable Shift Click Drop under the Controls section.

Now you are ready to get running with Old School Runescape scripts!

Last edited by StickToTheScript; 02-09-2019 at 08:48 PM.
Reason: Updated.

This post teaches you how to install and properly setup Simba to work with Runescape 3.

Introduction

Simba is the open source program that we use to write, compile, and run all of the code used in the Runescape scripts found on the forum. This means that if you plan to write your own script or one that has been posted on the site, you will need to make sure Simba is installed correctly as well as the proper include (more on this later) to be able to have the script compile and run. The language used in Simba is called Lape.

Now that you have a bit of an understanding of Simba, let's get started.

Setting up

Before we jump into it, you should know about the different types of includes that we have on the forums. In the case you do not already know, an include or library is a collection of code that is already written in such a way to allow the programmer to accomplish a specific task with ease by giving the programmer a collection of methods/functions/procedures to use. Below you will find the different types of includes that are available Runescape 3. Each is linked to their development threads or Github pages, as well as some tutorials to help you make up your mind on which one you feel is best for you. For this tutorial, I will show you how to install the Runescape 3 SRL-6 library.

After downloading the installer, run it and install to your computer. It is recommended that you install to the default location since there is a lower possibility that Simba cannot find the Java installation folder.

NOTE: You may be a little confused as to why we are needing to install Java since Runescape does not completely depend on it anymore. The primary reason we do this is that we use a program known as S.M.A.R.T. which is a virtual environment that runs the Java version of Runescape and allows you to have multiple bots running concurrently. We do this in the case that you want to be able to use S.M.A.R.T. but it is not always necessary. You can read here for more information about how to run multiple instances without S.M.A.R.T.

program new;{$define SMART}//If not using SMART, then comment this line out{$i srl-6/srl.simba}

begin clearDebug(); setupSRL();end.

Compile the program by selecting Script->Compile or by pressing Control Key + F9. After a couple of seconds you should see the output:

Code:

Compiled successfully in XXXX ms.

Since we now know that there are no errors in the code, we can run it by selecting Script->Run, by pressing F9, or by pressing the Green Play Button in the tool bar. This will cause SMART to load and will terminate the program. In the debug section in Simba, you should see:

NOTE: If you do not wish to have the console window visible, you can disable it by pressing the Hide/Show Console button in the to

In-game Graphics

Congratulations! We are almost done! All we have to do now is worry about making sure our in-game interfaces are setup correctly. Each version of Runescape has to be setup a little differently, so be sure to pay close attention.

Open up the in-game settings after you have logged in on your account and set Load Layout to Old School.

The Simba Documentation has lots of information that can often answer general questions and inform you about how Simba works. If you have not taken a look through it yet, I would highly recommend it.

NOTE: Keep in mind that some of the information in the documentation is out of date but that does not mean it is not relevant.

Frequently Asked Questions

Below you will find common frequently asked questions and their solutions. As more are discovered, they will be posted here.

Currently under construction

What is Simba and is it safe to use?
Most of your questions regarding Simba can be answered by visiting the Simba Documentation. You will also find that since it is an open source project, both your computer and your account are safe.

There are so many includes. Which one do I choose?
If this is your first time ever programming, I'd recommend that you start with SRL-6 for RS3 and either SRL-OSR or AeroLib for Old School. If you are a little more advanced already, feel free to experiment and look through the information given by the others. If you're still stuck on trying to figure it out, feel free to post or PM me and I'll help you out!

I am getting errors while attempting to install. What is wrong?
If you are ever stuck with getting errors while attempting to install an include, feel free to jump in on our chat services and ask away! There is a large number of people willing to help! Just remember, be specific when asking questions!

I followed the tutorial but nothing works. What do I do?
It is possible that you happened to skip over a step, place something in the wrong location, or just made some sort of mistake along the way. If this happened, just try to uninstall Simba and delete the installation folder and try all the steps again. If this still did not work, you are more than welcome to post here and we will do our best to help you out!

I am getting errors when attempting to load SMART (or any other Java related errors)
When choosing which version of the Java Development Kit (JDK) to install, make sure you choose the 32-Bit version. The 64-Bit version will not work.

I am able to load an instance of SMART but cannot get my player to log in.
It is possible that even though SMART gets loaded, Simba hasn't be setup to target the client. To do this you can simply:

Targeting SMART

And in the output, you should get:

Code:

New window: XXXXXX

Try pressing 'Run' again.

I am getting the error: 'Error: File "XXX/XXX.simba" not found at line X'
This error is most likely because you have not installed the include you are attempting to use properly. Make sure that the include you downloaded is named properly in your Includes folder to what you are attempting to run. For example, the Old School Includes should be labled as such:

I am getting an empty/black screen when loading SMART.
This means that you have not correctly updated all of your libraries/includes. To do this, we can follow the following instructions:

Update via Simba

Originally Posted by slacky

Open Simba 1.1 [Simba.exe], find the SRL menu, navigate down to "Automatically.." disable "Update" and "Check for update". Now repeat these steps under the plugin menu as well.

Once done, you must naviage to the plugin menu once more, and this time under "Settings" select override update if it's not already. Now still under the plugin menu, click "Update" and wait for it to update.

The problem should no longer appear, nor reappear.

Again, as always, use Simba 1.2Rc to run your script. Let there be no confusion about that.

I am getting the error: 'Error: Plugin(SimpleOCR32) has not been found'
This is most likely because of a problem with your antivirus. The file is completely safe to use, it just gets flagged by certain AV's. You can add the Plugins folder to your AV's ignore list if you wish to continue using it regularily.

If anything is missing or needs to be corrected, please let me know and I'll update it as soon as possible.

If you have anything to contribute, please let me know and I can include it.

NOTE: For those with their own modified versions of the includes, I have not included those since I am trying to keep things simple.

You just have to use the package manager in the referred Simba version to update. And if you also use the old simba (<= 1.1), and there are update conflicts, then you just disable it's updater.

The "SRL Updater", is not part of the Simba version recommend in this tutorial (hereafter referred to as Simba X). So that message is from Simba 1.1, and only happens because of the package manager which is in Simba X isn't compatible with the updater in 1.1. So roughly what happens is that the updater in Simba 1.1 doesn't know what version of SRL-6 you have, so it just updates SRL-6 itself.

Refering to the referenced version of Simba as Simba X because it's NOT Simba 1.3 as the name suggest, nor is it Simba 1.2, just simply a fork of Simba that expands on Simba 1.2 with experimental features and changes.

Hey, thanks very much for the tutorial. I'm having an issue though... Despite uninstalling and starting over a couple times my script doesn't return from the srl.Setup procedure. The SMART window opens but nothing called after the setup procedure is executed. Any ideas?

Hey, thanks very much for the tutorial. I'm having an issue though... Despite uninstalling and starting over a couple times my script doesn't return from the srl.Setup procedure. The SMART window opens but nothing called after the setup procedure is executed. Any ideas?

Does anything show up in the debug box in Simba when you run it?

Also, since SMART does open, it does mean that Simba, as well as the includes, are installed properly.