Nucleus is no longer updated and this site is frozen in time. Some links may be broken.
Welcome to the new docs site for Nucleus v2! Still on Nucleus v1? Visit the old site here.

World Module

Introduction

The World module allows for basic World management, such as creating and deleting worlds, and setting world borders.

Creating Worlds

To create a world, use the command /world create [flags] [worldname]. The name is required. All other options in this command are optional, and are specified by flags. Each flag requires an argument after their names. These flags are:

  • -d/–dimension : the dimension to use as a base world type. Defaults to the overworld.
  • -g/–generator : the world generator to use. Defaults to the default generator.
  • -m/–modifier : a world generator modifier to use. Can be specified multiple times for multiple modifiers.
  • –di/–difficulty : the initial world difficulty. Defaults to normal.
  • –gm/–gamemode : the default game mode for players in the world. Defaults to survival.
  • -s/–seed : The seed to use to generate the world. If not specified, a random seed will be used.
  • -i: Indicates that this world might exist and can be imported.
  • -n/–nostructures: If specified, will not generate structures in the world
  • -l/–loadonstartup <true false>: If false, the world will not be loaded on startup. Defaults to true.
  • -k/–keepspawnloaded <true false>: If false, the spawn will not be kept loaded. Defaults to true.
  • -c/–allowcommands <true false>: If false, commands will not be allowed on the world. Defaults to true.
  • -b/–bonuschest <true false>: If false, the bonus chests will not be generated. Defaults to true.

Dimension refers to the type of world (that is, overworld, nether or the_end), and generator refers to the type of generator used to generate the world. This may be a custom generator provided by another plugin.

Presets (WorldArchetypes) in /world create

By using the -p flag, you can specify a preset world type - to create a void world, you can now run /world create -p the_void <name>, and to create a skylands world, ` /world create -p the_skylands `. Other presets might be available - depending on other plugins that might supply `WorldArchetypes`.

Importing Worlds

To import an existing world, place a copy of the world, with the directory name that reflects the name of the world you want to import within the server world/ directory (or whatever your default/primary world name is, as set in server.properties). Then, run the command /world create -i [world name], and the import process should start for you.

Enabling, disabling, loading and unloading worlds.

Nucleus provides commands that allows admins to manage whether a world is loaded or not, or whether it can even be accessed. A world can be in one of the following states:

  • Loaded - a world is loaded and accessible.
  • Unloaded - a world is not loaded, but will be loaded if someone tries to access it.
  • Disabled - a world is not loaded and is not accessible, meaning that a player trying to access it will fail.

The commands /world load, /world unload, /world disable and /world enable can change between these states.

Note that the “default” worlds cannot be disabled as of right now.

Deleting worlds

Nucleus can attempt to delete worlds for you. Use the /world delete [world] command, and Nucleus will attempt to remove all traces of the world from your disc. Be careful, once it’s gone, you can’t get it back if you haven’t backed it up first!

World Borders

Nucleus uses Minecraft’s in built world border support and makes it easy to update or change it.

To display the current world border information, run the command /world border [world]. If you omit the world argument, it will default to the world you are currently in.

To set the world border, run the command /world border set [world] [centre-x] [centre-z] <diameter> [delay]. Only the diameter is mandatory if you are a player in the world, otherwise all arguments are required. The diameter is the size of the border from edge to edge (twice the distance from the centre to the edge). centre-x and centre-z refer to the new centre of the world border, and delay defines, in seconds, how long it will take Minecraft to change to the diameter of the world border from the old one, defaulting to 0 - instantaneous change.

Pre-Generating Chunks

For more information on why you should do this and how to do this in more detail, see our How To page.

To pre-generate chunks in the world, run the command /world border gen [world], where the world is optional if you are a player in a world. Sponge will start pre-generating chunks. If you wish to stop the pre-generation early, use /world border cancelgen [world]. Restarting the server will also cancel the pre-generation unless the command was run with the -r flag.

If you want to try to run the pre-generation faster, you can change the same interval to be much higher, and run in “aggressive” mode. Adding -a to the command indicates aggresive mode, where 90% of tick time is dedicated to the generation routines, and memory checks are turned off. To change the save interval, add --save <time> to your command, where <time> is a Timespan Argument.

