hotcat-bot-qq 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 CHCAT1320
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,53 @@
1
+ # HotCat Bot
2
+
3
+ 基于 [node-napcat-ts](https://github.com/HkTeamX/node-napcat-ts) 的 TypeScript QQ 机器人框架。
4
+
5
+ <p align="center">
6
+ <img src="logo.png" width="120" alt="HotCat Bot Logo">
7
+ </p>
8
+
9
+ ## 安装
10
+
11
+ ```bash
12
+ npm add hotcat-bot-qq
13
+ # or
14
+ pnpm add hotcat-bot-qq
15
+ # or
16
+ bun add hotcat-bot-qq
17
+ ```
18
+
19
+ ## 快速开始
20
+
21
+ ```ts
22
+ import { BotClient, Message } from 'hotcat-bot-qq'
23
+
24
+ const bot = new BotClient({
25
+ baseUrl: 'ws://localhost:8082/onebot/v11/ws/',
26
+ accessToken: 'your-access-token',
27
+ })
28
+ await bot.start()
29
+
30
+ bot.event.message.onGroupMessage(async (bot, event) => {
31
+ await bot.api.sendGroupMessage(event.group_id,
32
+ Message.reply(event.message_id),
33
+ Message.text('pong!')
34
+ )
35
+ })
36
+ ```
37
+
38
+ ## 特性
39
+
40
+ - **类型安全** — 完整的 TypeScript 类型推导,封装 napcat 全部 API
41
+ - **消息段构建** — `Message` 类支持文本、图片、表情、文件等所有消息类型
42
+ - **彩色日志** — 内置 `BotConsole` 控制台日志,自动解析 CQ 码
43
+ - **事件系统** — `BotEvent` 按类别分组暴露 message/messageSent/request/notice 事件
44
+
45
+ ## 文档
46
+
47
+ 完整文档 → [hotcat-bot-qq.docs.chcat1320.top](https://hotcat-bot-qq.docs.chcat1320.top)
48
+
49
+ 快速开始 → [docs/guide/getting-started.md](docs/guide/getting-started.md)
50
+
51
+ ## 协议
52
+
53
+ MIT © CHCAT1320