Skip to content

Latest commit

 

History

History
124 lines (98 loc) · 6.31 KB

README.md

File metadata and controls

124 lines (98 loc) · 6.31 KB
Raw

简体中文 | English


Logo

Stapxs QQ Lite 2.0

一个兼容 OneBot 的非官方网页 QQ 客户端
🌎 访问 DEMO  |   📦️ 下载程序  |   💬 反馈问题

本网页应用仅供学习交流使用，请勿用于其他用途
版权争议请提出 issue 协商

view

✨ 特性支持

  • ✅ 使用 Vue.js 全家桶开发，快乐前后端分离
  • 🎨 自适应布局，竖版也能使用
  • 🖥️ 支持 PWA（都有 Electron 了（小声））
  • 🌚 Light/Dark Mode 自动切换
  • 🍱 该有的都有（虽然比不过官方端）
    • 复杂消息显示、转发、回复、撤回
    • 群文件、群公告、群设置（一小部分）、精华消息
    • 图片、收藏表情、文件发送
  • 📦️ 支持多种 bot，我就是要用！
  • 🔥 水深火热但是更好看的 Electron 客户端
  • 🥚 彩蛋！来更多的彩蛋！
  • 🛠 更多特性开发中

♿️ 快速使用

> 运行服务

Stapxs QQ Lite 需要一个 QQ Bot 后端提供服务，你可以参考 📖 这个文档 布置它。

> 访问应用

本仓库开启了 GitHub Pages, 所有向主分支提交的代码将会自动构建并发布。你可以直接访问 🌎 这个页面 来使用已经构建并部署的页面。

> 安装应用

除了直接使用本仓库的构建页面，你也可以下载使用 electron 打包的功能稍稍更丰富的客户端版本，访问 📦️ 这儿 查看版本发布列表。

当然你也可以使用包管理来安装它，使用包管理安装将会更便于更新 Stapxs QQ Lite 而不用每次都从 Github 上手动更新，访问 💬 这儿 来查看目前支持的包管理。

💬 提醒和问题

> 关于不安全连接

  • 当使用 https 页面连接 ws 服务（反之相同）的情况下，连接将会失败；这是由于其中某一者是不安全的。在这种情况下，你可以选择将 ws 提升为 wss 或者将 https 降级为 http（不安全）来解决问题，此处不提供解决方案。>> Stapxs-QQ-Lite#32

> 我能使用其他 QQ Http Bot 吗

  • 如果它兼容 OneBot 11 协议, 你可以尝试连接它, 但是由于消息体格式和接口扩展的差异，大部分情况下都不能完全正常使用。 已经兼容的 Bot 都写在了文档里，可以去 这里 查看。

> 使用 Bot 是否有风险

  • 如果你使用的是 oicq-http, 可以查看此处了解 使用风险, 如果你尝试使用其他 QQ Bot (参见上一条问题), 请自行参考它的文档。

> 我遇到了问题

  • 如果有什么奇奇怪怪的问题, 欢迎发起 issue 询问! 如果有什么 BUG 和优化建议也可以哦!

📦️ 构建应用

为了规范对其他仓库的引用，Stapxs QQ Lite 2.0 仓库含有一些子模块，这意味着你需要在克隆仓库的时候包含子模块：

git clone https://github.com/Stapxs/Stapxs-QQ-Lite-2.0 --recursive

如果你已经克隆了仓库，也可以使用这个来补全子模块：

git submodule update --init

> 构建 Web 页面

Stapxs QQ Lite 2.0 是一个基于 Vue 的单页应用，这意味着如果你想自行部署到网页服务需要进行构建。当然你同样可以前往 这儿 来下载预构建好的根目录文件包。

注意。在正式构建前，如果你的网站运作目录并不在根域名下，你需要修改（或增加）项目根目录下 vue.config.js 内导出的 publicPath 字段的值，它代表着最终你会运行在的目录，比如它在现在是 /Stapxs-QQ-Lite-2.0/；如果你本来就运行在根目录下，可以直接删去它。

下面是构建 Vue 应用的命令，构建结果将最终输出在 dist 下：

# 安装依赖
yarn install
# 运行本地调试
yarn serve
# 代码检查和自动格式化
yarn lint
# 构建应用
yarn build

> 构建 Electron 客户端

在 2.3.0 版本后，Stapxs QQ Lite 2.0 支持构建为 Electron 应用并补充部分平台特性的功能，你也可以自行构建。

下面是构建 Electron 应用的命令，构建结果将最终输出在 dist_electron/out 下：

# electron 运行本地调试
yarn electron:serve
# electron 构建应用
yarn electron:build

你可以补充平台选项来指定构建某个平台：

yarn electron:build --linux

> Github Actions

为什么会有人对自动构建感兴趣，总之自动构建脚本我写了好久。感兴趣就自己去看好了（无端）。

auto-build

🎉 鸣谢

感谢这些小伙伴们在开发和文本中提供的支持 ——