diff --git a/.agents/plugins/marketplace.json b/.agents/plugins/marketplace.json index f632ecd5..de3fdd55 100644 --- a/.agents/plugins/marketplace.json +++ b/.agents/plugins/marketplace.json @@ -337,6 +337,18 @@ "authentication": "ON_INSTALL" }, "category": "Coding" + }, + { + "name": "remotion", + "source": { + "source": "local", + "path": "./plugins/remotion" + }, + "policy": { + "installation": "AVAILABLE", + "authentication": "ON_INSTALL" + }, + "category": "Design" } ] } diff --git a/README.md b/README.md index 2e68e165..9f67f94c 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,4 @@ Highlighted richer examples in this repo include: - `plugins/build-ios-apps` for SwiftUI implementation, refactors, performance, and debugging - `plugins/build-macos-apps` for macOS SwiftUI/AppKit workflows, build/run/debug loops, and packaging guidance - `plugins/build-web-apps` for deployment, UI, payments, and database workflows -- `plugins/netlify`, `plugins/render`, and `plugins/google-slides` for additional public skill- and MCP-backed plugin bundles +- `plugins/netlify`, `plugins/remotion`, and `plugins/google-slides` for additional public skill- and MCP-backed plugin bundles diff --git a/plugins/remotion/.codex-plugin/plugin.json b/plugins/remotion/.codex-plugin/plugin.json new file mode 100644 index 00000000..4d2caed1 --- /dev/null +++ b/plugins/remotion/.codex-plugin/plugin.json @@ -0,0 +1,44 @@ +{ + "name": "remotion", + "version": "1.0.0", + "description": "Remotion video creation skills — best practices, animations, audio, captions, 3D, and more for building programmatic videos with React.", + "author": { + "name": "Remotion", + "email": "hi@remotion.dev", + "url": "https://remotion.dev" + }, + "homepage": "https://remotion.dev", + "repository": "https://github.com/remotion-dev/remotion", + "license": "MIT", + "keywords": [ + "remotion", + "video", + "react", + "animation", + "composition", + "rendering", + "ffmpeg", + "captions", + "audio" + ], + "skills": "./skills/", + "interface": { + "displayName": "Remotion", + "shortDescription": "Create motion graphics from prompts", + "longDescription": "Build videos programmatically with Remotion and React. Covers animations, timing, audio, captions, 3D, transitions, charts, text effects, and more.", + "developerName": "Remotion", + "category": "Design", + "capabilities": ["Read", "Write"], + "websiteURL": "https://remotion.dev", + "privacyPolicyURL": "https://remotion.pro/privacy", + "termsOfServiceURL": "https://remotion.pro/terms", + "defaultPrompt": [ + "Create an animated chart with 5 bars", + "Make an animated call-to-action subscribe button for our YouTube channel", + "Use Remotion to add captions and audio to a video composition." + ], + "brandColor": "#0B84F3", + "composerIcon": "./assets/icon.png", + "logo": "./assets/logo.png" + } +} diff --git a/plugins/remotion/README.md b/plugins/remotion/README.md new file mode 100644 index 00000000..97e719de --- /dev/null +++ b/plugins/remotion/README.md @@ -0,0 +1,34 @@ +# @remotion/codex-plugin + +OpenAI Codex plugin that packages [Remotion](https://remotion.dev) skills for AI-assisted video creation. + +## Building + +```bash +bun build.mts +``` + +This copies skills from `packages/skills/skills/` into the `skills/` directory in the Codex plugin format. + +## Installation + +See the [official OpenAI Codex plugin docs](https://developers.openai.com/codex/plugins/build) for how to install and test plugins locally. + +## Plugin structure + +``` +.codex-plugin/ + plugin.json # Plugin manifest +skills/ + remotion/ # Remotion best practices (animations, audio, etc.) + SKILL.md + rules/*.md +``` + +## Contributing + +This repository is a mirror of [`packages/codex-plugin`](https://github.com/remotion-dev/remotion/tree/main/packages/codex-plugin) in the [Remotion monorepo](https://github.com/remotion-dev/remotion), which is the source of truth. Please send contributions there. + +## Skills included + +- **remotion** — Best practices for video creation with Remotion and React. Covers project setup, animations, timing, audio, captions, 3D, transitions, charts, text effects, fonts, and 30+ more topics. diff --git a/plugins/remotion/assets/icon.png b/plugins/remotion/assets/icon.png new file mode 100644 index 00000000..ec599a98 Binary files /dev/null and b/plugins/remotion/assets/icon.png differ diff --git a/plugins/remotion/assets/logo.png b/plugins/remotion/assets/logo.png new file mode 100644 index 00000000..ec599a98 Binary files /dev/null and b/plugins/remotion/assets/logo.png differ diff --git a/plugins/remotion/skills/remotion/SKILL.md b/plugins/remotion/skills/remotion/SKILL.md new file mode 100644 index 00000000..84679e27 --- /dev/null +++ b/plugins/remotion/skills/remotion/SKILL.md @@ -0,0 +1,95 @@ +--- +name: remotion-best-practices +description: Best practices for Remotion - Video creation in React +metadata: + tags: remotion, video, react, animation, composition +--- + +## When to use + +Use this skills whenever you are dealing with Remotion code to obtain the domain-specific knowledge. + +## New project setup + +When in an empty folder or workspace with no existing Remotion project, scaffold one using: + +```bash +npx create-video@latest --yes --blank --no-tailwind my-video +``` + +Replace `my-video` with a suitable project name. + +## Starting preview + +Start the Remotion Studio to preview a video: + +```bash +npx remotion studio +``` + +## Optional: one-frame render check + +You can render a single frame with the CLI to sanity-check layout, colors, or timing. +Skip it for trivial edits, pure refactors, or when you already have enough confidence from Studio or prior renders. + +```bash +npx remotion still [composition-id] --scale=0.25 --frame=30 +``` + +At 30 fps, `--frame=30` is the one-second mark (`--frame` is zero-based). + +## Captions + +When dealing with captions or subtitles, load the [./rules/subtitles.md](./rules/subtitles.md) file for more information. + +## Using FFmpeg + +For some video operations, such as trimming videos or detecting silence, FFmpeg should be used. Load the [./rules/ffmpeg.md](./rules/ffmpeg.md) file for more information. + +## Silence detection + +When needing to detect and trim silent segments from video or audio files, load the [./rules/silence-detection.md](./rules/silence-detection.md) file. + +## Audio visualization + +When needing to visualize audio (spectrum bars, waveforms, bass-reactive effects), load the [./rules/audio-visualization.md](./rules/audio-visualization.md) file for more information. + +## Sound effects + +When needing to use sound effects, load the [./rules/sfx.md](./rules/sfx.md) file for more information. + +## How to use + +Read individual rule files for detailed explanations and code examples: + +- [rules/3d.md](rules/3d.md) - 3D content in Remotion using Three.js and React Three Fiber +- [rules/animations.md](rules/animations.md) - Fundamental animation skills for Remotion +- [rules/assets.md](rules/assets.md) - Importing images, videos, audio, and fonts into Remotion +- [rules/audio.md](rules/audio.md) - Using audio and sound in Remotion - importing, trimming, volume, speed, pitch +- [rules/calculate-metadata.md](rules/calculate-metadata.md) - Dynamically set composition duration, dimensions, and props +- [rules/can-decode.md](rules/can-decode.md) - Check if a video can be decoded by the browser using Mediabunny +- [rules/charts.md](rules/charts.md) - Chart and data visualization patterns for Remotion (bar, pie, line, stock charts) +- [rules/compositions.md](rules/compositions.md) - Defining compositions, stills, folders, default props and dynamic metadata +- [rules/extract-frames.md](rules/extract-frames.md) - Extract frames from videos at specific timestamps using Mediabunny +- [rules/fonts.md](rules/fonts.md) - Loading Google Fonts and local fonts in Remotion +- [rules/get-audio-duration.md](rules/get-audio-duration.md) - Getting the duration of an audio file in seconds with Mediabunny +- [rules/get-video-dimensions.md](rules/get-video-dimensions.md) - Getting the width and height of a video file with Mediabunny +- [rules/get-video-duration.md](rules/get-video-duration.md) - Getting the duration of a video file in seconds with Mediabunny +- [rules/gifs.md](rules/gifs.md) - Displaying GIFs synchronized with Remotion's timeline +- [rules/images.md](rules/images.md) - Embedding images in Remotion using the Img component +- [rules/light-leaks.md](rules/light-leaks.md) - Light leak overlay effects using @remotion/light-leaks +- [rules/lottie.md](rules/lottie.md) - Embedding Lottie animations in Remotion +- [rules/measuring-dom-nodes.md](rules/measuring-dom-nodes.md) - Measuring DOM element dimensions in Remotion +- [rules/measuring-text.md](rules/measuring-text.md) - Measuring text dimensions, fitting text to containers, and checking overflow +- [rules/sequencing.md](rules/sequencing.md) - Sequencing patterns for Remotion - delay, trim, limit duration of items +- [rules/tailwind.md](rules/tailwind.md) - Using TailwindCSS in Remotion +- [rules/text-animations.md](rules/text-animations.md) - Typography and text animation patterns for Remotion +- [rules/timing.md](rules/timing.md) - Timing with interpolate and Bézier easing, springs +- [rules/transitions.md](rules/transitions.md) - Scene transition patterns for Remotion +- [rules/transparent-videos.md](rules/transparent-videos.md) - Rendering out a video with transparency +- [rules/trimming.md](rules/trimming.md) - Trimming patterns for Remotion - cut the beginning or end of animations +- [rules/videos.md](rules/videos.md) - Embedding videos in Remotion - trimming, volume, speed, looping, pitch +- [rules/parameters.md](rules/parameters.md) - Make a video parametrizable by adding a Zod schema +- [rules/maps.md](rules/maps.md) - Add a map using Mapbox and animate it +- [rules/silence-detection.md](rules/silence-detection.md) - Adaptive silence detection using FFmpeg loudnorm and silencedetect +- [rules/voiceover.md](rules/voiceover.md) - Adding AI-generated voiceover to Remotion compositions using ElevenLabs TTS diff --git a/plugins/remotion/skills/remotion/rules/3d.md b/plugins/remotion/skills/remotion/rules/3d.md new file mode 100644 index 00000000..c9d254f1 --- /dev/null +++ b/plugins/remotion/skills/remotion/rules/3d.md @@ -0,0 +1,86 @@ +--- +name: 3d +description: 3D content in Remotion using Three.js and React Three Fiber. +metadata: + tags: 3d, three, threejs +--- + +# Using Three.js and React Three Fiber in Remotion + +Follow React Three Fiber and Three.js best practices. +Only the following Remotion-specific rules need to be followed: + +## Prerequisites + +First, the `@remotion/three` package needs to be installed. +If it is not, use the following command: + +```bash +npx remotion add @remotion/three # If project uses npm +bunx remotion add @remotion/three # If project uses bun +yarn remotion add @remotion/three # If project uses yarn +pnpm exec remotion add @remotion/three # If project uses pnpm +``` + +## Using ThreeCanvas + +You MUST wrap 3D content in `` and include proper lighting. +`` MUST have a `width` and `height` prop. + +```tsx +import { ThreeCanvas } from "@remotion/three"; +import { useVideoConfig } from "remotion"; + +const { width, height } = useVideoConfig(); + + + + + + + + +; +``` + +## No animations not driven by `useCurrentFrame()` + +Shaders, models etc MUST NOT animate by themselves. +No animations are allowed unless they are driven by `useCurrentFrame()`. +Otherwise, it will cause flickering during rendering. + +Using `useFrame()` from `@react-three/fiber` is forbidden. + +## Animate using `useCurrentFrame()` + +Use `useCurrentFrame()` to perform animations. + +```tsx +const frame = useCurrentFrame(); +const rotationY = frame * 0.02; + + + + +; +``` + +## Using `` inside `` + +The `layout` prop of any `` inside a `` must be set to `none`. + +```tsx +import { Sequence } from "remotion"; +import { ThreeCanvas } from "@remotion/three"; + +const { width, height } = useVideoConfig(); + + + + + + + + +; +``` diff --git a/plugins/remotion/skills/remotion/rules/animations.md b/plugins/remotion/skills/remotion/rules/animations.md new file mode 100644 index 00000000..4a02e553 --- /dev/null +++ b/plugins/remotion/skills/remotion/rules/animations.md @@ -0,0 +1,31 @@ +--- +name: animations +description: Fundamental animation skills for Remotion +metadata: + tags: animations, transitions, frames, useCurrentFrame +--- + +All animations MUST be driven by the `useCurrentFrame()` hook. +Write animations in seconds and multiply them by the `fps` value from `useVideoConfig()`. + +For eased motion, prefer `interpolate` with explicit frame ranges and an easing—especially `Easing.bezier`, which matches CSS `cubic-bezier` so timing can be shared with web specs and curve editors. See [timing](./timing.md). + +```tsx +import { useCurrentFrame, Easing } from "remotion"; + +export const FadeIn = () => { + const frame = useCurrentFrame(); + const { fps } = useVideoConfig(); + + const opacity = interpolate(frame, [0, 2 * fps], [0, 1], { + extrapolateRight: "clamp", + extrapolateLeft: "clamp", + easing: Easing.bezier(0.16, 1, 0.3, 1), + }); + + return
Hello World!
; +}; +``` + +CSS transitions or animations are FORBIDDEN - they will not render correctly. +Tailwind animation class names are FORBIDDEN - they will not render correctly. diff --git a/plugins/remotion/skills/remotion/rules/assets.md b/plugins/remotion/skills/remotion/rules/assets.md new file mode 100644 index 00000000..a5d40152 --- /dev/null +++ b/plugins/remotion/skills/remotion/rules/assets.md @@ -0,0 +1,78 @@ +--- +name: assets +description: Importing images, videos, audio, and fonts into Remotion +metadata: + tags: assets, staticFile, images, fonts, public +--- + +# Importing assets in Remotion + +## The public folder + +Place assets in the `public/` folder at your project root. + +## Using staticFile() + +You MUST use `staticFile()` to reference files from the `public/` folder: + +```tsx +import { Img, staticFile } from "remotion"; + +export const MyComposition = () => { + return ; +}; +``` + +The function returns an encoded URL that works correctly when deploying to subdirectories. + +## Using with components + +**Images:** + +```tsx +import { Img, staticFile } from "remotion"; + +; +``` + +**Videos:** + +```tsx +import { Video } from "@remotion/media"; +import { staticFile } from "remotion"; + +