From 7e03e0edfa365fab4658bc638297a9aa731d5485 Mon Sep 17 00:00:00 2001 From: BRanulf Date: Thu, 5 Jun 2025 18:16:43 +0800 Subject: [PATCH] markdown --- README.md | 2 ++ README_EN.md | 36 +++++++++++++++++++----------------- 2 files changed, 21 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 35dd0d5..20ecc98 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # 一个服务器在线玩家时间以及服务器状态的简单的mod [English](https://git.branulf.top/Branulf/ServerPlayerOnlineTracker/src/branch/master/README_EN.md) +注意:本mod并不完善,可能会存在些许的bug ### 包含功能: * 显示/记录服务器在线玩家时间 * 显示服务器状态 @@ -12,6 +13,7 @@ 2. 将最新版本的mod放入mods文件夹 3. 首次启动服务器自动生成配置文件 4. 修改Web服务器端口(默认60048),语言(目前仅支持zh_cn和en_us),自动保存时间(默认300秒) +5. 如需在外部访问请确保端口已开放 ### API获取数据: *(也许可以用于机器人?)* diff --git a/README_EN.md b/README_EN.md index 830977c..a34c84e 100644 --- a/README_EN.md +++ b/README_EN.md @@ -1,22 +1,24 @@ -# A simple mod for online player time and server status +# A simple mod for tracking online player time and server status [中文简体](https://git.branulf.top/Branulf/ServerPlayerOnlineTracker/src/branch/master/README.md) -### Includes functions: -* Display /Record server online player time -* Display server status -* Show the server online player list -* ~~Remove Herobrine in the game~~ +Note: This mod is not perfect and may have some bugs. +### Features include: +* Display/record server online player time +* Show server status +* Display a list of online players on the server +* ~~Remove Herobrine from the game~~ ### How to use: -1. Install Fabric Loader and Fabric API -2. Put the latest version of mods into the mods folder -3. Automatically generate configuration files when starting the server for the first time -4. Modify the web server port (default 60048), language (currently only supports zh_cn and en_us), automatic save time (default 300 seconds) +1. Install Fabric Loader and Fabric API. +2. Place the latest version of the mod into the mods folder. +3. The configuration file will be generated automatically when starting the server for the first time. +4. Modify the web server port (default 60048), language (currently only supports zh_cn and en_us), and automatic save interval (default 300 seconds). +5. If external access is needed, ensure that the port is open. -### API to get data: -*(Maybe it can be used for robots?)* -* Get the online player list of servers: [Server IP+configured port] +`/api/online-players` -* Get server status: [Server IP+configured port] +`/api/server-status` -* Get the server online player time: [Server IP+configured port] +`/api/stats` -* Get the number of online players on the server: [Server IP+configured port] +`/api/player-count` -* ~~Raw data file: [Server IP+configured port] +`/api/playerdata`~~ \ No newline at end of file +### API data retrieval: +*(Maybe can be used for bots?)* +* Get a list of online players on the server: [Server IP + configured port] + `/api/online-players` +* Get server status: [Server IP + configured port] + `/api/server-status` +* Get online player time on the server: [Server IP + configured port] + `/api/stats` +* Get number of online players on the server: [Server IP + configured port] + `/api/player-count` +* ~~Raw data file: [Server IP + configured port] + `/api/playerdata`~~ \ No newline at end of file