Skip to content

tessel-la/robo-boy

Repository files navigation

Robo-Boy

Tests Docker Build Coverage Version License

Robo-Boy Logo

Robo-Boy is a web interface for controlling and visualizing ROS 2 robots. It includes camera streaming, configurable control pads, 3D visualization, behavior-tree editing, and custom themes.

Start With Docker

Prerequisites

  • Docker with Docker Compose
  • mkcert

Run

git clone git@github.com:tessel-la/robo-boy.git
cd robo-boy
mkcert -install
mkdir -p infra/caddy/certs
mkcert -key-file infra/caddy/certs/local-key.pem -cert-file infra/caddy/certs/local-cert.pem localhost 127.0.0.1 ::1 YOUR_HOST_IP
cp config/env/no-overlay.env.example .env
docker compose up -d --build

Replace YOUR_HOST_IP with the computer's local network IP if Robo-Boy will be opened from another device.

Open https://localhost, or https://YOUR_HOST_IP from a device on the same network.

Stop

docker compose down

Documentation

See the documentation index for application usage, development commands, ROS workspace overlays, custom gamepads, and architecture.

License

See LICENSE.

About

A web application for controlling ROS 2 robots, tailored for mobile usage. Inspired by retro handheld consoles.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors