Skip to content
Get started

The @allyhub/sdk reference

What a piece is written with, for the version of the SDK installed beside them. Read the file a piece needs before writing it. Commands are not here: allyhub help lists them, allyhub help <command> says what one does and its options' defaults. Every export also has its documentation in JSDoc.

  • project.md: a project’s folders, its list of work (allyhub.yaml) and items, the SDK bound to the file that imports it, imports of media, data and other items, scripts and shared text, allyhub.config.ts, fonts.
  • contract.md: what the build, the check and the render rely on: a piece drawn from time alone, what piece code may not do, the rules a problem is reported under.
  • video.md: video(), formats, part(), a part’s length, layers and their stacking, transitions, the look, covers, the camera filming the picture, post.
  • layers.md: defineComponent() and its prop types, custom(), the layer’s ctx, the DOM and layout helpers, animation, text, path and noise helpers, and a person’s input as functions of time (cursor, a mouse’s that glides; handPath, a hand’s; reach, tap, drag, scrolling, typing), starter components.
  • speech.md: take(), say(), word references, anchors, shown and said text, captions, edits files.
  • sound.md: music, sound effects, the mix, the master, how the voice was recorded.
  • footage.md: footage() layers: placing, cropping, reframing, punch-ins, faces and mattes, the background behind the person, a video item inside another.
  • pictures.md: picture(), a still in CSS’s terms: fit, focal point, crop, mask, corners, blend mode, filter; footage() of a still; a deck’s crop to fill and fit.
  • slides.md: presentation(), masters, layouts and shapes, a deck’s slides file and script, what a deck renders to.
  • image.md: image() and its boards, each its own size or as tall as it holds; layers named by key; words; what an image checks, measures and renders to.
  • batches.md: the matrix: dimensions, slots, pools, structures, rules, combos.
  • scenery.md: 3D sceneries: defineScenery(), cameras and their moves, the hand that holds one, the scenery() layer and its screens.
  • modeling.md: a prop modelled in code with @allyhub/model and put in a scenery.
  • docs.md: a doc, one MDX file: its title, the Markdown and tags it reads, pictures and links, check and render.
  • sheets.md: a sheet, a workbook as YAML and CSV: tables, formulas, names, checks, the openpyxl API (@allyhub/sdk/sheets), calc, trace and render.
  • canvas.md: a canvas, a JSON Canvas file laying a project’s work out with notes, groups and edges.
  • x.md: an X post, thread or long post in POST /2/tweets’s fields, and an X article in X’s blocks: what X counts and refuses, and what they render to.
  • websites.md: a website, any web project with its JSON file: how Studio serves it while it is made (PORT, HOST, the preview hosts), a project’s videos in its pages, its build.
  • defaults.md: every default of the piece API, generated from the code’s constants, with the option that changes it.
Was this page helpful?