From b36c1cff661b700f5dcd827ad5eb68cb934a8240 Mon Sep 17 00:00:00 2001 From: Andrew Brower Date: Thu, 14 Aug 2025 23:46:28 -0400 Subject: [PATCH] readme --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7a9df62 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# slimeball + +Slime world parsing in Rust + +Slimeball is a library providing helpers for loading and storing Minecraft worlds saved in the +[Slime world format](https://hypixel.net/threads/dev-blog-5-storing-your-skyblock-island.2190753/). + +Anvil is historically a [very bloated format](https://minecraft.wiki/w/Chunk_format#Block_format), storing +lots of data that is unnecessary for short-lived minigame servers. The Slime world format is similar, but contains much +less world generation-related data and compresses much better (uses zstd). + +This library is intended for use in [crawlspace](https://github.com/xoogware/crawlspace), but a +converter to prune and convert Anvil worlds to Slime is also being developed here. -- 2.51.2