robot-plugins/README.md

HRIStudio Robot Plugins

This repository contains robot plugins for use with HRIStudio, a platform for designing and executing human-robot interaction experiments.

Repository Structure

robot-plugins/
├── plugins/         # Robot plugin definitions (JSON)
├── assets/         # Robot images and 3D models
│   ├── repository-icon.png  # Repository icon (256x256px)
│   ├── repository-logo.png  # Repository logo (512x512px)
│   ├── repository-banner.png  # Repository banner (optional)
│   └── {robotId}/  # Assets for each robot
└── docs/           # Plugin documentation

Adding a New Robot Plugin

1. Create a new JSON file in the plugins directory with your robot's plugin definition
2. Add required assets to the assets/{robotId} directory
3. Update documentation if needed
4. Submit a pull request

Required Files

For each robot plugin, you need:

Plugin Definition

• plugins/{robotId}.json - Plugin configuration file

Assets

• assets/{robotId}/thumb.png - Thumbnail image (160x160px)
• assets/{robotId}/logo.png - Robot logo (512x512px, transparent background)
• assets/{robotId}/main.png - Main image (16:9 aspect ratio)
• Additional views (optional):
  • assets/{robotId}/front.png
  • assets/{robotId}/side.png
  • assets/{robotId}/top.png

Repository Assets

• assets/repository-icon.png - Repository icon (256x256px, square)
• assets/repository-logo.png - Repository logo (512x512px, transparent background)
• assets/repository-banner.png - Repository banner (optional, 1280x640px)

Plugin Schema

See docs/schema.md for the complete plugin schema documentation.

Example Plugin

See the TurtleBot3 Burger plugin (plugins/turtlebot3-burger.json) for a complete example.

Contributing

1. Fork this repository
2. Create your plugin following the structure above
3. Test your plugin with HRIStudio
4. Submit a pull request

License

MIT License - See LICENSE file for details