sleepy

欢迎来到 Sleepy Project 的主仓库!

一个用于 视奸 查看个人在线状态 (以及正在使用软件) 的 Flask 应用，让他人能知道你不在而不是故意吊他/她

功能 / 演示 / 部署 / 服务端配置 / 使用 / Client / API / 关于

功能

• 自行设置在线状态 (活着 / 似了 等, 也可 自定义 状态列表)
• 实时更新设备使用状态 (包括 是否正在使用 / 打开的应用名, 通过 client 主动推送)
• 美观的展示页面 [见 Preview]
• 开放的 Query / Metrics 接口, 方便统计
• 支持 HTTPS (需要自行配置 SSL 证书)

Tip

如有 Bug / 建议, 可发 issue (Bug / Feature) 或选择下面的联系方式 (注明来意).

Working...

我们正在使用 FastAPI 重构此项目, 请关注以下社交平台消息:

• Discord
• QQ
• Telegram

预计将在 1-2 个月内完成 (希望吧)

如仍需使用此分支, 请仔细阅读本仓库的文档, 或找上面的 DeepWiki Ask.

Tip

以及 V4 API (即不带 /api 前缀的 API) 兼容默认启用, 文档: plugins/v4_compatible/README.md

Preview

演示站: sleepy.wyf9.top

开放预览站: sleepy-preview.wyf9.top

展开更多

HuggingFace 部署预览: wyf9-sleepy.hf.space

Vercel 部署预览: sleepy-vercel.wyf9.top

开发服务器: 请在 Discord 服务器查看

部署 / 更新

请移步 部署教程 或 更新教程 (多图警告)

客户端

搭建完服务端后，你可在 /client 找到客户端 (用于手动更新状态/自动更新设备打开应用)

目前已有 Windows, Linux, IOS / MacOS, Android, 油猴脚本 等客户端

Important

每个客户端的标题可以 点击跳转最新文件, 不要使用固定 commit 的链接, 否则无法获取最新文件

API

详细的 API 文档见 doc/api.md.

Star History

贡献者

Warning

在提交代码前, 请先查阅 贡献准则 和 贡献指南

因为权限问题, 我把贡献者名单 actions 扬了, 请 在此 查看

关于

非常感谢 ZMTO (原名 VTEXS) 的 「开源项目免费 VPS 计划」 对项目提供的算力支持！

Link (使用此链接获得 10% 优惠)

---

本项目灵感由 Bilibili UP @WinMEMZ 而来: site / blog / repo: maoawa/sleepy, 并部分借鉴使用了前端代码, 在此十分感谢。

templates/steam-iframe.html 来自 repo gamer2810/steam-miniprofile.

---

对智能家居 / Home Assistant 感兴趣的朋友，一定要看看 WinMEMZ 的 sleepy 重生版: maoawa/project-sleepy!

感谢 @1812z 的 B 站视频推广~ (BV1LjB9YjEi3)

---