diff --git a/examples/hello_world_plugin/README.md b/examples/hello_world_plugin/README.md index ffc253342..91e5d3469 100644 --- a/examples/hello_world_plugin/README.md +++ b/examples/hello_world_plugin/README.md @@ -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. diff --git a/tutorials/03_rendering_plugins.md b/tutorials/03_rendering_plugins.md index 999a42165..a44760126 100644 --- a/tutorials/03_rendering_plugins.md +++ b/tutorials/03_rendering_plugins.md @@ -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).