Files
OpenFly/README.md
T

136 lines
3.8 KiB
Markdown

# OpenFly
一个 [Fabric](https://fabricmc.net/) 模组,为玩家提供便捷的飞行功能。
## 功能特性
- 🕊️ **自由飞行** — 通过命令开启/关闭创造模式飞行能力
- ⚡ **飞行速度调节** — 通过命令在 0.01–0.15 范围内自定义飞行速度
- 🛡️ **摔落保护** — 飞行状态下免疫摔落伤害
- 💾 **状态持久化** — 飞行状态与速度保存到配置文件,退出重进或服务器重启后自动恢复
- 👥 **多玩家支持** — 管理员可为其他玩家切换飞行状态
## 环境要求
- Minecraft **1.21.11**
- Java **21+**
- Fabric Loader **≥ 0.19.5**
- Fabric API
## 安装
1. 安装 [Fabric Loader](https://fabricmc.net/use/installer/)
2. 下载 [Fabric API](https://modrinth.com/mod/fabric-api) 并放入 `mods` 文件夹
3. 将 OpenFly 的 `.jar` 文件放入 `mods` 文件夹
4. 启动游戏
## 命令用法
### `/fly`
切换自己的飞行状态。所有玩家均可执行。
```
/fly
```
- 如果当前未飞行,执行后**开启飞行**
- 如果当前正在飞行,执行后**关闭飞行**
### `/fly speed <0.01-0.15>`
设置自己的飞行速度,范围为 0.01 到 0.15(默认 0.05)。所有玩家均可执行。
```
/fly speed 0.10
```
- 数值越大飞行越快,0.15 为允许的最大速度
- 设置后立即生效,无需重新开启飞行
- 速度会与飞行状态一起保存,退出重进后仍然保留
### `/fly player <player>`
切换指定玩家的飞行状态。需要 OP 权限(权限等级 2)。
```
/fly player Steve
```
- 如果目标玩家未飞行,执行后**为其开启飞行**
- 如果目标玩家正在飞行,执行后**为其关闭飞行**
- 操作记录会广播到聊天栏
## 使用指南
### 基本飞行
1. 在游戏中输入 `/fly` 即可开启飞行
2. 开启后可以使用与创造模式相同的飞行操作:
- **空格键** — 上升
- **Shift 键** — 下降
- **双击空格** — 切换飞行/普通状态
3. 再次输入 `/fly` 关闭飞行,回到普通模式
### 飞行速度
使用 `/fly speed <数值>` 调整飞行速度(0.01–0.15):
- `/fly speed 0.03` — 较慢的飞行速度
- `/fly speed 0.05` — 默认速度
- `/fly speed 0.15` — 最快速度
### 管理员操作
作为服务器管理员,你可以为其他玩家管理飞行权限:
```
/fly player <玩家名>
```
例如:
- `/fly player Steve` — 为 Steve 开启飞行
- `/fly player Alex` — 关闭 Alex 的飞行
### 摔落保护
飞行开启期间,你不会受到任何摔落伤害。关闭飞行后,摔落伤害恢复正常。
### 重连恢复
玩家的飞行状态(是否飞行)与飞行速度会持久化保存。退出游戏后重新加入,甚至服务器重启,都会自动恢复上次的飞行状态与速度。
## FAQ
### Q: 飞行状态会一直保留吗?
A: 会。飞行状态(是否飞行)与飞行速度会保存到服务端的 `config/openfly_flight_data.json` 文件。玩家退出重进、服务器重启后都会自动恢复上次的状态。
### Q: 飞行时还会受到摔落伤害吗?
A: 不会。飞行状态下免疫所有摔落伤害,关闭飞行后恢复正常。
### Q: 普通玩家可以使用 `/fly` 吗?
A: 可以。`/fly` 与 `/fly speed` 命令对所有玩家开放,无需 OP 权限。但 `/fly player <player>` 需要 OP 权限。
### Q: 这个模组需要安装在客户端还是服务端?
A: 服务端。这是一个服务端模组,只需安装在服务器上即可。客户端无需安装。
### Q: 与其他模组兼容吗?
A: OpenFly 基于 Fabric API 开发,与大多数 Fabric 模组兼容。如果遇到冲突,请在 [Issues](https://git.opensource-studio.info/database-mysql/OpenFly.git/issues) 中反馈。
## 构建
```bash
./gradlew build
```
构建产物位于 `build/libs/` 目录。
## 许可证
[Apache-2.0](LICENSE)