https://github.com/davidpl1/mujoco_ros_plugin_template

Template repository to create new MuJoCo ROS plugins
https://github.com/davidpl1/mujoco_ros_plugin_template

mujoco plugin ros simulation template-repository

Last synced: 3 months ago
JSON representation

Template repository to create new MuJoCo ROS plugins

• Host: GitHub
• URL: https://github.com/davidpl1/mujoco_ros_plugin_template
• Owner: DavidPL1
• License: bsd-3-clause
• Created: 2024-07-10T19:48:21.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-10T20:59:23.000Z (about 1 year ago)
• Last Synced: 2025-04-10T21:36:05.277Z (6 months ago)
• Topics: mujoco, plugin, ros, simulation, template-repository
• Language: C++
• Homepage:
• Size: 4.88 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# MuJoCo ROS Plugin Template

This repository serves as a template for creating plugins for MuJoCo ROS. It provides a starting point for developing custom plugins that integrate MuJoCo physics simulation with ROS.

## Customizing the Plugin

To customize the plugin for your specific needs, make the following changes:

- Modify the `src/main.cpp` file:

  - Implement your custom plugin logic here.

  - Optionally rename the file.

- Modify the `config/template_example_config.yaml` file:

  - Modify the example config to showcase configuration options.

  - Rename the file.

- Modify the `CMakeLists.txt` file:

  - Modify the package name and add dependencies as needed.

  - Add any additional compilation flags or options.

  - Add any additional source files and libraries to be compiled.

  - Modify includes and linking as needed.

- Modify the `plugin_template.xml` file:

  - Correct the library name

  - Correct the class name and type

  - Correct the plugin_namespace

  - Correct the description

- Modify the `package.xml` file:

  - Correct the package name and dependencies as needed.

  - Correct maintainers and authors

  - Correct the `plugin_template.xml` filename

- Modify the `launch/mujoco_ros_plugin_template.launch` file:

  - Modify the example launch file with the appropriate parameters and configurations.

## Contributing

Contributions to this template repository are welcome. If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.

## License

This repository is licensed under the [BSD License](LICENSE).