Skip to content

Pregeneration

pop4959 edited this page Nov 30, 2021 · 12 revisions

Set-up

Pre-generating chunks using Chunky is extremely easy. Most servers pre-generate to avoid unnecessary lag while loading chunks and for creating clean looking map renders of their world.

If you haven't already, be sure to install Chunky first.

Before continuing, there are a few things worth noting:

  • Pre-generation is best done before players join your server. It will usually complete faster, and avoid possible impact on gameplay.
  • The preferred method of using Chunky is through the server console. If you are using Chunky in-game you will need to add a leading slash / before each command.
  • Large worlds can use significant disk space. Keep this in mind when pre-generating your world. We usually suggest starting with a radius of 5000 for smaller servers, and 10000 for larger ones. If you change your mind you can safely increase it later.
  • If you have a map rendering plugin installed, such as Dynmap, BlueMap, or Pl3xMap, you may wish to disable it while pre-generating. Rendering the map afterward typically produces best results. See map rendering for details.

Start your server, and type chunky to make sure it installed successfully. If you don't see a help menu pop up, double check that you have followed the installation instructions correctly and try restarting the server.

Pre-generating

Before you start pre-generating, you'll need to select a region that you want to pre-generate. The world, shape, center, and radius are all considered part of your selection. By default, this will be a square region in your main world, centered at 0, 0 with a radius of 500 blocks (or 1000x1000 in size).

Here's a simple example where we just want to pre-generate a square region in your main world centered at 0, 0 with a radius of 5000 blocks:

chunky radius 5000
chunky start

If you also want to generate the same area in the nether, you could do so by simply starting another task in the nether:

chunky start world_nether

Yeah, it's actually just that easy. For selecting other types of regions, refer to the full list of selection commands.

Checking progress

When you run chunky start you will start receiving update messages in console that report pre-generation progress. This includes information such as the number of chunks processed, percent to completion, ETA (estimated time remaining in hours:minutes:seconds), the generation rate in chunks per second (cps), and the location of the current chunk being generated.

Not seeing update messages? These are usually shown in the server console. If you are using a client to pre-generate, you may need to enable the "output log" in your launcher, or use the chunky progress command (if available).

Pre-generation of large selections can often take many hours. Glance at the ETA, and ensure that the estimated time it takes to generate the world is reasonable. Consider restarting the task with a smaller radius if it isn't.

You can pause tasks at any time using the chunky pause command. When you're ready to resume, type chunky continue.