From 029b0760a9fa557e0bdaa7c01faa7d56de2d6dc6 Mon Sep 17 00:00:00 2001 From: takayama Date: Fri, 30 Oct 2020 23:08:30 +0900 Subject: [PATCH] add --no-save update README.md --- .gitignore | 7 +-- README.md | 124 ++++++++++++++++++++++++++++----------------------- main.js | 4 +- package.json | 4 +- 4 files changed, 76 insertions(+), 63 deletions(-) diff --git a/.gitignore b/.gitignore index 65b40c8..8216486 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ -node_modules -.vscode -config.js +node_modules +.vscode +data +config.js diff --git a/README.md b/README.md index 16f8b89..25cd326 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ 1. 下载安装 [nodejs](https://nodejs.org) 2. 下载此源码包 (建议用`git clone`) -执行 `npm up` 安装依赖 (已集成自动安装) +执行 `npm up --no-save` 安装依赖 (已集成自动安装) 3. 重命名 `config.sample.js` 为 `config.js` 并配置 4. 运行 `node main 123456789` (数字是登陆账号) @@ -24,46 +24,58 @@ ---- -## API +## API ([参考文档](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md))
-已实现 +已实现(文档中已列出) -|名称|参数([参考文档](https://github.com/howmanybots/onebot/blob/master/v11/specs/api/public.md))|备注| +|名称|备注| +|-|-| +|get_friend_list | +|get_group_list | +|get_group_info | +|get_group_member_list | +|get_group_member_info | +|get_stranger_info | +|send_private_msg |返回的message_id是字符串格式 +|send_group_msg |返回的message_id是字符串格式 +|send_msg | +|delete_msg | +|set_friend_add_request | +|set_group_add_request | +|set_group_special_title| +|set_group_admin | +|set_group_card | +|set_group_kick | +|set_group_ban | +|set_group_leave | +|set_group_name | +|set_group_whole_ban | +|set_group_anonymous | +|send_like | +|get_login_info | +|can_send_image | +|can_send_record | +|get_status | +|get_version_info |暂时返回的是内核版本 +|.handle_quick_operation|仅WS有效 +|get_cookies |暂时更新可能存在问题 +|get_csrf_token |暂时更新可能存在问题 +|clean_cache | + +
+ +
+ +已实现(新增) + +|名称|参数|备注| |-|-|-| -|get_friend_list || -|get_stranger_list || -|get_group_list || -|get_group_info || -|get_group_member_list || -|get_group_member_info || -|get_stranger_info || -|send_private_msg ||返回的message_id是字符串格式 -|send_group_msg ||返回的message_id是字符串格式 +|get_stranger_list ||获取陌生人列表 |send_discuss_msg |discuss_id
message
auto_escape|发讨论组消息,没有message_id -|send_msg || -|delete_msg || -|set_friend_add_request || -|set_group_add_request || -|send_group_notice || +|send_group_notice |content|发送群公告 |send_group_poke |group_id
user_id|群戳一戳,未来可能会用CQ码实现 -|set_group_special_title|| -|set_group_admin || -|set_group_card || -|set_group_kick || -|set_group_ban || -|set_group_leave || -|set_group_name || -|set_group_whole_ban || -|set_group_anonymous || -|send_like || -|get_login_info || -|can_send_image || -|can_send_record || -|get_status || -|get_version_info ||暂时返回的是内核版本 -|.handle_quick_operation||仅WS有效 |set_online_status |status|设置在线状态(※仅限手机协议支持)
11我在线上 31离开 41隐身 50忙碌 60Q我吧 70请勿打扰| |add_group |group_id
comment|加群和加好友是风险接口,频繁调用账号会被风控 |add_friend |group_id
user_id
comment|添加好友
暂时只能添加群员 @@ -75,9 +87,6 @@ |set_description |description|设置个人说明 |set_signature |signature|设置签名 |set_portrait |file|设置个人头像,与CQ码中的file格式相同 -|get_cookies ||更新可能存在问题 -|get_csrf_token ||更新可能存在问题 -|clean_cache ||
@@ -85,16 +94,17 @@ 尚未实现 -|名称|是否计划实现| -|-|-| -|get_msg|否| -|get_forward_msg|否| -|get_group_honor_info|否| -|get_credentials|否| -|get_record|否| -|get_image|否| -|set_group_snonymous_ban|是| -|set_restart|是| +|名称| +|-| +|get_msg| +|get_forward_msg| +|get_group_honor_info| +|get_credentials| +|get_vip_info| +|get_record| +|get_image| +|set_group_snonymous_ban| +|set_restart| @@ -131,7 +141,7 @@ |管理变更|notice.group.admin |notice.group_admin | |群组禁言|notice.group.ban |notice.group_ban | |群组转让|notice.group.transfer | | -|群组文件| |notice.group_upload | +|群组文件|表现为CQ码 |notice.group_upload | |头衔变更|notice.group.title | | |群戳一戳|notice.group.poke | | |群设置变|notice.group.setting | | @@ -146,22 +156,24 @@ ## 其他 -* [x] _async异步调用api * [x] 字符串或数组消息段 * [x] 鉴权 * [x] WS心跳 -* [ ] 事件上报过滤 +* [x] _async异步调用api * [x] _rate_limited限速调用api +* [ ] 事件上报过滤 * [x] 自动更新内核版本 [内核功能支持和CQ码](https://github.com/takayama-lily/oicq/blob/dev/docs/project.md) ---- -### 为什么要使用Nodejs +### 本项目的优势,以及为什么使用Nodejs -* 依附于强大的node&v8引擎,高速稳定,彻底告别平台兼容性导致的异常崩溃等问题 -* 利用npm包管理器一键更新依赖库,版本升级简单方便 -* node是单线程事件循环,非常适合此类io密集型应用,从根源上杜绝多线程带来数据竞争等奇怪问题 -* 使用最新的ECMAScript2010语法,用最少的代码实现所需功能,项目可维护性显著上升 -* 考虑到JavaScript仍然是使用人数最多的编程语言,而node运行时完全开源,任何人都可以尝试解决问题,而不仅限于发现问题 +* 完美的跨平台和多账号支持,部署简单方便。 +* 利用npm包管理器自动更新依赖库,版本升级简单方便。 +* 运行时几乎没有垃圾文件产生,占用最低限资源。 +* 依附于强大的node&v8引擎,高速稳定,彻底告别平台兼容性导致的异常崩溃等问题。 +* 单线程事件循环搭配语言层面的协程,非常适合此类io密集型应用,从根源上杜绝多线程带来的数据竞争等奇怪问题。 +* 考虑到JavaScript仍然是使用人数最多的编程语言,而项目运行时完全开源,使得任何人都可以尝试解决问题,而不仅限于发现问题。 +* 使用最新的ECMAScript2010语法,用最少的代码实现所需功能,使项目可维护性显著提升。便于阅读和调试的源码,带你走进底层OICQ协议的世界。 diff --git a/main.js b/main.js index 749f7e8..d415c92 100644 --- a/main.js +++ b/main.js @@ -19,9 +19,9 @@ try { try { console.log(`正在检查&更新内核版本..`); - require("child_process").execSync("npm up", {stdio: "ignore"}); + require("child_process").execSync("npm up --no-save", {stdio: "ignore"}); } catch (e) { - console.log(`"npm up"执行失败,你可能需要手动执行。`); + console.log(`"npm up --no-save"执行失败,你可能需要手动执行。`); } require("oicq"); diff --git a/package.json b/package.json index 56e5f14..8d4ca45 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "node-onebot", - "version": "1.1.0", + "version": "1.1.2", "description": "onebot", "main": "main.js", "scripts": { @@ -17,7 +17,7 @@ }, "homepage": "https://github.com/takayama-lily/onebot#readme", "dependencies": { - "oicq": "^1.3.6", + "oicq": "^1.10.0", "ws": "^7.3.1" } }