Skip to content

Stapxs/Stapxs-QQ-Lite-2.0

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 上手动更新,访问 💬 这儿 来查看目前支持的包管理。

> 自行部署网页

Stapxs QQ Lite 在版本发布时构建了一份根目录下的 Web 文件,你可以在 📦️ 这儿 找到它,它一般叫做Stapxs.QQ.Lite-<版本>-web.zip,将它解压放置到你的网页服务器中即可。

什么?不会部署网页服务器?Stapxs QQ Lite 网页版现在已经发布到了 npm 上!你可以使用 npx 工具快速启动它:

npx ssqq-web hostname=127.0.0.1 port=8081

💬 提醒和问题

> 关于不安全连接

  • 当使用 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

在开始构建之前请安装依赖,请确保安装了 yarn

# 安装依赖
yarn

or

yarn install

> 构建 Web 页面

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

下面是构建该项目的命令,构建结果将最终输出在 dist 目录下:

# 运行本地调试
yarn dev

# 代码检查和自动格式化
yarn lint

# 构建应用
yarn build

> 构建 Electron 客户端

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

下面是构建 Electron 应用的命令,构建结果将最终输出在 dist_electron/out 目录下:

# electron 运行本地调试
yarn dev:electron

# electron 构建应用
yarn build:win

其他平台构建查看命令列表

> 命令列表

命令格式为yarn <命令>,其中<命令>为列表中的一个:

命令 描述
install 安装依赖
lint 代码检查和自动格式化
dev 网页调试
dev:electron Electron 调试
dev:ios Ios 调试
dev:android 安卓调试
build 网页构建
build:win 构建 Windows 应用
build:mac 构建 Mac Os 应用
build:linux 构建 Liunx 应用
build:ios 构建 Ios 应用
build:android 构建 Andorid 应用

> Github Actions

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

auto-build

🎉 鸣谢

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