Skip to main content
Version: Latest

Configuration Note

Framework Configuration​

Brobot uses Spring Boot's configuration system. All framework settings should be configured through:

  • application.yml (recommended)
  • application.properties
  • Environment variables

Access configuration in your code via dependency injection with BrobotProperties.

Example Configuration​

Using application.yml:​

brobot:
  mock: true                # Enable mock mode for testing
  core:
    image-path: images/     # Path to image resources
  screenshot:
    save-history: true      # Save action history
    save-snapshots: true    # Save screenshots
    path: screenshots/      # Screenshot directory
    history-path: history/  # History directory
  mouse:
    move-delay: 0.5         # Mouse movement delay
    pause-before-down: 0.0  # Pause before mouse down

Using application.properties:​

# Mock mode
brobot.mock=true

# Core settings
brobot.core.image-path=images/

# Screenshot settings
brobot.screenshot.save-history=true
brobot.screenshot.save-snapshots=true
brobot.screenshot.path=screenshots/
brobot.screenshot.history-path=history/

# Mouse settings
brobot.mouse.move-delay=0.5
brobot.mouse.pause-before-down=0.0

Default Values​

Default configuration values are provided in brobot-defaults.properties within the Brobot library. Your application configuration will override these defaults.

Mock Mode Screenshots​

When using mock mode with predefined screenshots:

  1. Configure mock mode in your properties file
  2. Place screenshot files in the configured screenshot directory
  3. The framework will use these files instead of capturing from the screen

For a complete list of available configuration properties, see the BrobotProperties class in the source code or refer to the brobot-defaults.properties file in the Brobot library.