Skip to content

Commit 4c5a914

Browse files
authored
tutorials/physics: Small fixes and Windows support (#2627)
Signed-off-by: Martin Pecka <[email protected]>
1 parent 43b435a commit 4c5a914

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

tutorials/physics.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ by default.
1010

1111
Downstream developers may also integrate other physics engines by creating new
1212
Gazebo Physics engine plugins. See
13-
[Gazebo Physics](https://gazebosim.org/api/physics/7/tutorials.html)'s
13+
[Gazebo Physics](https://gazebosim.org/api/physics/8/tutorials.html)'s
1414
tutorials to learn how to integrate a new engine.
1515

1616
## How Gazebo finds engines
@@ -25,24 +25,32 @@ If you've created a custom engine plugin, you can tell Gazebo where to find it
2525
by setting the `GZ_SIM_PHYSICS_ENGINE_PATH` environment variable to the
2626
directory where the plugin's shared library can be found.
2727

28-
For example, if you've created the following physics engine shared library on
29-
Linux:
28+
For example, if you've created the following physics engine shared library:
3029

3130
```
31+
# Linux
3232
/home/physics_engines/libCustomEngine.so
33+
# Windows
34+
C:\Users\Robot\physics_engines\CustomEngine.dll
3335
```
3436

3537
You should set the variable as follows:
3638

3739
```
40+
# Linux
3841
export GZ_SIM_PHYSICS_ENGINE_PATH=/home/physics_engines
42+
# Windows
43+
set GZ_SIM_PHYSICS_ENGINE_PATH=C:\Users\Robot\physics_engines
3944
```
4045

4146
If you have several libraries installed in different paths, you can add more
4247
paths, for example:
4348

4449
```
50+
# Linux, separate with :
4551
export GZ_SIM_PHYSICS_ENGINE_PATH=/home/physics_engines:/home/more_engines
52+
# Windows, separate with ;
53+
set GZ_SIM_PHYSICS_ENGINE_PATH=C:\Users\Robot\physics_engines;C:\MoreEngines
4654
```
4755

4856
## Tell Gazebo what engine to load
@@ -52,6 +60,7 @@ There are a few different ways of telling Gazebo which engine to load.
5260
For any method, you should provide the name of your plugin's shared library,
5361
but the `lib` prefix and the file extension are optional. So in this example,
5462
the file is `libCustomEngine.so` but it's enough to set `CustomEngine`.
63+
That is also prefered to support multiple operating systems.
5564

5665
### From SDF
5766

@@ -103,23 +112,23 @@ Gazebo supports the following physics engine configurations through SDF.
103112
These options are available to all physics engines, but not all engines
104113
may support them. The default physics engine, DART, supports all these options.
105114

106-
* [//physics/dart/collision_detector](http://sdformat.org/spec?ver=1.8&elem=physics#dart_collision_detector)
115+
* [//physics/dart/collision_detector](http://sdformat.org/spec?ver=1.11&elem=physics#dart_collision_detector)
107116
* Options supported by DART: `ode` (default), `bullet`, `fcl`, `dart`.
108117

109-
* [//physics/dart/solver/solver_type](http://sdformat.org/spec?ver=1.8&elem=physics#solver_solver_type)
118+
* [//physics/dart/solver/solver_type](http://sdformat.org/spec?ver=1.11&elem=physics#solver_solver_type)
110119
* Options supported by DART: `dantzig` (default), `pgs`
111120

112121
## Troubleshooting
113122

114123
> Failed to find plugin [libCustomEngine.so]. Have you checked the
115124
> GZ_SIM_PHYSICS_ENGINE_PATH environment variable?
116125
117-
Gazebo can't find out where `libCustomEngine.so` is located.
126+
Gazebo can't find out where `libCustomEngine.so` or `CustomEngine.dll` is located.
118127

119128
If that's an engine you believe should be installed with Gazebo Physics,
120129
check if the relevant plugin is installed.
121130

122-
If that's a 3rd party engine, find where the `.so` file is installed and add
131+
If that's a 3rd party engine, find where the `.so` or `.dll` file is installed and add
123132
that path to the environment variable as described above.
124133

125134
> Unable to load the [/home/physics_engines/libCustomEngine.so] library.

0 commit comments

Comments
 (0)