Contributors
Want to contribute?
Check out the repo and open a PR. We welcome contributions of all kinds.
How to contribute
The project lives on GitHub at theexperiencecompany/keyloom. The fastest paths in:
- Open an issue describing the component you want — include a reference image or short loom if you have one.
- Send a PR for a new scene by following the structure of an existing simple scene (
StatCounteris the easiest reference). - Improve docs — every page is an MDX file in
apps/web/content/docs/.
Adding a new scene
Every scene needs to be wired through six sync points, all in the same change:
apps/remotion/src/compositions/<Name>/<Name>.tsx— the React component.apps/remotion/src/compositions/<Name>/meta.ts— theCompositionInfo(id, dimensions, defaultProps, inspector fields).apps/remotion/src/registry.ts— add the info to thecompositionsarray.apps/remotion/src/componentsBase.ts— add the component to the lookup map.apps/web/content/docs/<kebab-name>.mdx— the docs page (mirror an existing one).apps/web/lib/docs.ts— import the MDX and add to thedocsarray.
Every scene accepts the universal clipStyle prop (background, text color, font and accent) and reads it through resolveClipStyle(clipStyle, defaults). A scene that imitates a real product such as Twitter, GitHub or WhatsApp passes the brand's real colors and font as those defaults. It then matches the brand until a user overrides a control.
Maintainers
Keyloom is built and maintained by The Experience Company. It's part of GAIA — the personal AI assistant.