Skip to content

Commit f5c1304

Browse files
committed
📝 update README.md
1 parent 828566a commit f5c1304

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
11
# HashBook
22

3-
一个 Paper 插件, 将成书的数据存储在外部以实现 Minecraft 中高密度的成书存储.
3+
HashBook 是一个 Paper 插件, 通过将书籍数据存储在外部, 实现 Minecraft 中高密度书籍存储.
4+
5+
## 功能
6+
7+
序列化书籍内容, 生成并保存哈希值, 并按配置将书籍内容保存在外部存储中.
8+
9+
## 注意事项
10+
11+
存储后的书籍会删除书页信息, 以便在 Minecraft 中高密度存储书籍, 并防止区块数据溢出.
12+
13+
书籍的哈希值将使用 PDC [(Persistent Data Container)](https://docs.papermc.io/paper/dev/pdc) 或 NBT 存储在书籍中。
14+
15+
哈希值可以是任意字符串. 可以使用外部工具生成带有指定哈希值的 NBT 标签的书籍, 并将书籍数据附加到外部存储中, 实现书籍数据的转移.
16+
17+
外部存储只会保存书籍的书页数据, 不会保存书籍的标题, 作者等信息.
18+
19+
## 优点
20+
21+
- 高效的书籍存储: 通过外部存储减少 Minecraft 区块大小, 防止区块数据溢出.
22+
- 灵活的哈希值管理: 允许使用任意字符串作为哈希值, 方便书籍数据的管理和转移.
23+
24+
## 如何使用
25+
26+
1. 添加 [CommandAPI](https://www.spigotmc.org/resources/api-commandapi-1-16-5-1-20-6.62353/),
27+
[NBTAPI](https://www.spigotmc.org/resources/nbt-api.7939/)(可选) 前置依赖
28+
2. 安装并配置 HashBook 插件.

0 commit comments

Comments
 (0)