BTick Logo

Getting Started

  • Installation & Getting Started
    • Prerequisites
    • Option A: Docker Compose Deployment
      • 1. Creating the Docker Compose File
      • 3. Starting and Stopping the Container
      • First Launch
    • Option B: Native Linux Desktop Package (.deb)
      • First Launch

Concepts

  • System Architecture
    • System Overview
    • Components
    • Robot Communication Protocols
    • Internal Web Transports
      • Groot2 Connection Settings
    • Common Event Model
    • Connection States
  • Protocol Comparison
    • Capability Comparison Matrix
    • Which One Should I Use?

Application Guides

  • Monitor User Guide
    • 1. Overview
    • 2. Monitor Workspace
    • 3. Behavior Tree Display Area
      • Navigating the Display Area
      • Execution Status Colors
      • Live Status Reset Modes
    • 4. Selecting Nodes and Inspecting Details
    • 5. Execution Logs and Failure Investigation
      • Event Log
      • Investigating Failures
    • 6. Blackboard Inspection
      • Opening the Blackboard Watcher
      • Viewing Blackboard Variables
    • 7. Interactive Debugging
      • Breakpoints
      • Forced Statuses and Delay Injection
      • Integration Debugging Capabilities
    • 8. Session Recording and Replay
      • Recording a Session
      • Replaying a Recorded Session
    • 9. Integration Differences
  • XML Editor User Guide
    • Accessing the Editor
    • Opening & Creating Behavior Tree XML Files
      • Creating a New Tree
      • Opening an Existing XML File
    • Editing the Tree Structure
      • The Node Palette
      • Adding & Connecting Nodes
    • Configuring Node Properties & Ports
    • Validation & Error Handling
    • Raw XML Mode
    • Saving & Exporting Files

Integrations

  • BTick Integration
    • Overview & Capabilities
    • Prerequisites & Dependencies
      • Building the btick Package
    • Package Configuration
      • CMakeLists.txt
      • package.xml
    • C++ Integration Example: Adding BTick to main()
      • Step 1: Include the BTick Header
      • Step 2: Attach the BTick Monitor
      • Step 3: Enable Optional Logging
      • Step 4: Complete BTick Integration
      • Working Example: Turtlesim BT
BTick
  • Search
  • GitHub


© Copyright 2026, Sherif Fathey.

Built with Sphinx using a theme provided by Read the Docs.