Skip to content

armgit / hypit

Public Imported from GitHub
0

Clone any viral video with AI agents. Not just a script, the whole workflow: swap the face, the words, the B-roll, ship 100 variants in one command, and get your 100M views.

docs: retain current public Companion guides after history cleanup

kashorinb2bd290172a1
diff --git a/docs/guide/studio-companion-architecture.md b/docs/guide/studio-companion-architecture.md
new file mode 100644
index 00000000..802b09e0
--- /dev/null
+++ b/docs/guide/studio-companion-architecture.md
@@ -0,0 +1,46 @@
+---
+title: Studio Companions
+description: Give a component useful timeline entities and editing controls in Studio.
+---
+
+A component draws the video. Its **Studio Companion** explains that component to the editor: which
+objects appear on the timeline, what their labels mean, and which source properties can be edited.
+This lets a project component offer useful controls while keeping its visual implementation reusable.
+
+## Package it with the component
+
+A Companion is an application contribution. Project components can ship it as a separate file and
+facet in the same physical package. The official Distribution supplies its Companions through
+independent packages. In both cases, Studio loads the Companions for the packages selected by the
+current Source and Distribution.
+
+The [Companion SDK](https://github.com/hypit-ai/hypit/blob/main/packages/studio-adapter/README.md)
+provides the activation and interface examples. External packages import `@hypit/hypit/studio-adapter`,
+compile the Companion to JavaScript, and ship it with the component. Restart Studio after changing
+the installed code so the new contribution is loaded.
+
+## Describe the author-facing objects
+
+A Track Companion matches the component's terminal Type and authored Surface. It describes timeline
+entities, labels, material previews and Inspector fields using the component's public values.
+A graphic can expose its appearance, content, placement and event timing without exposing every
+internal drawing value.
+
+Studio supplies the controls and interactions. A Companion selects scalar, list or record controls
+and binds them to source values. A Film Companion identifies the Film's time source and Tracks;
+a Script Companion supports the source mapping needed to relocate Selection and Moment markers.
+An authored ProgramSpace supports animation without a Script lane.
+
+## Make edits meaningful
+
+Timeline editing follows the chosen temporal relationship. Moving a shared Script event changes the
+marker and its consumers. A parameter-based handle changes that authored parameter. Values with no
+supported inverse remain available for inspection.
+
+Inspector fields bind to the author values they change. A shared Recipe or Frame may affect several
+uses, so the property represents that shared decision. Studio applies the edit to the corresponding
+Source, recompiles the same Run, and reports an error with the previous files restored if the edit
+cannot be published.
+
+[Studio Temporal Lineage](./studio-temporal-windows.md) explains how these relationships retain their
+author meaning through projection. [Studio](../quickstart/preview.md) introduces the editing interface.
diff --git a/docs/zh/guide/studio-companion-adapter-architecture.md b/docs/zh/guide/studio-companion-adapter-architecture.md
new file mode 100644
index 00000000..e040dfe2
--- /dev/null
+++ b/docs/zh/guide/studio-companion-adapter-architecture.md
@@ -0,0 +1,26 @@
+---
+title: Studio Companion
+description: 为组件提供有意义的时间线实体和 Studio 编辑控件。
+---
+
+组件绘制视频,**Studio Companion** 向编辑器解释组件:哪些对象出现在时间线上,标签代表什么,哪些 Source 属性可以编辑。项目组件由此可以提供实用控件,同时保持视觉实现的可复用性。
+
+## 与组件一起分发
+
+Companion 是应用贡献。项目组件可以在同一个物理包中,以独立文件和 facet 携带它;官方 Distribution 通过独立包提供官方 Companion。两种情况下,Studio 都加载当前 Source 和 Distribution 所选包的 Companion。
+
+[Companion SDK](https://github.com/hypit-ai/hypit/blob/main/packages/studio-adapter/README.md) 提供 activation 与接口示例。外部包使用 `@hypit/hypit/studio-adapter`,将 Companion 编译为 JavaScript 并与组件一起分发。修改安装代码后,重启 Studio 加载新贡献。
+
+## 描述作者面对的对象
+
+Track Companion 匹配组件的终端 Type 与作者 Surface,使用组件公开值描述时间线实体、标签、素材预览和 Inspector 字段。图形可以公开外观、内容、位置和事件时间,而不必暴露每一个内部绘制数值。
+
+控件与交互由 Studio 提供,Companion 选择标量、列表或记录控件,并将其绑定到 Source 值。Film Companion 指明 Film 的时间来源与 Track;Script Companion 支持移动 Selection、Moment 标记所需的源码映射。作者声明的 ProgramSpace 支持没有 Script 轨道的动画。
+
+## 让编辑保留含义
+
+时间线编辑沿用所选时间关系。移动共享 Script 事件会改变标记与其消费者;基于参数的手柄修改对应作者参数。没有可支持反向编辑的值,仍可供查看。
+
+Inspector 字段绑定到实际修改的作者值。共享 Recipe 或 Frame 可能影响多个使用位置,因此字段代表的是这项共享决定。Studio 将修改写到对应 Source,以同一份 Run 重新编译;修改无法发布时,显示错误并恢复之前的文件。
+
+[Studio 时间谱系](./studio-temporal-windows.md) 介绍这些关系如何在投影后保留作者含义,[Studio](../quickstart/preview.md) 介绍编辑界面。