Table of Contents¶
SikuliX - how does it work and system specific information¶
SikuliX scripting and usage in programming scenarios (preferably Java based)¶
- SikuliX - general aspects of scripting
- Using JavaScript
- Using Jython and Python
- Setup your own Jython environment
- Access Python packages from SikuliX scripts run by SikuliX (GUI or commandline)
- Prepare and use your own jar files in the Jython environment
- Using SikuliX with real C-based Python (version 2.7 up to 3.7 latest)
- Scripting with IntelliJ PyCharm and IDEA with Python plugin
- Using Ruby
- Using SikuliX in Java programming
- Using SikuliX in non-Java programming scenarios
- Using RobotFramework
- Experimental: SikulixServer - run scripts from anywhere with zero-delay
SikuliX IDE create/run scripts and organize your images¶
SikuliX API for scripting and Java programming¶
- /General features regarding scripting and image handling
- Controlling Sikuli Scripts and their Behavior
- Writing and redirecting log and debug messages
- File and Path handling - convenience functions
- Image Search Path - where SikuliX looks for image files
- Importing other Sikuli Scripts (reuse code and images)
- Running scripts and snippets from within other scripts and run scripts one after the other
- Interacting with the User and other Applications
- General Settings and Access to Environment Information
- Region (rectangular pixel area on a screen)
- Create a Region, Set and Get Attributes
- Get evenly sized parts of a Region (as rows, columns and cells based on a raster)
- Extend Regions and create new Regions based on existing Regions
- Finding inside a Region and Waiting for a Visual Event
- Find more than one image in a Region at the same time
- Observing Visual Events in a Region
- Acting on a Region
- Extracting Text from a Region
- Low-level Mouse and Keyboard Actions
- Exception FindFailed
- Grouping Method Calls ( with Region: )
- Location
- Screen
- Pattern
- Match
- Finder
- Key Constants
- The Application Class (App)
- Working with text and using OCR features
Miscellanous¶
- Can I do X or Y or Z in SikuliX?
- How to run SikuliX from Command Line
- Command Line Options (generally, debug output related)
- Command Line Options (special)
- Command Line Options (intention: IDE should open)
- Command Line Options (intention: run a script without opening the IDE)
- Command Line Options (intention: run the experimental scriptrun server)
- Command Line Options (intention: provide user parameters for running scripts)
- How to use SikuliX API in your JAVA programs or Java aware scripting
- Extensions