diff --git a/README.md b/README.md index 40f6867..0c88330 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/assets/repository-banner.png b/assets/repository-banner.png new file mode 100644 index 0000000..a59d224 Binary files /dev/null and b/assets/repository-banner.png differ diff --git a/assets/repository-icon.png b/assets/repository-icon.png new file mode 100644 index 0000000..9925d00 Binary files /dev/null and b/assets/repository-icon.png differ diff --git a/assets/repository-logo.png b/assets/repository-logo.png new file mode 100644 index 0000000..f6311da Binary files /dev/null and b/assets/repository-logo.png differ diff --git a/docs/schema.md b/docs/schema.md index 4193c96..85f9437 100644 --- a/docs/schema.md +++ b/docs/schema.md @@ -2,7 +2,60 @@ This document describes the schema for HRIStudio robot plugins. -## Overview +## Repository Metadata + +The repository itself is defined by a `repository.json` file with the following structure: + +```json +{ + "id": string, + "name": string, + "description": string?, + "url": string (URL), + "official": boolean, + "author": { + "name": string, + "email": string (email)?, + "url": string (URL)?, + "organization": string? + }, + "maintainers": [ + { + "name": string, + "email": string (email)?, + "url": string (URL)? + } + ]?, + "homepage": string (URL)?, + "license": string, + "defaultBranch": string, + "lastUpdated": string (ISO date), + "trust": "official" | "verified" | "community", + "assets": { + "icon": string?, + "logo": string?, + "banner": string? + }, + "compatibility": { + "hristudio": { + "min": string, + "recommended": string? + }, + "ros2": { + "distributions": string[], + "recommended": string? + }? + }, + "tags": string[], + "stats": { + "downloads": number, + "stars": number, + "plugins": number + }? +} +``` + +## Plugin Schema Each plugin is defined in a JSON file with the following top-level structure: @@ -40,7 +93,7 @@ Each plugin is defined in a JSON file with the following top-level structure: ```json "manufacturer": { "name": string, - "website": string (URL), + "website": string (URL)?, "support": string (URL)? } ``` @@ -61,14 +114,14 @@ Each plugin is defined in a JSON file with the following top-level structure: ```json "assets": { "thumbnailUrl": string, + "logo": string?, "images": { "main": string, "angles": { "front": string?, "side": string?, "top": string? - }, - "dimensions": string? + } }, "model": { "format": "URDF" | "glTF" | "other", @@ -89,8 +142,7 @@ Each plugin is defined in a JSON file with the following top-level structure: }, "capabilities": string[], "maxSpeed": number, - "batteryLife": number, - "payload": number? + "batteryLife": number } ``` diff --git a/plugins/turtlebot3-burger.json b/plugins/turtlebot3-burger.json index f9e8723..e0d13b0 100644 --- a/plugins/turtlebot3-burger.json +++ b/plugins/turtlebot3-burger.json @@ -21,7 +21,7 @@ "assets": { "thumbnailUrl": "assets/turtlebot3-burger/thumb.png", "images": { - "main": "assets/turtlebot3-burger/main.png", + "main": "assets/turtlebot3-burger/main.jpg", "angles": { "front": "assets/turtlebot3-burger/front.png", "side": "assets/turtlebot3-burger/side.png", diff --git a/repository.json b/repository.json index 60cda97..e3e0395 100644 --- a/repository.json +++ b/repository.json @@ -23,6 +23,7 @@ "trust": "official", "assets": { "icon": "assets/repository-icon.png", + "logo": "assets/repository-logo.png", "banner": "assets/repository-banner.png" }, "compatibility": {