|
1 | 1 | # huaji-bot-dotnet
|
2 | 2 |
|
3 |
| -## 介绍/开发计划 |
| 3 | +## 💡 介绍/开发计划 |
4 | 4 |
|
5 | 5 | 插件式,多适配器,多通信协议
|
6 | 6 |
|
7 |
| -## 如何参与开发 |
| 7 | +## 💻 如何参与开发 |
8 | 8 |
|
9 | 9 | - 安装 [Visual Studio 2022](https://visualstudio.microsoft.com/zh-hant/vs/community/)
|
10 | 10 | - 安装 [微软 .NET 8 SDK](https://dotnet.microsoft.com/zh-cn/download)
|
11 | 11 | - clone 本仓库源码
|
12 | 12 | - 使用`Visual Studio 2022`打开 `HuaJiBot.NET.sln` 解决方案
|
13 | 13 | - then just coding ...
|
14 | 14 |
|
15 |
| -## How to build? |
| 15 | +## 🛠️ How to build? |
16 | 16 |
|
17 | 17 | - ensure `.NET 8 SDK` installed
|
18 | 18 | - clone this repo
|
19 | 19 | - run `dotnet build`
|
20 | 20 |
|
21 |
| -## How to deploy? |
| 21 | +## 🚀 How to deploy? |
22 | 22 |
|
23 | 23 | you guess it. (> ω <)
|
24 | 24 |
|
25 |
| -## Project Structure |
26 |
| - |
| 25 | +## 🧩 Project Structure |
| 26 | +<!-- |
27 | 27 | - `src`
|
| 28 | + - `HuaJiBot.NET.CLI` |
| 29 | + - Command line interface for `HuaJiBot.NET`, entry point for running `HuaJiBot.NET` |
28 | 30 | - `HuaJiBot.NET`
|
29 | 31 | - Core project, include core functions such as `plugin manager`,`interface`,` event`,`utils ` and so on.
|
30 |
| - - `HuaJiBot.NET.Adapter.Red` |
31 |
| - - `Red Protocol` adapter for connecting to `__NT` |
32 |
| - - `HuaJiBot.NET.CLI` |
33 |
| - - Command line interface (current only support `Red Protocol`) |
| 32 | + - `HuaJiBot.NET.Adapter.OneBot` |
| 33 | + - [`OneBot Protocol`](https://onebot.dev/) adapter for connecting to IM platforms |
| 34 | + - `HuaJiBot.NET.Adapter.Satori` |
| 35 | + - [`Satori Protocol`](https://satori.js.org/en-US/protocol/) adapter for connecting to IM platforms |
34 | 36 | - `HuaJiBot.NET.Plugin.RepairTeam`
|
35 |
| - - `Repair Team` plugin for `Red Protocol` |
| 37 | + - `Repair Team` plugin, for pushing messages from [Repair Service](https://github.com/nbtca/Saturday) to IM platforms |
| 38 | + - `HuaJiBot.NET.Plugin.GitHubBridge` |
| 39 | + - `GitHub Bridge` plugin, push GitHub events to IM platforms |
| 40 | + - `HuaJiBot.NET.Plugin.Calendar` |
| 41 | + - `Calendar` plugin, for pushing calendar events to IM platforms --> |
| 42 | +``` |
| 43 | +📁 src/ |
| 44 | +├── 🗂️ HuaJiBot.NET.CLI (Command-Line Interface for running the bot) |
| 45 | +├── 🗂️ HuaJiBot.NET (Core project with core functionalities) |
| 46 | +│ ├── Events (Event handling components) |
| 47 | +│ ├── PluginManager (Plugin management system) |
| 48 | +│ ├── Utils (Utility functions) |
| 49 | +│ └── ... (Other core files) |
| 50 | +├── 🗂️ HuaJiBot.NET.Adapter.* (Adapters for connecting to IM platforms) |
| 51 | +│ ├── OneBot (Adapter for the OneBot protocol) |
| 52 | +│ └── Satori (Adapter for the Satori protocol) |
| 53 | +│ └── ... (Other potential adapters) |
| 54 | +├── 🗂️ HuaJiBot.NET.Plugin.* (Plugins for specific functionalities) |
| 55 | +│ ├── Calendar (Plugin for pushing calendar events) |
| 56 | +│ ├── GitHubBridge (Plugin for pushing GitHub events) |
| 57 | +│ ├── RepairTeam (Plugin for pushing messages from Repair Service) |
| 58 | +│ └── ... (Other potential plugins) |
| 59 | +└── ... (Other project files) |
| 60 | +``` |
0 commit comments