Helios Studio
The Helios Studio is a Vite-based development server and preview environment. It provides a hot-reloading environment for building compositions and acts as the "Editor" interface for Helios projects.
Quick Start
Run the studio from your project root:
npx @helios-project/cli studio
This will start a local server (typically at http://localhost:5173) where you can view and debug your composition.
Features
Playback & Preview
- Interactive Timeline: Scrub through your animation frame-by-frame.
- Hot Reloading: Preserves timeline state (current frame) when you edit code.
- Audio Controls: Volume slider and Mute toggle.
- Safe Area Guides: Toggle Action/Title Safe guides and Crosshair.
- Keyboard Shortcuts:
Space: Play/Pause
Arrow Left/Right: Step 1 frame
Shift + Arrow: Step 10 frames
Home: Seek to start
I / O: Set In / Out points (Playback Range)
L: Toggle Loop
MCP Server
The Studio runs a Model Context Protocol (MCP) server, allowing AI agents to:
- Inspect composition schemas.
- Update input props.
- Trigger renders.
- Create new compositions.
Props Editor
The Props Editor generates a UI based on your HeliosSchema.
- Groups: Organize props into collapsible sections using the
group schema property.
- Schema-Aware Inputs:
number: Slider (if min/max set), Stepped Slider (if step set).
color: Color picker.
boolean: Toggle switch.
string: Text input or Enum dropdown.
image, video, audio, font: Asset selector with preview.
model: 3D Model selector (.glb, .gltf).
json: JSON file selector.
shader: Shader file selector (.glsl).
- Recursive Support: Generates nested UIs for
object and array types.
- Drag & Drop: Drag assets from the Assets Panel directly into compatible inputs.
- Metadata Editing: Click "Edit Composition" to change Width, Height, FPS, and Duration.
Assets Management
- Assets Panel: View and manage files in your
assets/ directory.
- Upload: Drag & drop files onto the panel to upload them.
- Previews: Rich previews for video (hover-play), audio, fonts, and images.
- Supported Types:
- Images: jpg, png, svg, webp
- Audio: mp3, wav, ogg
- Video: mp4, webm
- 3D: glb, gltf
- Data: json
- Shaders: glsl, vert, frag
Render Management
- Renders Panel: Trigger server-side renders directly from the UI.
- Configuration: Select format (MP4/WebM), resolution, and codec.
- Progress: Track render progress and cancel jobs if needed.
- Persistent Jobs: Render history persists across server restarts.
- Client-Side Export: Export directly from the browser using WebCodecs.
Environment Variables
Common Issues
- Port in Use: If 5173 is taken, Vite will try the next available port. Check the terminal output.
- File Not Found: Ensure your composition HTML file exists in the directory or subdirectories of the root.
Source Files
- CLI Command:
packages/cli/src/commands/studio.ts
- Studio App:
packages/studio/
1---2name: helios-studio-23description: Studio tool for developing and previewing Helios compositions. Use when you want to launch the interactive development environment or manage assets.4metadata:5 source: https://skillmd.com/skills/bintzgavin/helios-studio-26---78# Helios Studio910The Helios Studio is a Vite-based development server and preview environment. It provides a hot-reloading environment for building compositions and acts as the "Editor" interface for Helios projects.1112## Quick Start1314Run the studio from your project root:1516```bash17npx @helios-project/cli studio18```1920This will start a local server (typically at `http://localhost:5173`) where you can view and debug your composition.2122## Features2324### Playback & Preview25- **Interactive Timeline:** Scrub through your animation frame-by-frame.26- **Hot Reloading:** Preserves timeline state (current frame) when you edit code.27- **Audio Controls:** Volume slider and Mute toggle.28- **Safe Area Guides:** Toggle Action/Title Safe guides and Crosshair.29- **Keyboard Shortcuts:**30 - `Space`: Play/Pause31 - `Arrow Left/Right`: Step 1 frame32 - `Shift + Arrow`: Step 10 frames33 - `Home`: Seek to start34 - `I` / `O`: Set In / Out points (Playback Range)35 - `L`: Toggle Loop3637### MCP Server38The Studio runs a Model Context Protocol (MCP) server, allowing AI agents to:39- Inspect composition schemas.40- Update input props.41- Trigger renders.42- Create new compositions.4344### Props Editor45The Props Editor generates a UI based on your `HeliosSchema`.4647- **Groups:** Organize props into collapsible sections using the `group` schema property.48- **Schema-Aware Inputs:**49 - `number`: Slider (if min/max set), Stepped Slider (if step set).50 - `color`: Color picker.51 - `boolean`: Toggle switch.52 - `string`: Text input or Enum dropdown.53 - `image`, `video`, `audio`, `font`: Asset selector with preview.54 - `model`: 3D Model selector (.glb, .gltf).55 - `json`: JSON file selector.56 - `shader`: Shader file selector (.glsl).57 - **Recursive Support:** Generates nested UIs for `object` and `array` types.58- **Drag & Drop:** Drag assets from the Assets Panel directly into compatible inputs.59- **Metadata Editing:** Click "Edit Composition" to change Width, Height, FPS, and Duration.6061### Assets Management62- **Assets Panel:** View and manage files in your `assets/` directory.63- **Upload:** Drag & drop files onto the panel to upload them.64- **Previews:** Rich previews for video (hover-play), audio, fonts, and images.65- **Supported Types:**66 - Images: jpg, png, svg, webp67 - Audio: mp3, wav, ogg68 - Video: mp4, webm69 - 3D: glb, gltf70 - Data: json71 - Shaders: glsl, vert, frag7273### Render Management74- **Renders Panel:** Trigger server-side renders directly from the UI.75- **Configuration:** Select format (MP4/WebM), resolution, and codec.76- **Progress:** Track render progress and cancel jobs if needed.77- **Persistent Jobs:** Render history persists across server restarts.78- **Client-Side Export:** Export directly from the browser using WebCodecs.7980## Environment Variables8182- `HELIOS_PROJECT_ROOT`: Override the root directory scanning path.83 ```bash84 HELIOS_PROJECT_ROOT=./my-project npx @helios-project/cli studio85 ```8687## Common Issues8889- **Port in Use:** If 5173 is taken, Vite will try the next available port. Check the terminal output.90- **File Not Found:** Ensure your composition HTML file exists in the directory or subdirectories of the root.9192## Source Files9394- CLI Command: `packages/cli/src/commands/studio.ts`95- Studio App: `packages/studio/`