World Access Permissions

If you wish to prevent access to certain worlds, settings separate-permissions in the Nucleus Worlds configuration will enable the ability to use permissions to restrict access to worlds.

Consideration has been taking for end portal teleporting, and will teleport the player to a near safe location if they would be in danger.

The permission format is nucleus.worlds.[world name]

The following are incompatibilities that may occur with this module, along with how to resolve the problem. For the full mod/plugin incompatibility list, see the compatibility page.

  • Critical issues are where some function of Nucleus is seriously affected in a way server owners are not expecting and have no known workaround, other than removing the plugin in question. It is advised that server owners remove the plugin in question and find an alternative if they wish to use the Nucleus feature it affects.
  • Major issues are where some function of Nucleus is seriously affected in a way server owners are not expecting by default but a workaround exists to mitigate or fix the issue.
  • Minor issues are where some function of Nucleus can be mildy affected, possibly in an unwanted way, but is not enabled by default or has little impact on day to day server running and management. A workaround exists to restore or use the affected Nucleus functionality.
  • Info issues are really non-issues. Incompatibilities with this label tend to be wanted (such as a world management plugin taking over the `/world` command), and are documented here for completeness, along with how to restore or use Nucleus functions.
Mod/Plugin: ProjectWorlds. Affected Module(s): world.

The /world commands are not Nucleus commands when using ProjectWorlds

Info

Reason: ProjectWorlds is a world management plugin and takes over the /world command.

Resolution: Use /nworld for Nucleus management commands.

/world
Module: world
Parent command for all other world commands.

Aliases: /world, /nworld, /nucleusworld

Usage: /world

Default Role: ADMIN

Basic Command Permission: nucleus.world.base

Permissions

  • nucleus.world.base - Default Role: ADMIN
    Allows the user to run the command /world
/world border
Module: world
Parent command for world border commands.

Aliases: /world border

Usage: /world border [<world>]

Default Role: ADMIN

Basic Command Permission: nucleus.world.border.base

Permissions

  • nucleus.world.border.base - Default Role: ADMIN
    Allows the user to run the command /world border
/world border cancelgen
Module: world
Cancels any current world border generation.

Aliases: /world border cancelgen

Usage: /world border cancelgen [<world>]

Default Role: ADMIN

Basic Command Permission: nucleus.world.border.gen.base

Permissions

  • nucleus.world.border.gen.base - Default Role: ADMIN
    Allows the user to run the command /border gen
/world border gen
Module: world
Generates chunks up to the world border.

When invoked, Nucleus will start generating chunks up to the world border. During this time, the server will be susceptible to reduced performance.

There are a few flags you can use:

* -a - aggressive mode, turns off memory checks, saves less often, uses every three ticks (instead of four) to generate
* -u - ultra-aggressive mode, turns off memory checks, saves every 2 minutes, uses every tick to generate
* -r - restart pre-generation if the server is restarted (use with caution, does not disable if the pre-gen causes the crash)
* -t [1-100] - the percentage of a tick to use when generating, defaults to 80% (90% with aggressive mode, 95% with ultra aggressive mode)
* -f [1-100] - the number of ticks to wait after a generation to perform the next generation - defaults to Sponge default (3 in aggressive mode, 1 in ultra aggressive mode)
* --save [timespan] - frequency to perform a save at, defaults to 20 seconds (30 seconds with aggressive mode, 120 for ultra aggressive)

If you want to maximise generation, run "/world border gen -u -t 100 -f 1", but be prepared for lag!

Aliases: /world border gen, /world border genchunks, /world border generatechunks, /world border chunkgen

Usage: /world border gen [-r|--restart <r>] [-f|--frequency <f>] [-u|--ultra-aggressive <u>] [-t|--tickpercent <t>] [--save <save>] [-a|--aggressive <a>] [<world>]

Default Role: ADMIN

Basic Command Permission: nucleus.world.border.gen.base

Permissions

  • nucleus.world.border.gen.notify - Default Role: ADMIN
    If granted and enhanced generation is being used, these players are notified of progress to the generation.
  • nucleus.world.border.gen.base - Default Role: ADMIN
    Allows the user to run the command /border gen
/world border reset
Module: world
Resets the world border to the default width.

Aliases: /world border reset

