Skip to content

Pregeneration

pop4959 edited this page Jun 6, 2021 · 12 revisions

Set-up

Pre-generating chunks using Chunky is very easy. Most servers pre-generate their chunks to avoid unnecessary lag while loading chunks or when rending a map of their world.

If you haven't already, be sure to install Chunky on your server.

Start your server, and type chunky (or /chunky if in-game) to check that it has successfully installed. If you don't see a command menu pop up, then double check that you have followed the instructions and make sure that you have restarted your server.

Before continuing, here are a few things to note:

  • Pre-generation is best done before players join your server. It will complete quicker, and will not impact gameplay.
  • Having mentioned that, we also recommend using Chunky via the server console. The rest of this guide assumes you are running commands from console, but if you are running them in-game you will need to add a slash / before the command.
  • Large radius pre-gen can use a lot of disk space. Keep this in mind when selecting a size for your world. A general recommendation is 5k radius (which uses about 3-5gb per world) for smaller servers, and 10k radius (which uses about 10-15gb per world) for larger ones.
  • If you have a map rendering plugin installed (Dynmap, BlueMap, or Pl3xMap) you may wish to disable it while pre-generating, and render the world afterward for best results. See map rendering for more information.

Selecting and pre-generating a region

The first thing you'll want to do is select a region which you will be pre-generating. The world, shape, center, and radius are all considered part of the selection. By default, the selection will be a square region in the main server world, centered at 0, 0 with a radius of 500 blocks (total size 1000 x 1000). Using selection commands you can change this to fit your needs.

Let's just say for example that we just want to generate 5k radius (10000 x 10000 blocks) in our main world. You would need the following commands:

chunky radius 5000
chunky start

If right after, you decide that you want to generate this same area in the nether, you only need to change the world, then start another task:

chunky world world_nether
chunky start

That's pretty much all there is to it. For help with selecting other types of regions, take a look at the selection commands.

Checking progress

When you run chunky start you should start receiving update messages in console reporting pre-generation progress. Included information are the number of chunks processed, percent to completion, ETA (estimated time to complete in hours:minutes:seconds), the generation rate in chunks per second (cps), and the current chunk being generated.

Pre-generation for larger areas can often take many hours. Glance at the ETA, and ensure that the estimated time it takes to generate the world is reasonable. If it isn't, you might want to restart the task with a smaller radius.

If for some reason you need to pause the task, such as to restart your server, you can use the chunky pause command. When you're ready to continue, just run chunky continue.