docs: 添加 LimboBackSpawn插件的 README 文件

- 创建 README.md 文件,介绍 LimboBackSpawn 插件的功能和使用方法
- 插件功能包括限制玩家活动范围、防止虚空掉落和自动传送回出生点
- 提供了详细的配置说明、使用方法和注意事项
- 添加了项目的开源许可信息
This commit is contained in:
CNLuminous 2025-08-08 02:02:28 +08:00
parent 6284cff152
commit 0e226aa11e
1 changed files with 53 additions and 0 deletions

53
README.md Normal file
View File

@ -0,0 +1,53 @@
# LimboBackSpawn
![Version](https://img.shields.io/badge/version-1.0-blue.svg)
![License](https://img.shields.io/badge/license-MIT-green.svg)
这是一个基于 [LOOHP/Limbo](https://github.com/LOOHP/Limbo) 服务器的扩展插件,用于限制玩家活动范围。当玩家离开设定范围时,自动将其传送回出生点。
## 功能特性
- 🚦 限制玩家在 X/Z 轴上的活动范围
- ⚡ 防止玩家掉入虚空
- 🏠 自动传送回出生点
- ⚙️ 可自定义范围参数
## 配置说明
插件会在首次运行时自动生成配置文件 `config.properties`
### 配置项详解
| 配置项 | 说明 | 默认值 |
|--------|------|--------|
| [maxX](file://G:\IdeaProjects\LimboBackSpawn\src\main\java\com\blockfantasy\LimboBackSpawn.java#L22-L22) | X 轴最大距离(相对于出生点) | 50 |
| [maxZ](file://G:\IdeaProjects\LimboBackSpawn\src\main\java\com\blockfantasy\LimboBackSpawn.java#L24-L24) | Z 轴最大距离(相对于出生点) | 50 |
| [minY](file://G:\IdeaProjects\LimboBackSpawn\src\main\java\com\blockfantasy\LimboBackSpawn.java#L23-L23) | 最小 Y 坐标限制 | -10 |
## 使用方法
1. 将插件 JAR 文件放入 Limbo 服务器的 `plugins` 文件夹
2. 启动服务器,插件会自动生成默认配置文件
3. 根据需要修改 `plugins/LimboBackSpawn/config.properties` 配置文件
4. 重启服务器使配置生效
## 命令
- `/getloc` - 显示玩家当前位置坐标(需要 `blockfantasy.getloc` 权限)
## 权限节点
| 权限节点 | 说明 |
|----------|------|
| `blockfantasy.getloc` | 允许使用 `/getloc` 命令 |
## 注意事项
- 距离计算基于世界出生点作为原点
- X/Z 轴限制使用绝对距离计算(双向限制)
- Y 轴限制仅对低于设定值的位置生效
## 开源许可
本项目采用 MIT 许可证,详情请参见 [LICENSE](LICENSE) 文件。