SRL Archive - Forum Guides

[anchor="top"]

Foreword:

Hello, and welcome to the guide. I hope that this thread helps you get to know Simba. If I miss anything, please reply to the thread! Enjoy.

Table of Contents

1. [jumpto="intro"]Introduction[/jumpto]
2. [jumpto="home"]Project Simba Home Page[/jumpto]
3. [jumpto="program"]Program Simba;[/jumpto]
4. [jumpto="buttons"]Buttons[/jumpto]
5. [jumpto="tips"]Tips[/jumpto]
6. [jumpto="author"]Author's Notes[/jumpto]

[anchor="intro"]Introduction[/anchor]

Hey guys, the aim for this guide is to help you utilise the features that Simba enables you to use!

[anchor="home"]Project Simba[/anchor]

"Project Simba". The platform of SRL. Simba provides numerous features to help you code with ease! You can view the Simba Home Page here: http://wizzup.org/simba/.


On this page, you can view the important information regarding Simba like:

• What is Simba?
• Download Links
• Documentation
• Source Code

The Project Simba website also provides inquisitive tutorials, which can be found with the documentation.

[anchor="program"]Program Simba;[/anchor]

This is what you have all come for. The actual program, Simba! Before we begin, you must install and setup Simba and SRL correctly. I recommend following this guide (also provides help if you have issues). Let's begin.

Open up Simba and you should see this:


Let's go through the dropdown menus at the top.

File:

• New (CTRL + N) - Creates a blank .simba file.
• Open (CTRL + O) - Opens any .simba file.
• Open Recent - Provides a list of the recently opened .simba files for easy access.
• Save (CTRL + S) - Saves your file to a location of your choice, or quick saves if you have already saved.
• Save as… - Saves your file to a location of your choice.
• Save as Default - Saves your current code as the default code to be displayed when you create a new file.
• Save All (SHIFT + CTRL + S) - Saves all tabs open.
• New Tab (CTRL + T) - Creates a new tab.
• Close Tab (CTRL + W) - Closes current tab.
• Close All Tabs - Closes all tabs.
• Exit (CTRL + Q) - Exits Simba.

Edit:

• Undo (CTRL + Z) - Undoes your last code change.
• Redo (CTRL + Y) - Redoes your last code change.
• Cut (CTRL + X)- Cuts (removes) selected code.
• Copy (CTRL + C) - Copies (keeps) selected code.
• Paste (CTRL + P) - Pastes code that has been cut/copied.
• Delete (DEL) - Deletes selected code.
• Select All (CTRL + A) - Selects all code in your current file.
• Find (CTRL + F) - Type a string and it will highlight it in your current file. Will display red if none found.
• Find Next (F3) - Goes to next string found after entered in the find box.
• Replace (CTRL + R) - Replaces entered code with code of your choosing.
• Goto Line (CTRL + G) - Goes to line of your choosing.

Script:

• Run (F9) - Executes code.
• Compile (CTRL + F9) - Compiles code and displays results in the debug box.
• Pause - Pauses script.
• Stop (F2) - Stops script.
• Interpreter (PascalScript/Lape) - Choose the way you want your code to be interpreted. More about Lape: http://villavu.com/forum/forumdisplay.php?f=479.

View:

• Colour History - Displays recently picked colours from the built-in colour picker (See: [jumpto="buttons"]Buttons[/jumpto])
• Debug Image - ?
• Function List - Shows or hides the list of SRL functions on the left hand side (See: [jumpto="function"]Function List[/jumpto])
• Extensions - Shows your currently enabled extensions. Allows you to disable and enable any of them.
• Extensions Menu - Allows the "Extensions" dropdown menu to be seen.
• SRL Menu - Allows the "SRL" dropdown menu to be seen.
• SPS Menu - Allows the "SPS" dropdown menu to be seen.
• MSI Menu - Allows the "MSI" dropdown menu to be seen.

Tools:

• Fill Function List (CTRL + D) - Fills the function list to the left of the screen with the functions defined in your code.
• Update - Check for an update to Simba. Also allows you to force update.
• Settings (Expert) - Advanced Simba settings.
• Settings - General Simba settings.
• DTM Editor (Must enable the 'dtm_editor.sex' extension for it to appear) - Allows you to create a DTM for an object. I recommend looking at this guide for DTM's: http://villavu.com/forum/showthread.php?t=68018.
• Bitmap Conversion - Allows you to convert a Bitmap (.bmp) file to string for use with Pascal.
• Associate File Extensions - Allows you to associate various file extensions with Simba.
• Export Script as HTML - Exports script as HTML.
• Security (Must enable the 'security.sex' extension) - Allows you to choose settings for your security.

Help:

• About - Displays information about Simba.
• Handbook - Directs you to http://docs.villavu.com/simba/.
• Report a Bug - Directs you to http://bugs.villavu.com/mantis/bug_report_page.php.

