SikuliX2 (version 2.0.x)

latest useable version is 1.1.1

---

**Version 2.0.0 under developement**
[](https://travis-ci.org/RaiMan/SikuliX2)

Translation project: [Transifex::SikuliX2](https://www.transifex.com/sikulix/sikulix2/dashboard/)

Documentation project: [ReadTheDocs::SikuliX2](http://sikulix2.readthedocs.org/) based on [GitHub::SikuliX2-Docs](https://github.com/RaiMan/SikuliX2-Docs)

---

**Forking and/or downloading this repo only makes sense:**

• if you want to get a knowledge about the internals of Sikuli
• if you want to create your own packages containing Sikuli features
• if you want to contribute.

---

BE AWARE The use for scripting and Java programming is only possible after the first nightly builds are available. Currently you might fork the project and make your tests in the project context. Issues and pull requests are only accepted here on Github.

---

Maven module structure for developement

sikulixapi

the API to be used in Java and Java aware scripting languages

• the new features will be in com.sikulix.core and com.sikulix.api
• the official API in org.sikuli.script will be kept for backwards compatibility, but rerouted to com.sikulix.api as needed
• new projects using Java should use the API as provided by com.sikulix.api

sikulixcoretest

basic tests for developement of the new packages com.sikulix.core and com.sikulix.api

sikulixapitest

(inactive) basic tests for org.sikuli.script as regression test (will later be a seperate package)

sikulix

the SikuliX IDE (internally using jEdit 5.3.0)

• full featured multi-purpose editor
• SikuliX image handling added via jEdit plugin
• run scripts (scripting supported internally: JavaScript, (J)Python, (J)Ruby, RobotFramework)
• everyone may simply add whatever feature needed based on the possibilities of jEdit

For tests in the project context the jEdit package has to be downloaded from here, unzipped into the folder SikulixAppData/SX2/Extension, so you finally have a folder SikulixAppData/SX2/Extension/SXEditor.

---

Prerequisites for development and testing

• a Java JDK 1.7+
• Maven 3+
• only 64-Bit Systems supported

For developement I use the JetBrains IDEs

• IntelliJ IDEA CE for Java and everything else
• PyCharm CE for special Jython/Python stuff
• RubyMine for special JRuby/Ruby stuff (special license for OpenSource projects)

Be aware for development and testing

• the so called folder SikulixAppData, where SikuliX specific stuff is stored once per machine, for SikuliX2 now is SikulixAppData/SX2 to allow the parallel usage of SikuliX1 and SikuliX2 on the same machine.