Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xia-mc committed Mar 1, 2024
1 parent 83c9114 commit 87484a6
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,35 @@
<img width="256" src="https://github.com/xia-mc/McStats/assets/108219418/49530208-97e4-46a7-b339-8eaf2ea65091" alt="logo">

# McStats
一个服务端模组,允许您显示服务器统计信息
一个服务端模组,允许您统计服务器的一些信息
</div>

## 它可以做什么
```
----------服务器日报----------
日活:%s
上线最久的玩家:%s %s分钟
最活跃的玩家:%s
日活:1 | 机器人日活:1
上线最久的玩家:xia__mc 1秒
上线最久的机器人:bot 1分钟
感谢各位玩家对服务器做出的贡献!
```
按时生成这样的文本,并发送到游戏和群聊里。

## 兼容性
支持**Vanish** Mod:隐身玩家不会被标记为在线,也不会统计它们的在线时间。
支持**Carpet** Mod: 通过```/player```召唤的假人会被列入“机器人”。

## 如何使用
```[Github Action](https://github.com/xia-mc/McStats/actions)```获取开发版。
```[Github Release](https://github.com/xia-mc/McStats/releases)```获取稳定版。(暂无)

- 安装mod到服务端 **(1.20.1 fabric)**
- 启动支持```onebot```协议的QQ机器人。
- 启动服务器,调整配置文件里的设置。(可能需要重启服务器以加载)
- 启动服务器,调整配置文件里的设置。
- 通过```/mcstats```控制Mod(普通玩家只可使用部分指令)。

## 贡献
欢迎提issue或提交pull request。

## 使用项目
- [OneBot Client](https://github.com/cnlimiter/onebot-client)
- [Packet Events](https://github.com/retrooper/packetevents)
- [AtomConfig Toml](https://github.com/TheRandomLabs/AutoConfig-TOML)

0 comments on commit 87484a6

Please sign in to comment.