Basic information and quick start

Global options — setup and usage Added in 1.1.0

SikuliX now has a basic implementation of a global options repository, that is recognized and loaded at startup time (IDE and API usage). At runtime, this options store can be accessed to get and set values. Persistence (save) and merge of additional options files is not yet supported.

Since internally the options are stored in a Java Properties object as key-value-pairs in string representation, the options file must conform to the applicable rules).

Where SikuliX looks for SikulixOptions.txt

At startup these locations are searched in order — first appearance wins:

• Directoryworking folder/ ← checked first

  • SikulixOptions.txt
• Directoryuser’s home folder/

  • SikulixOptions.txt
• DirectorySikulixStore/ (inside the Sikulix repository)

  • SikulixOptions.txt

Settings class overrides

Options defined in the Settings class behave specially — see Controlling Sikuli Scripts and their Behavior.

Any Settings.option = value declaration in the options file will overwrite the existing option value in the Settings class at startup.

Other options recognised at startup

Debug.level = n

Preferably n as 3. Debug information is produced from the very beginning of startup.

Settings.OverwriteImages = yes

When saving images in the IDE with a name that already exists, files are normally renamed with a -n suffix. With this option on (default: off), naming images with an existing name will replace the file without notice.

classpath = list of absolute-paths

Appends the given paths to the end of the classpath in sequence. Same rules as Java classpath on that system — on Windows, backslashes must be doubled (escaped).

Up to 1.1.3 only

Successor in 2.0.0

Since version 1.1.4 and 2.0.0+, see the Extensions feature, which supersedes this mechanism.

Run only parts of a script Added in 2.0.0

Note

Until noted, this feature is only available for Jython scripting.

By right-clicking on a line number the pop-up context menu lets you:

Run this line

Run only the line at this line number.

Run from top

Run the script from the beginning up to and including this line.

Run to bottom

Run the script from this line to the end.

Run selection

Run the snippet in the current selection — or this line if nothing is selected.

The Run menu now contains the entry Run selection (Shift+Ctrl/Cmd+R), which also runs the current selection — or the line at the caret if nothing is selected. The advantage is the available shortcut, which saves additional mouse actions.

Jython gotcha

If the first line of a selection has an indent, if True: is added as first line to make the snippet runnable.

This feature might be a neat replacement for the no-longer-available interactive mode from the commandline.

Plain Python scripts — open, edit, save and run Added in 2.0.0

Work in progress

See the related request bug for status and discussion.

It is now possible to work with plain Python files in the IDE, which allows direct support of the classic Python style of scripts and folder structures (modules).

• Open and save .py files
• Image handling in the .py context
• Running .py files

Text files — open, edit and save Added in 2.0.0

Work in progress

Special Sikulix text files

• SikulixOptions.txt — global runtime options
• extensions.txt — extension manifest
• sites.txt — image search path roots

Where to next?

Controlling Sikuli Scripts and their Behavior Configure script behavior via Settings, Debug, and runtime options.

Extensions feature The 2.0.0 successor mechanism for plugging in new IDE capabilities.

Image Search Path Where SikuliX looks for image files when your scripts run.