# wechaty-room-manager

> a room manager that can manage room.

Latest version **0.0.9** (published 2020-05-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install wechaty-room-manager
pnpm add wechaty-room-manager
yarn add wechaty-room-manager
bun add wechaty-room-manager
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2020-05-30 |
| First published | 2020-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 74.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | LegendaryJesse |
| Maintainers | legendaryjesse |
| Keywords | wechaty, manager, room manager, topic |

## Links

- npm: https://www.npmjs.com/package/wechaty-room-manager
- Repository: https://github.com/JesseWeb/wechaty-room-manager
- Homepage: https://github.com/JesseWeb/wechaty-room-manager#readme
- Issues: https://github.com/JesseWeb/wechaty-room-manager/issues
- npm.io page: https://npm.io/package/wechaty-room-manager

## Dependencies (3)

- [lowdb](https://npm.io/package/lowdb.md) ^1.0.0
- [rx-queue](https://npm.io/package/rx-queue.md) ^0.8.5
- [@types/lowdb](https://npm.io/package/@types/lowdb.md) ^1.0.9

## Recent versions

- 0.0.9 (latest) — 2020-05-30
- 0.0.8 — 2020-05-30
- 0.0.7 — 2020-05-14
- 0.0.6 — 2020-05-14
- 0.0.5 — 2020-05-14
- 0.0.4 — 2020-05-13
- 0.0.3 — 2020-05-13
- 0.0.2 — 2020-05-13
- 0.0.1 — 2020-05-12

## README

# Wechaty-Room-Manager [![Npm Version](https://img.shields.io/npm/v/wechaty-room-manager.svg?sanitize=true)](https://www.npmjs.com/package/wechaty-room-manager)

## What is this?

I am wechaty multiple room manager who leterally could do anything.

我是 [wechaty](https://github.com/wechaty/wechaty) 多群管理插件，目标是减轻群管理工作量
## Installation

```bash
npm install wechaty-room-manager@latest
```
## Usage

```javascript
import {Wechaty} from "wechaty"

import {manager} from "wechaty-room-manager"

const bot = new Wechaty({
   name:"wechaty-room-manager"
})

bot.use(manager({
   rooms: [{
      id: "1238716979@chatroom",
      topic: "机器人测试群",//either id or topic , using "===" to compare ｜ id topic二选一即可 建议id避免混淆 使用===比较

      knockKnock:"我要进群",  //机器人拉用户进入该群的口令


      //接受好友邀请的
      

      //新人入群的欢迎消息
      roomHiTemp:"欢迎入群，请遵守群规", //@someone 欢迎入群，请遵守群规

      
      // 为什么使用array？
      // 因为laptop与手机端表情字符存在不一致的情况。且可支持多指令。
      voteSymbol: ['[弱]', '/:MMWeak'], 

      // 该房间的白名单、无法被投票。必须为id，防止修改成同样的alias伪装管理员
      // 注：此whiteList对kickout无效
      whiteList:[
         "botorange_yeah"
      ],
      /*
      *  踢出命令   @someone[炸弹]
      *  注：kickout只有admin才有权限
      *  
      */
      kickoutSymbol: ["[炸弹]", "/:bome"],

      // 被投票次数、超出即自动踢出
      voteCount: 3,
      // 踢出模版 
      // 会在开头自动@被踢出人
      kickoutTemp() {
         return "您已被踢出"   //@someone 您已被踢出
      },
      voteOutTemp(count) {
         return `您已被警告${count}次，您已被踢出群聊`  //@someone 您已被警告${count}次，您已被踢出群聊
      },
      warnTemp(count, voteCount) {
         return `您已被其他人警告次数达到${count}次，请谨慎发言。警告次数达到${voteCount}将被踢出`
      },
      autoKick:{
         keyword: new RegExp("砍我一下") || "帮我助力", //正则使用test() 。字符串使用includes()
         message: "您已触犯群规，将被踢出"
      }
   }],
   //全局管理员、拥有高级能力例如直接踢人
   admins: [
      "xyzcain"
   ],
   //是否自动接受好友请求
   friendshipAcceped: true, 

   //接受好友请求发送的内容
   hiTemp:`你好，我是机器人。加群请发送"我要进群"`, 
}))

bot.start()
   .catch(console.error)
```

## Test
```bash
npm run test
```

## Build
```bash
npm run build
```
## Maintainers
* @LegendaryJesse - [LegendaryJesse](https://github.com/JesseWeb)

## Copyright & License

* Code & Docs © 2020-now LegendaryJesse|Wechaty
* Code released under the MIT License
* Docs released under Creative Commons

---
_Source: https://npm.io/package/wechaty-room-manager · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._