为觉城构建宁静体验
觉城中的每个体验都是一个独立的小型 Web 应用。它运行在自己的源站上,位于沙盒框架内,并通过一个轻量 SDK 与平台通信。你可以继续使用自己的引擎、框架和发布节奏。
各部分如何协作
- 平台会在沙盒框架中打开你的入口 URL,并在 URL 片段中传入平台自身源站和实例 ID。
- 你的代码调用
connect()。短暂握手后,每次调用都会通过私有MessagePort传递。你的框架不会直接调用觉城服务器。 - 平台会根据为你的确切版本批准的能力检查每次调用,然后替你保存、记录或呈现结果。
SDK 提供的功能
- 访客主题颜色、浅色或深色模式、字体和减少动效设置会以 CSS 变量提供,并实时更新。
- 安全存档带版本和修订号的存档槽,支持冲突检测、安全重试和自动保存。
- 计时你只需报告体验是否正在运行。平台负责计时,你无需自行计算。
- 片刻与徽章让访客留下一张静谧时刻的图片,并申请由平台核验的徽章。
- 页头操作可将声音、重新开始、帮助和你自己的简短操作放在平台页头。
- 语言与时间上下文会附带访客的语言和时区,让你的体验能用对方熟悉的语言问候。
隐私数据
插件不会收到电子邮件地址、账号标识、访问令牌或浏览器标识。上下文只包含显示名称、语言、时区、会员等级、主题、可选的声音偏好,以及经批准的城市记录选择。框架无法打开弹窗、显示警告对话框、提交表单或导航页面。
指南
- 快速开始创建项目,连接测试宿主,并保存第一份进度。
- 清单与权限声明你的身份、托管位置和所需能力。
- SDK 参考客户端 SDK 的所有方法、选项、限制和错误代码。
- 生命周期与存档握手、暂停与恢复、保活报告、修订号和重试。
- 托管与审核托管体验、通过审核,并安全发布新版本。
获取 SDK
@zenclub/sdk 是一个无依赖的 ES 模块包,附带 TypeScript 类型。我们会与合作创作者共享。联系我们聊聊你的想法,我们会发送当前版本并安排审核时段。