# LilyWhiteBot

**Repository Path**: mrhso/LilyWhiteBot

## Basic Information

- **Project Name**: LilyWhiteBot
- **Description**: 互联机器人莉莉白
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-01-26
- **Last Updated**: 2022-06-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

LilyWhiteBot
===

[简化字版](https://github.com/mrhso/LilyWhiteBot/blob/master/README-hans.md)

[简化字版（内地用语）](https://github.com/mrhso/LilyWhiteBot/blob/master/README-hans-cn.md)

在多個群組間傳話的機器人。原名為「qq-tg-irc」。

## 如何安裝
目前支援 QQ、Telegram、IRC 和 Discord（[試驗中](https://github.com/mrhso/LilyWhiteBot/issues/4)）四種群組互聯。

### 必需步驟
* 根據實際需要準備機器人賬號。（具體方法見後面）
* 安裝 Node.js，版本要求：>=7.x。
* 下載機器人本體。
* 執行：
```
npm install
node main.js
```
* 如果擔心 crash 的話請直接迴圈，例如 `while true; do node main.js; done`，或者：
```batch
:a
node main.js
goto a
```
* 根據實際需要修改 config.example.js，並改名為 config.js。
* QQ 群格式 `qq/QQ 群號`；Telegram 群格式 `telegram/一串數字`（該數字可透過`/thisgroupid`取得，後面有說明，而且請注意該數字是**負數**）；IRC 頻道格式 `irc/#頻道名`，別忘了`#`；Discord 頻道格式 `discord/頻道 ID`。

### 設定 QQ 機器人
1. 在正式啟用互聯之前，建議提前註冊一個 QQ 小號，掛機掛到一定等級，並往錢包裡塞一點錢，以減小被騰訊封殺的可能性。不過從實踐情況來看，只有一顆星或不塞錢也無妨。
2. **下載[酷 Q](https://cqp.cc/)**，啟動一下以便完成安裝。
3. 下載 [me.cqp.ishisashi.cqsocketapi.cpk](https://dl.bintray.com/mrhso/cqsocketapi/me.cqp.ishisashi.cqsocketapi.cpk)，並放到酷 Q 的 app 目錄中。
4. 再次啟動酷 Q，登入機器人賬號，然後在插件設定中啟用「CoolQ Socket API (Node.js)」。
5. 根據實際需要修改 badwords.example.js，並改名為 badwords.js。「敏感詞」功能僅對 QQ 機器人有效。
6. 請記得定期清除快取。
7. 因為目前沒做監控功能，所以還請自己盯一下酷 Q 的狀態。

注意：
1. 本程式需要酷 Q Air/Pro 和這個專門的 cqsocketapi 才能收發 QQ 群訊息。
2. 執行程式時，酷 Q 會有很大機率要求你開啟 QQ 的設備鎖，因此註冊小號時請不要亂填電話號。
3. 酷 Q 模擬的是安卓 QQ，而且 QQ 不允許多個手機同時登入。如果已經開啟酷 Q，而且需要直接操作機器人賬號，請用電腦登入。
4. 酷 Q 是私有軟體，和我沒關係。
5. 酷 Q 可以透過 wine 在 Linux/Mac 系統中執行，可以參考[這篇教程](https://cqp.cc/t/30970)進行設定，不過該教程不再維護，請參見教程頁面上方到酷 Q 的 Docker 版本的使用方法的連接。Docker 版可參照[這裡](https://github.com/yukixz/cqsocketapi/issues/19)與[這裡](https://github.com/mrhso/cqsocketapi/blob/master/omake.md#docker-%E7%9A%84%E6%AD%A3%E7%A1%AE%E4%BD%BF%E7%94%A8%E6%96%B9%E6%B3%95)解決到酷 Q 部分的 cqsocketapi 通訊的問題。

### 設定 Telegram 機器人
@BotFather，與其交互，按照熒幕提示進行操作，建立一個機器人賬號。設定完成後，BotFather 會給一個 Token，你需要把這個 Token 填到 config.js 中。

之後請記得執行 `/setprivacy` 命令，將機器人的 Privacy 設為 DISABLED，以便於讓它看到群組內的訊息。

在剛開始的時候，可以保留 config.js 之內「plugins」中的「groupid-tg」，然後執行程式，並且在群組中輸入 `/thisgroupid`，這樣機器人會自動給出群組 ID 以便設定互聯。如果沒看懂前面那句話，你也可以把 @combot 拉進群中，然後輸入 `/stat`，看機器人給出的數字是多少。注意，數字是負數。

### 設定 IRC 機器人
IRC 沒有什麼特別之處。如果你有 Cloak，請在 config.js 中輸入正確的 userName、sasl_password，並將 sasl 設為 true。

### 設定 Discord 機器人
進入 [Discord Developer Portal](https://discordapp.com/developers/applications/)，創建 Application。在 Bot 頁面中 Add Bot。將 Token 填到 config.js 中。

頻道 ID 可以在網頁版之 URL 看到，最後面的那串神祕數字便是。

## 提示
1. 如果把 config.js 中的 `paeeye` 設為 `//`，那麼在訊息之前加入 `//`（例如「//隱藏」）可防止被其他群組看見。
2. 如果允許 IRC 接受命令（plugins 中有「irccommand」），那麼可在 Telegram 和 QQ 中使用 `/command 命令`。該命令並非 IRC 命令，而是為配合 IRC 頻道中的機器人而設。
3. 如果允許查詢 IRC 的情況（plugins 中有「ircquery」），那麼可在 Telegram 和 QQ 中使用 `/names`（取得在線用戶清單）、`/whois 暱稱`（whois）和 `/topic`（取得 Topic）。
4. 「敏感詞」功能僅在 QQ 有效，而且僅對機器人自己「張嘴」有效。啟用之後，程式會自動把敏感詞清單中的詞語轉為「*」，可使用正規表示式。具體的政治敏感詞彙可參照中文維基百科「中華人民共和國審查辭彙列表」條目製作，本專案不再提供。詳情見 badwords.example.js。

### 其他功能
以下各功能的設定方法均為改 config.js。
* [filter](https://github.com/vjudge1/LilyWhiteBot/blob/master/plugins/filter.js)：過濾符合指定規則的訊息。
* [qqxiaoice](https://github.com/vjudge1/LilyWhiteBot/blob/master/plugins/qqxiaoice.js)：召喚 QQ 群的小冰。（需要 QQ 群群主開啟小冰/BabyQ 功能）
* [wikilinky](https://github.com/vjudge1/LilyWhiteBot/blob/master/plugins/wikilinky.js)