Skip to content

Commit 9a11a99

Browse files
committedJul 17, 2024
Update README.md
1 parent d1e3d8b commit 9a11a99

File tree

2 files changed

+36
-12
lines changed

2 files changed

+36
-12
lines changed
 

‎.github/workflows/deploy-plugins.yml

-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ jobs:
3636
key: ${{ secrets.REMOTE_SSHKEY }}
3737
script: |
3838
cd /home/nbtca/docker/huajibot
39-
docker compose pull
4039
docker compose down
4140
cp -r dist/plugins/* data/plugins/
4241
docker compose up -d

‎README.md

+36-11
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,60 @@
11
# huaji-bot-dotnet
22

3-
## 介绍/开发计划
3+
## 💡 介绍/开发计划
44

55
插件式,多适配器,多通信协议
66

7-
## 如何参与开发
7+
## 💻 如何参与开发
88

99
- 安装 [Visual Studio 2022](https://visualstudio.microsoft.com/zh-hant/vs/community/)
1010
- 安装 [微软 .NET 8 SDK](https://dotnet.microsoft.com/zh-cn/download)
1111
- clone 本仓库源码
1212
- 使用`Visual Studio 2022`打开 `HuaJiBot.NET.sln` 解决方案
1313
- then just coding ...
1414

15-
## How to build?
15+
## 🛠️ How to build?
1616

1717
- ensure `.NET 8 SDK` installed
1818
- clone this repo
1919
- run `dotnet build`
2020

21-
## How to deploy?
21+
## 🚀 How to deploy?
2222

2323
you guess it. (> ω <)
2424

25-
## Project Structure
26-
25+
## 🧩 Project Structure
26+
<!--
2727
- `src`
28+
- `HuaJiBot.NET.CLI`
29+
- Command line interface for `HuaJiBot.NET`, entry point for running `HuaJiBot.NET`
2830
- `HuaJiBot.NET`
2931
- 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
3436
- `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

Comments
 (0)
Please sign in to comment.