Sikuli Documentation¶ interesting project

Sikuli Documentation — Sikuli X 1.0 documentation

Sikuli Documentation¶

Getting Help

Looking for specific information?

• Try the Table of Contents
• Look through the Index
• Use the Search Page

See other people’s questions
or ask a question yourself.

If you think you’ve found bugs, search or report bugs in
our bug tracker.

This document is being maintained by the Sikuli Doc Team.

If you have any questions or ideas about this document,
you are welcome to contact us.

For questions regarding the
functions and features of Sikuli itself please use the Sikuli Questions and
Answers Board.

For hints and links of
how to get more information and help, please see the sidebar.

How to use this document¶

Sikuli Script is built as a Jython (Python for the Java platform)
library. You can use any syntax of the Python language. If you are new to
programming, you can still enjoy using Sikuli to automate simple repetitive
tasks without learning Python. A good start might be to have a look at the tutorials.

However, if you would like to write more powerful and
complex scripts, which might even be structured in modules, you have to dive into the Python Language.

The preface of each chapter in this documentaton briefly describes
a class or a group of methods. It
provides general usage information and hints that apply to all methods in
that chapter. We recommend to read it through before using the related features.

If you are totally new with Sikuli, it might be a good idea to just read
through this documentation sequentially. An alternative way might be to jump to the
chapters that you are interested in by scanning the table of contents.
A way in the middle would be reading the core classes:
Region, then Match, and finally Screen.

For the users of the previous versions (0.9.x and 0.10.x)
What’s new in Sikuli X is a good start.
After that, you can go to any
places of interest using the table of contents or
use the Index to browse all classes,
methods and functions in alphabetical order.

Getting Started¶

Tutorials¶

• 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

• Slide: Practical Sikuli: using screenshots for GUI automation and testing.

FAQ¶

• Can I do X or Y or Z in Sikuli?
• How to run Sikuli from Command Line
• How to create Unit Testing Scripts for GUI
• How to use Sikuli Script in your JAVA programs
• How to use Sikuli together with other IDE’s
• Sikuli is too slow or not robust. What can I do?

• Read more FAQs on Launchpad

Complete Guide to Sikuli Script¶

• What is new in Sikuli X
• Everything about Sikuli Script
  • Global Functions and Features
    • Importing other Sikuli Scripts (reuse code and images)
    • Controlling Sikuli Scripts and their Behavior
    • Controlling Applications and their Windows
    • Interacting with the User
    • Listening to Global Hotkeys
    • General Settings and Access to Environment Information
    • Advanced Settings for Tuning Vision Algorithm
  • Region
    • Creating a Region, Setting and Getting Attributes
    • Extending a Region
    • Finding inside a Region and Waiting for a Visual Event
    • 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: )
    • Special Methods for Developers
  • Screen
    • Screen: Setting, Getting Attributes and Information
    • Screen as (Default) Region
    • Capturing
    • Multi-Monitor Environments
  • Location
  • Match
    • Creating a Match, Getting Attributes
    • Iterating over Matches after findAll()
  • Pattern
  • Finder
  • Key Constants
    • Special Keys
    • Key Modifiers
• Sikuli Best Practice
  

Extensions¶

• Extensions
  • General Information About Sikuli Extensions
  • Sikuli Guide
  • Sikuli Copier
  • Sikuli Hotkey

For Hackers and Developers¶

• How Sikuli Works
  • Sikuli Script
  • The Structure of a Sikuli source/executable script (.sikuli, .skl)
  • Sikuli IDE
• How to get involved
  • Submit Patches
  • Internationalization and localization
• Changes in Sikuli
  • X 1.0 rc1 (2010-12-23)
  • 0.10.2 (2010-08-07)
  • 0.10.1 (2010-05-23)
  • 0.10 (2010-05-03)
  • 0.9.9 (2010-02-23)
  • 0.9.8 (2010-02-01)
  • 0.9.7 (2010-01-27)