Usage: /world border reset [<world>]

Default Role: ADMIN

Basic Command Permission: nucleus.world.border.set.base

Permissions

  • nucleus.world.border.set.base - Default Role: ADMIN
    Allows the user to run the command /border set
/world border set
Module: world
Sets the world border.

Aliases: /world border set

Usage: /world border set [<world>] <x> <z> <diameter> [<delay>]|<diameter> [<delay>]

Default Role: ADMIN

Basic Command Permission: nucleus.world.border.set.base

Permissions

  • nucleus.world.border.set.base - Default Role: ADMIN
    Allows the user to run the command /border set
/world clone
Module: world
Clones an existing world and registers it

Aliases: /world clone, /world copy

Usage: /world clone <world> <new name>

Default Role: OWNER

Basic Command Permission: nucleus.world.clone.base

Permissions

  • nucleus.world.clone.base - Default Role: OWNER
    Allows the user to run the command /world clone
/world create
Module: world
Creates a world with the specified name and options.

Creates a game world with the provided name, required. All other options in this command are optional, and are specified by flags. Each flag requires an argument after their names. These flags are:

* -d/--dimension <dimension>: the dimension to use as a base world type. Defaults to the overworld.
* -g/--generator <generator>: the world generator to use. Defaults to the default generator.
* -m/--modifier <modifier>: a world generator modifier to use. Can be specified multiple times for multiple modifiers.
* --di/--difficulty <difficulty>: the initial world difficulty. Defaults to normal.
* --gm/--gamemode <gamemode>: the default game mode for players in the world. Defaults to survival.
* -s/--seed <seed>: The seed to use to generate the world. If not specified, a random seed will be used.
* -i: Indicates that this world might exist and can be imported.
* -n/--nostructures: If specified, will not generate structures in the world
* -l/--loadonstartup <true|false>: If false, the world will not be loaded on startup. Defaults to true.
* -k/--keepspawnloaded <true|false>: If false, the spawn will not be kept loaded. Defaults to true.
* -c/--allowcommands <true|false>: If false, commands will not be allowed on the world. Defaults to true.
* -b/--bonuschest <true|false>: If false, the bonus chests will not be generated. Defaults to true.

You can also use a preset, using the flag "-p <preset>". Available presets can be found by running "/world presets"

The difficulty, the game mode, load on startup and keep spawn loaded properties can be changed after the world is generated.

Aliases: /world create

Usage: /world create [-p|--preset <p>] [-b|--bonuschest <b>] [-i <i>] [--gm|--gamemode <gm>] [-s|--seed <s>] [-k|--keepspawnloaded <k>] [-n|--nostructures <n>] [-l|--loadonstartup <l>] [-g|--generator <g>] [-d|--dimension <d>] [--di|--difficulty <di>] [-m|--modifier <m>] [-c|--allowcommands <c>] <name>

Default Role: ADMIN

Basic Command Permission: nucleus.world.create.base

Permissions

  • nucleus.world.create.base - Default Role: ADMIN
    Allows the user to run the command /world create
/world delete
Module: world
Deletes a world from the disc.

This command irreversibly removes a world that has been unloaded and disabled from the disc. Before removal, the file path will be shown to be checked before the removal is confirmed and completed.
It is vitally important to note that once the world is deleted, it cannot be recovered.

Aliases: /world delete, /world del

Usage: /world delete <world>

Default Role: OWNER

Basic Command Permission: nucleus.world.delete.base

Permissions

  • nucleus.world.delete.base - Default Role: OWNER
    Allows the user to run the command /world delete
/world disable
Module: world
Disables a world that is unloaded, preventing it from being loaded in future.

Disabling a world prevents a world from being loaded, however, if a world is currently loaded, it will not be unloaded, and so will not be fully disabled until it is unloaded.

Aliases: /world disable, /world dis

Usage: /world disable <world>

Default Role: ADMIN

Basic Command Permission: nucleus.world.disable.base

Permissions

  • nucleus.world.disable.base - Default Role: ADMIN
    Allows the user to run the command /world disable
/world enable
Module: world
Enables a world, allowing it to be loaded on demand.

Aliases: /world enable, /world en

Usage: /world enable <world>

Default Role: ADMIN

