Skip to content
PersonTheCat edited this page May 19, 2021 · 22 revisions

Welcome to the CaveGenerator wiki!

This is the primary source of information about the mod and how you can get started using it.

Cave Generator is a powerful and customizable replacement for Mojang's now-obsolete cave generation algorithm, prior to 1.13. It is and has been in beta status for a very long time. Realistically speaking, it will never hit release status. What this implies for the end user is that things may change and you should probably be aware of that before getting started.

Important Notice:

Cave Generator 1.0 just came out. This wiki is currently out of date. It is missing a bunch of new features, commands, and uses quite a few incorrect keys. Following this guide is still okay for the time being, as your old presets will be automatically transformed. I'll work on updating this guide as soon as I can. If you'd like to help, send me a message on GitHub or on Discord. Thanks!

What can it do?

Short answer: a lot.

Underground Forest--Included Preset

Check out this gallery for screenshots showing off its different features.

How it works

This mod works by creating any number of preset files which are loaded independently of your world settings. Presets are written in Hjson, which is just like regular JSON with relaxed syntax requirements. There are some additional rules, but ultimately, they are just settings files. There are a lot of settings.

Don't want to create presets? That's no problem. Cave Generator comes bundled with 15 different presets. All you need to do is copy them into the correct folder and enable whichever ones you want by running an interactive command: /cave list. Be aware that the included presets will all run simultaneously if they are enabled at the same time. This will produce a lot of caves. So many, in fact, that you may not see much underground, but you will take a performance hit. I recommend starting with one at a time.

Community

Discord Banner

Due to lack of availability, this mod generally goes through intermittent development cycles. However, I am always available on Discord. Please join us there if you have feedback or need help following this guide.

A note about future development:

I would love to update this mod to 1.16 (and especially 1.17), but this will take an enormous amount of time (several months - a year). Caves are a lot different since 1.13. Here's what I would need to get that going:

  • Research into how the new tunnel generation algorithm works
  • Information about which fields it uses and which ones could feasibly be customized, and
  • How to register the new generator as a WorldCarver, replacing the old one.

If you can help me answer any of these questions or even setup a skeleton, that would be extraordinarily helpful. Please message me on Discord or create a PR and let me know how you can help. Thanks!

Continue reading

Here are some of the pages you might find useful in this guide:

Clone this wiki locally