Skip to content

About

uBot Manager: desktop app and CLI (ubot) to install, update and build uBot packages in Unreal Engine 5.5 projects.

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Repository files navigation

uBot

uBot Manager

Install, update and build uBot packages in your Unreal Engine 5.5 projects.

release license Unreal Engine 5.5

Documentation · Releases · Roadmap · Issues

English | 简体中文

What it is

uBot Manager is a Windows desktop app that installs, updates, enables, disables and removes uBot packages in an Unreal Engine 5.5 project. It resolves dependencies, shows the plan, then downloads a prebuilt package or clones and builds one from source. The ubot command line runs the same core for scripts and CI.

  • Review before applying. Every change is listed as steps and runs only after you confirm.
  • Prebuilt or source. Installs a prebuilt package when the index has one for your launcher-installed engine, and builds from source otherwise.
  • Dependencies included. Required packages and engine plugins are installed or enabled together.
  • Recipes. Install a preset set of packages, such as ROS 2 Sensors, in one step.
  • Problems and quick fixes. Dependency problems are listed with quick fixes.
  • Graph, task log, themes. A dependency graph, a log per task, English and Simplified Chinese, dark and light.

Install

  1. Download uBot-Manager_<version>_x64-setup.exe from Releases and run it. It installs for the current user without administrator rights; the install folder is selectable.
  2. The installer is not code-signed. SmartScreen reports an unknown publisher; choose More info > Run anyway.

Alternatives:

  • ubot command line. Not included in the installer. Build it with cargo build --release -p ubot-cli (Rust stable, MSVC); the output is target\release\ubot.exe.
  • From source. Build the desktop app, see docs/DEVELOPMENT.md.
  • Without the Manager. Install the plugins manually, see the install guide.

Requires Windows 10 or 11 (WebView2 runtime, included in Windows 11) and Unreal Engine 5.5. Installing from source also requires Git and Visual Studio 2022 with the C++ toolchain.

Quick start

  1. Start uBot Manager, click Open… and select your .uproject.
  2. Click Recipes, select ROS 2 Sensors, then click Review Changes… and Apply.
  3. Open the project in UE 5.5. Window > uBot lists the loaded packages.

On the command line (plan only prints the plan):

ubot --project .\MyRobotSim.uproject status
ubot --project .\MyRobotSim.uproject plan install:UBotROS
ubot --project .\MyRobotSim.uproject apply install:UBotROS --yes

The desktop app and the command line share one core:

flowchart LR
  App["Desktop app"] --> Core["Core (Rust)"]
  CLI["ubot CLI"] --> Core
  Core -->|reads| Index["Package index"]
  Core -->|installs| Plugins["Plugins/uBot: prebuilt zip, or git clone + build"]
  Core -->|edits| Proj[".uproject"]
Loading

Documentation

The documentation site and the files in docs/ are in Simplified Chinese.

I want to ... Go to
Install uBot packages in a project Install uBot
Learn the views, tasks and problems Interface tour
Install, update or remove packages Install, update, remove
Install a set of packages at once Recipes
Change settings and index sources Settings
Use it in scripts or CI ubot command line
Write a uBot package Package authoring
Build or release the Manager DEVELOPMENT · RELEASING · INTERNALS

uBot series

Repository What it is
uBotCore Simulation clock, frame header, shared interfaces, package management
uBotSensor Pose, IMU, odometry, 2D/3D lidar, RGB and depth cameras
uBotROS ROS 2 over a TCP bridge: sensors, TF, /clock, cmd_vel
uBotAerial Multirotor drones: simplified flight, rigid-body dynamics, wind
uBotManager Desktop app and CLI to install, update and build uBot packages
uBotDocs Documentation site: https://astreox.github.io/uBotDocs/

Development

  • Needs Rust (stable, MSVC) and Node.js 22.12 or later. In app/ run npm ci and npm run tauri build -- --no-bundle; at the root run cargo build --release -p ubot-cli.
  • Test with cargo test --workspace and, in app/, npm test.
  • Details are in docs/DEVELOPMENT.md; the release process is in docs/RELEASING.md.
  • Report bugs and ideas in Issues.

License

Copyright 2026 AstreoX. Licensed under the Apache License 2.0; see also NOTICE.

Code signing policy

Release installers are built from this repository's source by the Release workflow and then signed. Signing is being applied for with the SignPath Foundation; installers released before it takes effect are not signed.

Free code signing provided by SignPath.io, certificate by SignPath Foundation.

Privacy policy: uBot Manager does not collect or send personal data, usage data or telemetry. It connects to other systems only to:

  • download the package index, by default from raw.githubusercontent.com: at startup (can be turned off with Settings > Package Index > Sync index on startup) and when you click the refresh button;
  • download prebuilt packages or clone package repositories from the addresses listed in the index (by default github.com) when you install or update packages;
  • ask the GitHub Releases API (api.github.com) for the latest uBot Manager release: once at startup (can be turned off with Settings > About > Check for a new version of uBot Manager on startup) and when you click Check for Updates. The request carries the app name and version as its user agent and nothing else; nothing is downloaded or installed.

Requests to GitHub are covered by the GitHub General Privacy Statement.

About

uBot Manager: desktop app and CLI (ubot) to install, update and build uBot packages in Unreal Engine 5.5 projects.

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages