Skip to content

Add sections on world loading - #39

Open
LooFifteen wants to merge 2 commits into
Minestom:masterfrom
LooFifteen:docs/loading
Open

LooFifteen wants to merge 2 commits into
Minestom:masterfrom
LooFifteen:docs/loading

Conversation

@LooFifteen

Copy link
Copy Markdown
Collaborator

Adds useful Javadoc links and updated documentation regarding chunk loading. This also adds a page on the external Polar loader, which I feel is a popular enough library to be included in the official documentation with a big warning stating the lack of update guarantees.

Comment thread docs/world/loading.md
## Loaders

* [No-op](https://javadoc.minestom.net/net/minestom/server/instance/IChunkLoader.html#noop())
* [Anvil](/docs/world/loading/anvil.md)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't tested but pretty sure this won't work. Shouldn't they be without .md? So just /docs/world/loading/{anvil,polar}

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works on the local development server. I'd also assume that would work when the site is generated.

@mworzala

Copy link
Copy Markdown
Member

Seems kinda weird to have docs for an external library on the main wiki to me...

@ZakShearman

Copy link
Copy Markdown

Seems kinda weird to have docs for an external library on the main wiki to me...

I think it makes more sense than not having it. It's a common use-case and you'll find with almost any wiki of a big enough piece of software they will include recommendations for external tools that fill common gaps.

@LooFifteen

Copy link
Copy Markdown
Collaborator Author

Removed references to Polar.

@LooFifteen
LooFifteen requested a review from mworzala October 17, 2025 09:20

## Requirements

Worlds to be used with [`AnvilLoader`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/anvil/AnvilLoader.html) only need to contain the `region` directory, which is where the chunk data comes from. Chunk loaders do not read entity data.

@mudkipdev mudkipdev Jul 24, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please update it to use new format: dimensions/minecraft/overworld/region

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants