Table of Contents

SikuliX - how does it work and system specific information

• SikuliX - the basics
  • SikuliX allows one to automate visual workflows
  • SikuliX can be used for visual testing
  • SikuliX - how does it find images on the screen?
  • SikuliX - handling of images
• SikuliX - system specifics
  • Some general aspects
  • SikuliX on Windows
  • SikuliX on Mac
  • SikuliX on Linux

SikuliX scripting and usage in programming scenarios (preferably Java based)

• SikuliX - general aspects of scripting
  • What is a SikuliX script
  • Where and how can a SikuliX script be stored
  • How to run a SikuliX script
• 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

• Basic information and quick start
  • Global options - setup and usage
  • Run only parts of a script
  • Plain Python scripts - open, edit, save and run
  • Text files - open, edit and save

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
  • PopUps and input dialogs
  • Timed (autoclosing) popups
  • Listening to Global Hotkeys
  • Starting and stopping other applications and bring them to front
• General Settings and Access to Environment Information
  • Store some of your information persistently and reload it later
  • Using SikuliX’s preferences store for your own key-value pairs (deprecated version)
  • Using SikuliX’s preferences store for your own key-value pairs (new version)
  • Get Information about the runtime environment
• 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
  • Screen: Setting, Getting Attributes and Information
  • Screen as (Default) Region
  • Capturing - taking screenshots - create images
  • Multi-Monitor Environments
  • Connecting to a VNC Server (VNCScreen)
  • Connecting to an Android device or emulator (ADBScreen)
• Pattern
• Match
  • Creating a Match, Getting Attributes
  • Iterating over Matches after findAll()
• Finder
• Key Constants
  • Special Keys
  • Key Modifiers (modifier keys)
• The Application Class (App)
  • Using class or instance methods
  • Dealing with Application windows
  • General aspects, hints and tipps
  • Some technical information on the implementation
• Working with text and using OCR features
  • OCR Summary
  • Accuracy of text recognition (confidence)
  • Handling OCR options
  • OCR engine mode (OEM)
  • OCR page segmentation mode(PSM)
  • Switch to another language
  • Have your own Tesseract datapath
  • Other possibilities to tweak the Tesseract OCR process
  • The Text and OCR features in Detail (Class OCR)

Miscellanous

• Can I do X or Y or Z in SikuliX?
  • Can I write a loop in SikuliX?
  • Can I create a GUI in SikuliX?
  • Can I connect to MySQL/MS SQL/PostgreSQL or any database systems in SikuliX?
  • Can I read/write files 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
  • 1. Include sikulixapi.jar in the CLASSPATH of your Java project.
  • 2. Import the Sikuli classes you need
  • 3. Write code!
  • A comment on projects using Maven
  • Other valuable information
  • How to use images stored in jar files
• Extensions
  • General Information About Sikuli Extensions
  • Sikuli Guide

Tutorials

• Hello World (Mac)
• Hello World (Windows)
• Goodbye Trash (Mac)
• Uncheck All Checkboxes
• Check the Right Checkbox
• Working with Sliders
• Desktop Surveillance
• Resizing a Window
• Working with masked images (ignoring parts of the image) # 1.1.4

For Developers

• How Sikuli Works
  • Sikuli Script
  • The Structure of a Sikuli source folder or zipped file (.sikuli, .skl)
• How to get involved
  • Submit Patches
  • Documentation, internationalization and localization