Skip to content

Latest commit

 

History

History
119 lines (91 loc) · 5.56 KB

README_en-US.md

File metadata and controls

119 lines (91 loc) · 5.56 KB
Raw

简体中文 | English


Logo

Stapxs QQ Lite 2.0

An unofficial web QQ client compatible with OneBot
🌎 Live Demo  |   📦️ Downloads  |   💬 Feedback

This application is for educational and research purposes only.
For copyright issues, please file an issue for negotiation.

card

✨ Supported Features

  • ✅ Developed with a complete Vue.js framwork, frontend-backend seperated
  • 🎨 Adaptive landscape and portrait layouts
  • 🖥️ PWA support (why not just use our cool Electron app anyway)
  • 🌚 Auto Light/Dark Mode
  • 🍱 Includes almost everything you need!
    • Sending, revoking, forwarding or replying to a message. Complex messages handled!
    • Group storage (files), announcements, some group-specified settings and "essence"
    • Sending images, files and your favorite emotes!
  • 📦️ Multiple QQ bot APIs support
  • 🔥 A nice-looking Electron desktop app
  • 🥚 Easter eggs to be discovered!
  • 🛠 More to come ...

♿️ Get Started

> Running Services

Stapxs QQ Lite requires connecting to a QQ bot API to function properly. You can set one up by following 📖 this documentation.

> Using the App On the Go

GitHub Pages is enabled and is serving a live demo 🌎 over here.

> Installing the App

Besides the live demo, you can also download the desktop app built with Electron that has more features 📦️ here.

💬 Tips and FAQs

> Insecure connections?

  • When connecting to a WebSocket (ws) service via an HTTPS page, or vice versa, the connection will fail because one of them is insecure. In this case, you can choose to upgrade the WebSocket connection to a secure WebSocket (wss) or downgrade the HTTPS connection to HTTP (insecure) to solve the problem. However, specific solutions are not provided here. >> Stapxs-QQ-Lite#32

> Could I use other QQ bot APIs?

  • You can give them a try if they support the OneBot 11 protocol. However, the differences in message body formats and extension APIs may prevent them from being fully usable. Bot APIs supported are listed here.

> What are the risks involved in using a bot API?

  • For potential risks in using oicq-http, refer to this page. If you're using other QQ bot APIs, check out their own repositories for more infomation.

> I have questions / problems.

  • Don't hesitate to send us an issue if you do. Bug reports and suggestions are also welcome.

📦️ Building the App

> Building Webpages

Stapxs QQ Lite 2.0 is a single-page Vue application, which means you'll have to build the page before serving it.

NOTE: if you do not serve the app at public web root, you'll have to modify the value of publicPath in vue.config.js to your need before you build it. You can also remove the mentioned key if you only plan to serve the app at web root.

Below are commands used to test and build this Vue app. Artifacts will be in dist folder.

# Install dependencies
yarn install
# Test the app locally
yarn serve
# Check and format the code
yarn lint
# Build the app
yarn build

> Building the Electron App

Starting from version 2.3.0, Stapxs QQ Lite 2.0 can be built into an Electron app with enhanced features for some platforms. You can also build the app yourself with instructions below.

Commands for testing and building the Electron app are shown below. Artifacts will be in dist_electron/out folder.

# Run local Electron test
yarn electron:serve
# Build the Electron app
yarn electron:build

You can also specify the desired platform with an option:

yarn electron:build --linux

> GitHub Actions

Why would anyone be interested in build automation? Anyway, I had worked on it for so long and you can check it out yourself in GitHub Actions.

auto-build

🖼️ Screenshots

1 2 3 3

🎉 Credits

Shoutout to my friends who have offered help in development and translation!