EyeStudio

EyeStudio is a visual script editor. Use EyeStudio to create and maintain scripts and images.

Editing a Script

Edit the script using a WYSIWYG-editor that contains both text and images.

Adding Commands

Use the Command List to select a command to insert into the script. Select from different collections of commands using the drop-down or search for a command using the search field.

Right-click a command and select Context Help from the menu to view detailed information, available parameters and examples of how to use the command.

Left-click a command to add it to the script at the current cursor position. You may need to specify a number of command parameters before the new command is added to the script.

A command may also be typed manually using the editor. Add parameters (like values, images or scripts) manually or by using the Script menu or toolbar buttons. Select a command and press the F1 key for context sensitive help.

Capture Images

An image can be captured or recaptured from many places in EyeStudio.

Use the mouse to press and hold the left mouse button while moving the mouse to select an area of the screen to capture. Release the left mouse button to capture the image.

Click the right mouse button to cancel the image capture.

Use the scroll wheel to zoom in or out when capturing images from the Capture Window or Remote Window. The Capture Window will appear when the screen is zoomed.

Adjust the preferred way of capturing images from the Settings/Capture Options menu.

Note than the image needs to be at least 10 pixels in width and height.

Capture Options

There are capture options in the Settings/Capture Options menu:

Hide Studio During Capture	Hide EyeStudio while capturing an image.
Use Capture Dialog	Use a dialog instead of the full screen when capturing images. This is the default option for non Windows machines.

Rename Image

Image names are automatically generated. You may rename images easily by right-clicking an image and selecting the Rename option. Renaming a file will also adjust the script automatically.

Note that renaming an image might cause other scripts to fail since EyeStudio will only modify the currently edited script.

Properties

Images can be edited using the Properties dialog. You may recapture the image, load a new image, change the target location/area or modify the image. Click on an image to open the Properties dialog.

Use the mouse to select a target location, if needed. Left-click on any position within or outside the image to select a new target location. The target location is in the center of the image by default.

You may also use the mouse to click and drag in order to select a target area. The target area is indicated by a rectangle and the target location is in the center of the target area for Move or Click commands.

Use the Select All button to select the entire image.

Use the Deselect button to remove the current selection and return the target to the center of the image.

Use the Crop button to cut out everything but the selected rectangle.

Use the Erase button to remove the content in the selected rectangle that in some cases may distract the image recognition AI. The content will be replaced with the automatically detected background color.

Comments

Add blank lines and comments to the script to make the script more readable. A commented line is italic and begins with two forward slashes “//”.

Detect Font from Image

Using texts instead of images are useful when creating data driven scripts. You need to set the correct font, using the Font command, so that texts can be translated into images.

Right-click an image and select the Detect Font from Image option to automatically detect the correct font. You need to specify the text to detect from the image. In order to improve the detection speed you will also have to specify the font style. You will be asked to insert a Font command when a possible match has been detected.

Copy Images

Managing a large set of images can be difficult. Use the Copy Images function in the Script menu to copy all images in the current script to another location. View the script with the copied set of images by using the Set Image Folder option in the Settings menu.

Copy Script

Use the Copy Script function in the Script menu to copy the currently edited script to a new location. All the images will also be copied to the “images” folder below the copied script. The script and “images” folder will be created if needed. Since the images are placed relative to the script, so that the folder can be moved easily, the following Set command is appended to the script:

Set ImageFolder “{ScriptFolder}/images”

Import Bundle

A bundle may contain scripts, images, data, widget, commands, tools or anything else required to run or edit the scripts. It is simply a zip file (with the “.eye” extension) that is unzipped in the EyeStudio root folder.

Use the File \ Import Bundle option to extract a bundle to the EyeStudio root folder. You might need to restart EyeStudio for the changes to be applied.

Export Bundle

Export all files (like scripts, images, data, widgets and commands) used in the latest script run.

Note that you need to run the entire test or test suite before exporting the bundle so that EyeStudio can detect what files to include.

Use the File \ Export Bundle option in EyeStudio to export the bundle.

A typical scenario is to develop the bundle on one machine and use another machine for running the bundle periodically or on demand.

Context Sensitive Help

Select a command and press the F1 key for context sensitive help. This will open a web page with information about the command.

Settings

Settings can be found in the Settings menu in EyeStudio. Other settings can be found under All Commands in the Command List.

File Synchronization	Check this option to enable file synchronization.
Auto Indent	Automatically insert tabs when recommended.
Set Image Folder	Sets the default image folder. The path is available from the ImageFolder parameter and is default set to “images”. Useful when designing scripts that uses two or more sets of images.
Set Root Folder	Sets the root folder for scripts, images and data. The path is available from the RootFolder parameter and is default set to the installation folder of EyeAutomate (the folder that contains the EyeAutomate.jar file). Change the root folder to store the “scripts”, “images” and “data” folders on another location.
Set Parameter	Sets a parameter in the “parameter.properties” file. A parameter stored in the “parameter.properties” file can be used in any script.