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 Old School Runescape. Each is linked to their Github repositories.
Old School Runescape Includes
Installing Java (Java Client/Reflection)
You may be a little confused as to why we are needing to install Java since Runescape does not completely depend on it anymore. If you are using the Reflection include or would just like to play using the Java client, it is required to have Java installed on your machine. If you are using the SRL-OSR include, you can use it with the Steam client.
- Get the latest 32-Bit version of Java from Oracle's Java Download Page.
- 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.
How to install/setup Simba 1.4 for Old School Runescape
Simba 1.4 has been updated to include more features and make writing and editing scripts a bit easier. If you are interested in trying it out, you can follow the steps to setting it up below.
- Download Simba 1.4 from here and place it in the Simba directory found at "C:\Simba".
- Open up Simba and open the Package Manager by clicking the
icon. - In the Packages window, press the Add button and paste the GitHub link of the library you'd like to use and hit 'OK'.
- Press Install and overwrite the installation directory.
- Repeat the previous two steps with the following links:
Code:
https://github.com/srl/srl-plugins
https://github.com/srl/srl-fonts
- Restart Simba and paste the following program into Simba:
Simba Code:
program new;
{$I SRL/OSR.simba}
begin
end.
- Compile the program by selecting Script->Compile. 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. In the debug section in Simba, you should see:
Code:
Successfully executed.
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. Depending on the library you are using (such as SRL-OSR), each script might have slightly different configurations, but the general rule of thumb is the following:
- Open up the in-game settings after you have logged in on your account and set brightness to max and set Zoom to maximum zoom out.
- If you are using 'Resizable Mode', make sure that Transparent side panel setting is disabled.
- Make sure that Show Data Orbs is enabled.
- Make sure that toggle roofs is off.
- Make sure that Shift Drop is enabled.
Now you are ready to get running with Old School Runescape scripts!