WorldGeneratorApi

Wiki and plugin tutorials - Bug reports

Designing your own world generator for Bukkit is hard. Bukkit doesn't let you hook into the Minecraft terrain generator, so if you just want to change the shape of the terrain, you would need to rewrite almost the entirety of the Minecraft terrain generator. Alternatively, you can hook into Minecraft internals, but this is tricky and tends to break on every Minecraft update.

WorldGeneratorApi provides a clean API to design your own world generator, while still using components of Minecraft if you want. In just a few lines of code, we can create a complete plugin that generates flat worlds:

public class YourPlugin extends JavaPlugin {
   public ChunkGenerator getDefaultWorldGenerator(String worldName, String id) {
       return WorldGeneratorApi.getInstance(this, 0, 6).createCustomGenerator(WorldRef.ofName(worldName), generator -> {
           // Code modifying the world generator goes here
           generator.setBaseTerrainGenerator(new BaseTerrainGenerator() {
 
               @Override
               public int getHeight(BiomeGenerator biomeGenerator, int x, int z, HeightType type) {
                   // Used by for example village generation to probe if the terrain is not too hilly
                   // If calculating the terrain height would be too complex, you can also extend a
                   // "BaseNoiseGenerator" instead of a "BaseChunkGenerator" - that class automatically
                   // calculates the terrain height based on the noise function you give it
                   return 70;
               }

               @Override
               public void setBlocksInChunk(GeneratingChunk chunk) {
                   chunk.getBlocksForChunk().setRegion(0, 0, 0, CHUNK_SIZE, 70, CHUNK_SIZE, Material.STONE);
               }
           });
       });
   }
}

As you can see, only the shape of the terrain is modified, the rest of the world generator is untouched. Want to disable flowers and grass? Add generator.getWorldDecorator().withoutDefaultDecorations(DecorationType.VEGETAL_DECORATION);. Don't like caves and ravines? Add generator.getWorldDecorator().withoutDefaultDecorations(DecorationType.CARVING_AIR);.

Features

• Control the base shape of the terrain.
• Control the locations of biomes.
• Disable vanilla resources (caves, flowers, villages, etc.)
• Add custom resources
• Supports the async chunk generator of Spigot and Paper

See the wiki for how to get started writing your plugin.

Limitations

• There is no way to add custom biomes yet.
• There is no way to spawn entities yet.

For server admins
You'll only need this plugin if another plugin asks you to download it. To modify the terrain, you will need to download one of the plugins listed below at "Plugins using WorldGeneratorApi".

There's a command /worldgeneratorapi reload that you may find useful: it reloads the world generators of all worlds, applying any updated settings. This might save you quite a few server restarts. The permission node for the command is worldgeneratorapi.command. OPs have this permission node by default.

Plugins using WorldGeneratorApi

Dough World Generator
This is a little plugin designed to show the power of WorldGeneratorApi. It allows you to customize the shape of your terrain. It can import the settings from the old Customized world type.

More information - Install

Pancake World Generator
This is a tiny plugin that flattens your terrain, while leaving all other elements of world generation intact. So you will still have biomes, caves, structures, ores, trees, grass, etc.

More information - Install

Bento's Boxed
Start in a tiny box, which expands as you gain achievements. Uses WorldGeneratorApi for custom terrain height and biome placement.

More information

Made a plugin? Please tell me, I will add it here!