Skip to main content

Setup

Start a new Spring Boot Project​

A Spring Boot project can be created with the Spring Initializr or directly in Intellij or Spring Tools 4, which works with Eclipse, Visual Studio Code, and Atom IDE.

Add the Brobot Library​

Version 1.0.3 or higher is needed.

Maven:

    <dependency>
      <groupId>io.github.jspinak</groupId>
      <artifactId>brobot</artifactId>
      <version>1.0.3</version>
    </dependency>

Gradle:

    implementation 'io.github.jspinak:brobot:1.0.3'

Some tips:

  • Note that Brobot works with Java version 14 or lower.
  • Don't forget to add JavaPoet as a dependency. JavaPoet writes the files in your State Structure.
  • The latest version of Brobot, which you would need to find images based on color, compare histograms, perform image segmentation and classification, detect motion, and other advanced features, requires that you have an installation of OpenCV. If you are working on a Windows machine, happy days! OpenCV is already installed for you. If you are on a Mac or Linux machine, you will need to install OpenCV. OpenCV is notoriously difficult to install. If you have problems with the installation or don't need the more advanced features of Brobot, you can use Brobot version 1.0.3.

If you are using gradle, the full build.gradle file should look similar to this:

    plugins {
        id 'org.springframework.boot' version '2.6.2'
        id 'io.spring.dependency-management' version '1.0.11.RELEASE'
        id 'java'
    }
    
    group = 'com.example'
    version = '0.0.1-SNAPSHOT'
    sourceCompatibility = '14'
    
    configurations {
        compileOnly {
            extendsFrom annotationProcessor
        }
    }
    
    repositories {
        mavenCentral()
    }
    
    dependencies {
        implementation 'org.springframework.boot:spring-boot-starter'
        compileOnly 'org.projectlombok:lombok'
        annotationProcessor 'org.projectlombok:lombok'
        testImplementation 'org.springframework.boot:spring-boot-starter-test'
        implementation 'io.github.jspinak:brobot:1.0.3'
        implementation('com.sikulix:sikulixapi:2.0.5') {
            exclude group: 'org.slf4j', module: 'slf4j-nop'
        }
        implementation group: 'com.squareup', name: 'javapoet', version: '1.9.0'
    }

Create Folders for Images​

  • Create a folder called images to hold the images used by your Brobot application to manipulate GUI elements.
  • Create a folder called screenshots to store screenshots captured by your Brobot application while you manipulate the target environment manually.

The folder structure should look like this (the build folder will be created automatically if using Gradle):

project structure