Skip to content

Commit 821e2b8

Browse files
committed
📖 Docs: Add comprehensive project documentation and README update.
1 parent bd3683a commit 821e2b8

1 file changed

Lines changed: 240 additions & 0 deletions

File tree

README.md

Lines changed: 240 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,243 @@
22
<h5 align="center">FiFu 核心及周边套件 - Powered by FiFu Project</h5>
33

44
------
5+
6+
## 🎮 项目概述
7+
8+
FiFu Powered 是 FiFu 旗下的 Minecraft 服务器插件工具集,秉承"原版体验,功能增强"的设计理念,提供高度集成的插件模块套件。每个组件都经过精心设计,既能独立部署满足特定需求,又能无缝协作构建完整的服务器解决方案。作为 FiFu 的技术实践,我们致力于通过模块化架构为 Minecraft 服务器带来专业级的游戏体验和管理工具,在保留原版游戏魅力的同时,为玩家和管理员提供强大的功能支持。
9+
10+
## 🏗️ 技术架构
11+
12+
### 核心特性
13+
- **Minecraft 兼容**:基于 Minecraft 服务端 API 开发,确保最佳性能和兼容性
14+
- **模块化设计**:每个插件独立打包,可按需部署
15+
- **Kotlin/Java 混合开发**:充分利用现代 JVM 语言优势
16+
- **Gradle 构建系统**:统一的依赖管理和构建流程
17+
18+
### 技术栈
19+
- **运行环境**:Minecraft 服务端
20+
- **开发语言**:Kotlin 2.1.21 + Java
21+
- **构建工具**:Gradle 8.14.3 + Shadow Plugin
22+
- **许可证**:Mulan PSL v2 开源许可
23+
24+
## 🧩 FiFu 组件生态
25+
26+
作为 FiFu 的核心组成部分,每个插件都遵循统一的设计理念和开发标准,共同构建完整的服务器工具集:
27+
28+
### 🏝️ FiFuSky - 空岛生存系统
29+
**FiFu 核心游戏系统 - 原版体验的空岛生存**
30+
31+
FiFuSky 是整个 FiFu 生态系统的核心基石,完美体现了"保留原版功能和特性的空岛"设计理念。作为 FiFu 的核心游戏系统,它不仅提供了完整的空岛生存体验,更通过精心的技术架构设计,确保在不破坏 Minecraft 原版游戏平衡的前提下,为玩家和管理员提供强大的功能支持。
32+
33+
#### 🏗️ 核心架构设计
34+
- **岛屿坐标系统**:采用 1024×1024 方块的标准化岛屿网格,支持近 30,000 个岛屿的无限扩展
35+
- **智能岛屿分配**:通过螺旋算法自动分配岛屿位置,确保岛屿分布合理且易于管理
36+
- **模块化权限系统**:基于所有者-成员的二级权限架构,支持精细化的岛屿访问控制
37+
- **SQLite 数据持久化**:采用轻量级数据库存储岛屿数据、玩家信息和权限配置
38+
39+
#### 🎮 原版体验保护机制
40+
- **完整保留原版生存机制**:玩家可以体验纯正的 Minecraft 生存玩法,包括合成、建造、探索等核心功能
41+
- **非侵入式功能增强**:所有管理功能都以辅助工具形式存在,绝不改变游戏本质玩法
42+
- **原版经济系统兼容**:完全兼容 Minecraft 原版经济机制,支持玩家间的自由交易
43+
- **标准游戏规则维护**:严格遵循 Minecraft 原版游戏规则,确保公平竞争环境
44+
45+
#### 🛠️ 技术实现亮点
46+
- **智能岛屿生成**:使用 Minecraft 原版 `clone` 命令复制模板岛屿,确保生成的岛屿完全符合原版标准
47+
- **实时权限监听**:通过事件监听机制实时保护玩家岛屿,防止恶意破坏和盗窃
48+
- **异步数据处理**:采用异步任务处理岛屿生成和数据操作,确保服务器性能稳定
49+
- **动态区块加载**:智能预加载相关区块,提供流畅的岛屿传送体验
50+
51+
#### 🌟 特色功能模块
52+
- **岛屿参观系统**:支持玩家间互相参观岛屿,促进社区交流和建设灵感分享
53+
- **标记收藏功能**:玩家可以标记喜欢的岛屿,方便日后回访学习
54+
- **生物群系定制**:支持岛屿生物群系修改,满足玩家个性化需求。通过 `/s biome` 命令,岛屿所有者可以查看当前区块生物群系、浏览所有可用生物群系列表,并使用生物群系名称或编号进行精确修改。系统支持 Minecraft 全部生物群系类型,允许玩家在 16×16 区块范围内进行完整的生物群系转换,为岛屿创造独特的生态环境和视觉效果。
55+
- **爆炸保护控制**:可配置的爆炸保护机制,平衡安全性与游戏趣味性
56+
57+
#### 🔧 管理员赋能工具
58+
- **完整的命令体系**:提供 `/s` 玩家命令和 `/fs-admin` 管理员命令双轨制管理
59+
- **实时数据监控**:支持岛屿信息查询、玩家权限管理和系统状态监控
60+
- **灵活配置选项**:丰富的配置参数,支持不同服务器的个性化需求
61+
- **完善的日志系统**:详细的操作日志记录,便于问题追踪和系统维护
62+
63+
#### 🎯 项目价值定位
64+
FiFuSky 不仅仅是一个空岛插件,它是 FiFu 生态系统的技术基石和实践典范。通过 FiFuSky,我们证明了如何在保持 Minecraft 原版魅力的同时,为服务器提供专业级的管理工具。这种"原版优先,功能增强"的设计理念,将成为 FiFu 所有组件的共同标准,为玩家带来既熟悉又新颖的游戏体验。
65+
66+
### 🗄️ FiFuServerBackup - 数据备份工具
67+
**FiFu 数据备份工具**
68+
- **核心功能**:提供服务器数据备份功能,支持自动备份和插件管理
69+
- **项目定位**:FiFu 的数据备份工具,保障服务器数据安全
70+
- **技术特色**:简洁的备份机制,支持插件备份和恢复操作
71+
- **集成优势**:为 FiFu 生态系统提供基础的数据安全保障
72+
73+
### 📖 FiFuBookEdit - 书籍编辑器
74+
**FiFu 书籍编辑工具**
75+
- **核心功能**:提供直观的书籍内容编辑和管理功能,支持书籍复制、导入导出和模板管理
76+
- **项目定位**:作为 FiFu 的书籍编辑工具,为服务器提供便捷的文档处理方案
77+
- **技术特色**:简洁的命令操作界面,支持文件导入导出和批量书籍管理
78+
- **集成优势**:与其他 FiFu 组件配合,为玩家提供完整的知识管理体验
79+
80+
### ⛏️ FiFuMiningList - 挖掘榜
81+
**FiFu 挖掘统计工具**
82+
- **核心功能**:实时追踪玩家挖掘数据,提供挖掘统计显示和排行榜功能
83+
- **项目定位**:FiFu 的挖掘统计工具,为玩家提供挖掘数据可视化
84+
- **技术特色**:轻量级的数据记录机制,支持实时显示和自定义配置
85+
- **集成优势**:为玩家提供直观的挖掘统计,助力游戏进度管理
86+
87+
### 🩸 FiFuBloodVolumeDisplay - 血量显示
88+
**FiFu 战斗辅助工具**
89+
- **核心功能**:通过 ActionBar 实时显示实体血量信息,提供战斗视觉反馈
90+
- **项目定位**:FiFu 的血量显示工具,增强战斗体验
91+
- **技术特色**:简洁的事件监听机制,支持多种攻击方式的血量显示
92+
- **集成优势**:为玩家提供清晰的战斗信息,提升游戏沉浸感
93+
94+
### 🐱 FiFuNekoMark - 物品标记
95+
**FiFu 物品管理工具**
96+
- **核心功能**:提供玩家物品标记和管理功能,支持物品安全标识和操作记录
97+
- **项目定位**:FiFu 的物品管理工具,保障玩家物品安全
98+
- **技术特色**:简单直观的标记机制,支持物品状态追踪和管理
99+
- **集成优势**:与其他 FiFu 组件配合,为玩家提供物品安全保障
100+
101+
### 💊 FiFuYao - 娱乐乘骑
102+
**FiFu 娱乐互动工具**
103+
- **核心功能**:提供玩家间乘骑互动功能,支持骑乘操作和娱乐体验
104+
- **项目定位**:FiFu 的娱乐乘骑工具,增加游戏趣味性
105+
- **技术特色**:简洁的交互机制,支持实体乘骑和玩家互动
106+
- **集成优势**:与 FiFu 社交组件配合,为玩家提供丰富的娱乐功能
107+
108+
## 🎯 FiFu 设计理念
109+
110+
### 🌟 原版体验,功能增强
111+
112+
FiFu 的核心设计哲学是**保留原版功能和特性的空岛体验**。我们深知 Minecraft 原版游戏的独特魅力,因此在开发每一个组件时都严格遵循以下原则:
113+
114+
- **原版机制保护**:绝不破坏 Minecraft 原版的核心游戏机制和平衡性
115+
- **功能而非替代**:提供辅助工具和管理功能,而非改变游戏本质玩法
116+
- **体验增强**:在保持原版体验的基础上,为玩家和管理员提供便利
117+
- **社区友好**:确保所有功能都符合 Minecraft 社区的期望和习惯
118+
119+
### 🌟 工具集思维
120+
- **原版优先**:所有组件设计以保留原版游戏特性为前提,在不破坏游戏平衡的前提下提供功能增强
121+
- **统一架构**:所有组件遵循 FiFu 统一设计标准,确保一致的用户体验
122+
- **无缝集成**:组件间深度协作,提供1+1>2的用户体验,同时保持原版游戏的核心魅力
123+
- **模块化部署**:支持按需组合,灵活适应不同服务器需求,让每个服务器都能找到最适合的配置方案
124+
125+
### 🎮 玩家体验至上
126+
- **原版体验**:保留 Minecraft 原版游戏机制和玩法,让玩家感受纯正的游戏乐趣
127+
- **直观交互**:统一的命令体系和操作逻辑,简化复杂操作
128+
- **沉浸体验**:流畅的游戏流程和丰富的视觉反馈,增强游戏代入感
129+
- **个性化定制**:支持玩家自定义设置和偏好保存,打造专属游戏体验
130+
131+
### 🛠️ 管理员赋能
132+
- **智能管理**:提供完善的管理工具和自动化功能
133+
- **精细控制**:详细的权限系统和配置选项
134+
- **数据驱动**:基于统计数据的决策支持系统
135+
136+
### ⚡ 性能与稳定
137+
- **极致优化**:轻量级设计和异步处理机制
138+
- **内存安全**:严格的内存管理和泄漏防护
139+
- **高可用性**:完善的错误处理和恢复机制
140+
141+
## 🚀 快速部署
142+
143+
### 环境要求
144+
- Minecraft 服务端
145+
- Java 17+
146+
- 足够的服务器内存
147+
148+
### 安装步骤
149+
```bash
150+
# 克隆项目
151+
git clone [repository-url]
152+
153+
# 构建所有插件
154+
./gradlew clean build
155+
156+
# 部署插件
157+
cp */build/libs/*.jar /path/to/server/plugins/
158+
```
159+
160+
### 单独构建
161+
```bash
162+
# 构建特定插件
163+
./gradlew :fifu-sky:build
164+
./gradlew :fifu-blood-display:build
165+
# ... 其他插件
166+
```
167+
168+
## 📋 插件命令
169+
170+
### FiFuBookEdit
171+
- `/book help` - 查看帮助信息
172+
173+
### FiFuMiningList
174+
- `/wjb` - 开启或关闭挖掘助手
175+
176+
### FiFuNekoMark
177+
- `/neko-mark <操作符> <参数>` - 标记管理命令
178+
179+
### FiFuSky
180+
- `/s help [命令]` - 玩家命令帮助
181+
- `/fs-admin help [命令]` - 管理员命令帮助
182+
183+
## 🔧 配置说明
184+
185+
每个插件都包含独立的配置文件,位于插件目录的 `config.yml` 中。管理员可以根据服务器需求调整各项参数。
186+
187+
## 🌟 FiFu 核心优势
188+
189+
### 🔄 持续进化
190+
- **版本同步**:紧跟 Minecraft 服务端版本更新,确保最佳兼容性
191+
- **性能迭代**:基于用户反馈的持续性能优化和功能增强
192+
- **社区驱动**:开放的开发模式,积极响应社区需求和建议
193+
194+
### 🛡️ 企业级稳定
195+
- **质量保证**:严格的测试流程和兼容性验证
196+
- **安全防护**:完善的安全机制和数据保护措施
197+
- **监控体系**:全面的错误监控和自动恢复机制
198+
199+
### 🎨 无限可能
200+
- **原版兼容**:所有功能增强都基于原版游戏机制,确保与 Minecraft 核心体验完美融合
201+
- **深度定制**:丰富的配置选项和扩展接口,让每个服务器都能打造独特体验
202+
- **国际化**:完整的多语言支持框架,服务全球玩家社区
203+
- **主题系统**:灵活的UI主题和样式自定义,在不影响原版体验的前提下美化界面
204+
- **API开放**:为开发者提供完整的API接口和文档,鼓励社区创新
205+
206+
## 🤝 加入 FiFu
207+
208+
我们诚邀您加入 FiFu 的建设:
209+
210+
### 📝 贡献方式
211+
- **代码贡献**:遵循 FiFu 代码规范,提交高质量的功能增强
212+
- **测试反馈**:提供详细的测试报告和改进建议
213+
- **文档完善**:协助完善项目文档和使用指南
214+
- **社区建设**:参与技术讨论,帮助其他用户解决问题
215+
216+
### 🎯 贡献标准
217+
- 遵循 FiFu 统一的代码规范和注释标准
218+
- 提供完整的单元测试和集成测试
219+
- 更新相关文档和配置示例
220+
- 提交清晰的 Pull Request 描述和变更说明
221+
222+
### 🌟 贡献者权益
223+
- 在项目贡献者列表中获得署名
224+
- 参与 FiFu 的重要决策讨论
225+
- 优先体验新功能和测试版本
226+
- 获得 FiFu 社区的技术支持
227+
228+
## 📄 开源许可
229+
230+
本项目采用 Mulan PSL v2 许可证,详情请参考 [LICENSE](LICENSE) 文件。
231+
232+
## 📞 技术支持
233+
234+
- **作者**:NekokeCore
235+
- **问题反馈**[GitHub Issues]
236+
- **功能建议**[GitHub Discussions]
237+
- **技术交流**[社区论坛]
238+
239+
---
240+
241+
<div align="center">
242+
<p>🍉 Made with ❤️ by FiFu Team</p>
243+
<p>守护原版机制,赋能管理体验</p>
244+
</div>

0 commit comments

Comments
 (0)