soconnor/robot-plugins
1
0
Fork 0
mirror of https://github.com/soconnor0919/robot-plugins.git synced 2025-12-15 08:24:45 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README and schema with repository and plugin asset details

Browse Source
This commit is contained in:
Sean O'Connor
2025-02-13 15:03:07 -05:00
parent 82a680eae8
commit c9e3135564
7 changed files with 69 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -8,6 +8,9 @@ This repository contains robot plugins for use with HRIStudio, a platform for de
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
```
@@ -28,13 +31,18 @@ For each robot plugin, you need:
### 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)
- `assets/{robotId}/dimensions.png` - Technical drawing (optional)
- 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](docs/schema.md) for the complete plugin schema documentation.