Skip to content

Commit

Permalink
Added World Documentation (#190)
Browse files Browse the repository at this point in the history
* Added World Documentation

* Added new page to vitepress
  • Loading branch information
DirefulBelt6803 authored Oct 26, 2024
1 parent fe934dc commit 527777e
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export default defineConfig({
{ text: "Networking", link: "/developer/networking" },
{ text: "Authentication", link: "/developer/authentication" },
{ text: "RCON", link: "/developer/rcon" },

{ text: "World", link: "developer/world"},
],
},

Expand Down
52 changes: 52 additions & 0 deletions docs/developer/world.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
### World Formats
> [!IMPORTANT]
> Currently, Pumpkin only supports Anvil World Format, which is the format used by vanilla
> Minecraft. There is planned support for other world formats in the future though, as listed
>below.
### Region File Format
Minecraft Beta 1.3 to Relase 1.2 used a Minecraft format known as "Region file format".

The files stored in this format are .mcr files, each storing a group of 32x32 chunks called a region.

More details can be found on the [Minecraft Fandom](https://minecraft.fandom.com/wiki/Region_file_format).

### Anvil File Format
Replacing the Region File Format after Minecraft Release 1.2, this is the file format used to store modern vanilla Java Minecraft worlds.

The files stored in this format are .mca files, while using the same region logic, there were a number of changes. The notable changes include an increase
to a 256 hight limit, then to 320, as well as a higher number of block ID's.

More details can be found on the [Minecraft Fandom](https://minecraft.fandom.com/wiki/Anvil_file_format).

### Linear File Format
There is a more modern file format known as the Linear region file format. Saving on disk space and using the zstd library instead of zlib. This is beneficial as zlib is extremely old and
outdated.

The files stored in this format are .linear files, and it says about 50% of disk space in the Overworld and Nether, while saving 95% in the end.

More details can be found at the github page for [LinearRegionFileFormatTools](https://github.com/xymb-endcrystalme/LinearRegionFileFormatTools).

### Slime File Format
Developed by Hypixel to fix many of the pitfalls of the Anvil file format, Slime also replaces zlib and saves space compared to Anvil, in addition to saving the entire world in a single save
file, and allowing that file to be loaded into multiple instances.

The files stored in this format are .slime files.

More details can be found on the github page for [Slime World Manager](https://github.com/cijaaimee/Slime-World-Manager#:~:text=Slime%20World%20Manager%20is%20a,worlds%20faster%20and%20save%20space.), as well as on [Dev Blog #5](https://hypixel.net/threads/dev-blog-5-storing-your-skyblock-island.2190753/) for Hypixel.

### Schematic File Format
Unlike the other File Formats listed, the Schematic File Format is not for storing minecraft worlds, but instead for use within 3rd party programs such as MCEdit, WorldEdit, and Schematica.

The files stored in this format are .schematic files, and are stored in NBT format.

More details can be found on the [Minecraft Fandom](https://minecraft.fandom.com/wiki/Schematic_file_format)


### World Generation
So far the plains is the only biome that has been implemented.

A chunk height is set, then bedrock, stone, and grass blocks are all filled in. After that, flowers and grass are added.


Blocks are able to be placed and broken, but changes are not able to be saved in any world format. Anvil worlds are currently read only.
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 527777e

Please sign in to comment.