Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shugen002/BotRoot
开黑啦机器人JavaScript SDK
https://github.com/shugen002/BotRoot
bot kaiheila
Last synced: about 2 months ago
JSON representation
开黑啦机器人JavaScript SDK
- Host: GitHub
- URL: https://github.com/shugen002/BotRoot
- Owner: shugen002
- License: mit
- Created: 2020-12-17T04:04:23.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-19T14:23:09.000Z (over 1 year ago)
- Last Synced: 2024-05-22T13:33:17.930Z (4 months ago)
- Topics: bot, kaiheila
- Language: TypeScript
- Homepage:
- Size: 414 KB
- Stars: 18
- Watchers: 3
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BotRoot
开黑啦机器人 JavaScript SDK
## 安装 install
```
npm i kaiheila-bot-root
```
## 用法 usage
### Webhook 独立模式
在开黑啦机器人概况中选择连接模式为 webhook 并设置为
```
http://你的公网IP或域名:8600/?compress=0
```
代码：
```js
var Bot = require('kaiheila-bot-root').KaiheilaBot
var bot = new Bot({
mode: 'webhook',
port: 8600,
key: 'YOUR ENCRYPT KEY', // 和设置的一致，如果这个值为空视为不加密
token: 'YOUR TOKEN',
verifyToken: 'YOUR VERIFY TOKEN',
})
/**
* 输出保存原始数据
*/
bot.messageSource.on('message', (e) => {
console.log(e)
if (typeof e.msg_id === 'string') {
writeFile(
`cache/${e.msg_id}.json`,
JSON.stringify(e, undefined, 2),
(e) => {
if (e) {
console.error(e)
}
}
)
}
})
/**
* 监听文本信息
*/
bot.on('textMessage', (e) => {
console.log(e)
})
bot.listen()
```
### Webhook 合并模式
做了，懒得写了
### websocket 模式
```js
var Bot = require('kaiheila-bot-root').KaiheilaBot
var bot = new Bot({
mode: 'websocket',
token: 'YOUR TOKEN',
})
/**
* 输出保存原始数据
*/
bot.messageSource.on('message', (e) => {
console.log(e)
if (typeof e.msg_id === 'string') {
writeFile(
`cache/${e.msg_id}.json`,
JSON.stringify(e, undefined, 2),
(e) => {
if (e) {
console.error(e)
}
}
)
}
})
/**
* 监听文本信息
*/
bot.on('textMessage', (e) => {
console.log(e)
})
bot.listen()
```