Prepare Scripting Folder

Navigation:  Toolboxes > Scripting Toolbox >

Prepare Scripting Folder

Previous pageReturn to chapter overviewNext page

20-sim comes with a Scripting Folder that contains documentation of all scripting functions, the function library and example scripts. You have to install this folder to use scripting.

Installation

1.Open the Install Scripting program from the Windows Start menu (located under 20-sim 4.6)
- or -
Go to the folder where 20-sim is installed (e.g. C:\Program Files\20-sim 4.6\Scripting or C:\Program Files (x86)\20-sim 4.6\Scripting)  and open 20simScripting.exe
2.This will open a dialog where you can choose where to extract the 20-sim scripting files. Change the path to a local working folder of your choice (for example: C:\Users\yourusername\Documents\20simscripting)

20simScriptingExtractor

20-sim Scripts extraction

Note: To write/modify scripts, the scripting folder should be accessible and writable by the user. Do not install the scripting folder on C:\Program Files (x86) or C:\Program Files.

 

For the remainder of this chapter, we use the name scripting working folder when we refer to the folder where you just extracted the 20-sim scripting files.

Contents

Your newly created scripting working folder contains a number of subfolders:

1.documentation: This folder contains the scripting API documentation: a list of supported functions and their syntax. You can browse the documentation by opening the index.html file in your web browser.
 
Note: the API documentation is also accessible from the Windows Start menu under 20-sim 4.6\Scripting API documentation
2.library: This folder contains the core scripting functions.
3.tutorials: This folder contains basis scripts with a step by step explanation. You can use these scripts as a base for your own scripts.
4.examples: This folder contains some more advanced scripts.