Communitygithub.com

sandeshrajbhandari/hyperframes-instruct

Le contrat de composition HyperFrames — construisez un projet rendable. À utiliser pour la structure de composition, les attributs `data-*` de timing, `class="clip"`, les pistes, les sous-compositions, les variables, la lecture multimédia gérée par le framework, les règles de rendu déterministe et la validation. À lire avant d'écrire du HTML de composition.

Qu'est-ce que hyperframes-instruct ?

Ce skill définit le contrat technique fondamental pour construire des projets HyperFrames, un framework qui transforme du HTML en vidéo en utilisant des attributs `data-*` pour déclarer le timing et une timeline seekable. Il couvre en détail la structure de composition (standalone vs. sous-composition), les règles de nommage et de dimensionnement, les attributs de timing, les pistes et clips, les variables, la lecture multimédia gérée par le framework, et les règles de rendu déterministe (pas d'horloges temps réel, de `Math.random` non seedé ou de réseau). Une section importante est dédiée aux pièges à éviter pour les agents : conflits entre transformations CSS et tweens GSAP, mauvaise gestion de la visibilité des clips, règles de transport des sous-compositions, et validation par `npx hyperframes check`. Des références vers des fichiers détaillés (`references/`) sont fournies pour chaque aspect. Le skill est conçu pour les assistants IA comme Claude Code, Cursor ou Codex, afin de garantir que le code généré soit conforme et évite les erreurs silencieuses.

Compatible avec~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/sandeshrajbhandari/hyperframes-instruct/tree/HEAD/.agents/skills/hyperframes-core

Demander à votre IA préférée

Ouvre une nouvelle conversation avec cette compétence d'agent déjà préchargée.

Documentation

Installation du plugin : Avant les commandes de configuration ou de mise à jour, suivez les règles d'installation du plugin lorsque cette compétence se trouve à l'intérieur d'un plugin HyperFrames. Les installations autonomes conservent les instructions de mise à jour ci-dessous.

HyperFrames Core

Pièges pour les agents (à lire en premier) :

  • Centrer avec flex/inset, pas avec CSS transform: translate(-50%,-50%) sur un nœud que vous animez ensuite avec GSAP x/y. Linter : gsap_css_transform_conflict. Utilisez fromTo ou xPercent/yPercent.
  • N'ajoutez pas de tl.set(..., {visibility:"hidden"}) en sortie de scène. Le runtime cache déjà les clips temporisés. Les fondus d'opacité sur les nœuds internes (ou opacity sur .clip) sont suffisants. Les arrêts bruts de légende sont une règle différente.
  • window.__timelines["id"] doit correspondre au data-composition-id racine.
  • Après render, lisez la deuxième ligne du résumé : beginframe vs screenshot, mode GPU, timings d'étape. screenshot + software gpu sur Linux est le chemin lent.

HyperFrames rend une vidéo à partir d'HTML. Une composition est un fichier HTML dont le DOM déclare le timing avec des attributs data-*, dont le runtime d'animation est seekable, et dont la lecture multimédia est gérée par le framework.

Cette compétence est le contrat technique — comment construire un projet hyperframes. Le corps ci-dessous est le guide de construction ; les détails par sujet se trouvent dans references/ (index ci-dessous), à lire à la demande. Les documents de processus (brief, storyboard, review, production, dispatch, frame-worker) se trouvent dans /hyperframes → references/. Les autres préoccupations se trouvent dans les compétences de domaine sœurs — hyperframes-animation, hyperframes-creative, media-use, hyperframes-cli, hyperframes-registry. La carte des capacités dans /hyperframes indique ce que chacune couvre.

Références

FichierLisez-le pour…
references/minimal-composition.mddémarrer à partir du plus petit squelette de composition rendable
references/composition-patterns.mdchoisir entre monolithique et modulaire ; structurer un index.html modulaire ; choisir un archétype de sous-comp
references/data-attributes.mdrechercher n'importe quel attribut data-* (racine / clip / hôte de sous-comp / alias hérités) ; utiliser class="clip"
references/tracks-and-clips.mdcomprendre ce que data-track-index contrôle (et ne contrôle pas), le z-index, temporiser un clip par rapport à un autre ; lister chaque piste et clip avec npx hyperframes timeline
references/creator-editing-recipes.mdcopier des recettes d'édition (couper/rogner/réorganiser/retemporiser/geler/caméra/masque/fondu enchaîné/audio) fiables et leurs limites
references/sub-compositions.mdcâbler une sous-composition (attributs hôte, <template>, variables par instance) et animer à l'intérieur
references/variables-and-media.mddéclarer des variables ; placer <video>/<audio>, régler le volume, rogner
references/determinism-rules.mdconstruire une timeline seekable ; interdictions de déterminisme ; disposition / ajustement du texte
references/full-screen-motion.mdcréer un mouvement plein écran avec des arrière-plans partagés
references/tailwind.mdtravailler dans un projet Tailwind v4 (init --tailwind ; le contrat d'exécution diffère de la v3 de Studio)

Pour les spécificités du runtime d'animation (API GSAP, Lottie, Three.js, etc.), consultez hyperframes-animation → adapters/<runtime>.md.

Construire une composition

Deux formes racines (non interchangeables)

  • Autonome (index.html de premier niveau) : <div data-composition-id="…"> racine se trouve directement dans <body>, pas de wrapper <template>. Envelopper une racine autonome cache tout le contenu et lint le rejette (standalone_composition_wrapped_in_template, erreur).
  • Sous-composition (chargée via data-composition-src) : enveloppez la racine dans <template>. C'est la forme à écrire : le chargeur accepte aussi un document complet normal et se rabat sur son <body>, mais la forme avec template est celle que supposent les exemples et les outils.

⚠ Règle de transport : pour une sous-composition avec template, l'assembleur supprime les propres <head> <style>/<script> du fichier (packages/core/src/compiler/compositionAssembly.ts, la porte hasTemplate), donc mettez <style>/<script> à l'intérieur du template. <link> est remonté de toute façon. ⚠ Convention d'ID hôte : donnez à l'emplacement hôte, au template interne et à la clé window.__timelines["<id>"] le même id. Un id local différent est supporté (l'assembleur se rabat sur la première racine du fichier) mais l'inadéquation est silencieuse, donc faites-les correspondre sauf si vous avez une raison de ne pas le faire.

Forme du fichier, câblage hôte et liste de contrôle pré-rendu → references/sub-compositions.md.

La racine doit être dimensionnée (bogue de disposition silencieux)

La racine autonome définit width/height: 100%. La taille du canevas est data-width/data-height. Le runtime colle ces pixels sur la racine de la composition. Ne codez pas en dur 1920px/1080px sur #root. Squelette → references/minimal-composition.md.

Une timeline en pause

Chaque composition enregistre exactement une gsap.timeline({ paused: true }) à window.__timelines["<id>"] (clé = data-composition-id racine). Le construire dans un callback asynchrone (document.fonts.ready) est supporté ; ce qui compte est que vous enregistrez seulement après la fin de la construction. La durée du rendu est le data-duration racine, pas la longueur de la timeline : une timeline qui dépasse est coupée, et une qui se termine tôt conserve sa dernière image. Omettez data-duration racine et la durée est inférée à la place (timeline, fenêtre média ou adaptateur). Vous n'avez pas besoin de window.__timelines = window.__timelines || {} : le runtime crée le registre avant que vos scripts en ligne ne s'exécutent, et lint ne le demande plus. N'imbriquez pas manuellement de sous-timelines dans l'hôte ; le runtime auto-imbrique les timelines enfants enregistrées. Contrat complet (incl. runtimes non GSAP) → references/determinism-rules.md + hyperframes-animation/adapters/.

Pièges de lint de premier passage (un premier échec de construction garanti)

Règles que lint attrape, mais seulement après coup. Écrivez-les correctement du premier coup :

  • Ne couplez jamais un transform CSS initial avec une tween GSAP sur la même propriété — la valeur CSS et le début de la tween se battent et lint le rejette avec gsap_css_transform_conflict. Définissez l'état initial dans la tween avec gsap.fromTo(el, { x: -40 }, { x: 0 }) au lieu d'un transform: translateX(-40px) CSS.
  • Ne mettez jamais crossorigin sur <video>/<audio>. lint le rejette inconditionnellement avec media_crossorigin_breaks_preview (erreur), y compris pour la lecture canvas/WebGL/WebAudio. Il n'y a pas de suppression.
  • Ne donnez jamais à un <video data-start> un ancêtre qui porte aussi data-start. lint le rejette avec video_nested_in_timed_element (erreur). Mettez le timing sur le wrapper ou la vidéo, pas les deux.
  • Chaque <audio> a besoin d'un id. lint le rejette avec media_missing_id, et un <audio> sans id n'est jamais récupéré par le mixeur, donc le rendu est silencieux.
  • Ne tweenez jamais un .clip avec autoAlpha ou visibility — lint le rejette avec gsap_animates_clip_element. Animez un enfant à la place.
  • Une font-family CSS nommée a besoin d'un @font-face dans le fichier pointant vers un fichier local livré, ou lint déclenche font_family_without_font_face.
  • La sous-composition #root utilise width/height: 100% (ou inset: 0), pas du 1920px/1080px codé en dur. La taille du canevas est data-width/data-height.

Une erreur de lint désactive aussi les audits de disposition et de contraste : check rapporte alors 0 sample(s) et 0/0 text checks, ce qui ressemble à un fichier propre mais signifie que rien n'a été exécuté. Nettoyez les erreurs de lint avant de faire confiance à ces chiffres.

Règles non négociables (bogues silencieux que les portes automatisées peuvent manquer)

Signalées ici ; justification complète dans la référence liée. Ne violez pas :

  • Pas d'horloges de rendu temps réel / Math.random non seedé / réseau / état d'entrée ; repeat: -1 seulement sous un data-duration racine fini (exportez des clips vers lui — sinon utilisez un nombre fini). → determinism-rules.md
  • Ne tweenez jamais display, visibility, ou autoAlpha sur un élément .clip. Le framework gère la visibilité des clips, et lint le rejette (gsap_animates_clip_element). Animez un enfant à la place. → determinism-rules.md
  • Pas de <br> dans le texte du corps ; les éléments transformés doivent être de niveau bloc + dimensionnés ; les décoratifs absolus pulsés ont besoin de dégagement de crête. → determinism-rules.md
  • <video>/<audio> sont trouvés par une requête plate du document, donc le framework les cherche et les décode à n'importe quelle profondeur d'imbrication (y compris à l'intérieur d'un <template> ou wrapper de sous-comp). Une limite dure : lint signale une erreur si un <video data-start> se trouve à l'intérieur d'un autre élément simple qui a aussi data-start, et l'échec est réel (mauvaises images source, puis le clip disparaît mi-chemin), donc mettez le timing sur le wrapper ou sur la vidéo, jamais les deux. Les hôtes de sous-composition sont exemptés : le média à l'intérieur d'une sous-composition est rendu correctement. L'autre mise en garde concerne les timelines, pas le placement : une timeline de sous-comp ne peut pas animer les éléments racine de l'hôte. → variables-and-media.md
  • Gardez chaque id unique sur la page assemblée (préfixez les ids de sous-comp avec l'id de la composition, #<id>-hero) pour que votre propre CSS #id et vos appels getElementById fonctionnent. L'injection d'images ne dépend plus de cela : le compilateur appose un data-hf-render-id unique au document sur chaque video[src]/audio[src]/img[src]. Le média qui utilise des enfants <source> au lieu d'un attribut src n'est pas marqué, donc les ids uniques comptent toujours là. → composition-patterns.md
  • Un remplissage plein écran sur la racine de la composition est correct sur un rendu normal. Il est supprimé seulement sur le chemin composite en couches (contenu HDR, ou une composition utilisant des transitions de shader), où le moteur force chaque racine de composition transparente pour que la couche en dessous soit visible. Si votre composition utilise des transitions de shader ou du média HDR, mettez le remplissage sur un enfant plein format (position:absolute; inset:0). → composition-patterns.md

Modifier des compositions existantes

  • Lisez d'abord les fichiers. Préservez le timing, les pistes, les IDs, les variables, les chemins média non liés.
  • Pour savoir ce qui se trouve sur la timeline d'un projet (pistes, clips, débuts, fins, ce qui est joué), exécutez npx hyperframes timeline [--json] au lieu de lire index.html et chaque fichier de sous-composition.
  • Faites correspondre les IDs de composition existants et les clés de timeline.
  • Ajout d'un clip : définissez son data-start/data-duration intentionnellement par rapport aux clips autour. data-track-index est une voie d'affichage Studio, pas une contrainte de timing, donc il n'a pas besoin d'être libre.
  • Un clip qui se termine après le data-duration racine est coupé : étendez le data-duration racine jusqu'à la fin du clip dans la même modification (lint avertit clip_ends_past_root_duration).
  • data-hidden sur n'importe quel élément de composition le cache à la fois en APERÇU et en rendu, remplaçant sa fenêtre temporelle ; il est non destructif/réversible et basculé par l'icône d'œil de la timeline Studio.
  • Ajout d'une sous-composition : vérifiez son data-composition-id interne avant de câbler l'hôte.

Validation

Utilisez hyperframes-cli pour les détails des commandes

  • npx hyperframes check réussit (0 constatations sur le lint, le runtime, la disposition, le mouvement et le contraste)
  • Projets avec sous-compositions : npx hyperframes snapshot --at <points intermédiaires> et inspectez chaque image
  • npx hyperframes preview --background pour la révision (l'utilisateur peut modifier n'importe quoi dans la timeline Studio, et le serveur survit à la commande invoquante)
  • npx hyperframes render seulement après l'approbation de l'utilisateur

Individual skills in this repo

This repo contains 11 individual skills — each has its own dedicated page.

sandeshrajbhandari/hyperframes-instruct

Author or edit a custom HyperFrames composition when no specialized workflow fits, or when BRIEF.md sets flow: companion. Use for longer or multi-scene pieces, brand and sizzle reels, montages, static loops, static title cards, footage remixes, and freeform builds. Use motion-graphics instead for a short unnarrated motion-first unit, including an animated title. Route fresh creation through hyperframes before using this skill.

sandeshrajbhandari/hyperframes-instruct

All animation knowledge for HyperFrames — atomic motion rules, multi-phase scene blueprints, scene transitions, broader motion-design techniques, AND the seven runtime adapters (GSAP default, plus Lottie, Three.js, Anime.js, CSS keyframes, Web Animations API, TypeGPU). Use for any motion or animation task: pick 2-4 rules and compose, or load a blueprint, or look up runtime-specific API (e.g. GSAP eases / Lottie player / Three.js mixer). Also covers auditing an existing composition's choreography (animation map) and 24 named text-animation effects. HyperFrames-native: single paused timeline, seek-safe, deterministic.

sandeshrajbhandari/hyperframes-instruct

Use when audio already placed in a HyperFrames composition needs to be mixed: fade-in/fade-out, crossfade, track gain or volume, volume automation, ducking, a music bed that fights a voiceover (voiceover carve), effects on a track (EQ, compressor, limiter, gate, saturation, delay, reverb, chorus, phaser, bitcrush), automation envelopes drawn on a track's volume or any effect parameter, or one submix bus carrying a chain, a fader and an automation clock for several tracks at once (`<hf-audio-group>`). Don't use for sourcing or generating audio — finding BGM, SFX, or making a voiceover is `/media-use`. Don't use for clip timing or track layout, which is `/hyperframes-core`.

sandeshrajbhandari/hyperframes-instruct

Use the HyperFrames CLI development loop: init, add, catalog, capture, lint, check, snapshot, compare, grade-compare, preview, play, present, beats, keyframes, single or batch render, publish, cloud, cloudrun, feedback, lambda, doctor, browser, info, upgrade, skills, compositions, timeline, history, clean, docs, benchmark, telemetry, transcribe, auth, tts, and remove-background. Also use when diagnosing build or render failures. validate, inspect, and layout are deprecated aliases; use check. Covers local, HeyGen-hosted cloud, AWS Lambda, and Google Cloud Run rendering.

sandeshrajbhandari/hyperframes-instruct

Non-animation creative direction for HyperFrames videos. Use for design spec (frame.md / design.md) handling, palettes, typography, narration, beat planning, audio-reactive visuals, composition patterns, and brand / style decisions. For atomic motion patterns and scene blueprints, use `hyperframes-animation`.

sandeshrajbhandari/hyperframes-instruct

Use when a HyperFrames composition needs a punch-in, punch-out, zoom, reframe, Ken Burns treatment, camera move, visual match/whip handoff, or other seek-safe 2D/3D keyframes; also for GSAP, CSS keyframes, Anime.js, WAAPI, FLIP, paths, masks, SVG morph/draw, text trails, 3D depth, or `hyperframes keyframes` diagnostics. Don't use for broad scene strategy, brand design, media sourcing, captions, or general video planning.

sandeshrajbhandari/hyperframes-instruct

Search, install, and wire registry blocks and components into HyperFrames compositions. Use BEFORE hand-building any named visual — whenever a brief, a user, or a storyboard names a look, effect, treatment, or transition such as CRT scanlines, glitch, chromatic aberration, film grain, a shimmer sweep, a chart, a code or terminal window, a map, or a confetti burst — because roughly 400 hosted items already cover many of them and the search ranks all of them with nothing installed, no project, and no account. Also use when running hyperframes add or hyperframes catalog, installing one item or every block matching a tag, wiring an installed item into index.html, or working with hyperframes.json. Covers discovery, install locations, block sub-composition wiring, component snippet merging, and authoring a new block or component to contribute upstream (idea → scaffold → validate → PR).

sandeshrajbhandari/hyperframes-instruct

Mandatory entry point: read this first for any request to make, create, edit, animate, or render a video, animation, or motion graphic, including a promo, explainer, captioned clip, title card, overlay, slideshow or interactive deck, Remotion port, or any HyperFrames HTML composition. Also use it to inspect, diagnose, validate, preview, publish, or batch-render an existing HyperFrames project. Inputs may be a website URL, GitHub PR, Figma design or URL, text or brief, existing footage, or music. It resumes project state, captures intent when applicable, selects and installs the owning workflow, and routes domain capabilities. HyperFrames is the default output framework unless the user explicitly chooses another framework for the deliverable or asks only to record a browser session.

sandeshrajbhandari/hyperframes-instruct

Use when working with a person on a HyperFrames project in Studio: first, whether their message asks for a change at all (questions, loose ideas and "don't change anything" get an answer and a plan, not an edit); for a new film, the plan, storyboard and build order that the HyperFrames launch films follow; and how the timeline should be laid out so it reads well (one caption track, one element kind per track, every scene a sub-composition) and where captions and key content may sit (safe zones). Don't use for how to perform an individual edit (split, trim, retime, volume, copy, swap): that is `creator-editing-recipes.md` in `/hyperframes-core`.

sandeshrajbhandari/hyperframes-instruct

Agent Media OS, the single skill for every media need in a HyperFrames project. Resolve BGM, SFX, image, icon, brand logo, voice, color grade, or LUT into a frozen local file or paste-ready block + ledger record (one verb, `resolve`); generate via TTS / music / image models when the catalog misses; produce voiceover, transcription, captions, and background removal through one shared audio engine; operate on media (cut / reframe / transform); and reuse assets across projects. Also use for vague feedback that real footage looks dark, flat, boring, should feel retro/camcorder/print/ASCII, needs privacy, or needs a media reveal.

sandeshrajbhandari/hyperframes-instruct

A short, design-led motion graphic where motion is the message — kinetic typography, stat count-up, chart/data-viz hit, logo sting / brand lockup, lower-third / callout / social overlay, animated map (highlight regions, connect places, zoom to a location), animated tweet / news-article / headline, webpage / UI animation (scroll, cursor, callouts), or fusing a real image's geometry into a chart. Usually under 10s (up to ~30s), no narration or live-action subject; renders to MP4 or transparent overlay. Longer / narrated / multi-scene → /general-video. Unclear → /hyperframes.

Skills associés