ringhyacinth / Star-Office-UI
A pixel office for your OpenClaw: turn invisible work states into a cozy little space with characters, daily notes, and guest agents. Code under MIT; art assets for non-commercial learning only.
AI Architecture Analysis
This repository is indexed by RepoMind. By analyzing ringhyacinth/Star-Office-UI in our AI interface, you can instantly generate complete architecture diagrams, visualize control flows, and perform automated security audits across the entire codebase.
Our Agentic Context Augmented Generation (Agentic CAG) engine loads full source files into context on-demand, avoiding the fragmentation of traditional RAG systems. Ask questions about the architecture, dependencies, or specific features to see it in action.
Repository Overview (README excerpt)
Crawler viewStar Office UI 🌐 Language: **中文** | English | 日本語 **一个像素风格的 AI 办公室看板** —— 把 AI 助手的工作状态实时可视化,让你直观看到"谁在做什么、昨天做了什么、现在是否在线"。 支持多 Agent 协作、中英日三语、AI 生图装修、桌面宠物模式。 与 OpenClaw 深度集成时体验最佳,也可以独立部署作为状态看板使用。 > 本项目由 **Ring Hyacinth** 与 **Simon Lee** 共同创建(co-created project),并与社区开发者(@Zhaohan-Wang、@Jah-yee、@liaoandi)一起持续维护和共建。 > 欢迎提交 Issue 和 PR,也感谢每一位贡献者的支持。 --- ✨ 快速体验 方式一:让龙虾帮你部署(推荐给 OpenClaw 用户) 如果你正在使用 OpenClaw,直接把下面这句话发给你的龙虾: 龙虾会自动完成 clone、安装依赖、启动后端、配置状态同步,并把访问地址发给你。 方式二:30 秒手动部署 > **环境要求:Python 3.10+**(代码使用了 union type 语法,不支持 3.9 及更低版本) 打开 **http://127.0.0.1:19000** 然后试试切状态: --- 🤔 适合谁用? 有 OpenClaw / AI Agent 的用户 这是**完整体验**。Agent 在工作时自动切换状态,办公室里的像素角色会实时走到对应区域——你只需要打开网页,就能看到 AI 此刻在做什么。 没有 OpenClaw 的用户 也完全可以部署。你可以: • 用 或 API 手动 / 脚本推送状态 • 把它当成一个像素风的个人状态页 / 远程办公看板 • 接入任何能发 HTTP 请求的系统来驱动状态 --- 📋 功能一览 • **状态可视化** —— 6 种状态( / / / / / )自动映射到办公室不同区域,动画 + 气泡实时展示 • **昨日小记** —— 自动从 读取最近一天的工作记录,脱敏后展示为"昨日小记"卡片 • **多 Agent 协作** —— 通过 join key 邀请其他 Agent 加入你的办公室,实时查看多人状态 • **中英日三语** —— CN / EN / JP 一键切换,界面文案、气泡、加载提示全部联动 • **美术资产自定义** —— 侧边栏管理角色 / 场景 / 装饰素材,支持动态帧同步,避免闪烁 • **AI 生图装修** —— 接入 Gemini API,用 AI 给办公室换背景;不接入 API 也能正常使用核心功能 • **移动端适配** —— 手机直接打开即可查看,适合外出时快速瞄一眼 • **安全加固** —— 侧边栏密码保护、生产环境弱密码拦截、Session Cookie 加固 • **灵活公网访问** —— 推荐 Cloudflare Tunnel 一键公网化,也可用自有域名 / 反向代理 • **桌面宠物版** —— 可选的 Electron 桌面封装,把办公室变成透明窗口的桌面宠物(见下方说明) --- 🚀 详细部署指南 1) 安装依赖 2) 初始化状态文件 3) 启动后端 打开 > ✅ 首次部署可以先保留默认配置;在生产环境中,请复制 为 并设置强随机的 与 ,避免弱密码和会话泄露。 4) 切换状态 5) 公网访问(可选) 拿到 链接即可分享。 6) 验证安装(可选) 所有检查显示 即表示部署成功。 --- 🦞 OpenClaw 深度集成 > 以下内容面向 OpenClaw 用户。如果你不使用 OpenClaw,可以跳过这一节。 状态自动同步 在你的 (或 Agent 规则文件)中加入以下规则,让 Agent 自觉维护状态: **6 种状态 → 3 个区域的映射:** | 状态 | 办公室区域 | 触发场景 | |------|-----------|---------| | | 🛋 休息区(沙发) | 待命 / 任务完成 | | | 💻 工作区(办公桌) | 写代码 / 写文档 | | | 💻 工作区 | 搜索 / 调研 | | | 💻 工作区 | 执行命令 / 跑任务 | | | 💻 工作区 | 同步数据 / 推送 | | | 🐛 Bug 区 | 报错 / 异常排查 | 邀请其他 Agent 加入办公室 **Step 1:准备 join key** 首次启动后端时,如果当前目录下不存在 ,服务会自动根据 生成一个运行时的 (内含示例 key,例如 )。你可以在生成后的 中自行添加、修改或删除 key,每个 key 默认支持最多 3 人同时在线。 **Step 2:让访客 Agent 运行推送脚本** 访客只需下载 ,填写 3 个变量即可: 脚本会自动加入办公室并每 15 秒推送一次状态。访客会出现在看板上,根据状态自动走到对应区域。 **Step 3(可选):访客安装 Skill** 访客也可以把 作为 Skill 使用,Agent 会自动完成配置和推送。 > 详细的访客接入说明见 --- 📡 常用 API | 端点 | 说明 | |------|------| | | 健康检查 | | | 获取主 Agent 状态 | | | 设置主 Agent 状态 | | | 获取多 Agent 列表 | | | 访客加入办公室 | | | 访客推送状态 | | | 访客离开 | | | 获取昨日小记 | | | 获取 Gemini API 配置 | | | 设置 Gemini API 配置 | | | 轮询生图进度 | --- 🖥 桌面宠物版(可选) 目录提供了一个基于 **Electron** 的桌面封装版本,可以把像素办公室变成一个透明窗口的桌面宠物。 • 启动时自动拉起 Python 后端 • 窗口默认指向 • 支持通过环境变量自定义项目路径和 Python 路径 > ⚠️ 这是一个**可选的实验性功能**,目前主要在 macOS 上开发测试。详见 。 > > 🙏 桌面宠物版由 @Zhaohan-Wang 独立开发,感谢他的贡献! --- 🎨 美术资产与开源许可 资产来源 访客角色动画使用了 **LimeZu** 的免费资产: • [Animated Mini Characters 2 (Platformer) [FREE]](https://limezu.itch.io/animated-mini-characters-2-platform-free) 请在二次发布 / 演示时保留来源说明,并遵守原作者许可条款。 许可协议 • **代码 / 逻辑:MIT**(见 ) • **美术资产:禁止商用**(仅学习 / 演示 / 交流用途) > 如需商用,请将所有美术资产替换为你自己的原创素材。 --- 📝 更新日志 | 日期 | 概要 | 详情 | |------|------|------| | 2026-03-06 | 🔌 默认端口调整 — 默认后端端口从 18791 调整为 19000,以避开 OpenClaw Browser Control 端口冲突;同步更新脚本、桌面壳与文档默认值 | | | 2026-03-05 | 📱 稳定性修复 — CDN 缓存修复、生图异步化、移动端侧边栏优化、Join Key 过期与并发控制 | | | 2026-03-04 | 🔒 P0/P1 安全加固 — 弱密码拦截、后端模块拆分、stale 状态自动回 idle、首屏骨架屏优化 | | | 2026-03-03 | 📋 开源发布检查清单完成 | | | 2026-03-01 | 🎉 **v2 重制发布** — 新增三语支持、资产管理系统、AI 生图装修、美术资产全面替换 | | --- 📁 项目结构 --- ⭐ Star History