Basic Command Permission: nucleus.world.enable.base

Permissions

  • nucleus.world.enable.base - Default Role: ADMIN
    Allows the user to run the command /world enable
/world gamerule
Module: world
Displays a world's game rules.

Aliases: /world gamerule

Usage: /world gamerule [<world>]

Default Role: ADMIN

Basic Command Permission: nucleus.world.gamerule.base

Permissions

  • nucleus.world.gamerule.base - Default Role: ADMIN
    Allows the user to run the command /world gamerule
/world gamerule set
Module: world
Sets the specified world's game rule.

Aliases: /world gamerule set

Usage: /world gamerule set [<world>] <gamerule> <value>

Default Role: ADMIN

Basic Command Permission: nucleus.world.gamerule.set.base

Permissions

  • nucleus.world.gamerule.set.base - Default Role: ADMIN
    Allows the user to run the command /gamerule set
/world generators
Module: world
Shows available generators for use when creating a world.

Aliases: /world generators, /world listgenerators

Usage: /world generators

Default Role: ADMIN

Basic Command Permission: nucleus.world.create.base

Permissions

  • nucleus.world.create.base - Default Role: ADMIN
    Allows the user to run the command /world create
/world info
Module: world
Displays information about one world.

This is otherwise identical to "/world list".

Aliases: /world info

Usage: /world info <world>

Default Role: ADMIN

Basic Command Permission: nucleus.world.list.base

Permissions

  • nucleus.world.list.base - Default Role: ADMIN
    Allows the user to run the command /world info
/world list
Module: world
Lists all worlds.

Displays all worlds and information about them, including their seed, if the viewer in question has the "nucleus.world.list.seed" permission.

Aliases: /world list, /world ls

Root command aliases: /worlds /nworlds

Usage: /world list

Default Role: ADMIN

Basic Command Permission: nucleus.world.list.base

Permissions

  • nucleus.world.list.base - Default Role: ADMIN
    Allows the user to run the command /world info
  • nucleus.world.list.seed - Default Role: ADMIN
    Allows the user to see world seeds.
/world load
Module: world
Loads a world that is currently unloaded.

The command will refuse to load a disabled world unless the "-e" flag is specified and you have permission to run the "/world enable" command.

Aliases: /world load

Usage: /world load [-e|--enable <e>] <world>

Default Role: ADMIN

Basic Command Permission: nucleus.world.load.base

Permissions

  • nucleus.world.load.base - Default Role: ADMIN
    Allows the user to run the command /world load
/world modifiers
Module: world
Shows available modifiers for use when creating a world.

Aliases: /world modifiers, /world listmodifiers

Usage: /world modifiers

Default Role: ADMIN

Basic Command Permission: nucleus.world.create.base

Permissions

  • nucleus.world.create.base - Default Role: ADMIN
    Allows the user to run the command /world create
/world presets
Module: world
Shows available presets for use when creating a world.

Aliases: /world presets, /world listpresets

Usage: /world presets

Default Role: ADMIN

Basic Command Permission: nucleus.world.create.base

Permissions

  • nucleus.world.create.base - Default Role: ADMIN
    Allows the user to run the command /world create
/world rename
Module: world
Allows you to rename and unloaded world.

It is important to note that the world in question MUST be unloaded. If you cannot unload the world, consider stopping your server and renaming the world using an NBT editor on the world dat file.

Aliases: /world rename

Usage: /world rename <world> <new name>

Default Role: OWNER

Basic Command Permission: nucleus.world.rename.base

Permissions

  • nucleus.world.rename.base - Default Role: OWNER
    Allows the user to run the command /world rename
/world setdifficulty
Module: world
Sets the difficulty of a world.

Aliases: /world setdifficulty, /world difficulty

Usage: /world setdifficulty <difficulty> [<world>]

Default Role: ADMIN

Basic Command Permission: nucleus.world.setdifficulty.base

Permissions

  • nucleus.world.setdifficulty.base - Default Role: ADMIN
    Allows the user to run the command /world setdifficulty
/world setgamemode
Module: world
Sets the gamemode of a world.

Aliases: /world setgamemode, /world setgm, /world gamemode, /world gm

Usage: /world setgamemode game mode [<world>]

Default Role: ADMIN

