Skip to content

Commit 9ecd37c

Browse files
authored
Added descriptions to all gems (#66)
Signed-off-by: Michał Pełka <[email protected]>
1 parent 9f6f328 commit 9ecd37c

File tree

2 files changed

+40
-6
lines changed

2 files changed

+40
-6
lines changed

doc/Pointcloud.png

2.08 MB
Loading

readme.md

Lines changed: 40 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# robotec-o3de-tools
22

33
This repository is a collection of useful gems that are usable in O3DE.
4-
Those gems are open source, but refer to the license of every gem.
4+
Those gems are open source but refer to the license of every gem.
55
Note that this is not a "Canonical" part of O3DE - those gems are third-party contributions and are not tested against any particular version of the O3DE engine.
66

77
# RobotecRecordingTools
@@ -10,8 +10,8 @@ Toolset for joystick-controlled cameras and spline animation tools.
1010
# SplineTools
1111
The tools for expanding the usability of the Spline component in O3DE.
1212
It allows to:
13-
## Load spline from CSV file
14-
13+
- Import spline from CSV file
14+
- Export spline to a CSV file
1515
Having a CSV file formatted as :
1616
```csv
1717
x,y,z
@@ -52,17 +52,23 @@ A component that allows to look at an entity from 3rd person perspective and to
5252

5353
# RobotecWatchdogTools
5454

55-
Minimal dependency Gem that allows to setup runtime checks and prevents starting the Editor/GameLauncher if the requirements are not met
55+
Minimal dependency Gem that allows the setup runtime checks and prevents starting the Editor/GameLauncher if the requirements are not met
5656
Refer to [readme](Gems/RobotecWatchdogTools/readme.md)
5757

58+
# Disable the main view
59+
60+
Deprecated, please use `-console-mode` switch available in o3de 2409.
61+
The description of said feature is in the original [PR](https://github.com/o3de/o3de/pull/18093).
5862

5963
# LevelModificationTools
6064

61-
TBD
65+
The level modification tool contains a component called PrefabVariantEditorComponent.
66+
This component allows the change a variant of loaded prefab during game mode.
67+
It exposes PrefabVariantRequestsBus to Script Canvas or LUA.
6268

6369
# SensorDebug
6470

65-
A tool that allows to adjust frequency, activate and deactive sensor during game mode.
71+
A tool that allows the adjusted frequency, activate and deactivate sensor during the game mode.
6672

6773
# Smoothing
6874

@@ -102,3 +108,31 @@ alt lat lon name
102108
0 12.5897646831551 30.1933927129084 ball
103109
104110
```
111+
112+
# ExposeConsoleToRos
113+
114+
Simple utility Gem that exposes the O3DE console to ROS 2 topics.
115+
It has two std_msgs/msg/String topics:
116+
```
117+
\o3de_console_out
118+
\o3de_console_in
119+
```
120+
Currently `o3de_console_in` is usable only.
121+
The gem functionality is available only in Profile/Debug.
122+
123+
# Pointcloud
124+
125+
A Gem that introduces point clouds to O3DE.
126+
It offers:
127+
- PointcloudFeatureProcessor with public API
128+
- Pointcloud product asset
129+
- A public API for configuration (`PointcloudConfigurationBus`)
130+
131+
At this moment it accepts [PLY](https://en.wikipedia.org/wiki/PLY_(file_format)) as a source asset.
132+
133+
![](doc/Pointcloud.png)\
134+
Pointcloud asset was obtained from [potree](https://github.com/potree/potree).
135+
136+
# ROS2PoseControl
137+
138+
A utility gem that introduces a way to control robots in simulation as puppets with Pose messages or TFs.

0 commit comments

Comments
 (0)