Rename o3de-demo-project to RobotVacuumSample

Signed-off-by: Steve Pham <[email protected]>

CMakeLists.txt

@@ -12,7 +12,7 @@ if(NOT PROJECT_NAME)
     cmake_minimum_required(VERSION 3.20)
     include(cmake/EngineFinder.cmake OPTIONAL)
     find_package(o3de REQUIRED)
-    project(ROS2-Gem-Demo
+    project(RobotVacuumSample
         LANGUAGES C CXX
         VERSION 1.0.0.0
     )

Docker/Dockerfile

@@ -118,7 +118,7 @@ RUN if [ "${IMAGE_TYPE}" = "simulation" ]; then \
         $WORKSPACE/o3de/scripts/o3de.sh register -pp $WORKSPACE/o3de-demo-project/  && \
         . /opt/ros/${ROS_VERSION}/setup.sh && \
         cmake -B $WORKSPACE/o3de-demo-project/build/linux -S $WORKSPACE/o3de-demo-project -G "Ninja Multi-Config" -DLY_STRIP_DEBUG_SYMBOLS=TRUE -DLY_DISABLE_TEST_MODULES=ON && \
-        cmake --build $WORKSPACE/o3de-demo-project/build/linux --config profile --target AssetProcessorBatch ROS2-Gem-Demo.GameLauncher ROS2-Gem-Demo.Assets -j 20 && \
+        cmake --build $WORKSPACE/o3de-demo-project/build/linux --config profile --target AssetProcessorBatch ROS2-Gem-Demo.GameLauncher RobotVacuumSample.Assets -j 20 && \
         $WORKSPACE/cleanup.bash; \
     elif [  "${IMAGE_TYPE}" = "navstack" ]; then \
         apt-get install -y --no-install-recommends ros-${ROS_DISTRO}-desktop && \

Docker/LaunchSimulation.bash

@@ -15,7 +15,7 @@ export LD_LIBRARY_PATH=/data/workspace/o3de-demo-project/build/linux/bin/profile
 if [ -d /data/workspace/o3de-demo-project/build/linux/bin/profile ]
 then
     cd /data/workspace/o3de-demo-project/build/linux/bin/profile
-    ./ROS2-Gem-Demo.GameLauncher -bg_ConnectToAssetProcessor=0 > /data/workspace/simulation_launch.log 2>&1
+    ./RobotVacuumSample.GameLauncher -bg_ConnectToAssetProcessor=0 > /data/workspace/simulation_launch.log 2>&1
 else
     echo "Simulation not installed on this image"
 fi

Gem/CMakeLists.txt

@@ -10,12 +10,12 @@ set(gem_path ${CMAKE_CURRENT_LIST_DIR})
 set(gem_json ${gem_path}/gem.json)
 o3de_restricted_path(${gem_json} gem_restricted_path gem_parent_relative_path)
 
-# Currently we are in the ROS2-Gem-Demo/Gem folder: ${CMAKE_CURRENT_LIST_DIR}
+# Currently we are in the RobotVacuumSample/Gem folder: ${CMAKE_CURRENT_LIST_DIR}
 # Get the platform specific folder ${pal_dir} for the current folder: ${CMAKE_CURRENT_LIST_DIR}/Platform/${PAL_PLATFORM_NAME}
 # Note: o3de_pal_dir will take care of the details for us, as this may be a restricted platform
 #       in which case it will see if that platform is present here or in the restricted folder.
-#       i.e. It could here : ROS2-Gem-Demo/Gem/Platform/<platform_name>  or
-#            <restricted_folder>/<platform_name>/ROS2-Gem-Demo/Gem
+#       i.e. It could here : RobotVacuumSample/Gem/Platform/<platform_name>  or
+#            <restricted_folder>/<platform_name>/RobotVacuumSample/Gem
 o3de_pal_dir(pal_dir ${CMAKE_CURRENT_LIST_DIR}/Platform/${PAL_PLATFORM_NAME} "${gem_restricted_path}" "${gem_path}" "${gem_parent_relative_path}")
 
 # Now that we have the platform abstraction layer (PAL) folder for this folder, thats where we will find the
@@ -30,15 +30,15 @@ if(NOT PAL_TRAIT_ROBOT_VACUUM_SAMPLE_SUPPORTED)
     return()
 endif()
 
-# We are on a supported platform, so add the ROS2-Gem-Demo target
-# Note: We include the common files and the platform specific files which are set in ros2-gem-demo_files.cmake and
-# in ${pal_dir}/ros2-gem-demo_${PAL_PLATFORM_NAME_LOWERCASE}_files.cmake
+# We are on a supported platform, so add the RobotVacuumSample target
+# Note: We include the common files and the platform specific files which are set in robot-vacuum-sample_files.cmake and
+# in ${pal_dir}/robot_vacuum_sample_${PAL_PLATFORM_NAME_LOWERCASE}_files.cmake
 ly_add_target(
-    NAME ROS2-Gem-Demo.Static STATIC
+    NAME RobotVacuumSample.Static STATIC
     NAMESPACE Gem
     FILES_CMAKE
-        ros2-gem-demo_files.cmake
-        ${pal_dir}/ros2-gem-demo_${PAL_PLATFORM_NAME_LOWERCASE}_files.cmake
+        robot_vacuum_sample_files.cmake
+        ${pal_dir}/robot_vacuum_sample_${PAL_PLATFORM_NAME_LOWERCASE}_files.cmake
     INCLUDE_DIRECTORIES
         PUBLIC
             Include
@@ -49,29 +49,29 @@ ly_add_target(
 )
 
 ly_add_target(
-    NAME ROS2-Gem-Demo ${PAL_TRAIT_MONOLITHIC_DRIVEN_MODULE_TYPE}
+    NAME RobotVacuumSample ${PAL_TRAIT_MONOLITHIC_DRIVEN_MODULE_TYPE}
     NAMESPACE Gem
     FILES_CMAKE
-        ros2-gem-demo_shared_files.cmake
-        ${pal_dir}/ros2-gem-demo_shared_${PAL_PLATFORM_NAME_LOWERCASE}_files.cmake
+        robot_vacuum_sample_shared_files.cmake
+        ${pal_dir}/robot_vacuum_sample_shared_${PAL_PLATFORM_NAME_LOWERCASE}_files.cmake
     INCLUDE_DIRECTORIES
         PUBLIC
             Include
     BUILD_DEPENDENCIES
         PRIVATE
-            Gem::ROS2-Gem-Demo.Static
+            Gem::RobotVacuumSample.Static
             AZ::AzCore
 )
 
-# if enabled, ROS2-Gem-Demo is used by all kinds of applications
-ly_create_alias(NAME ROS2-Gem-Demo.Builders NAMESPACE Gem TARGETS Gem::ROS2-Gem-Demo)
-ly_create_alias(NAME ROS2-Gem-Demo.Tools    NAMESPACE Gem TARGETS Gem::ROS2-Gem-Demo)
-ly_create_alias(NAME ROS2-Gem-Demo.Clients  NAMESPACE Gem TARGETS Gem::ROS2-Gem-Demo)
-ly_create_alias(NAME ROS2-Gem-Demo.Servers  NAMESPACE Gem TARGETS Gem::ROS2-Gem-Demo)
+# if enabled, RobotVacuumSample is used by all kinds of applications
+ly_create_alias(NAME RobotVacuumSample.Builders NAMESPACE Gem TARGETS Gem::RobotVacuumSample)
+ly_create_alias(NAME RobotVacuumSample.Tools    NAMESPACE Gem TARGETS Gem::RobotVacuumSample)
+ly_create_alias(NAME RobotVacuumSample.Clients  NAMESPACE Gem TARGETS Gem::RobotVacuumSample)
+ly_create_alias(NAME RobotVacuumSample.Servers  NAMESPACE Gem TARGETS Gem::RobotVacuumSample)
 
 ################################################################################
 # Gem dependencies
 ################################################################################
 
 # Enable the specified list of gems from GEM_FILE or GEMS list for this specific project:
-ly_enable_gems(PROJECT_NAME ROS2-Gem-Demo GEM_FILE enabled_gems.cmake)
+ly_enable_gems(PROJECT_NAME RobotVacuumSample GEM_FILE enabled_gems.cmake)

Gem/Registry/assetprocessor_settings.setreg

@@ -2,13 +2,13 @@
     "Amazon": {
         "AssetProcessor": {
             "Settings": {
-                "ScanFolder ROS2-Gem-Demo/Assets": {
-                    "watch": "@GEMROOT:ROS2-Gem-Demo@/Assets",
+                "ScanFolder RobotVacuumSample/Assets": {
+                    "watch": "@GEMROOT:RobotVacuumSample@/Assets",
                     "recursive": 1,
                     "order": 101
                 },
-                "ScanFolder ROS2-Gem-Demo/Registry": {
-                    "watch": "@GEMROOT:ROS2-Gem-Demo@/Registry",
+                "ScanFolder RobotVacuumSample/Registry": {
+                    "watch": "@GEMROOT:RobotVacuumSample@/Registry",
                     "recursive": 1,
                     "order": 102
                 }

Gem/Source/ROS2-Gem-DemoModule.cpp → Gem/Source/RobotVacuumSampleModule.cpp

@@ -9,7 +9,7 @@
 #include <AzCore/Memory/SystemAllocator.h>
 #include <AzCore/Module/Module.h>
 
-#include "ROS2-Gem-DemoSystemComponent.h"
+#include "RobotVacuumSampleSystemComponent.h"
 
 namespace RobotVacuumSample
 {

Gem/Source/ROS2-Gem-DemoSystemComponent.cpp → Gem/Source/RobotVacuumSampleSystemComponent.cpp

@@ -10,7 +10,7 @@
 #include <AzCore/Serialization/EditContext.h>
 #include <AzCore/Serialization/EditContextConstants.inl>
 
-#include "ROS2-Gem-DemoSystemComponent.h"
+#include "RobotVacuumSampleSystemComponent.h"
 
 namespace RobotVacuumSample
 {

Gem/Source/ROS2-Gem-DemoSystemComponent.h → Gem/Source/RobotVacuumSampleSystemComponent.h

@@ -10,7 +10,7 @@
 
 #include <AzCore/Component/Component.h>
 
-#include <ROS2-Gem-Demo/ROS2-Gem-DemoBus.h>
+#include <RobotVacuumSample/RobotVacuumSampleBus.h>
 
 namespace RobotVacuumSample
 {

Gem/enabled_gems.cmake

@@ -7,7 +7,7 @@
 #
 
 set(ENABLED_GEMS
-    ROS2-Gem-Demo
+    RobotVacuumSample
     Atom
     CameraFramework
     DebugDraw

Gem/gem.json

@@ -1,17 +1,17 @@
 {
-    "gem_name": "ROS2-Gem-Demo",
-    "display_name": "ROS2-Gem-Demo",
-    "license": "What license ROS2-Gem-Demo uses goes here: i.e. Apache-2.0 or MIT",
-    "license_url": "Link to the license web site goes here: i.e. https://opensource.org/licenses/Apache-2.0 Or https://opensource.org/licenses/MIT",
-    "origin": "The name of the originator goes here. i.e. XYZ Inc.",
-    "origin_url": "The primary repo for ROS2-Gem-Demo goes here: i.e. http://www.mydomain.com",
+    "gem_name": "RobotVacuumSample",
+    "display_name": "RobotVacuumSample",
+    "license": "Apache-2.0 or MIT",
+    "license_url": "https://opensource.org/licenses/Apache-2.0 Or https://opensource.org/licenses/MIT",
+    "origin": "O3DE",
+    "origin_url": "https://github.com/o3de/RobotVacuumSample",
     "type": "",
-    "summary": "A short description of ROS2-Gem-Demo.",
+    "summary": "A short description of RobotVacuumSample Gem.",
     "canonical_tags": [
         "Gem"
     ],
     "user_tags": [
-        "ROS2-Gem-Demo"
+        "RobotVacuumSample"
     ],
     "icon_path": "preview.png",
     "requirements": "",

Gem/ros2-gem-demo_files.cmake → Gem/robot_vacuum_sample_files.cmake

@@ -7,8 +7,8 @@
 #
 
 set(FILES
-    Include/ROS2-Gem-Demo/ROS2-Gem-DemoBus.h
-    Source/ROS2-Gem-DemoSystemComponent.cpp
-    Source/ROS2-Gem-DemoSystemComponent.h
+    Include/RobotVacuumSample/RobotVacuumSampleBus.h
+    Source/RobotVacuumSampleSystemComponent.cpp
+    Source/RobotVacuumSampleSystemComponent.h
     enabled_gems.cmake
 )

Gem/ros2-gem-demo_shared_files.cmake → Gem/robot_vacuum_sample_shared_files.cmake

@@ -7,5 +7,5 @@
 #
 
 set(FILES
-    Source/ROS2-Gem-DemoModule.cpp
+    Source/RobotVacuumSampleModule.cpp
 )

Platform/Android/android_project.json

@@ -1,7 +1,7 @@
 {
     "Tags": ["Android"],
     "android_settings" : {
-        "package_name" : "org.o3de.ROS2-Gem-Demo",
+        "package_name" : "org.o3de.RobotVacuumSample",
         "version_number" : 1,
         "version_name" : "1.0.0.0",
         "orientation" : "landscape"

README.md

@@ -1,6 +1,6 @@
 # RobotVacuumSample
 
-This project demonstrates how ROS2 Gem for O3DE can be used with a scene (The Loft project) and ROS 2 navigation stack.
+This sample project demonstrates a robotic vacuum simulation project navigating through the O3DE Loft scene using the ROS 2 Gem and the ROS 2 navigation stack.
 
 ![image](https://user-images.githubusercontent.com/16702721/174113203-e22cfd37-1bd5-4e42-a543-17b92de96c13.png)
 
@@ -21,7 +21,7 @@ This project has the following dependencies:
   - ROS 2 (Galactic or Humble) itself is also required, see [Gem Requirements](https://github.com/RobotecAI/o3de-ros2-gem#requirements)  
 - [Loft Scene Sample](https://github.com/aws-lumberyard/loft-arch-vis-sample)
   - `development` branch (the default) should work.
-- [ROS Gem Demo Project](https://github.com/RobotecAI/o3de-demo-project)
+- [Robot Vacuum Sample Project](https://github.com/o3de/RobotVacuumSample)
   - `main` branch (the default) should work.
 
 ## Setup Instructions
@@ -77,7 +77,7 @@ $ cd $DEMO_BASE
 ~/o3de-demo-project$ git lfs install
 ~/o3de-demo-project$ $DEMO_BASE/scripts/o3de.sh register -pp .
 ~/o3de-demo-project$ cmake -B build/linux -G "Ninja Multi-Config" -DLY_STRIP_DEBUG_SYMBOLS=TRUE -DLY_DISABLE_TEST_MODULES=ON
-~/o3de-demo-project$ cmake --build build/linux --config profile --target ROS2-Gem-Demo Editor AssetProcessor
+~/o3de-demo-project$ cmake --build build/linux --config profile --target RobotVacuumSample Editor AssetProcessor
 ```
 
 ### 5. Launch Editor

Resources/Platform/Mac/Info.plist

@@ -5,11 +5,11 @@
 	<key>CFBundleInfoDictionaryVersion</key>
 	<false/>
 	<key>CFBundleDisplayName</key>
-	<string>ROS2-Gem-Demo</string>
+	<string>RobotVacuumSample</string>
 	<key>CFBundleExecutable</key>
-	<string>ROS2-Gem-Demo.GameLauncher</string>
+	<string>RobotVacuumSample.GameLauncher</string>
 	<key>CFBundleIdentifier</key>
-	<string>com.amazon.ROS2-Gem-Demo</string>
+	<string>com.amazon.RobotVacuumSample</string>
 	<key>CFBundlePackageType</key>
 	<string>APPL</string>
 	<key>CFBundleShortVersionString</key>

Resources/Platform/iOS/Info.plist

@@ -5,15 +5,15 @@
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleDisplayName</key>
-	<string>ROS2-Gem-Demo</string>
+	<string>RobotVacuumSample</string>
 	<key>CFBundleExecutable</key>
-	<string>ROS2-Gem-Demo.GameLauncher</string>
+	<string>RobotVacuumSample.GameLauncher</string>
 	<key>CFBundleIdentifier</key>
-	<string>com.amazon.lumberyard.ROS2-Gem-Demo</string>
+	<string>com.amazon.lumberyard.RobotVacuumSample</string>
 	<key>CFBundleInfoDictionaryVersion</key>
 	<string>6.0</string>
 	<key>CFBundleName</key>
-	<string>ROS2-Gem-Demo</string>
+	<string>RobotVacuumSample</string>
 	<key>CFBundlePackageType</key>
 	<string>APPL</string>
 	<key>CFBundleShortVersionString</key>

build.sh

@@ -1 +1 @@
-cmake --build build/linux --config profile --target ROS2-Gem-Demo Editor AssetProcessor -j4
+cmake --build build/linux --config profile --target RobotVacuumSample Editor AssetProcessor -j4

project.json

@@ -1,22 +1,22 @@
 {
-    "project_name": "ROS2-Gem-Demo",
+    "project_name": "RobotVacuumSample",
     "project_id": "{9ed699a2-4b64-468e-ad9c-9cff6c0dfd3f}",
-    "origin": "The primary repo for ROS2-Gem-Demo goes here: i.e. http://www.mydomain.com",
-    "license": "What license ROS2-Gem-Demo uses goes here: i.e. https://opensource.org/licenses/Apache-2.0 Or https://opensource.org/licenses/MIT etc.",
-    "display_name": "ROS2-Gem-Demo",
-    "summary": "A short description of ROS2-Gem-Demo.",
+    "origin": "https://github.com/o3de/RobotVacuumSample",
+    "license": "https://opensource.org/licenses/Apache-2.0 Or https://opensource.org/licenses/MIT etc.",
+    "display_name": "RobotVacuumSample",
+    "summary": "Demo of a Robot Vacuum using the O3DE Loft Scene.",
     "canonical_tags": [
         "Project"
     ],
     "user_tags": [
-        "ROS2-Gem-Demo"
+        "RobotVacuumSample"
     ],
     "icon_path": "preview.png",
     "engine": "o3de",
     "external_subdirectories": [
         "Gem"
     ],
-    "restricted": "ROS2-Gem-Demo",
+    "restricted": "RobotVacuumSample",
     "gem_names": [
         "ROS2",
         "ArchVis"