rc-plugin/README.md
2023-02-18 14:46:44 +08:00

162 lines
5.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<p align="center">
<a href="https://gitee.com/kyrzy0416/rconsole-plugin">
<img width="200" src="./img/logo.png">
</a>
</p>
<div align="center">
<h1>R-plugin</h1>
写给朋友们用的<a href="https://gitee.com/Le-niao/Yunzai-Bot" target="_blank">Yunzai-Bot</a>插件,插件的各种业务来源于周围人
<img src="https://cdn.jsdelivr.net/gh/xianxincoder/xianxincoder/assets/github-contribution-grid-snake.svg">
</div>
## 🗃️ 文件架构
apps -- 业务核心
config -- 配置文件
img -- readme图片
model -- 核心文件[建议不动]
resource -- 资源文件
test -- 爬虫文件[python]
utils -- 工具类
index -- 主入口
## 🧏 ‍使用实例
![help](./img/example.png)
![help](./img/example2.png)
![help](./img/example3.png)
![help](./img/example4.png)
![help](./img/example5.png)
## 🤺 BUG及时交流群
【关于Windows适配】目前 [好冷群友](https://gitee.com/hetangx) 已经提供了一个比较可靠的解决方案,已经采纳并使用!
![help](./img/community.jpg)
> 备用方案https://t.me/+ZsZMNE8OI7E3MDdl
## 📔 使用说明
1.【必要】在`Yunzai-Bot`安装mongodb、axios(0.27.2)、代理工具tunnel、TwitterAPI依赖
> pnpm add mongodb axios tunnel twitter-api-v2 -w
2.【必要】下载插件
> git clone https://gitee.com/kyrzy0416/rconsole-plugin.git ./plugins/rconsole-plugin/
3.【可选】要使用`视频解析`功能要下载插件【推荐ubuntu系统】
```shell
# ubuntu
sudo apt-get install ffmpeg
# centos 参考https://blog.csdn.net/XIAOGUANG_/article/details/105343886
# Windows 参考https://www.jianshu.com/p/5015a477de3c
````
## 🧑‍🌾 进阶
【可选】备注考虑到不是所有电脑都有mongodb如果要开启`#我靠`功能,需要进行以下操作:
### 使用Python、Mongodb爬虫三次元图片
首先去test文件跑python代码(要安装`requirements.txt`要求的依赖)
> python3 ./test/main.py
需要把以下代码(apps/mystery.js)注释取消:
```javascript
// in apps/mystery.js
// Mongodb初始化
import mongodb from 'mongodb'
// Mongodb初始化
function initMongo () {
const MongoClient = mongodb.MongoClient
const url = 'mongodb://localhost:27017/'
return new Promise((resolve, reject) => {
MongoClient.connect(url, (err, db) => {
const dbo = db.db('test')
if (err) {
throw err // 和调用 reject(err) 效果类似
}
let collection = dbo.collection('temp')
resolve(collection)
})
})
}
const mongo = initMongo()
// ...
{
reg: '^#我靠', fnc: 'tuiimg'
}
// ...
async tuiimg (e) {
const MAX_SIZE = this.mysteryConfig.tuiimg.count
this.reply('这群早晚被你整没了...')
let images = []
const template = {
nickname: this.e.sender.card || this.e.user_id, user_id: this.e.user_id
}
await mongo.then(conn => {
return conn.aggregate([ { $sample: { size: MAX_SIZE } } ]).toArray()
}).then((result) => {
result.forEach((item) => {
images.push({
message: segment.image(item.url), ...template
})
})
})
return !!(await this.reply(await Bot.makeForwardMsg(images), false, {
recallMsg: recallTime
}))
}
```
> 备注:
> 1. linux/windows系统下自己装一个mongodb上一个密码(不上有风险)
> 2. `test/main.py`爬取链接要有python环境、配合mongodb使用
### 其他进阶操作
【可选】相关配置(apps/tools.js)
> twiiter-api:https://developer.twitter.com/en
注册完之后将`Bearer Token`填入app/tools.js twitter方法的TwitterApi后面的单引号里`const twitterClient = new TwitterApi('', {httpAgent});`
> 百度翻译api:https://fanyi-api.baidu.com/doc/21
注册完填入方式参考上方注释url (app/tools.js)
> 更改proxy地址在config/tools.yaml
`proxyAddr: '127.0.0.1' # 魔法地址`
`proxyPort: '6152' # 魔法端口`
## 📦 业务
![help](./img/help.jpg)
## 🤳 版本
![help](./img/version.jpg)
## ☕ 请我喝一杯瑞幸咖啡
如果你觉得插件能帮助到你增进好友关系,那么你可以在有条件的情况下[请我喝一杯瑞幸咖啡](https://afdian.net/a/zhiyu1998),这是我开源这个插件的最大动力!
![help](./img/afdian.jpg)
感谢以下朋友的支持!(排名不分多少)
| 昵称 | 赞助 |
|:---------------:|-----|
| 一杯凉 | 30 |
| 左轮ps. 我导师,泪目!) | 13 |
| mitsuha | 13 |
| [Kr] 5s¹ | 13 |
## 👩‍👩‍👧‍👧 开发团队
| Nickname | Contribution |
| :----------------------------------------------------------: |--------------|
|[易曦翰](https://gitee.com/yixihan) | 后端开发 |
|[zhiyu](https://gitee.com/kyrzy0416) | 后端开发 |
|[Diviner](https://gitee.com/divinerJJ) | 前端开发 |
|[小白白](https://gitee.com/little_White01) | 后端开发 |
## 🚀 后记
* 文件借鉴了很多插件,精简个人认为可以精简的内容。
* 素材来源于网络,仅供交流学习使用
* 严禁用于任何商业用途和非法行为
* 如果对你有帮助辛苦给个star这是对我最大的鼓励