Multiverse

A fabric mod for Minecraft that allows creating custom dimensions at runtime with commands!

## About The Project This is a server-side fabric mod that provides a few simple commands for creating custom dimensions at runtime. The motivation for this when building in creative, whether working on decorative builds or working with redstone it can be beneficial to work in a separate dimension. ## Usage After installing the mod the `/multiverse` command should become available to operators. The permissions for the command can also be modified using a permissions mod, [see the permissions section](#permissions). The command is quite simple, with only a few subcommands. Let's first discuss how to create a custom dimension. ### Creating Custom Dimensions To create a custom dimension we will use the `create` subcommand. There are 2 branches from the `create` subcommand: ```mcfunction /multiverse create from

/multiverse create vanilla ``` In the first, `from`, we can specify a pre-defined dimension type, give our dimension a namespaced identifier, optionally specify a seed (otherwise random), and also specify whether the dimension should have its own gamerules or whether it should inherit its gamerules. Finally, you can also specify whether the `/tick` command will work independently for that specific dimension. If set to `true` any `/tick` commands run inside that dimension will affect *only* that specific dimension, `/tick` run in any dimension that doesn't have a custom tickrate will also only affect dimensions that also don't have a custom tickrate. Dimension types define how the terrain is generated as well as some behaviors which you can find listed on the [Minecraft wiki](https://minecraft.wiki/w/Dimension_type). By default, vanilla has 3 types: `minecraft:overworld`, `minecraft:the_nether`, and `minecraft:the_end`. Multiverse adds 2 types: `multiverse:void` and `multiverse:white_glass`, generating a void world and a flat world with one layer of white glass respectively. You can also define your own dimension types for more control, see [the defining custom dimension types section](#defining-custom-dimension-types). The specified dimension id can be any namespaced id as long as no existing dimension has that id, for example you cannot use `minecraft:overworld` because vanilla uses that id. Here's an example command to create a dimension called `example:my_dimension` that is a glass superflat world with a random seed with its own gamerules: ```mcfunction /multiverse create from multiverse:white_glass example:my_dimension random true ``` The second `vanilla` allows you to create a set of 3 dimensions that mirror the behavior of vanilla's 3 dimensions. Here's an example command: ```mcfunction /multiverse create vanilla example:my_overworld example:my_nether example:my_end ``` This will create 3 dimensions, `example:my_overworld`, `example:my_nether`, and `example:my_end` with overworld, nether, and end generation respectively. `example:my_overworld` and `example:my_nether` can be linked with nether portals and will behave just like `minecraft:overworld` and `minecraft:the_nether` would. The same is true for the end portal. It is worth noting that returning back through the end portal will put the player at their spawn, or at global spawn (which may still be in `minecraft:overworld`). Additionally, the generated end dimension *will* spawn the ender dragon. ### Teleporting to Custom Dimensions Multiverse provides a command to teleport to different dimensions: ```mcfunction /multiverse teleport ``` ### Deleting Custom Dimensions Deleting custom dimensions is very simple: ```mcfunction /multiverse delete ``` Running this command won't immediately delete your dimension, instead it will ask you to confirm whether you truly want to delete the dimension as this action is destructive and cannot be undone. Running `/multiverse delete force` will bypass this prompt. ### Cloning Dimensions Multiverse allows you to clone any dimension, this may be useful when iterating on a build or for when you need to test the behavior of a redstone contraption. You will likely want to run `/save-all` prior to cloning a dimension to ensure that it's cloned in its most up-to-date state. The command is as follows: ```mcfunction /multiverse clone

``` Where `` is the existing dimension you want to clone from, and `` is the namespaced id you want to create as a clone. You can also specify whether the cloned dimension will have its own custom tickrate manager, for more details read [the creating custom dimensions section](#creating-custom-dimensions). Finally, you can also specify a [region area](https://minecraft.wiki/w/Chunk_format) to clone, you may also only specify one region in which case only that region will be cloned, if unspecified the *entire* dimension will be copied. This is not recommended as dimensions which take up a lot of storage as it copies *all* region files, and it also may hang your server. ### Dimension Files Multiverse's dimensions are located in your `world/dimensions//` directory, for example, if you create a dimension called `example:world` then your dimension files will be in `world/dimensions/example/world`. From here the structure of worlds is the same as the overworld/nether/end. ### Defining Custom Dimension Types Multiverse allows you to define your own custom dimension types in a datapack! Here's a guide on how to create a datapack on the [Minecraft wiki](https://minecraft.wiki/w/Tutorial:Creating_a_data_pack). The format is exactly the same as if you were to define a custom dimension for vanilla to load but just in a different directory. You can follow this tutorial on the [Minecraft wiki](https://minecraft.wiki/w/Tutorial:Adding_a_new_dimension) on how to create a new dimension but instead of putting your dimension files in `data//dimension/.json` you should put your dimension files in `data//multiverse/dimension/.json`. Custom dimension types should still be registered at `data//dimension_type/.json`. There is an example datapack in this repository which you can download as a template [here](https://github.com/senseiwells/Multiverse/raw/refs/heads/1.21.8/docs/example_datapack.zip), or you can view it [here](https://github.com/senseiwells/Multiverse/tree/1.21.8/docs/example_datapack). ### Permissions You can further customize access of the commands through the use of a permissions mod such as [LuckPerms](https://luckperms.net/). The permission `"multiverse.commands.multiverse"` grants the `/multiverse` command with further more specific permissions for the subcommands: - `"multiverse.commands.multiverse.create"` - `"multiverse.commands.multiverse.clone"` - `"multiverse.commands.multiverse.delete"` - `"multiverse.commands.multiverse.teleport"` ## License Distributed under the MIT License. See [MIT License](https://opensource.org/licenses/MIT) for more information.

Multiverse

Compatibility

Minecraft: Java Edition

Platforms

Supported environments

Links

Creators

Tags

Details