Page 1 of 5 123 ... LastLast
Results 1 to 25 of 113

Thread: Complete Guide to Setting Up Simba and SRL

  1. #1
    Join Date
    Feb 2012
    Location
    Canada
    Posts
    1,164
    Mentioned
    26 Post(s)
    Quoted
    433 Post(s)

    Default Complete Guide to Setting Up Simba and SRL

    Complete Guide to Setting Up Simba and SRL
    Verified Working On: November 3, 2021

    Table of Contents:
    Part 1: Simba & Old School Runescape
    Part 2: Simba & Runescape 3 (OUTDATED)
    Part 3: Questions and Help




    Part 1: Simba & Old School Runescape

    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 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.

    1. Get the latest 32-Bit version of Java from Oracle's Java Download Page.
    2. 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.
    1. Download Simba 1.4 from here and place it in the Simba directory found at "C:\Simba".
    2. Open up Simba and open the Package Manager by clicking the icon.
    3. In the Packages window, press the Add button and paste the GitHub link of the library you'd like to use and hit 'OK'.
    4. Press Install and overwrite the installation directory.
    5. Repeat the previous two steps with the following links:
      Code:
      https://github.com/srl/srl-plugins
      https://github.com/srl/srl-fonts
    6. Restart Simba and paste the following program into Simba:
      Simba Code:
      program new;
      {$I SRL/OSR.simba}

      begin
      end.
    7. Compile the program by selecting Script->Compile. After a couple of seconds you should see the output:
      Code:
      Compiled successfully in XXXX ms.
    8. 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!
    Last edited by StickToTheScript; 07-20-2023 at 06:51 PM. Reason: Updated links

  2. #2
    Join Date
    Feb 2012
    Location
    Canada
    Posts
    1,164
    Mentioned
    26 Post(s)
    Quoted
    433 Post(s)

    Default

    Part 2: Simba & Runescape 3 (OUTDATED)

    Note: SRL for RS3 is not currently functional and needs to be updated. Once a functioning version is released, this post will be updated.
    Last edited by StickToTheScript; 11-03-2021 at 06:19 PM. Reason: Updated - Nov 3, 2021

  3. #3
    Join Date
    Feb 2012
    Location
    Canada
    Posts
    1,164
    Mentioned
    26 Post(s)
    Quoted
    433 Post(s)

    Default

    Part 3: Questions & Help

    This post is about what to do if you have any questions or need help.


    Places To Get Help


    There are multiple places to get help from other members of the forums. You can:


    Start Programming


    Visit the Help & Tutorials section if you are ready to try writting your first script! You will find lots of help and tutorials for Runescape 3, Old School Runescape, other programming languages, and more!

    Here are a couple of generic scripting tutorials that I would recommend you check out:


    Once you have completed your first script and you would like some feedback, feel free to post them to the First Scripts Section. Otherwise, you can freely post them in the Runescape 3 Public Scripts Section or the Old School Runescape Public Scripts Section.


    Simba Documentation


    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:
      Example of Folders



      Credit: @slacky
    • 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

      Quote Originally Posted by slacky View Post
      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.
    Last edited by StickToTheScript; 09-07-2018 at 03:21 AM. Reason: Updated FAQ

  4. #4
    Join Date
    May 2012
    Location
    Glorious Nippon
    Posts
    1,011
    Mentioned
    50 Post(s)
    Quoted
    505 Post(s)

    Default

    Wow, this is awesome! Thanks for putting all of this together. It must have been a lot of work.

    One thing I noticed:
    Download and install Simba from here.
    Download the newest Simba update from here and replace the Simba.exe file in your installation folder.
    You probably shouldn't replace the official version of Simba. There's no reason not to keep both around (for now).

  5. #5
    Join Date
    Feb 2012
    Location
    Canada
    Posts
    1,164
    Mentioned
    26 Post(s)
    Quoted
    433 Post(s)

    Default

    Quote Originally Posted by Citrus View Post
    Wow, this is awesome! Thanks for putting all of this together. It must have been a lot of work.

    One thing I noticed:

    You probably shouldn't replace the official version of Simba. There's no reason not to keep both around (for now).
    Ha ha! Thanks! I completely agree. I accidentally wrote replace instead of place. All fixed.
    Last edited by StickToTheScript; 04-22-2018 at 10:00 AM.

  6. #6
    Join Date
    Dec 2011
    Location
    East Coast, USA
    Posts
    4,231
    Mentioned
    112 Post(s)
    Quoted
    1869 Post(s)

    Default

    Very nice tutorial, something the forum desperately needed. Thank you!
    GitLab projects | Simba 1.4 | Find me on IRC or Discord | ScapeRune scripts | Come play bot ScapeRune!

    <BenLand100> we're just in the transitional phase where society reclassifies guns as Badâ„¢ before everyone gets laser pistols

  7. #7
    Join Date
    Aug 2007
    Posts
    539
    Mentioned
    20 Post(s)
    Quoted
    266 Post(s)

    Default

    Great work! Nice to see this on the front page as well!
    Discord: Guy#1693

  8. #8
    Join Date
    Apr 2018
    Posts
    1
    Mentioned
    0 Post(s)
    Quoted
    0 Post(s)

    Default

    good post

  9. #9
    Join Date
    Jul 2017
    Posts
    30
    Mentioned
    0 Post(s)
    Quoted
    15 Post(s)

    Default

    SRL Updater: Local Version - "1" | Remote Version = "1403"
    SRL Updater: Update File - "http://wizzup.org/static/srl/srl-6.tar.bz2"
    SRL Updater: Downloading...
    SRL Updater: Decompressing...

    5 Minutes later.
    You'll have to manually update the SRL.
    Last edited by Grendal; 04-29-2018 at 05:33 AM.

  10. #10
    Join Date
    Feb 2012
    Location
    Norway
    Posts
    995
    Mentioned
    145 Post(s)
    Quoted
    596 Post(s)

    Default

    Quote Originally Posted by Grendal View Post
    SRL Updater: Local Version - "1" | Remote Version = "1403"
    SRL Updater: Update File - "http://wizzup.org/static/srl/srl-6.tar.bz2"
    SRL Updater: Downloading...
    SRL Updater: Decompressing...

    5 Minutes later.
    You'll have to manually update the SRL.
    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.
    Last edited by slacky; 04-29-2018 at 07:37 PM.
    !No priv. messages please

  11. #11
    Join Date
    Apr 2018
    Posts
    5
    Mentioned
    1 Post(s)
    Quoted
    4 Post(s)

    Default

    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?

  12. #12
    Join Date
    Feb 2012
    Location
    Canada
    Posts
    1,164
    Mentioned
    26 Post(s)
    Quoted
    433 Post(s)

    Default

    Quote Originally Posted by doodle3 View Post
    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.

  13. #13
    Join Date
    Feb 2012
    Location
    Norway
    Posts
    995
    Mentioned
    145 Post(s)
    Quoted
    596 Post(s)

    Default

    Quote Originally Posted by StickToTheScript View Post
    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.
    for runtime hints about errors that occur:
    > srl.Setup();
    instead of
    > srl.Setup([]);

    @doodle3 ^
    !No priv. messages please

  14. #14
    Join Date
    Apr 2018
    Posts
    5
    Mentioned
    1 Post(s)
    Quoted
    4 Post(s)

    Default

    So with srl.Setup() I get the following time out error

    Code:
    Compiled successfully in 2703 ms.
    Setting up
    [00:00:00]: Setting up SRL for OSR
    [00:00:00]: Waiting for client to load...
    [00:00:00]: Smart.Init()
    [00:00:00]: -Smart.PairToExisting()
    [00:00:00]: --Free clients: [3832]
    [00:00:00]: --Succesfully paired to existing client; SMART[3832]
    [00:00:00]: -Smart.PairToExisting(): Result = True
    [00:00:00]: Smart.Init(): Result = True
    [00:03:00]:[FATAL]: Timed out waiting for client. Make sure OSRS is setup correctly
    [00:03:00]: Freeing SMART[3832]
    Successfully executed.
    Seems as though isClientReady isn't returning true

  15. #15
    Join Date
    Feb 2012
    Location
    Canada
    Posts
    1,164
    Mentioned
    26 Post(s)
    Quoted
    433 Post(s)

    Default

    Quote Originally Posted by doodle3 View Post
    So with srl.Setup() I get the following time out error

    Code:
    Compiled successfully in 2703 ms.
    Setting up
    [00:00:00]: Setting up SRL for OSR
    [00:00:00]: Waiting for client to load...
    [00:00:00]: Smart.Init()
    [00:00:00]: -Smart.PairToExisting()
    [00:00:00]: --Free clients: [3832]
    [00:00:00]: --Succesfully paired to existing client; SMART[3832]
    [00:00:00]: -Smart.PairToExisting(): Result = True
    [00:00:00]: Smart.Init(): Result = True
    [00:03:00]:[FATAL]: Timed out waiting for client. Make sure OSRS is setup correctly
    [00:03:00]: Freeing SMART[3832]
    Successfully executed.
    Seems as though isClientReady isn't returning true
    Thought so. This should be able to be fixed by click and dragging the cross-hairs in simba to the SMART window:


    And in the output, you should get:
    Code:
    New window: XXXXXX

    Then try running the program again and it should work for you.

  16. #16
    Join Date
    Apr 2018
    Posts
    5
    Mentioned
    1 Post(s)
    Quoted
    4 Post(s)

    Default

    Ahh that looked promising but it still doesn't seem to be able to detect the login screen

    Code:
    [00:00:00]: Setting up SRL for OSR
    [00:00:00]: Waiting for client to load...
    [00:00:00]: Smart.Init()
    [00:00:00]: -Smart.PairToExisting()
    [00:00:00]: --Free clients: [11480]
    [00:00:00]: --Succesfully paired to existing client; SMART[11480]
    [00:00:00]: -Smart.PairToExisting(): Result = True
    [00:00:00]: Smart.Init(): Result = True
    New window: 4917400
    [00:03:00]:[FATAL]: Timed out waiting for client. Make sure OSRS is setup correctly
    [00:03:00]: Freeing SMART[11480]
    Successfully executed.
    After more digging it seems to be the procedure LoginScreen.IsOpen never returns true

  17. #17
    Join Date
    Feb 2012
    Location
    Norway
    Posts
    995
    Mentioned
    145 Post(s)
    Quoted
    596 Post(s)

    Default

    Quote Originally Posted by doodle3 View Post
    Ahh that looked promising but it still doesn't seem to be able to detect the login screen

    Code:
    [00:00:00]: Setting up SRL for OSR
    [00:00:00]: Waiting for client to load...
    [00:00:00]: Smart.Init()
    [00:00:00]: -Smart.PairToExisting()
    [00:00:00]: --Free clients: [11480]
    [00:00:00]: --Succesfully paired to existing client; SMART[11480]
    [00:00:00]: -Smart.PairToExisting(): Result = True
    [00:00:00]: Smart.Init(): Result = True
    New window: 4917400
    [00:03:00]:[FATAL]: Timed out waiting for client. Make sure OSRS is setup correctly
    [00:03:00]: Freeing SMART[11480]
    Successfully executed.
    After more digging it seems to be the procedure LoginScreen.IsOpen never returns true
    make sure you got the latest SRL release. There was a bugfix like 11 days ago that solved an issue that caused something like this error. So just make sure.
    !No priv. messages please

  18. #18
    Join Date
    Apr 2018
    Posts
    5
    Mentioned
    1 Post(s)
    Quoted
    4 Post(s)

    Default

    Quote Originally Posted by slacky View Post
    make sure you got the latest SRL release. There was a bugfix like 11 days ago that solved an issue that caused something like this error. So just make sure.
    Here's a quick video of my update/run process, I should be using the most recent SRL code

    youtube.com/watch?v=sQtkorTpgu0

    Apologies, I can't actually link it yet

  19. #19
    Join Date
    Apr 2018
    Posts
    5
    Mentioned
    1 Post(s)
    Quoted
    4 Post(s)

    Default

    Code:
    [00:00:00]: Setting up SRL for OSR
    [00:00:00]: Waiting for client to load...
    Range check error at line 197
    Execution failed.
    The following bitmaps were not freed: [0, Minimap mask]
    New error, this is after commenting out smart and using the regular oldschool client.

    This is right after logging in manually, on the welcome screen. Error occurs in FindColorsTolerance file.

  20. #20
    Join Date
    Feb 2012
    Location
    Norway
    Posts
    995
    Mentioned
    145 Post(s)
    Quoted
    596 Post(s)

    Default

    Quote Originally Posted by doodle3 View Post
    Code:
    [00:00:00]: Setting up SRL for OSR
    [00:00:00]: Waiting for client to load...
    Range check error at line 197
    Execution failed.
    The following bitmaps were not freed: [0, Minimap mask]
    New error, this is after commenting out smart and using the regular oldschool client.

    This is right after logging in manually, on the welcome screen. Error occurs in FindColorsTolerance file.
    Retarget RS with simba, and try again
    !No priv. messages please

  21. #21
    Join Date
    Jun 2007
    Location
    south park
    Posts
    1,160
    Mentioned
    0 Post(s)
    Quoted
    62 Post(s)

    Default

    Error: File "SRL/OSR.simba" not found at line 3

    when i try to compile script, i have downloaded all the files i needed to>


    My includes folder :includes.PNG

    Simba folder :
    simba.PNG
    Last edited by randy marsh; 05-07-2018 at 05:43 PM.
    http://www.youtube.com/user/YoHoJoSRL
    Good scripting guides on youtube
    Formerly known as (djcheater)

  22. #22
    Join Date
    Dec 2011
    Posts
    2,147
    Mentioned
    221 Post(s)
    Quoted
    1068 Post(s)

    Default

    Quote Originally Posted by randy marsh View Post
    Error: File "SRL/OSR.simba" not found at line 3

    when i try to compile script, i have downloaded all the files i needed to>


    My includes folder :includes.PNG

    Simba folder :
    simba.PNG
    Your include setup is wrong - you need to put the contents of the extracted zips into \Includes\ so it ends up being \Includes\srl\osr.simba, without the extra SRL-1.03 directory in between.

  23. #23
    Join Date
    Jun 2007
    Location
    south park
    Posts
    1,160
    Mentioned
    0 Post(s)
    Quoted
    62 Post(s)

    Default

    Quote Originally Posted by Clarity View Post
    Your include setup is wrong - you need to put the contents of the extracted zips into \Includes\ so it ends up being \Includes\srl\osr.simba, without the extra SRL-1.03 directory in between.

    Arghhh im so confused sorry I never used simba before just used to use srl way back in the day.
    Do you have a screenshot of correct folder layout?

    I did put the extracted zips in to \Includes\
    Last edited by randy marsh; 05-07-2018 at 08:29 PM.
    http://www.youtube.com/user/YoHoJoSRL
    Good scripting guides on youtube
    Formerly known as (djcheater)

  24. #24
    Join Date
    Feb 2012
    Location
    Norway
    Posts
    995
    Mentioned
    145 Post(s)
    Quoted
    596 Post(s)

    Default

    Quote Originally Posted by randy marsh View Post
    Arghhh im so confused sorry I never used simba before just used to use srl way back in the day.
    Do you have a screenshot of correct folder layout?

    I did put the extracted zips in to \Includes\

    The contents may differ slightly, but should by quite similar, like the .gitattr file is irrelevant.

    Here is my a little tutorial for setting up SRL and RSWalker, it contains some extra steps (that are implied in this tutorial) that may clarify shit for you:
    https://villavu.com/forum/showthread.php?t=118211
    Last edited by slacky; 05-07-2018 at 09:12 PM.
    !No priv. messages please

  25. #25
    Join Date
    Jun 2007
    Location
    south park
    Posts
    1,160
    Mentioned
    0 Post(s)
    Quoted
    62 Post(s)

    Default

    Ty so much!!!!!!!!!!!!!!!!
    Now i got set up aerolib
    http://www.youtube.com/user/YoHoJoSRL
    Good scripting guides on youtube
    Formerly known as (djcheater)

Page 1 of 5 123 ... LastLast

Thread Information

Users Browsing this Thread

There are currently 3 users browsing this thread. (0 members and 3 guests)

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •