Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions to build using release version of o3de #246

Closed
wants to merge 5 commits into from
Closed

Add instructions to build using release version of o3de #246

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4ec7e5b
Add instructions to build using release version of o3de
arturkamieniecki May 4, 2023
3d6c048
Modify instructions to link directly to existing documentations
arturkamieniecki May 4, 2023
c59e741
Modify readme to follow contribution guidelines
arturkamieniecki May 4, 2023
2cacbc6
Add small adjustments to improve instructions
arturkamieniecki May 5, 2023
ce86155
Update Launching the Editor section
arturkamieniecki May 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 37 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,12 @@ The project runs on Ubuntu 22.04 with ROS 2 Humble.

💡 ***Note:*** This demo is **not supported on Windows!**

## O3DE
## O3DE (from release)
1. Refer to the [O3DE System Requirements](https://www.o3de.org/docs/welcome-guide/requirements/) documentation to make
sure that the system/hardware requirements are met.
2. Download and prepare O3DE [(O3DE download)](https://www.o3de.org/download/)

## O3DE (from source)
arturkamieniecki marked this conversation as resolved.
Show resolved Hide resolved

1. Refer to the [O3DE System Requirements](https://www.o3de.org/docs/welcome-guide/requirements/) documentation to make
sure that the system/hardware requirements are met.
Expand All @@ -74,7 +79,7 @@ The following commands should prepare O3DE:

This project uses the [ROS 2 Gem](https://github.com/o3de/o3de-extras/blob/development/Gems/ROS2).
Please make sure to follow the installation guide
in [README.md](https://github.com/o3de/o3de-extras/blob/development/Gems/ROS2/README.md) file.
in [README.md](https://github.com/o3de/o3de-extras/blob/development/Gems/ROS2/README.md) file or use the [documentation](https://www.o3de.org/docs/user-guide/interactivity/robotics/project-configuration/).
arturkamieniecki marked this conversation as resolved.
Show resolved Hide resolved
To learn more about how the Gem works check out
the [ROS 2 Gem user guide](https://github.com/RobotecAI/o3de-ros2-gem/blob/development/docs/guides/ros2-gem.md).

Expand Down Expand Up @@ -115,7 +120,26 @@ export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp

# Building this project

## Build steps
## Build steps (GUI)

1. Clone this project:

```
git clone https://github.com/o3de/ROSConDemo.git
```

2. Open the O3DE project manager. To open the release version:
```
/opt/O3DE/<engine_version>/bin/Linux/profile/Default/o3de
```

3. Select new project and click open existing project.

4. Select ROSConDemo/Project. A new project should appear in the project manager called ROSConDemo.

5. Build the project and launch the editor.

## Build steps (CLI)

1. Clone this project:

Expand Down Expand Up @@ -144,10 +168,17 @@ cmake -B build/linux -G"Ninja Multi-Config" -DLY_DISABLE_TEST_MODULES=ON
5. Execute build (this will take a while the first time):

```
cmake --build build/linux --config profile --target ROSConDemo Editor AssetProcessor ROSConDemo.Assets
cmake --build build/linux --config profile --target ROSConDemo Editor ROSConDemo.Assets
```

## Launching the Editor (from release)
arturkamieniecki marked this conversation as resolved.
Show resolved Hide resolved

Launch the editor through O3DE project manager
```
/opt/O3DE/<engine_version>/bin/Linux/profile/Default/o3de
```

## Launching the Editor
## Launching the Editor (from source)


Launch the O3DE Editor (in the Project directory):
Expand Down Expand Up @@ -221,7 +252,7 @@ To spawn a new Apple Kraken, you can used named points (provided by a Spawner Co
You can use the spawn service with following robot names:
- apple_kraken_rusty
- apple_kraken_shiny
- apple_kraken (defualts to shiny).
- apple_kraken (defaults to shiny).
These two robots are functionally the same.

#### Available named spawn poses
Expand Down