https://github.com/caomeiyouren/koishi-plugin-adapter-wechaty
Koishi Wechaty 适配器
https://github.com/caomeiyouren/koishi-plugin-adapter-wechaty
Last synced: about 2 months ago
JSON representation
Koishi Wechaty 适配器
- Host: GitHub
- URL: https://github.com/caomeiyouren/koishi-plugin-adapter-wechaty
- Owner: CaoMeiYouRen
- License: agpl-3.0
- Created: 2023-12-07T08:10:51.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-12-08T13:38:22.000Z (almost 2 years ago)
- Last Synced: 2025-08-08T14:30:53.820Z (3 months ago)
- Language: TypeScript
- Size: 50.8 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
@cao-mei-you-ren/koishi-plugin-adapter-wechaty
> Koishi Wechaty 适配器
>
> 本项目是原 [koishi-plugin-adapter-wechaty](https://code.mycard.moe/3rdeye/koishi-plugin-adapter-wechaty) 的修复版，在最新的 koishi@4.15.7 可用
>
> Tips: 关于可用性，目前仅在 Windows 下测试通过，Docker(Linux) 平台自测不通过，macOS 缺乏设备。如果有成功接入的用户，请在 issues 或 discussions 中反馈一下，谢谢。
## 🏠 主页
[https://github.com/CaoMeiYouRen/koishi-plugin-adapter-wechaty#readme](https://github.com/CaoMeiYouRen/koishi-plugin-adapter-wechaty#readme)
## 📦 依赖要求
- node >=16
- koishi >= 4.15.7
## 🚀 安装
### 插件市场安装
前往插件市场搜索 `@cao-mei-you-ren/adapter-wechaty` 然后安装即可。
**Tips**：被提示为`不安全`是正常的，具体原因可见：[应当避免的情况](https://koishi.chat/zh-CN/cookbook/design/storage.html#%E5%BA%94%E5%BD%93%E9%81%BF%E5%85%8D%E7%9A%84%E6%83%85%E5%86%B5)。
> 简而言之就是 wechaty 这个包本身用到了基于 gyp 的包，故依赖 wechaty 的本项目也被提示 **不安全**
### 手动安装
```sh
npm install @cao-mei-you-ren/koishi-plugin-adapter-wechaty
```
## 👨💻 使用
前往插件页面按照引导完成配置，然后点击启用
### name
注意，`name` 字段在启用多个插件实例的时候不可重复！
### puppet
默认为 `wechaty-puppet-wechat`。
详见：https://wechaty.js.org/zh/docs/specs/puppet
### selfId
机器人自身 ID，用于比对是否为机器人自身的消息。
注意和微信号不同。
### ioToken
详见：https://wechaty.js.org/zh/docs/puppet-services/tokens
### wechaty-puppet-wechat
启动插件，并在 Koishi 控制台的『日志』或是 stdout 中查看二维码，扫描登录。
如果一切正常的话，应该可以在日志页面看到如下图片，扫码登录即可
## 🛠️ 开发
```sh
npm run dev
```
## 🔧 编译
```sh
npm run build
```
## 🔍 Lint
```sh
npm run lint
```
## 💾 Commit
```sh
npm run commit
```
## 👤 作者
**CaoMeiYouRen**
* Website: [https://blog.cmyr.ltd/](https://blog.cmyr.ltd/)
* GitHub: [@CaoMeiYouRen](https://github.com/CaoMeiYouRen)
## 🤝 贡献/提问
欢迎 贡献、提问或提出新功能！
如有问题请查看 [issues page](https://github.com/CaoMeiYouRen/koishi-plugin-adapter-wechaty/issues).
贡献或提出新功能可以查看[contributing guide](https://github.com/CaoMeiYouRen/koishi-plugin-adapter-wechaty/blob/master/CONTRIBUTING.md).
### 关于问题反馈的额外说明
可以向本项目提出问题和反馈，但不一定能得到解决。
由于本项目的核心代码都是从[原项目](https://code.mycard.moe/3rdeye/koishi-plugin-adapter-wechaty)复制的，所以很多逻辑我也没有理清楚，故仅提供基础维护，即：确保在 `Wechaty`本身可用的情况下确保`@cao-mei-you-ren/koishi-plugin-adapter-wechaty`可用。
### 关于 License
由于原项目使用了 [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.zh-cn.html)，故根据 AGPL-3.0，本项目也需要使用 AGPL-3.0 进行开源。
## 💰 支持
如果觉得这个项目有用的话请给一颗⭐️，非常感谢
## 🌟 Star History
[](https://star-history.com/#CaoMeiYouRen/koishi-plugin-adapter-wechaty&Date)
## 📝 License
Copyright © 2023 [CaoMeiYouRen](https://github.com/CaoMeiYouRen).
This project is [AGPL-3.0](https://github.com/CaoMeiYouRen/koishi-plugin-adapter-wechaty/blob/master/LICENSE) licensed.
***
_This README was generated with ❤️ by [cmyr-template-cli](https://github.com/CaoMeiYouRen/cmyr-template-cli)_