diff --git a/README.md b/README.md new file mode 100644 index 0000000..d154344 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Simple Tombstone Mod + +## 简介 +Simple Tombstone 是一个 Minecraft 1.20.4 模组,当玩家死亡时,会在死亡位置生成一个花盆,花盆中保存玩家的物品。玩家重生后,可以通过靠近花盆或与向花盆右键两次拔出再次种植花朵交互来恢复物品。 + +## 安装 +1. 确保你已经安装了 Minecraft 1.20.4 和 Fabric Loader。 +2. 将本模组的 JAR 文件放入 `mods` 文件夹中。 +3. **注意:** 本模组可仅需在服务器端安装,客户端无需安装。 + +## 开发状态 +本模组目前仍在开发中,可能存在一些未完善的功能或潜在的 Bug。我们欢迎任何反馈和建议。 + +## 已知的问题 +- **玩家靠近触发:** 玩家在一次复活后只能靠近并激活一个墓碑,其余的需要通过交互花盆来激活,服务器重启后所有玩家都需要与花盆交互(右键两次重新种植花朵)。这并不是一个问题,这是对于服务器性能影响的预防性设计,可能会在之后修改机制。 + +## 可能存在的问题 +- **服务器 Tick 检查:** 当前模组在每个服务器 Tick 中检查玩家是否靠近墓碑,这可能会对服务器性能产生一定影响,尤其是在玩家数量较多时。 + +## 贡献 +如果你有兴趣为这个项目做出贡献,请 fork 本项目并提交 Pull Request。我们欢迎任何形式的贡献,包括代码、文档、测试等。 + +## 许可证 +本项目采用 MIT 许可证,详情请参阅 [LICENSE](LICENSE) 文件。 \ No newline at end of file