@unityclaw/skills 1.0.0

package/unityclaw-image-compress/SKILL.md

@@ -0,0 +1,229 @@
+---
+name: unityclaw-image-compress
+description: Compress images with quality control to reduce file size
+version: 1.0.0
+metadata:
+  openclaw:
+    requires:
+      env:
+        - UNITYCLAW_API_KEY
+      bins:
+        - node
+        - npm
+    primaryEnv: UNITYCLAW_API_KEY
+    emoji: "🗜️"
+    homepage: https://unityclaw.com
+    install:
+      - kind: node
+        package: "@unityclaw/sdk"
+        bins: []
+---
+
+# UnityClaw Image Compress
+
+Compress images to reduce file size while maintaining visual quality.
+
+## Installation
+
+```bash
+npm install @unityclaw/sdk
+```
+
+## Configuration
+
+Set your API key as environment variable:
+
+```bash
+export UNITYCLAW_API_KEY=your-api-key
+```
+
+## Quick Start
+
+```typescript
+import { UnityClawClient } from '@unityclaw/sdk';
+
+const client = new UnityClawClient();
+
+const result = await client.image.compress({
+  attachment: [
+    { tmp_url: 'https://example.com/large-image.jpg', name: 'image.jpg' }
+  ],
+  quality: 80
+});
+
+if (result.code === 0) {
+  console.log('Compressed images:', result.data);
+}
+```
+
+## API Reference
+
+### compress()
+
+Compress one or more images with customizable quality.
+
+```typescript
+await client.image.compress({
+  attachment: AttachmentFieldItem[],
+  quality?: number
+}): Promise<APIResponse<AttachmentResult[]>>
+```
+
+## Parameters
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `attachment` | `AttachmentFieldItem[]` | Yes | Array of images to compress |
+| `quality` | `number` | No | Compression quality (0-100, default: 80) |
+
+### AttachmentFieldItem
+
+```typescript
+interface AttachmentFieldItem {
+  tmp_url: string;    // URL of the image to compress
+  name?: string;      // File name
+  type?: string;      // MIME type (e.g., 'image/jpeg')
+}
+```
+
+## Examples
+
+### Single Image Compression
+
+```typescript
+const client = new UnityClawClient();
+
+const result = await client.image.compress({
+  attachment: [
+    { tmp_url: 'https://example.com/photo.jpg', name: 'photo.jpg', type: 'image/jpeg' }
+  ],
+  quality: 75
+});
+
+if (result.code === 0 && result.data) {
+  const compressedImage = result.data[0];
+  console.log('Compressed URL:', compressedImage.content);
+}
+```
+
+### Batch Compression
+
+```typescript
+const images = [
+  { tmp_url: 'https://example.com/img1.jpg', name: 'img1.jpg' },
+  { tmp_url: 'https://example.com/img2.png', name: 'img2.png' },
+  { tmp_url: 'https://example.com/img3.webp', name: 'img3.webp' }
+];
+
+const result = await client.image.compress({
+  attachment: images,
+  quality: 80
+});
+
+if (result.code === 0 && result.data) {
+  result.data.forEach((img, i) => {
+    console.log(`Image ${i + 1}: ${img.content}`);
+  });
+}
+```
+
+### High Quality Compression
+
+```typescript
+// Preserve more detail (larger file size)
+const result = await client.image.compress({
+  attachment: [{ tmp_url: 'https://...', name: 'photo.jpg' }],
+  quality: 90
+});
+```
+
+### Aggressive Compression
+
+```typescript
+// Smaller file size (more quality loss)
+const result = await client.image.compress({
+  attachment: [{ tmp_url: 'https://...', name: 'photo.jpg' }],
+  quality: 50
+});
+```
+
+### With Generated Images
+
+```typescript
+// Generate then compress
+const generated = await client.image.gemini({
+  prompt: 'A beautiful landscape'
+});
+
+if (generated.code === 0 && generated.data) {
+  const compressed = await client.image.compress({
+    attachment: generated.data.map(img => ({
+      tmp_url: img.content,
+      name: img.name
+    })),
+    quality: 75
+  });
+
+  console.log('Compressed generated images:', compressed.data);
+}
+```
+
+## Response Format
+
+```typescript
+interface AttachmentResult {
+  name: string;
+  contentType: 'attachment/url';
+  content: string;  // URL to compressed image
+}
+```
+
+## Error Handling
+
+```typescript
+const result = await client.image.compress({
+  attachment: [{ tmp_url: 'invalid-url', name: 'test.jpg' }],
+  quality: 80
+});
+
+if (result.code !== 0) {
+  console.error('Compression failed:', result.msg);
+} else {
+  console.log('Success:', result.data);
+}
+```
+
+## Quality Guidelines
+
+| Quality | Use Case | File Size Reduction |
+|---------|----------|---------------------|
+| 90-100 | Print, professional photography | Minimal |
+| 75-89 | Web display, social media | Moderate |
+| 50-74 | Thumbnails, previews | Significant |
+| 0-49 | Aggressive optimization | Maximum |
+
+## Supported Formats
+
+- JPEG/JPG
+- PNG
+- WebP
+- GIF (static)
+
+## Task Folders
+
+Each execution creates a task folder with logs and downloaded attachments:
+
+```typescript
+const result = await client.image.compress({
+  attachment: [{ tmp_url: 'https://...', name: 'image.jpg' }],
+  quality: 80
+});
+
+console.log('Task ID:', result.taskId);
+console.log('Task Folder:', result.taskFolder);
+console.log('Local Attachments:', result.attachments);
+```
+
+## Related Skills
+
+- [unityclaw-image-generation](../unityclaw-image-generation/SKILL.md) - Generate images before compression

