Bundled Worlds

How to replace normal world generation with a pre-generated world.

Bundled World Settings

Using a bundled world replaces the normal world creation process entirely, copying a pre-generated world instead of generating one from scratch.

Field	Type	Default	Description
folder	string	N/A	The name of the source world folder, in config/worldpresets/worlds/.
reset_player_data	boolean	true	If true, all player data from the source world will be removed while loading. This includes resetting inventory, health, advancements, stats, etc.
reset_world_state	boolean	false	If true, all world data from the source world will be removed while loading. This includes resetting time of day, weather, wandering trader time, etc.

World Loading Mechanics

When a world is created from a bundled world, the existing world is copied from the source folder into the saves folder. World creation settings from the world will be loaded into the world creation menu when the preset is loaded, so all of the world's saved settings can be seen and edited.

Some world creation options and preset options will not apply when using a bundled world, since the world generation portion has already been completed. This includes the world's type, the world's seed, the preset's spawn location and dimension override, and any preset starting structures. When these options appear in the world creation menu, they will be grayed out and not editable.

Example

For this example, a world folder named skyblock has been placed in config/worldpresets/worlds/.

{
    title: "Skyblock",
    description: "Start on a floating island with limited resources.",

    world: {
        name: "Skyblock",
        difficulty: "hard"
    },

    bundled_world: {
        folder: "skyblock",
        reset_player_data: true,
        reset_world_state: true
    }
}