tanebi
Version:
NTQQ Node.js Protocol Implementation
99 lines (79 loc) • 2.1 kB
Markdown
<div align="center">
[GitHub Homepage](https://github.com/tanebijs/tanebi)
</div>
This is the core library of the project. It provides the basic functions of the QQ protocol, such as login, message sending, and so on.
## Features
<details>
<summary> Protocol </summary>
- [x] Windows[^1]
- [x] macOS[^1]
- [x] Linux
[^1]: Theoretically. You need to find a sign server yourself.
</details>
<details>
<summary> Login </summary>
- [x] QRCode
- [x] NTEasyLogin
- [ ] Password[^2]
[^2]: Deprecated and not planned.
</details>
<details>
<summary> Message </summary>
- [x] Text
- [x] Face[^4]
- [x] Mention (At)
- [x] Image
- [x] Reply
- [x] Record
- [x] Video[^3]
- [ ] Market Face
- [x] Multi Forwarded Message
- [ ] XML
- [x] Light App[^3]
- [ ] Markdown
[^3]: Only implemented receiving.
[^4]: *May* not function properly when sending.
</details>
<details>
<summary> Operation </summary>
- [x] Fetch friends
- [x] Fetch groups
- [x] Fetch group members
- [x] Send poke
- [x] Send face reaction
- [x] Recall message
- [x] Leave group
- [x] Set member card
- [x] Ban (mute) member[^5]
- [x] Kick member
- [x] Set member to admin
- [x] Set special title
- [x] Handle friend request
- [x] Handle group request
- [x] Handle group invitation
- [ ] Get client key
- [ ] Get cookies
</details>
<details>
<summary> Event </summary>
- [ ] Bot offline
- [x] Friend poke
- [x] Friend message recall
- [x] Friend request
- [x] Group poke
- [x] Group message recall
- [x] Group mute
- [x] Group join request
- [x] Group invited join request
- [x] Group member increase
- [x] Group member decrease
- [x] Group invitation
- [x] Group admin change
- [x] Group essence message
- [x] Group face reaction
- [ ] Group TODO
</details>
## Contribution
> [!TIP]
> If you want to contribute to this project, please consider using **Visual Studio Code** instead of JetBrains IDEs to improve type inferring performance and enhance coding experience.