Skip to content

Commit

Permalink
Revert GZ_SIM_ env vars to IGNITION_GAZEBO_
Browse files Browse the repository at this point in the history
Signed-off-by: methylDragon <methylDragon@gmail.com>
  • Loading branch information
methylDragon committed May 26, 2022
1 parent a90546a commit a8c9b4c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions examples/hello_world_plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ and `HelloWorldPlugin.dll` on Windows.

## Run

Be sure to have the `GZ_SIM_RENDER_ENGINE_PATH` environment variable set to the path
Be sure to have the `IGN_GAZEBO_RENDER_ENGINE_PATH` environment variable set to the path
where your plugin is located. From within the `build` directory of this example, you can run

~~~
export GZ_SIM_RENDER_ENGINE_PATH=$PWD
export IGN_GAZEBO_RENDER_ENGINE_PATH=$PWD
~~~

to set the environment variable accordingly.
Expand Down
2 changes: 1 addition & 1 deletion tutorials/03_rendering_plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Finally, for your custom rendering engine to actually have any functionality and

Once you have your own rendering plugin written, you can build it similarly to how the example is built. It may be helpful to look at the [`CMakeLists.txt`](https://github.com/gazebosim/gz-rendering/tree/main/examples/hello_world_plugin) from the example as it contains the boilerplate code needed to get a custom rendering engine plugin built.

After you have your plugin built, you will need to set the `GZ_SIM_RENDER_ENGINE_PATH` environment variable to the path in which your built shared library resides. Note that you will need to do this for every command line instance unless you add the line to your startup shell script (`.bashrc`, `.zshrc`, etc.).
After you have your plugin built, you will need to set the `IGN_GAZEBO_RENDER_ENGINE_PATH` environment variable to the path in which your built shared library resides. Note that you will need to do this for every command line instance unless you add the line to your startup shell script (`.bashrc`, `.zshrc`, etc.).

From here, you should be able to reference your rendering plugin within Gazebo by the name of the generated shared library file (without the `lib` prefix or the file extension, i.e., libHelloWorldPlugin.so -> HelloWorldPlugin).

Expand Down

0 comments on commit a8c9b4c

Please sign in to comment.