Creation of O3DE tutorials #1
Conversation
Signed-off-by: Wiktoria Siekierska <[email protected]>
Signed-off-by: Wiktoria Siekierska <[email protected]>
Signed-off-by: Wiktoria Siekierska <[email protected]>
Signed-off-by: Wiktoria Siekierska <[email protected]>
Signed-off-by: Wiktoria Siekierska <[email protected]>
Signed-off-by: Wiktoria Siekierska <[email protected]>
Signed-off-by: Wiktoria Siekierska <[email protected]>
There was a problem hiding this comment.
I read your changes diagonally and I gave some nitpick comments, but I do not agree with the general concept.
There are few points that I would like to discuss with the others:
- I believe we should use
debinstallers and we should use automatic tools to download gems and templates aszippackages without any need to use command line tools. We never do it ourselves, so this exercise would allow us to check if everything is working as it should. Perfect before the release - I believe we should focus on
ROS2ProjectTemplatetemplate only. This project allows to I) run the navstack; ii) implement some ROS 2 interfaces (advanced tutorial); note: we might build the project from the GUI - We should first agree on the content of tutorials. I would suggest the following:
- installation + creating ROS 2 project based on the template;
- running the template (in Game mode); extending the template by doing some modifications in the Editor;
- extending the template with more ROS 2 things (some topics to do basic things, e.g. moving some objects based on ROS 2 topic)
- creating a project from scratch with ROS 2 gem
| libglu1-mesa-dev libxcb-xinerama0 libxcb-xinput0 libxcb-xinput-dev \ | ||
| libfontconfig1 libssl-dev uuid-dev clang lld | ||
|
|
||
| Step 2: Clone the O3DE Repository |
There was a problem hiding this comment.
It takes ages to clone and build O3DE from the source - shouldn't we focus on using a deb package? This tutorial should take 15 minutes only.
|
|
||
| .. code-block:: bash | ||
|
|
||
| ./scripts/o3de.sh create-project --project-path <path-to-your-project> --template Default |
There was a problem hiding this comment.
We should focus on ROS 2 templates, using default template makes no sense for ROS 2 community.
|
|
||
| .. code-block:: bash | ||
|
|
||
| git checkout stabilization/2409 |
There was a problem hiding this comment.
After pulling the default branch of O3DE, development will be pulled. stabilization2409 branch will NOT build against unstable O3DE.
|
|
||
| ./scripts/o3de.sh register --all-engines-path <o3de-extras>/Engines | ||
| ./scripts/o3de.sh register --all-projects-path <o3de-extras>/Projects | ||
| ./scripts/o3de.sh register --all-gems-path <o3de-extras>/Gems |
There was a problem hiding this comment.
This line is a duplicate of 179
|
|
||
| .. code-block:: bash | ||
|
|
||
| ./scripts/o3de.sh enable-gem --gem-name <gem name> --project-name <project name> No newline at end of file |
There was a problem hiding this comment.
In most cases (at least until we get 2409 up and running) this will trigger a conflict between PhysX and PhysX5 gems.
|
|
||
| ros2 launch Examples/panda_moveit_config_demo.launch.py | ||
|
|
||
| And for the palletization try: |
There was a problem hiding this comment.
It is not clear the other level is needed. I would stick to Panda - the other level might be removed after 2409 as we plan to clean up the assets.
|
|
||
| **Goal:** Setup a robot simulation and control it from ROS 2. | ||
|
|
||
| **Tutorial level:** Advanced |
There was a problem hiding this comment.
You called this tutorial Basic
|
|
||
| 4. **Configure and build the Project**: | ||
|
|
||
| After installing dependencies, cofigure and build the project using the following commands: |
There was a problem hiding this comment.
Please use some tools to check for typos and other language issues:
| After installing dependencies, cofigure and build the project using the following commands: | |
| After installing dependencies, configure and build the project using the following commands: |
|
|
||
| .. code-block:: bash | ||
|
|
||
| <path-to-o3de-directory>/build/bin/profile/Editor |
There was a problem hiding this comment.
You might use the game launcher directly, there is no need to go to Editor at this stage.
|
|
||
| Once in the Editor, open the SLAM navigation level by navigating to the ``Levels`` tab and selecting the SLAM navigation level. | ||
|
|
||
| Press ``Ctrl+G`` to start the simulation. |
There was a problem hiding this comment.
No need to start the editor to start the game mode
Signed-off-by: Wiktoria Siekierska <[email protected]>
Downloading o3de .zip package and lauching a simulation
Added O3DE in Advanced/Simulators tutorials and created three basic tutorials: