add-sfx_skill

Overview

This skill adds a new sound effect to @remotion/sfx so it becomes available for programmatic video projects. It guides you through required prerequisites, how to add the audio asset and export, and the documentation and build steps needed to ship the sound effect. Follow the checklist to ensure consistent naming, licensing, and metadata.

How this skill works

The skill verifies that the WAV file exists in the remotion.media source-of-truth and then adds a public export URL to the @remotion/sfx package. It creates or updates documentation pages, sidebar entries, a table-of-contents entry with a playable preview, and the skills rules file. Finally, it builds the sfx package and increments the docs availability version where required.

When to use it

• You have a CC0 WAV sound effect normalized to peak at -3dB ready for distribution.
• You need the sound hosted in remotion.media before adding it to @remotion/sfx.
• You want consistent docs and preview playback for new sfx assets.
• You must register the asset in site navigation and the skills rules list.

Best practices

• Add the WAV to remotion.media first; that repo is the single source of truth.
• Use WAV format, CC0 license, and normalize peaks to -3dB before upload.
• Name exports in camelCase and avoid JavaScript reserved words (e.g., use uiSwitch instead of switch).
• Add a docs page with frontmatter, <AvailableFrom> incremented by one patch, a PlayButton, duration, attribution and example code.
• Add the new item to the docs sidebar, sfx table of contents, and the skills rules list before building.
• Use the current version from core version.ts when setting availability and build after all changes.

Example use cases

• Add a UI click or ambient effect to programmatic video templates.
• Provide a licensing-compliant library of SFX for community contributors.
• Ship a new sfx asset with playback demo and usage snippet for creators.
• Register a bulk of new sounds while keeping docs, navigation and build artifacts in sync.