The documentation site of the uBot plugin family for Unreal Engine 5.5.
English | 简体中文
This repository is the source of the documentation site for the uBot plugins for Unreal Engine 5.5. The site is written in Simplified Chinese and built with Astro Starlight. It has a manual for each plugin, an API reference generated from the data the plugins export, and a dependency graph of the plugins.
- Blueprint graphs from text. Examples are written as text blocks and drawn as Unreal-style node graphs at build time.
- Generated API reference. Pages for classes, structs, enums and nodes come from each plugin's exported
docs/api.jsonplus Chinese summaries. - Driven by the package index. The sidebar, the dependency graph and the search filter read the uBot package index, so a new plugin needs data and pages, not code.
- In step with the plugins. A daily workflow opens a pull request when the package index or the exported API data change.
| Section | What you find |
|---|---|
| Get started | Introduction, installation, a five-minute quickstart, choosing a recipe |
| Core concepts | Frame header, simulation clock, coordinates and units, identity, how plugins connect |
| Plugin manuals: uBotCore · uBotSensor · uBotROS · uBotAerial | One manual per plugin, with Blueprint graphs |
| uBot Manager | Interface tour, installing and updating packages, recipes, settings, the ubot command line |
| API reference | Classes, structs, enums and nodes, a node index, engine nodes |
| Developers | Sensors and interfaces from C++, ROS publishers, writing a package, migration |
| 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/ |