# ServerInfo

**Repository Path**: slimeabc/ServerInfo

## Basic Information

- **Project Name**: ServerInfo
- **Description**: 一款轻量级 BeamMP 服务器状态插件，完全通过纯文本文件进行通信。
可轻松将您服务器的实时数据集成到任何网站中。
- **Primary Language**: Lua
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-27
- **Last Updated**: 2025-12-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: BeamNG

## README

[English](README.en.md) | **中文**

# ServerInfo  
欢迎使用 **ServerInfo**——一款轻量级 BeamMP 服务器状态插件，完全通过纯文本文件进行通信。  
可轻松将您服务器的实时数据集成到任何网站中。

**提示：** 本插件已在 **BeamMP Server 3.X** 上测试通过，其他版本的兼容性**不保证**。

---

## ✨ 主要功能
- 实时持久化**在线玩家列表**  
- 持久化**最大玩家上限**  
- 持久化**Mod 列表及文件大小**  
- 纯 **.txt** 通信——零依赖，兼容性极高  
- 任何能读取文本文件的 Web 技术栈均可即插即用

---

## 🚀 安装步骤
1. 在 [releases 页面](https://gitee.com/slimeabc/ServerInfo/releases) 下载最新的 **ServerInfo.zip**。  
2. 解压压缩包。  
3. 将整个 `ServerInfo` 文件夹放入  
   ```
   BeamMP-Server\Resources\Server\
   ```  
4. 打开 `path.yml`，设置各状态文件的保存路径。  
   示例：
   ```yaml
   player list path: "F:\example\ players.txt"
   player number limit: "F:\example\ player_limit.txt"
   mod list: "F:\example\ mods.txt"
   ```  
5. 打开 `config.yml`，调整刷新频率（单位：秒）。  
   示例：
   ```yaml
   # ServerInfo 插件配置

   debug: false
   # 设为 true 时，每次保存文件都会打印更新信息

   update rate: 3
   # 读取服务器状态并写入文本文件的间隔时间
   ```  
6. 启动 BeamMP 服务器（`BeamMP-Server.exe`）。

---

## 🔌 文本文件接口参考  
由于作者技术有限，只好用文本文件当接口 (｡•́︿•̀｡)。

### 1. 玩家列表文件（`players.txt`）
- **空服务器**
  ```
  Online players: 0
  No players online.
  ```  
- **有玩家在线**
  ```
  Online players: 5
  Slime_MC
  xzh738
  mclobe233
  ckgarden
  me262
  ```  
  - 第 1 行：当前在线人数  
  - 其余行：玩家昵称

### 2. 最大玩家数文件（`player_limit.txt`）
```
6
```  
- 仅一行：服务器允许的最大玩家数

### 3. Mod 列表及大小文件（`mods.txt`）
```
sunburst.zip:285.48 MB
test.zip:114.5 MB
```  
- 每行格式：`[文件名]:[大小（MB）]`