Skip to content

Commit

Permalink
Update english readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
401U committed Sep 7, 2021
1 parent 24da792 commit eef91b2
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Online

**简体中文** | [English](./README_EN.md)

一个可以查看多个服务器在线人数的 [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) 插件

***
## 简介

借助MC服务器原版的rcon功能, 发送list指令, 获得玩家列表

![image](./pictures/1.png)
Expand All @@ -14,20 +18,18 @@

2. 安装本插件

3. 启动 MCDReforged, 插件会在 `config/online/` 目录下自动生成配置文件, 名为 `config.json` 其内容如下:
3. 启动 MCDReforged, 插件会自动生成名为 `config/online/config.json` 的配置文件, 其默认内容如下:
```json
{
"join": true,
"click_event": true
}
```
其中,

- `join`为是否开启进服提示, `true` 为开启, `false` 为关闭

- `click_event` 为是否启用点击服务器名切换服务器的点击事件

- 如果`click_event` 设置为true,请确保 `multi_rcon_api` 中服务器名保持与跨服配置相同的服务器名,即 `/server` 指令后的对应名称

4. 最后,使用 `!!MCDR r all` 重载你的MCDR插件,或重启服务器,重新加入服务器即可看到服务器在线人数(如果 `join``true` 的话),也可以通过 `!!online` 指令来查看效果
- 如果`click_event` 设置为 `true`, 请确保 `multi_rcon_api` 中服务器名保持与跨服配置相同的服务器名, 即 `/server` 指令后的对应名称

4. 最后,使用 `!!MCDR r all` 重载你的MCDR插件, 或重启服务器来让插件工作起来
35 changes: 35 additions & 0 deletions README_EN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Online

[简体中文](./README.md) | **English**

An [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) plugin which can easily query the online players

***
## Introduction

Send `list` command to other sub-server through rcon, then parse the online players and display it, that's all!

![image](./pictures/1.png)

***
## Usage

1. Add the dependency [multi_rcon_api](https://github.com/FAS-Server/MultiRconAPI) and add your config!

2.Add this plugin

3. Launch the MCDReforged, the config file will automatically generated in `config/online/config.json` with the default value as following:
```json
{
"join": true,
"click_event": true
}
```

- `join` whether show the online list after player join

- `click_event` whether to add click event for switch between sub-servers by click the server name

- If `click_event` is set to true,please make sure the server name in `multi_rcon_api` is as the same with your server proxy (just the name after `/server` command)

4. Finally, use `!!MCDR r all` to reload, or restart your server to make it works

0 comments on commit eef91b2

Please sign in to comment.