package/unityclaw-image-generation/SKILL.md

@@ -0,0 +1,213 @@
+---
+name: unityclaw-image-generation
+description: Generate high-quality images using Gemini or JiMeng (Doubao) models
+version: 1.0.0
+metadata:
+  openclaw:
+    requires:
+      env:
+        - UNITYCLAW_API_KEY
+      bins:
+        - node
+        - npm
+    primaryEnv: UNITYCLAW_API_KEY
+    emoji: "🎨"
+    homepage: https://unityclaw.com
+    install:
+      - kind: node
+        package: "@unityclaw/sdk"
+        bins: []
+---
+
+# UnityClaw Image Generation
+
+Generate high-quality images using Gemini or JiMeng (Doubao) AI models.
+
+## Installation
+
+```bash
+npm install @unityclaw/sdk
+```
+
+## Configuration
+
+Set your API key as environment variable:
+
+```bash
+export UNITYCLAW_API_KEY=your-api-key
+```
+
+## Quick Start
+
+```typescript
+import { UnityClawClient } from '@unityclaw/sdk';
+
+const client = new UnityClawClient();
+
+// Generate image with Gemini
+const result = await client.image.gemini({
+  prompt: 'A beautiful sunset over mountains',
+  aspect_ratio: { value: '16:9', label: '16:9' }
+});
+
+if (result.code === 0) {
+  console.log('Generated images:', result.data);
+}
+```
+
+## Available APIs
+
+### Gemini Image Generation
+
+```typescript
+// Basic usage
+const result = await client.image.gemini({
+  prompt: 'A beautiful sunset over mountains'
+});
+
+// With all options
+const result = await client.image.gemini({
+  prompt: 'A futuristic city at night',
+  attachment: [{ tmp_url: 'https://...', name: 'reference.jpg' }],
+  model: { value: 'gemini-2.0-flash-exp', label: 'Gemini 2.0 Flash' },
+  aspect_ratio: { value: '16:9', label: '16:9' },
+  size: { value: '2K', label: '2K' }
+});
+
+// Gemini V2
+const result = await client.image.geminiV2({
+  prompt: 'An abstract digital art piece',
+  aspect_ratio: { value: '1:1', label: '1:1' }
+});
+```
+
+### JiMeng Image Generation
+
+```typescript
+// Basic usage
+const result = await client.image.jimeng({
+  prompt: '一只可爱的猫咪在花园里玩耍',
+  size: { value: '1024x1024', label: '1:1' }
+});
+
+// With all options
+const result = await client.image.jimeng({
+  prompt: 'A serene Japanese garden in autumn',
+  attachment: [{ tmp_url: 'https://...', name: 'style.jpg' }],
+  size: { value: '1024x1024', label: '1:1' },
+  model_selector: { value: 'general', label: 'General' },
+  web_search: { value: true, label: 'Enable' },
+  image_count: { value: 4, label: '4 images' }
+});
+
+// JiMeng V3
+const result = await client.image.jimengV3({
+  prompt: 'A mystical forest with glowing mushrooms',
+  size: { value: '1024x1024', label: '1:1' }
+});
+```
+
+## Parameter Types
+
+### GeminiImageParams
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `prompt` | `string \| TextFieldItem[]` | Yes | Text description of the image |
+| `attachment` | `AttachmentFieldItem[]` | No | Reference images for style transfer |
+| `model` | `LabelFieldItem` | No | Model selection (default: gemini-2.0-flash-exp) |
+| `aspect_ratio` | `LabelFieldItem` | No | Aspect ratio: `'1:1'`, `'9:16'`, `'16:9'` |
+| `size` | `LabelFieldItem` | No | Resolution: `'1K'`, `'2K'`, `'4K'` |
+
+### JiMengImageParams
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `prompt` | `string \| TextFieldItem[]` | Yes | Text description (supports Chinese) |
+| `attachment` | `AttachmentFieldItem[]` | No | Reference images |
+| `size` | `LabelFieldItem` | Yes | Size: `'1024x1024'` (1:1), `'896x1152'` (9:16), `'1152x896'` (16:9) |
+| `model_selector` | `LabelFieldItem` | No | Model type |
+| `web_search` | `LabelFieldItem` | No | Enable web search for references |
+| `image_count` | `LabelFieldItem \| number` | No | Number of images to generate |
+
+## Examples
+
+### Text-to-Image
+
+```typescript
+const client = new UnityClawClient();
+
+const result = await client.image.gemini({
+  prompt: 'A cyberpunk cityscape with neon lights reflecting on wet streets',
+  aspect_ratio: { value: '16:9', label: '16:9' },
+  size: { value: '2K', label: '2K' }
+});
+
+if (result.code === 0 && result.data) {
+  result.data.forEach((img, i) => {
+    console.log(`Image ${i + 1}: ${img.content}`);
+  });
+}
+```
+
+### Image-to-Image (Style Transfer)
+
+```typescript
+const result = await client.image.gemini({
+  prompt: 'Transform this photo into a watercolor painting style',
+  attachment: [
+    { tmp_url: 'https://example.com/photo.jpg', name: 'photo.jpg' }
+  ],
+  aspect_ratio: { value: '1:1', label: '1:1' }
+});
+```
+
+### Batch Generation
+
+```typescript
+const prompts = [
+  'A serene mountain lake at dawn',
+  'A bustling Tokyo street at night',
+  'An underwater coral reef scene'
+];
+
+const results = await Promise.all(
+  prompts.map(prompt => client.image.gemini({ prompt }))
+);
+
+results.forEach((result, i) => {
+  if (result.code === 0) {
+    console.log(`Prompt ${i + 1}: Success`);
+  }
+});
+```
+
+## Error Handling
+
+```typescript
+const result = await client.image.gemini({ prompt: 'test' });
+
+if (result.code !== 0) {
+  console.error('Error:', result.msg);
+  // Handle error
+} else {
+  console.log('Success:', result.data);
+}
+```
+
+## Task Folders
+
+Each execution creates a task folder:
+
+```typescript
+const result = await client.image.gemini({ prompt: 'test' });
+
+console.log('Task ID:', result.taskId);
+console.log('Task Folder:', result.taskFolder);
+console.log('Attachments:', result.attachments);
+```
+
+## Related Skills
+
+- [unityclaw-image-compress](../unityclaw-image-compress/SKILL.md) - Compress generated images
+- [unityclaw-video-generation-sora](../unityclaw-video-generation-sora/SKILL.md) - Generate videos with Sora