Basic Command Permission: nucleus.world.setgamemode.base

Permissions

  • nucleus.world.force-gamemode.override - Default Role: ADMIN
    If granted and the Nucleus per-world gamemodes are enforced, the player will not have their gamemode changed.
  • nucleus.world.setgamemode.base - Default Role: ADMIN
    Allows the user to run the command /world setgamemode
/world sethardcore
Module: world
Sets whether a world has hardcore mode enabled.

Aliases: /world sethardcore

Usage: /world sethardcore [<world>] <true|false>

Default Role: ADMIN

Basic Command Permission: nucleus.world.sethardcore.base

Permissions

  • nucleus.world.sethardcore.base - Default Role: ADMIN
    Allows the user to run the command /world sethardcore
Sets whether a world will keep the chunks around it's spawn point loaded.

Aliases: /world setkeepspawnloaded

Usage: /world setkeepspawnloaded [<world>] <true|false>

Default Role: ADMIN

Basic Command Permission: nucleus.world.setkeepspawnloaded.base

Permissions

  • nucleus.world.setkeepspawnloaded.base - Default Role: ADMIN
    Allows the user to run the command /world setkeepspawnloaded
/world setloadonstartup
Module: world
Sets whether a world will load on startup.

Aliases: /world setloadonstartup

Usage: /world setloadonstartup [<world>] <true|false>

Default Role: ADMIN

Basic Command Permission: nucleus.world.setloadonstartup.base

Permissions

  • nucleus.world.setloadonstartup.base - Default Role: ADMIN
    Allows the user to run the command /world setloadonstartup
/world setpvpenabled
Module: world
Sets whether a world has PVP enabled.

Aliases: /world setpvpenabled, /world setpvp

Usage: /world setpvpenabled [<world>] <true|false>

Default Role: ADMIN

Basic Command Permission: nucleus.world.setpvpenabled.base

Permissions

  • nucleus.world.setpvpenabled.base - Default Role: ADMIN
    Allows the user to run the command /world setpvpenabled
/world setspawn
Module: world
Sets the spawn point of a world.

Aliases: /world setspawn

Usage: /world setspawn [<world> <x> <y> <z>]

Default Role: ADMIN

Basic Command Permission: nucleus.world.setspawn.base

Permissions

  • nucleus.world.setspawn.base - Default Role: ADMIN
    Allows the user to run the command /world setspawn
/world spawn
Module: world
Teleports to world spawn.

Aliases: /world spawn

Usage: /world spawn

Default Role: ADMIN

Basic Command Permission: nucleus.world.spawn.base

Permissions

  • nucleus.world.spawn.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /world spawn
  • nucleus.world.spawn.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /world spawn
  • nucleus.world.spawn.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /world spawn
  • nucleus.world.spawn.base - Default Role: ADMIN
    Allows the user to run the command /world spawn
/world teleport
Module: world
Teleports you, or another player, to the specified world.

This command will teleport the target player to the target world provided it is enabled. It will not enable a disabled world.

Aliases: /world teleport, /world tp

Usage: /world teleport <world> [<player>]

Default Role: ADMIN

Basic Command Permission: nucleus.world.teleport.base

Permissions

  • nucleus.world.teleport.exempt.cost - Default Role: ADMIN
    Allows the user to bypass the cost for /world teleport
  • nucleus.world.teleport.exempt.cooldown - Default Role: ADMIN
    Allows the user to bypass the cooldown for /world teleport
  • nucleus.world.teleport.others - Default Role: ADMIN
    Allows the user to teleport other players to other worlds.
  • nucleus.world.teleport.base - Default Role: ADMIN
    Allows the user to run the command /world teleport
  • nucleus.world.teleport.exempt.warmup - Default Role: ADMIN
    Allows the user to bypass the warmup for /world teleport

This command is an equivalent to the following command(s) in Essentials: /world

Essentials Migration Notes: The world command in Essentials was just a warp command.

/world unload
Module: world
Unloads a world that is currently loaded.

Unloads the specified world, and optionally disables it. Simply unloading a world does not make is inaccessible, as it will remain enabled, which will cause the world to load when someone tries to connect to it. To disable the world at the same time as unloading it, add the "-d" flag to the command.

Aliases: /world unload

