add README_EN.md

Nova-Committee · Oct 28, 2022 · 6bf2005 · 6bf2005
1 parent e274dee
commit 6bf2005
Show file tree

Hide file tree

Showing 2 changed files with 136 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -20,12 +20,17 @@ _✨ 基于 [OneBot](https://github.com/howmanybots/onebot/blob/master/README.md
 </p>
 
 <p align="center">
-    <a href="#">English</a> | 
-    <a href="#">简体中文</a> |
-    <a href="#">QuickStart</a>
+    <a href="README_EN.md">English</a> | 
+    <a href="长期支持版本">长期支持版本</a> |
+    <a href="快速开始">快速开始</a>
 </p>
 
-# QuickStart
+# 长期支持版本
+
+> Forge-1.19.2  
+> Fabric-1.19.2
+
+# 快速开始
 
 ### 使用api进行请求
 
@@ -74,7 +79,7 @@ public class WebSocketServerTest {
 }
 ```
 
-# Client
+# 支持
 
 Bot-Connect 以 [OneBot-v11](https://github.com/howmanybots/onebot/tree/master/v11/specs)
 标准协议进行开发，兼容所有支持正向WebSocket的OneBot协议客户端
@@ -93,7 +98,7 @@ Bot-Connect 以 [OneBot-v11](https://github.com/howmanybots/onebot/tree/master/v
 
 * [OneBot](https://github.com/botuniverse/onebot)
 
-# License
+# 开源许可
 
 This product is licensed under the GNU General Public License version 3. The license is as published by the Free
 Software Foundation published at https://www.gnu.org/licenses/gpl-3.0.html.
@@ -104,13 +109,13 @@ The license is as published by the Free Software Foundation published at https:/
 Feel free to contact us if you have any questions about licensing or want to use the library in a commercial closed
 source product.
 
-# Thanks
+# 致谢
 
-Thanks [JetBrains](https://www.jetbrains.com/?from=Shiro) Provide Free License Support OpenSource Project
+感谢 [JetBrains](https://www.jetbrains.com/?from=Shiro) 提供了这么好用的软件~
 
 [<img src="https://mikuac.com/images/jetbrains-variant-3.png" width="200"/>](https://www.jetbrains.com/?from=mirai)
 
-## Stargazers over time
+## 星星（要要）~⭐
 
 [![Stargazers over time](https://starchart.cc/Nova-Committee/Bot-Connect.svg)](https://starchart.cc/Nova-Committee/Bot-Connect)
 

diff --git a/README_EN.md b/README_EN.md
@@ -0,0 +1,122 @@
+<p align="center">
+    <img width="300" src="https://s2.loli.net/2022/10/02/zrebhtAKjc3GyIl.png" alt="title">  
+</p>
+<div align="center">
+
+# Bot-Connect
+
+_✨ Based on [OneBot](https://github.com/howmanybots/onebot/blob/master/README.md) protocol's MineCraft QQ Robot✨_
+
+</div>
+<hr>
+<p align="center">
+    <a href="https://github.com/Nova-Committee/Bot-Connect/issues"><img src="https://img.shields.io/github/issues/Nova-Committee/Bot-Connect?style=flat" alt="issues" /></a>
+    <a href="https://www.curseforge.com/minecraft/mc-mods/botconnect">
+        <img src="http://cf.way2muchnoise.eu/botconnect.svg" alt="CurseForge Download">
+    </a>
+    <img src="https://img.shields.io/badge/license-GPLV3-green" alt="License">
+    <a href="https://github.com/howmanybots/onebot"><img src="https://img.shields.io/badge/OneBot-v11-blue?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABABAMAAABYR2ztAAAAIVBMVEUAAAAAAAADAwMHBwceHh4UFBQNDQ0ZGRkoKCgvLy8iIiLWSdWYAAAAAXRSTlMAQObYZgAAAQVJREFUSMftlM0RgjAQhV+0ATYK6i1Xb+iMd0qgBEqgBEuwBOxU2QDKsjvojQPvkJ/ZL5sXkgWrFirK4MibYUdE3OR2nEpuKz1/q8CdNxNQgthZCXYVLjyoDQftaKuniHHWRnPh2GCUetR2/9HsMAXyUT4/3UHwtQT2AggSCGKeSAsFnxBIOuAggdh3AKTL7pDuCyABcMb0aQP7aM4AnAbc/wHwA5D2wDHTTe56gIIOUA/4YYV2e1sg713PXdZJAuncdZMAGkAukU9OAn40O849+0ornPwT93rphWF0mgAbauUrEOthlX8Zu7P5A6kZyKCJy75hhw1Mgr9RAUvX7A3csGqZegEdniCx30c3agAAAABJRU5ErkJggg=="></a>
+
+</p>
+
+<p align="center">
+    <a href="README.md">简体中文</a> |
+    <a href="LTS">LTS</a> |
+    <a href="QuickStart">QuickStart</a>
+</p>
+
+# LTS
+
+> Forge-1.19.2  
+> Fabric-1.19.2
+
+# QuickStart
+
+### Use api to request
+
+```java
+public class TestCmd {
+    public static ArgumentBuilder<CommandSourceStack, ?> register() {
+        return Commands.literal("test")
+                .executes(TestCmd::execute);
+    }
+
+    public static int execute(CommandContext<CommandSourceStack> context) throws CommandSyntaxException {
+        System.out.println(BotApi.bot.sendGroupMsg(337631140, MsgUtils.builder().text("1").build(), true));
+        //send messages to the group
+        return 0;
+    }
+}
+```
+
+### Event Listener Instance
+
+```java
+public class WebSocketServerTest {
+    public static void main(String[] args) throws Exception {
+        LinkedBlockingQueue<String> blockingQueue = new LinkedBlockingQueue<>();//use queues to transfer data
+        Connection service = ConnectFactory.createWebsocketClient(new BotConfig("ws://127.0.0.1:8080", null, false), blockingQueue);
+        EventDispatchers dispatchers = new EventDispatchers(blockingQueue);//create an event distributor
+        GroupMessageListener groupMessageListener = new GroupMessageListener();
+        groupMessageListener.addHandler("weather", new Handler<GroupMessageEvent>() {
+            @Override
+            public void handle(GroupMessageEvent groupMessage) {
+                System.out.println(groupMessage);
+
+            }
+        });
+        dispatchers.addListener(groupMessageListener);//add listener
+        dispatchers.addListener(new SimpleListener<PrivateMessageEvent>() {//private listener
+            @Override
+            public void onMessage(PrivateMessageEvent privateMessage) {
+                System.out.println(privateMessage);
+            }
+        });
+
+        dispatchers.start(10);//thread groups process tasks
+
+    }
+}
+```
+
+# Client
+
+Bot-Connect  [OneBot-v11](https://github.com/howmanybots/onebot/tree/master/v11/specs)
+developed with standard protocols, compatible with all One Bot protocol clients that support forward Web sockets
+
+| Project Address                                                                | Platform                                      | Authors        | Note                                                                      |
+|--------------------------------------------------------------------------------|-----------------------------------------------|----------------|---------------------------------------------------------------------------|
+| [koishijs/koishi](https://github.com/koishijs/koishi)                          | [koishi](https://koishi.js.org/)              | shigma         |                                                                           |
+| [onebot-walle/walle-q](https://github.com/onebot-walle/walle-q)                |                                               | abrahum        |                                                                           |
+| [Yiwen-Chan/OneBot-YaYa](https://github.com/Yiwen-Chan/OneBot-YaYa)            | [先驱](https://www.xianqubot.com/)              | kanri          |                                                                           |
+| [richardchien/coolq-http-api](https://github.com/richardchien/coolq-http-api)  | CKYU                                          | richardchien   | Can be used by [mirai-native](https://github.com/iTXTech/mirai-native)    |
+| [Mrs4s/go-cqhttp](https://github.com/Mrs4s/go-cqhttp)                          | [MiraiGo](https://github.com/Mrs4s/MiraiGo)   | Mrs4s          |                                                                           |
+| [yyuueexxiinngg/OneBot-Mirai](https://github.com/yyuueexxiinngg/onebot-kotlin) | [Mirai](https://github.com/mamoe/mirai)       | yyuueexxiinngg |                                                                           |
+| [takayama-lily/onebot](https://github.com/takayama-lily/onebot)                | [OICQ](https://github.com/takayama-lily/oicq) | takayama       |                                                                           |
+
+# Credits
+
+* [OneBot](https://github.com/botuniverse/onebot)
+
+# License
+
+This product is licensed under the GNU General Public License version 3. The license is as published by the Free
+Software Foundation published at https://www.gnu.org/licenses/gpl-3.0.html.
+
+Alternatively, this product is licensed under the GNU Lesser General Public License version 3 for non-commercial use.
+The license is as published by the Free Software Foundation published at https://www.gnu.org/licenses/lgpl-3.0.html.
+
+Feel free to contact us if you have any questions about licensing or want to use the library in a commercial closed
+source product.
+
+# Thanks
+
+Thanks [JetBrains](https://www.jetbrains.com/?from=Shiro) Provide Free License Support OpenSource Project
+
+[<img src="https://mikuac.com/images/jetbrains-variant-3.png" width="200"/>](https://www.jetbrains.com/?from=mirai)
+
+## Stargazers over time
+
+[![Stargazers over time](https://starchart.cc/Nova-Committee/Bot-Connect.svg)](https://starchart.cc/Nova-Committee/Bot-Connect)
+
+