// 小广告 //
想在终端连接 Napcat？来看看 Stapxs QQ Shell 吧！
一个兼容 OneBot 的非官方网页 QQ 客户端
🌎 访问 DEMO |
📦️ 下载程序 |
💬 反馈问题
本网页应用仅供学习交流使用，请勿用于其他用途
版权争议请提出 issue 协商
以下是一些社区支持的版本，非常推荐大家试用：
- Stapxs QQ Lite X：扩展了更多功能的社区版本，支持更多接近原版 QQ 的功能
- Stapxs QQ Lite Pre Preview：Stapxs QQ Lite 的预览版本，跟随 dev 分支更新，可体验最新功能
- ✅ 使用 Vue.js 全家桶开发，快乐前后端分离
- 🎨 自适应布局，竖版也能使用
- 🖥️ 支持 PWA（都有 Electron 了（小声））
- 🌚 Light/Dark Mode 自动切换
- 🍱 该有的都有（虽然比不过官方端）
- 复杂消息显示、转发、回复、撤回
- 群文件、群公告、群设置（一小部分）、精华消息
- 图片、收藏表情、文件发送
- 📦️ 支持多种 bot，我就是要用！
- 🔥 水深火热但是更好看的 Electron 客户端
- 🥚 彩蛋！来更多的彩蛋！
- 🛠 更多特性开发中
Stapxs QQ Lite 需要一个 QQ Bot 后端提供服务。由于 QQ Bot 的部署较为复杂，请移步 Bot 适配情况 issue 查看目前支持的 Bot 并选择一个查阅其部署文档。
本仓库开启了 GitHub Pages，所有向主分支提交的代码将会自动构建并发布。你可以直接访问 🌎 这个页面 来使用已构建并部署的在线版本。
除了直接使用本仓库的构建页面，你也可以下载使用 Electron 打包的功能稍稍更丰富的客户端版本，访问 📦️ 这里 查看版本发布列表。
你也可以使用包管理器来安装，这样可以更方便地更新 Stapxs QQ Lite 而无需每次都从 GitHub 手动下载，访问 💬 这里 查看目前支持的包管理器。
Stapxs QQ Lite 在版本发布时会构建 Web 文件，你可以在 📦️ 这里 找到它，通常命名为 Stapxs.QQ.Lite-<版本>-web.zip，下载后解压并放置到你的网页服务器中即可。
不会部署网页服务器？Stapxs QQ Lite 网页版已经发布到了 npm！你可以使用 npx 工具快速启动：
npx ssqq-web hostname=127.0.0.1 port=8081Stapxs QQ Lite 已经原生支持了 Docker 部署，使用命令
docker pull ghcr.io/stapxs/stapxs-qq-lite-2.0:latest来拉取最新的镜像，如果您无法使用或者GHCR速度很慢，可以使用命令
docker pull ghcr.nju.edu.cn/stapxs/stapxs-qq-lite-2.0:latest来从镜像站拉取镜像，使用时请将容器内的8080端口对外开放，80端口可以忽略。
以下是关于使用 QQ Bot 和第三方客户端的常见疑问，你也可以查看 常见问题 issue 获取更多使用和部署相关的问题解答。
- 如果它兼容 OneBot 11 协议，你可以尝试连接，但由于消息体格式和接口扩展的差异，大部分情况下可能无法完全正常使用。 已兼容的 Bot 列表可以在 这里 查看。
- 使用 QQ Bot 服务可能存在一定风险，此风险并非由 Stapxs QQ Lite 造成，而是使用 QQ Bot 服务本身的风险。请自行查阅你所使用的 QQ Bot 相关文档以了解风险信息。
- 如果遇到任何问题，欢迎发起 issue 询问！发现 BUG 或有优化建议也欢迎反馈。
为了规范对其他仓库的引用，Stapxs QQ Lite 仓库包含一些 Git 子模块，这意味着你需要在克隆仓库时包含子模块：
git clone https://github.com/Stapxs/Stapxs-QQ-Lite-2.0.git --recursive如果你已经克隆了仓库，可以使用以下命令补全子模块：
git submodule update --init在开始构建之前，请先安装依赖。请确保已安装 yarn：
# 安装依赖
yarn install另外，Stapxs QQ Lite 使用了高德地图 API 来显示位置共享地图。.env 文件中提供了一个默认的高德地图 API Key，如果你打算自行部署，建议在 这里 申请属于你自己的 API Key 并替换默认值。
我们强烈建议使用自己的 API Key，因为默认 Key 有使用次数限制。
Stapxs QQ Lite 是一个基于 Vue 的单页应用，如果你想自行部署到网页服务器需要进行构建。你也可以直接前往 这里 下载预构建好的文件包。
以下是构建该项目的命令，构建结果将输出在 dist 目录下：
# 运行本地调试
yarn dev
# 代码检查和自动格式化
yarn lint
# 构建应用
yarn buildStapxs QQ Lite 支持 SSE 模式。在此模式下，应用将以 HTTP SSE + HTTP API 的方式连接到 QQ Bot 后端，提供更快速和轻量化的连接；甚至可以直接禁用 SSE 通知推送，仅使用 HTTP API 进行通信。
SSE 模式不支持动态切换，需要在构建前修改 .env 环境变量中 VITE_APP_SSE 开头的配置项来启用。启用 SSE 模式后，页面将无法使用其他连接模式。
VITE_APP_SSE_MODE=true
VITE_APP_SSE_SUPPORT=true
VITE_APP_SSE_EVENT_ADDRESS=api/_events
VITE_APP_SSE_HTTP_ADDRESS=apiSSE_MODE 指定了 SSE 模式的主开关；
SSE_SUPPORT 指定了是否支持 SSE 事件推送。设为 false 时将仅使用 HTTP API 进行通信，这将无法接收 QQ Bot 的主动推送消息，导致以下功能缺失：
- 无法接收新消息推送、通知推送
- 聊天面板新消息不会自动更新，但仍可通过重新加载面板来获取新消息
剩余两项指定了 SSE 模式的地址，可根据需求修改。
自 2.3.0 版本起，Stapxs QQ Lite 支持构建为 Electron 应用并提供部分平台特性功能，你也可以自行构建。
如果 Electron CLI 无法找到 Python，可以将
PYTHON_PATH导出到环境变量中，指向 Python 可执行文件路径。
以下是构建 Electron 应用的命令，构建结果将输出在 dist_electron/out 目录下：
# Electron 运行本地调试
yarn dev:electron
# Electron 构建应用
yarn build:electron自 3.2.0 版本起，Stapxs QQ Lite 支持构建为 Tauri 应用并提供部分平台特性功能，你也可以自行构建。
以下是构建 Tauri 应用的命令，构建结果将输出在 src/tauri/target/release/bundle 目录下：
# Tauri 运行本地调试
yarn dev:tauri
# Tauri 构建应用
yarn build:tauri
# Tauri 构建指定架构
yarn build:tauri -t x86_64-apple-darwin -b dmg
# 查看支持的架构
rustup target list注意：Tauri 不支持跨平台构建，需要在对应平台上进行构建。
自 3.0.0 版本起，Stapxs QQ Lite 支持通过 Capacitor 构建为移动端应用并提供部分平台特性功能，你也可以自行构建。
如果 Capacitor CLI 无法找到 Android Studio 和 Android SDK，可以将
CAPACITOR_ANDROID_STUDIO_PATH和ANDROID_HOME导出到环境变量中，它们分别指向 Android Studio 可执行文件路径和 Android SDK 路径。
你可以使用 yarn open:android 打开 Android Studio，通过 Build -> Generate Signed Bundle or APK 来构建 APK 文件。
你也可以直接使用 yarn build:android 构建 APK 文件。请检查并修改 capacitor.config.ts 文件中 android.buildOptions 的 keyStore 配置。
构建结果将输出在 src/mobile/android/app/build/outputs/apk/release 目录下。
你可以使用 yarn open:ios 打开 Xcode，通过 Product -> Archive 来构建 IPA 文件。
你也可以直接使用 yarn build:ios 构建 IPA 文件。此构建方式将执行 scripts/build-export-ipa.sh 脚本，构建将使用钥匙串中的默认开发者证书，请确保已配置开发者证书。
Xcode 的构建结果将输出在 src/mobile/ios/build 目录下，脚本构建结果将输出在 dist_capacitor 目录下。
以下是本项目的完整命令列表，你可以使用这些命令来快速构建和调试 Stapxs QQ Lite。
命令格式为 yarn <命令>，其中 <命令> 为列表中的一个：
| 命令 | 描述 |
|---|---|
| install | 安装依赖 |
| lint | 代码检查和自动格式化 |
| update:icon | 更新移动端应用图标集 |
| update:version | 更新移动端应用版本号 |
| dev | 网页调试 |
| dev:electron | Electron 调试 |
| dev:tauri | Tauri 调试 |
| dev:ios | iOS 调试 |
| dev:android | Android 调试 |
| open:ios | 在 Xcode 中打开项目 |
| open:android | 在 Android Studio 中打开项目 |
| build | 网页构建 |
| build:electron | 构建当前平台的 Electron 应用 |
| build:tauri | 构建 Tauri 应用 |
| build:ios | 构建 iOS 应用 |
| build:android | 构建 Android 应用 |
Stapxs QQ Lite 的 Tauri 版本使用了来自 DeltaChat 项目的 user-notify 代码，用于提供跨平台系统通知功能。由于这部分代码没有独立发布，我们将其源码复制到了 src/tauri/crates/user-notify 目录下。此部分代码已通过 .gitattributes 文件排除在语言统计之外。
感谢以下小伙伴在开发和文档中提供的支持 ——