Usage: /world unload [-t|--transfer <t>] [-d|--disable <d>] <world>

Default Role: ADMIN

Basic Command Permission: nucleus.world.unload.base

Permissions

  • nucleus.world.unload.base - Default Role: ADMIN
    Allows the user to run the command /world unload
Permission Suggested Role Description
nucleus.world.base ADMIN Allows the user to run the command /world
nucleus.world.border.base ADMIN Allows the user to run the command /world border
nucleus.world.border.gen.base ADMIN Allows the user to run the command /border gen
nucleus.world.border.gen.notify ADMIN If granted and enhanced generation is being used, these players are notified of progress to the generation.
nucleus.world.border.set.base ADMIN Allows the user to run the command /border set
nucleus.world.clone.base OWNER Allows the user to run the command /world clone
nucleus.world.create.base ADMIN Allows the user to run the command /world create
nucleus.world.delete.base OWNER Allows the user to run the command /world delete
nucleus.world.disable.base ADMIN Allows the user to run the command /world disable
nucleus.world.enable.base ADMIN Allows the user to run the command /world enable
nucleus.world.force-gamemode.override ADMIN If granted and the Nucleus per-world gamemodes are enforced, the player will not have their gamemode changed.
nucleus.world.gamerule.base ADMIN Allows the user to run the command /world gamerule
nucleus.world.gamerule.set.base ADMIN Allows the user to run the command /gamerule set
nucleus.world.list.base ADMIN Allows the user to run the command /world info
nucleus.world.list.seed ADMIN Allows the user to see world seeds.
nucleus.world.load.base ADMIN Allows the user to run the command /world load
nucleus.world.rename.base OWNER Allows the user to run the command /world rename
nucleus.world.setdifficulty.base ADMIN Allows the user to run the command /world setdifficulty
nucleus.world.setgamemode.base ADMIN Allows the user to run the command /world setgamemode
nucleus.world.sethardcore.base ADMIN Allows the user to run the command /world sethardcore
nucleus.world.setkeepspawnloaded.base ADMIN Allows the user to run the command /world setkeepspawnloaded
nucleus.world.setloadonstartup.base ADMIN Allows the user to run the command /world setloadonstartup
nucleus.world.setpvpenabled.base ADMIN Allows the user to run the command /world setpvpenabled
nucleus.world.setspawn.base ADMIN Allows the user to run the command /world setspawn
nucleus.world.spawn.base ADMIN Allows the user to run the command /world spawn
nucleus.world.spawn.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /world spawn
nucleus.world.spawn.exempt.cost ADMIN Allows the user to bypass the cost for /world spawn
nucleus.world.spawn.exempt.warmup ADMIN Allows the user to bypass the warmup for /world spawn
nucleus.world.teleport.base ADMIN Allows the user to run the command /world teleport
nucleus.world.teleport.exempt.cooldown ADMIN Allows the user to bypass the cooldown for /world teleport
nucleus.world.teleport.exempt.cost ADMIN Allows the user to bypass the cost for /world teleport
nucleus.world.teleport.exempt.warmup ADMIN Allows the user to bypass the warmup for /world teleport
nucleus.world.teleport.others ADMIN Allows the user to teleport other players to other worlds.
nucleus.world.unload.base ADMIN Allows the user to run the command /world unload
The following configuration is the default for this module:
                            # If positive, any new worlds that are created using "/world create" (or "/nworld create") will automatically get a world border that has this diameter (that is, from border to border). Set to 0 or a negative number to disable.
default-world-border-diameter=0
# If true, joining or changing worlds will change the gamemode of a player unless they have the Minecraft permission "nucleus.world.force-gamemode.override"
enforce-gamemode-on-world-change=false
pre-generation {
    # If true, then players with the "nucleus.world.border.gen.notify" permission will get an update on progress after each generation. Recommended to be off, because it can be VERY spammy.
    display-after-each-gen=false
    # If true world generation will warn players on the server that a pre-generation is in progress periodically.
    display-generation-warning=true
    # Time, in seconds, between notifications in chat warning players a pre-gen is in progress.
    notification-interval=20
}
# If true, changing worlds requires permission to access the target world - "nucleus.worlds.<worldname>"
separate-permissions=false

                        
Search

Downloading search database, this won't take long...