sercesh/sikulix-api

Sikuli's Java API for visual testing and automation (compatible to Sikuli X-1.0rc3-r930)

Sikuli API 1.1.0 developement branch

planned release date December 15th - betas will be available before

---

**Sikuli API 1.0.1
Service Update per August 12th, 2013**

---

**MANDATORY ;-) --->>>** [Read the Release Notes carefully to avoid problems from the beginning](https://github.com/RaiMan/SikuliX-API/wiki/Release-Notes-API)

to download setup-sikuli.jar version 1.0.1 start here

Sikuli API is targeted at people who want to develop, run and debug programs in Java, other Java based languages or Java aware scripting languages (for Jython we have Sikuli IDE ).

Same goes for people who want to develop, run and debug scripts using Sikuli IDE supported scripting languages in other IDE's like Eclipse, Netbeans,

... some quickstart info ...

The downloadable packages of Sikuli API contain everything needed to develop, test, run and debug with any suitable IDE (e.g. Eclipse, Netbeans, ...) or however you like ;-).

Hava a look at the Java docs: click to view Online or click to download as zipfile

This repo is fully Maven, so a fork of this repo can be directly used as project in NetBeans/Eclipse/... or with mvn on commandline.
A more detailed info on usage, contents and production of standalone runnable packages

It produces a lightweight sikulix-api.jar, that only contains the Sikuli Java API and is intended for use in pure Java or in Java aware scripting and testing environments while developing in IDEs using Maven (depends on and needs Sikuli Basics )

At runtime in pure Java or in Java aware scripting and testing environments as well when using standalone Jython you need the sikuli-java.jar in class path (contains Sikuli Basics).
It can be produced using
mvn -f pom_make_sikulix-java-jar.xml clean package assembly:single
having a valid Sikuli Basics in your local repo.

To run Sikuli scripts from commandline in any of the supported scripting languages you need the sikuli-script.jar (currently only Jython supported).It contains Sikuli Basics, Sikuli Jython and a complete Jython 2.5.4.
It can be produced using
mvn -f pom_make_sikuli-script-jar.xml clean package assembly:single
having the mentioned dependencies in your local repo.

If new to Sikuli, you might aternatively be interested in the pure Java implementation, which is to some extent feature compatible, but not API compatible: Sikuli Java API.

Roadmap

• 2013 September: start developement SikuliX 1.1
  
  
• 2013 December 15: release of SikuliX 1.1
• new features tbd.
  
  
• 2014: new versions in May and December

History

• this is based on the developement at MIT (Tsung-Hsiang Chang (Sean aka vgod) and Tom Yeh) which was discontinued end 2011 (https://github.com/sikuli/sikuli) with a latest version called Sikuli X-1.0r930.
• and the follow up repo, where I prepared the creation of a final version 1.0
• in April 2013 I decided, to divide Sikuli into the 2 packages Sikuli IDE and Sikuli API (this repo), to better support future contributions.

Support

• until otherwise noted: questions, requests and bugs can still be posted here
• the wiki in this repo will be used extensively to document anything (taking over this roll from the webpage and lauchpad)
• you might always post an issue with any content in this repo of course

Contribution

• pull requests are always welcome
• everyone is welcome to add interesting stuff, experiences, solutions to the wiki in this repo