Skip to content

Commit 343cf30

Browse files
[~] Improved README.md
1 parent 23bda50 commit 343cf30

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,15 @@
2828
<a href="https://github.com/NeonAngelThreads/DolphinBot/tree/master/src/main">
2929
<img src="https://img.shields.io/github/languages/code-size/NeonAngelThreads/DolphinBot" alt="GitHub code size"/>
3030
</a>
31+
<br>
32+
<a href="https://github.com/NeonAngelThreads/DolphinBot/releases">
33+
<img src="https://img.shields.io/github/downloads/neonangelthreads/dolphinbot/total" alt="downloads"/>
34+
</a>
3135
<p align="center">
3236
<a href="https://github.com/NeonAngelThreads/DolphinBot/blob/master/PluginDocs.md">📖Docs</a>
3337
·
3438
<a href="https://github.com/NeonAngelThreads/DolphinBot/issues">🐛Submit Suggestion/Bug</a>
39+
3540
</p>
3641
</p>
3742

@@ -126,12 +131,14 @@ In this section, you will understand below how-tos:
126131
<img src="assets/dolphinbot-profile.png" alt="profile list">
127132
</p>
128133
129-
>[!Note]
130-
**Warning:** command-line has high authority than config file, meaning that if options are duplicated, will only recognize
134+
> [!NOTE]
135+
>
136+
> **Warning:** command-line has high authority than config file, meaning that if options are duplicated, will only recognize
131137
command-line, and ignore config file one.
132138
133-
>[!TIP]
134-
Optionally, you can specify more option by adding argument:
139+
> [!TIP]
140+
>
141+
> Optionally, you can specify more option by adding argument:
135142
`--owner` : Specifying only who can use this bot.
136143
137144
**Example:**
@@ -157,13 +164,15 @@ In this section, you will understand below how-tos:
157164
```
158165
**multiple bot & proxy settings**
159166
In the profile config file, you can create `profiles` field in `bot.profiles.json` to specify multiple bot profiles to log to a server.
160-
>[!NOTE]
161-
Some servers may prohibit multiple bots started on same IP, proxy settings is aimed to help you to run multiple bots
167+
> [!NOTE]
168+
>
169+
> Some servers may prohibit multiple bots started on same IP, proxy settings is aimed to help you to run multiple bots
162170
from different network environments or requiring distinct egress IPs.
163171
164172
To configure proxy settings for each bot, you need to edit `proxy` field. An example shown below:
165-
>[!Warn]
166-
**Warning**: Defining multiple bots may trigger the anti-bot or anti-cheat, and some servers with strict policy may prohibit it.
173+
> [!Warn]
174+
>
175+
> **Warning**: Defining multiple bots may trigger the anti-bot or anti-cheat, and some servers with strict policy may prohibit it.
167176
```json
168177
{
169178
"profiles": {
@@ -213,8 +222,9 @@ In this section, you will understand below how-tos:
213222
| `address` | Remote IP address or host name of proxy server. |
214223
| `port` | Proxy server port. |
215224
| `type` | Proxy mode. (`HTTP`, `SOCKS4`, `SOCKS5`) |
216-
>[!TIP]
217-
"username", "password" is optional, if the remote proxy server require to auth, you need to add these.
225+
> [!TIP]
226+
>
227+
> "username", "password" is optional, if the remote proxy server require to auth, you need to add these.
218228
219229
In this case, if you want to load `bot#1` as your single bot, you should add below argument:
220230
```bash
@@ -230,7 +240,8 @@ In this section, you will understand below how-tos:
230240
```bash
231241
java -jar "DolphinBot-[version].jar" --profiles="bot#1;bot#2;bot#3;..."
232242
```
233-
>[!NOTE]
243+
> [!NOTE]
244+
>
234245
> - **Warning**: If the `--profiles` option is absented, it will load all bots in profile config by default.
235246
236247
**Owners:**

0 commit comments

Comments
 (0)