Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 8.29 KB

tutorial.md

File metadata and controls

55 lines (40 loc) · 8.29 KB

Tutorial Section

Where to put the plugin?

If your server is currently running, Stop it.
Download the latest plugin release and drop it in the plugin directory. Afterwards start your server back up. The plugin will automatically detect which ChunkGeneration version to use, generate the tiny configuration file and post some infos in your server's console.
To check if the plugin loaded successfully either run the command /plugins ingame or from the console and see if the plugin's name is listed green.

Setup of the bukkit.yml file

Setting up the bukkit.yml file is highly recommended, even tho it is only strictly needed for the default worlds.
Open up the bukkit.yml file from your server directory and go to the end of the file. At the end of the file the following snippet needs to be added for all the worlds we want the plugin to handle generation. Here we add the worlds we want the plugin to generate. Just replace the placeholders worldname_1 and worldname_2 with the actual world names. The list can be extended for however many world you want to use:

worlds:
  worldname_1:
    generator: VoidGen
  worldname_2:
    generator: VoidGen

It is also possible to modify the basic generator with additional parameters. You can use any amount of parameters you want to set in any order. Note that specifying the default value of a parameter is the same as not specifying it at all. Chaining multiple parameters together can be done with commas as can be seen in the examples:

worlds:
  worldname_3:
    generator: VoidGen:{biome:CRIMSON_FOREST}
  worldname_4:
    generator: VoidGen:{decoration:true, structures:true, mobs:true, biome:END_BARRENS}

World management

Coming soon...

Restart

Restart your server for all the changes to take effect. If you configured everything correctly, the generator will work in all newly created chunks.
If you find any bug, have crashed because of the plugin or are still experiencing issues, please report it at my official Discord server.

Parameters

Parameter Definition Values Syntax
biome Sets the biome of all locations in the generated world to the specified value.
Not setting this parameter, using a biome that is not supported by your server's version or using anything besides a biome name will result in the vanilla biome grid for your world seed.
The biome name needs to be UPPERCASE.		 Biomes for the latest version. {biome:DESERT}
All blocks will be set to the desert biome.
caves Controls the creation of vanilla style caves.
This includes ravines and similar world features. Not setting this parameter is the same as setting it to false. Since this plugin does not generate terrain, without the noise parameter no blocks will generate and therefor no caves.		 true / false {caves:true}
mobs Controls whether you want the server to spawn vanilla mobs or not.
Not setting this parameter is the same as setting it to false.		 true / false {mobs:true}
structures Controls vanilla structure generation.
Not setting this parameter is the same as setting it to false. Some structures need the decoration parameter to be set to true as well to generate correctly (e.g. strongholds).
If you set the biome parameter, only structures that are able to naturally generate in the specified biome can generate (e.g. ocean monuments can not generate in an all PLAINS world)		 true / false {structures:true}

{structures:true, decoration:true}
decoration Controls the creation of vanilla chunk decorations.
Not setting this parameter is the same as setting it to false. Mostly used in combination with the structures parameter.		 true / false {decoration:true}

{structures:true, decoration:true}
noise Controls the creation of blocks from noise. Think vanilla stone, basically everything between bedrock and the surface.
Not setting this parameter is the same as setting it to false.		 true / false {noise:true}
surface Controls the creation of surface blocks. Think vanilla gras blocks.
Not setting this parameter is the same as setting it to false. The surface can only generate if blocks are present. The easiest methode of doing so is enabling the noise parameter.		 true / false {noise:true}

{noise:true, noise:true}
bedrock Controls the creation of the vanilla bedrock layer at the bottom of the world.
Not setting this parameter is the same as setting it to false.		 true / false {bedrock:true}