Extensions:

• Update - Updates your Extensions.
• Check for Update - Checks for updates to Extensions.
• Automatically - Lets you decide whether to automatically update and check for updates.
• Settings - Allows you to choose to override the update and set a timer interval.

SRL:

• Update - Updates your SRL.
• Check for Update - Checks for updates to SRL.
• Automatically - Lets you decide whether to automatically update and check for updates.
• Settings - Allows you to choose to override the update and set a timer interval.

SPS:

• Update - Updates your SPS.
• Check for Update - Checks for updates to SPS.
• Automatically - Lets you decide whether to automatically update and check for updates.
• Settings - Allows you to choose to override the update and set a timer interval.

MSI: (Currently not available)

• Run - Runs MSI.
• Open - Opens the RunMe.simba file.
• Update - Updates your SRL.
• Check for Update - Checks for updates to SRL.
• Automatically - Lets you decide whether to automatically update and check for updates.
• Settings - Allows you to choose to override the update and set a timer interval.

ODTM: (Must have enabled the 'ObjectDTM.sex' extension.)

• Generation Tool - Opens the Object DTM Generation Tool file.
• Update - Updates your ODTM.
• Check for Update - Checks for updates to ODTM.
• Automatically - Lets you decide whether to automatically update and check for updates.
• Settings - Allows you to choose to override the update and set a timer interval.

[anchor="buttons"]Buttons[/anchor]

Kind of like a navigation bar for Simba. An array of buttons for ease of access to heavily used features of Simba. This is what it looks like:


From left to right, it goes (See [jumpto="program"]Program Simba;[/jumpto] Program Simba; for shortcut keys):

• New
• Open
• Save
• Save All
• Cut
• Copy
• Paste
• Play
• Pause
• Stop
• Add Tab
• Close Tab
• Clear Debug
• Pick Colour
• Select Client
• Reload Plugins
• Minimize to Tray
• Show/hide Console

These provide ease-of-access to the respective feature.

[anchor="function"]Function List[/anchor]

The function list allows you to view procedures and function that you've defined in your code and it places them in this list. You can double-click on any of them to jump straight to it.You can also view all of the code that is in the SRL Include, by this I mean all code available for use (OpenBank, WaitUpText, etc). Here is what it will look like upon opening a new file:


But, once you've actually added code to your file, it'll start looking like this:


*hope you don't mind @Flight, let me know if you want it changed*

Also in this area of the interface, there is a nice little search bar that you can use to find certain procedures and functions from the SRL Include. Just replace OpenBank with whatever you'd like. ;)


Double clicking any of them will open up the .simba file associated with it and jump to that procedure/function.


The Function List is one of your best friends while coding in Simba, so use it. ;)

[anchor="tips"]Tips[/anchor]

In this section I'll be outlining a few tips that you can utilise to make your time easier in Simba.

The CTRL + Space Feature (didn't know what to call this)

Description: Opens a list of functions and procedures that you can use from what you've already typed.

Example: OpenBank *CTRL + Space*


Uses: You can use this for basically anything you're doing in Simba. It will speed up your coding and will help you find new procedures/functions that you never even knew about!

Minimising Procedures/Functions

Description: Allows you to minimise any procedure or function you want in your code.

Example: Click the - next to begin, or procedure.


Should turn out like this:


Uses: This is extremely useful for large amounts of code to make it easier to access the code above/below it.

Post more in replies to the thread please. :)

[anchor="author"]Author's Note[/anchor]

Well, there's another guide done. Must be sick of me by now, surely! If there's any grammatical mistakes or things you'd like to be added/changed then please, let me know! Hope you enjoyed.

[jumpto="top"]Back to Top![/jumpto]

-Chris!

Wow, another fantastic guide! Will help out the newcomers for sure!

I didn't know about the replace tool, thanks :D

No problem. ;) Thanks.

Wonderful guide; neatly laid out, easy to read, explained in detail and plenty of pictures for visual aid. This is a well-written guide mate, you did great. :)

From: Flight
Wonderful guide; neatly laid out, easy to read, explained in detail and plenty of pictures for visual aid. This is a well-written guide mate, you did great. :)

Thanks Flight. :)

Nice guide Kriz!

From: BMWxi
I didn't know about the replace tool, thanks :D

Exactly What I said ^^

Nice one noob, maybe explain more of the extensions. e.g. security as that can be quite important

From: The Killer
Exactly What I said ^^

Nice one noob, maybe explain more of the extensions. e.g. security as that can be quite important

We shall see ;). Thanks!

Very nice man, will be a big help I'm sure

From: Ashaman88
Very nice man, will be a big help I'm sure

Thank you very much Ashaman <3.

good guide, thanks

From: t4q
good guide, thanks

Thanks, t4q!