-
Notifications
You must be signed in to change notification settings - Fork 97
FAQ
Chunky is designed to run as fast as possible automatically. It can only run as fast as the server that it's running on, so if you want it to go faster you'll need a faster server. Here's a few things you can do to get the most performance out of your chunk generation:
- Use a fast CPU. This is the most common bottleneck. CPUs with excellent single threaded performance are best, for example the Intel Core i9-10900K or AMD Ryzen 9 5950X. Number of threads is also important, as the server can utilize up to about 4 threads per world being generated simultaneously.
- Check that the world is stored on an SSD. Random read/write speeds are much better on SSDs, which improves throughput.
- Give the server enough memory. At least 2GB, but 4GB+ is recommended. The server may stall or crash if you don't have enough.
- Use Paper which supports asynchronous chunk generation and has a custom lighting engine which is known to have a large impact on world generation performance.
- Use Aikar's flags for your server start script. This helps tune the Java garbage collector, which is responsible for freeing up memory.
- If running a Paper server, consider adjusting the number of worker threads used by world generation. This can be done by adding the
-DPaper.WorkerThreadCount=Xflag to your start script. Do not set X higher than the number of threads available to your server. When you are done pre-generating it is suggested to remove this flag and use the default value for normal gameplay. - If running a Fabric server, try using Lithium and Starlight as these mods are known to greatly help server performance.
As an approximation, it takes about 10GB for a 10k radius square world, 40GB for a 20k radius square world, and so on. In other words, be careful about how large you decide to generate, as the area (and thus the time / disk space required) grows quadratically with the radius.
Yes, it's completely safe. Missing chunks are filled in, and existing chunks will be ignored / skipped.
Almost all custom generators should work, due to the fact that Chunky does very little outside of simply loading and generating chunks. If there is a problem, it's likely an issue with the custom generator. Also note that many custom generators are slower than Vanilla and can take much longer to pre-generate.
Maps rendered by another plugin such as Dynmap, Bluemap, or Pl3xMap will usually not automatically update themselves after you run chunky pre-generation or trim. See map rendering and trimming chunks for help fixing this.
These are mostly harmless errors that can occur during chunk generation, which you can ignore. However, some of them may also be fixed by updating your server.
Only known to occur on very outdated builds of Paper 1.15. If you see this, you must update your server.
This error has been known to occur on Purpur servers. If you are using Tuinity or Purpur, be sure to update to the latest version, and if you are still getting the error, then report it to their respective issue trackers.
There are two main reasons why you could be getting this error. One is if you are not allocating enough memory to the server, in which case you just need to increase the amount. The other is if java memory garbage collection is not able to keep up with the rate that chunks are generating. You can usually tell if this is happening by looking at your server's timings report. If this is the case, you should try to use Aikar's flags (mentioned above) if you aren't already.
Some hosts will automatically kill servers that are utilizing too much CPU. This is a problem with the host, as high CPU usage during chunk generation is normal. The only solution to this problem is politely asking your host to remove the limitation, or switch to a better host.
This warning will show up if the generation task is not able to shut down and save quickly enough when the server is abruptly stopped. It is more likely to occur on low end systems, and the only solution is to pause your tasks with chunky pause and wait for them to stop fully before shutting down your server.
