rclUE-Examples

UE Project which includes examples to use rclUE.

Documentation

• rclUE: This repo enables communication between UE and ROS 2.
• RapyutaSimulationPlugins: This repo has classes/tools to create ROS 2 enables robots with rclUE.

Branches

• devel: Main branch. Compatible with Unreal Engine 5.1 with Ubuntu 22.04

Maps

• Default: empty map.
• MeshExamples: Example map to show StaticMeshes
• Character: Examplme map to test character navigation
• Warehouse: Example map of warehouse composed oof contesnts in Epic Marketplace

Dependency

Some example maps uses assets from Epic MarketPlace. Sicne those can not be included in github repository even if it is free, you need to download followings under Contents folder

• Factory Environment Collection : Warehouse map and forklift models are comes from here.
• Vehicle Variety Pack : Track models are comes from here
• Mannequins Pack

*you can use lutris to use Epic launcher in Ubuntu.

Setup and run

• please check Getting Started as well.

1. Download UE5.1 for Linux by following Unreal Engine for Linux
2. Clone this repo : git clone --recurse-submodules [email protected]:rapyuta-robotics/rclUEExamples.git
3. Retrieve the large files : git-lfs pull && git submodule foreach git-lfs pull
4. Build and run

   cd rclUEExamples
   export UE5_DIR=<path to UE5>
   ./update_project_files.sh //this is only required first time.
   make rclUEExamplesEditor
   ./run_editor.sh 
   

Run client

Setup ROS 2 client repo by following this repo's README This example ROS 2 package spawn/control UE models from ROS 2 API.