# PlayerList

**Repository Path**: slimeabc/PlayerList

## Basic Information

- **Project Name**: PlayerList
- **Description**: 一款轻量的Minecarft Spigot插件，它提供了一个简单的 HTTP API，用于获取在线玩家信息
- **Primary Language**: Java
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

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

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Minecarft

## README

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

# PlayerList  
欢迎使用 **PlayerList** —— 一款轻量级却功能强大的 Minecraft Spigot 插件，它通过简单的 HTTP API 提供在线玩家列表。

**提示：** 本插件已在 **Minecraft 1.20.1** 上测试，**不保证**与其他版本兼容。

---

## ✨ 核心特性
- **高度可配置**  
- **极简 API**

---

## 🚀 安装步骤
1. 从 [releases 页面](https://github.com/SlimeABC/PlayerList/releases) 下载 jar 文件。  
2. 将文件放入服务器的 `plugins` 文件夹。  
3. 启动或重载服务器。  
4. 在控制台看到以下日志即表示启动成功：  
   ```
   [Server thread/INFO]: [PlayerList] Enabling PlayerList v1.0-SNAPSHOT  
   [Server thread/INFO]: [PlayerList] PlayerList 1.0 loaded  
   [Server thread/INFO]: [PlayerList] By Slime  
   [Server thread/INFO]: [PlayerList] www.slimeserver.top
   ```  
5. 编辑 `plugins/PlayerList/config.yml` 以符合你的需求。最小配置示例：  
   ```yaml
   # 同步间隔（秒）
   sync-interval: 1
   # API 绑定地址与端口
   api-url: "http://127.0.0.1:4000"
   # 启用调试日志
   debug: false
   ```  
6. 使用 `/playerlist reload` 重载插件，或直接重启服务器。

---

## 🔌 API 说明
访问配置的端点（默认 `http://127.0.0.1:4000`），将得到如下 JSON 响应：

```json
{"players":["Slime_MC","Alex","Steve"]}
```

| 键名   | 值                          | 含义                                     |
|--------|-----------------------------|------------------------------------------|
| players | ["Slime_MC","Alex","Steve"] | 当前在线玩家：Slime_MC、Alex 和 Steve |