-
Notifications
You must be signed in to change notification settings - Fork 59
Commands
Usage: chunky start [world] [shape] [<centerX> <centerZ>] [radius] [radius]
Permission: chunky.command.start
Description: Start a new chunk generation task, using your existing selection or defined in the command itself.
Examples:
chunky start - Starts pre-generation for the currently selected world, shape, center, and radius in blocks. Note: Unless changed, the default selection is typically a square region in the overworld, centered at 0, 0 with radius 500 (1000 x 1000 blocks).
chunky start world circle 0 0 1000 - Starts pre-generation of a circular region in "world", centered at 0, 0 with radius 1000.
Usage: chunky pause [world]
Permission: chunky.command.pause
Description: Pause current tasks and save progress. These tasks can be resumed via the continue command.
Examples:
chunky pause - Pauses pre-generation for all worlds.
chunky pause world - Pauses pre-generation only for "world".
Usage: chunky continue [world]
Permission: chunky.command.continue
Description: Continue current or saved tasks.
Examples:
chunky continue - Continues pre-generation for all worlds.
chunky continue world - Continues pre-generation only for "world".
Usage: chunky cancel [world]
Permission: chunky.command.cancel
Description: Stop and delete current or saved tasks. These tasks cannot be resumed via the continue command. Keep in mind that even though the task is cancelled, chunks that have already been generated are not deleted. For chunk deletion see the trim command.
Examples:
chunky cancel - Cancel pre-generation progress for all worlds.
chunky cancel world - Cancel pre-generation progress only for "world".
Usage: chunky world [world]
Permission: chunky.command.world
Description: Sets the target world.
Examples:
chunky world - Selects the player's current world.
chunky world world - Selects the world named "world".
Usage: chunky
Permission: chunky.command.shape
Description: Set the shape to generate. Available shapes can be found here.
Examples:
chunky shape square - Selects the square shape.
chunky shape circle - Selects the circular shape.
Usage: chunky center [<x> <z>]
Permission: chunky.command.center
Description: Set the center block location.
Examples:
chunky center - Sets the center location to your current location.
chunky center 0 0 - Sets the center location to 0, 0.
Usage: chunky radius <radius> [radius]
Permission: chunky.command.radius
Description: Set the radius (or radii) in blocks. The second radius is only used when also selecting a rectangle or ellipse shape.
Examples:
chunky radius 500 - Sets the radius to 500 blocks.
chunky radius 500 1000 - Sets the radius to 500 blocks in the X direction, and 1000 blocks in the Z direction.
chunky radius 10k - Sets the radius to 10000 blocks.
chunky radius 625c - Sets the radius to 625 chunks (10000 blocks).
chunky radius +1k - Expands the current radius by 1000 blocks.
chunky radius -1k - Contracts the current radius by 1000 blocks.
Usage: chunky worldborder [world]
Permission: chunky.command.worldborder
Description: Set the center and radius to that used by the world border in the currently selected world. Normally, the vanilla world border is used. However, if the WorldBorder plugin is installed and a border exists, this will import that world border instead.
Examples:
chunky worldborder - Sets the center and radius to match the currently active world border.
chunky worldborder world (Chunky 1.3.136 or later) - Sets the center and radius to match the world border in the world named "world".
Usage: chunky spawn
Permission: chunky.command.spawn
Description: Set the center to the default vanilla spawn point in the currently selected world. Note that this location can be moved with the setworldspawn command. Usually this is somewhere within a few hundred blocks of 0, 0 (which is also the default world border center).
Examples:
chunky spawn - Set the center location to the spawn point.
Usage: chunky corners <x1> <z1> <x2> <z2>
Permission: chunky.command.corners
Description: Set the center and radius automatically based on the set of XZ coordinates provided.
Examples:
chunky corners -500 -500 500 500 - Selects the region between [-500, -500] and [500, 500], which would be centered at 0, 0 with radius 500.
chunky corners 1000 2000 -1000 -2000 - Selects the region between [1000, 2000] and [-1000, -2000], which would be centered at 0, 0 with a radius of 1000 in the X direction and a radius of 2000 in the Z direction.
Usage: chunky pattern
Permission: chunky.command.pattern
Description: Set the generation pattern. This determines the order that chunks are generated. Available patterns can be found here. In most cases, the default pattern is recommended.
Examples:
chunky pattern concentric - Sets the pattern to concentric. Chunks generate from the center of the region outward.
chunky pattern loop - Sets the pattern to loop. Chunks generate across from one side of the region to the other.
Usage: chunky selection
Permission: chunky.command.selection
Description: Display the current selection.
Examples:
chunky selection - Shows current selection.
Usage: chunky silent
Permission: chunky.command.silent
Description: Toggle displaying update messages from pre-generation tasks.
Examples:
chunky silent - Disables update messages. If run again, will re-enable.
Usage: chunky quiet <interval>
Permission: chunky.command.quiet
Description: Set the quiet interval for update messages from pre-generation tasks.
Examples:
chunky quiet 5 - Sets the quiet interval to 5 seconds between update messages.
chunky quiet 0 - An update message is printed for every chunk that generates.
Usage: chunky progress
Permission: chunky.command.progress
Description: Display pre-generation progress in-game for all tasks, as normally shown automatically in the server console.
Examples:
chunky progress - Shows task progress.
Usage: chunky reload
Permission: chunky.command.reload
Description: Reload the configuration or tasks.
Examples:
chunky reload - Reloads the configuration.
chunky reload tasks - Reloads all tasks.
Usage: chunky trim [world] [shape] [<centerX> <centerZ>] [radius] [radius] [outside|inside] [inhabited]
Permission: chunky.command.trim
Description: Delete chunks outside the selection. This is effectively the opposite of the start command (which generates chunks inside the selection). Useful if you make a mistake and generate too much, or need to remove excess chunks outside of the world border. The last two arguments can also be specified to instead trim inside the selection, or only trim chunks with an inhabited time less than or equal to a given value. Keep in mind that deleted chunks cannot be restored without a backup, so exercise extreme caution and make backups before running this. The server must also be restarted after running trim to ensure that deleted chunks are not kept in memory. See trimming chunks for more details.
Since Chunky 1.3.90 it is also possible to choose whether trimming is outside (default) or inside of the region selected, as well as specify an inhabited time value (in ticks) to filter chunks to remove.
Examples:
chunky trim world square 0 0 10k - Deletes all chunks outside of the square region in "world" centered at 0, 0 with radius 10000.
chunky trim world square 0 0 0 0 outside 0 (Chunky 1.3.90 or later) - Deletes all chunks outside of the square region in "world" centered at 0, 0 with radius 0 (effectively everything), where the inhabited time value is zero (never loaded by players).