orb README

The project's README from github.com/LerSent001/orb. As one markdown file: README.md.

Liquid Orb Editor

一个使用 React、WebGPU/WGSL 和 Toolcraft UI 构建的实时液态玻璃球编辑器。

在线使用:https://lersent001.github.io/orb/

功能

维护状态

本项目处于持续迭代维护中。作者持续优化预设、运动模型、编辑器稳定性以及 WebGPU 与 SwiftUI/Metal 的输出一致性,并使用 OpenAI Codex 辅助代码实现、回归验证和发布。

本地运行

需要 Node.js 22、pnpm 11,以及支持 WebGPU 的浏览器。

pnpm install
pnpm dev

生产构建:

pnpm build
pnpm preview

代码结构

许可证

项目代码使用 MIT License。src/toolcraft 包含的 Toolcraft UI 代码保留其原始 MIT 版权声明,详见 TOOLCRAFT_LICENSE.md。

orb (LerSent001/orb)

Searching Database…

733 ·GitHub
What is this?Liquid Orb Editor is a real-time editor for creating animated liquid-glass orb effects, built with React and WebGPU/WGSL. You tweak color, speed, shape, glass refraction and glow, then export the result as a standalone web page or as SwiftUI/Metal code for iOS apps.
Is this a visual editor or a code library?It is a browser-based visual editor: you adjust parameters with sliders and previews, and it generates ready-to-use Web code or SwiftUI/Metal code for you, rather than being a library you import.
How do I run the editor?There is a hosted online version, or you can clone the repo and run it locally with pnpm (dev/build/preview scripts are powered by Vite).
What do I need installed to run it locally?You need Node.js 22 and pnpm 11, plus a browser that actually supports WebGPU to preview and edit the orb.
Will it run in any browser?No — the live preview depends on WebGPU support, so browsers without WebGPU can't render or edit the orb; the project is also still actively evolving, with ongoing changes to presets and output consistency.
What presets does it ship with?It comes with 12 editable, animated orb presets covering different colors, motion styles and glass looks that you can tweak or use as starting points.
Can I share a design I made with someone else?Yes — all your parameter choices are encoded into the page's URL hash, so sharing the link reproduces the exact orb you configured.
What role does OpenAI Codex play here?The author uses OpenAI Codex to help implement code, run regression verification on the Web/SwiftUI exports, and prepare releases.
Does the editor support Chinese and English?Yes, it auto-detects your browser language to show a Chinese or English interface, and you can switch between the two at any time.
Creator
LerSent001
Size
1.9 MB
Stars
733
Updated
CommitSep 16
Age
2mo
Commits · 90 Days