Configuration
Configuration
Variables
These are all of the variables in this plugin's config.yml file:
| Variable | Description |
|---|---|
| delay | Delay in server ticks before executing first repeat. |
| period | Period in server ticks of the task. |
| chunks | The number of chunk to try to grow a plant in on each repeat. |
| regions | List of all of the defined regions. |
| region::biomes | List of biomes that constitute a region. |
| region::weight | Relative probability of biome to grow a plant. |
| region::plants | The list of plants that will grow in a region. |
| region::probabilities | The relative probability of each plant growing in a region. |
Regions
A region is a collection of biomes that all have the same behaviour when it comes to growing plants. By grouping biomes together into regions, we are able to re-use information in multiple biomes. For instance, you could group the desert, desert hills and desert mountains biomes into a single region which has the same plant growth throughout.
Regions are defined in the configuration file in a numbered list, starting with the index 0. Each region added to the list should be indexed by the next largest integer. If a region is not labelled in this way, it's definition will not be loaded by the plugin.
Biomes
Each region must have a list of biomes that is included in that region. All of the biomes listed will have the region's plants grow in it. This is a list of all of the valid biomes and their keywords:
| Biome | Keyword |
|---|---|
| Beach | "beach" |
| Birch Forest | "birch_forest" |
| Birch Forest Hills | "birch_forest_hills" |
| Birch Forest Hills Mountains | "birch_forest_hills_mountains" |
| Birch Forest Mountains | "birch_forest_mountains" |
| Cold Beach | "cold_beach" |
| Cold Taiga | "cold_taiga" |
| Cold Taiga Hills | "cold_taiga_hills" |
| Cold Taiga Mountains | "cold_taiga_mountains" |
| Deep Ocean | "deep_ocean" |
| Desert | "desert" |
| Desert Hills | "desert_hills" |
| Desert Mountains | "desert_mountains" |
| Extreme Hills | "extreme_hills" |
| Extreme Hills Mountains | "extreme_hills_mountains" |
| Extreme Hills Plus | "extreme_hills_plus" |
| Extreme Hills Plus Mountains | "extreme_hills_plus_mountains" |
| Flower Forest | "flower_forest" |
| Forest | "forest" |
| Forest Hills | "forest_hills" |
| Frozen Ocean | "frozen_ocean" |
| Frozen River | "frozen_river" |
| Hell | "hell" |
| Ice Mountains | "ice_mountains" |
| Ice Plains | "ice_plains" |
| Ice Plains Spikes | "ice_plains_spikes" |
| Jungle | "jungle" |
| Jungle Edge | "jungle_edge" |
| Jungle Edge Mountains | "jungle_edge_mountains" |
| Jungle Hills | "jungle_hills" |
| Jungle Mountains | "jungle_mountains" |
| Mega Spruce Taiga | "mega_spruce_taiga" |
| Mega Spruce Taiga Hills | "mega_spruce_taiga_hills" |
| Mega Taiga | "mega_taiga" |
| Mega Taiga Hills | "mega_taiga_hills" |
| Mesa | "mesa" |
| Mesa Bryce | "mesa_bryce" |
| Mesa Plateau | "mesa_plateau" |
| Mesa Plateau Forest | "mesa_plateau_forest" |
| Mesa Plateau Forest Mountains | "mesa_plateau_forest_mountains" |
| Mesa Plateau Mountains | "mesa_plateau_mountains" |
| Mushroom Island | "mushroom_island" |
| Mushroom Shore | "mushroom_shore" |
| Ocean | "ocean" |
| Plains | "plains" |
| River | "river" |
| Roofed Forest | "roofed_forest" |
| Roofed Forest Mountains | "roofed_forest_mountains" |
| Savanna | "savanna" |
| Savanna Mountains | "savanna_mountains" |
| Savanna Plateau | "savanna_plateau" |
| Savanna Plateau Mountains | "savanna_plateau_mountains" |
| Sky | "sky" |
| Small Mountains | "small_mountains" |
| Stone Beach | "stone_beach" |
| Sunflower Plains | "sunflower_plains" |
| Swampland | "swampland" |
| Swampland Mountains | "swampland_mountains" |
| Taiga | "taiga" |
| Taiga Hills | "taiga_hills" |
| Taiga Mountains | "taiga_mountains" |
Plants
Each region needs to have a list of plants that grow in the region defined. The list should be in square brackets, use the correct keywords for each plant and be comma separated. A list of all the currently implemented plants and their keywords can be found here:
| Plant | Keyword | Growing Conditions | |
|---|---|---|---|
![]() | Tall grass | "grass" | On top of a grass block |
| Fern | "fern" | On top of a grass block | |
| Dead bush | "dead_bush" | On top of a sand block | |
![]() | Cactus | "cactus" | Oh top of a sand block with air around it |
| Sugar cane | "sugar_cane" | On top of sand or dirt block with a water source next to it | |
| Dandelion | "dandelion" | On top of a grass block | |
![]() | Poppy | "poppy" | On top of a grass block |
![]() | Blue Orchid | "blue_orchid" | On top of a grass block |
![]() | Allium | "allium" | On top of a grass block |
![]() | Azure Bluet | "azure_bluet" | On top of a grass block |
![]() | Red Tulip | "red_tulip" | On top of a grass block |
![]() | Orange Tulip | "orange_tulip" | On top of a grass block |
![]() | White Tulip | "white_tulip" | On top of a grass block |
![]() | Pink Tulip | "pink_tulip" | On top of a grass block |
![]() | Oxeye Daisy | "oxeye_daisy" | On top of a grass block |
There are some plant keywords that have a more complicated behaviour:
- "tulip": will grow either a red, orange, white or pink tulip with equal probability
Probabilities
Each region needs to have a list of probabilities that is equal in length to it's list of plants. The probability at each index corresponds to the plant at the same index for the region. The sum of all the probabilities must equal one, or the plugin will throw an exception and fail to load.
Example
This is an example of a valid configuration file:
delay: 1 period: 1 chunks: 1 regions: 0: biomes: [plains] weight: 1.0 plants: [grass, fern] probabilities: [0.75, 0.25] 1: biomes: [desert] weight: 0.5 plants: [dead_bush, cactus] probabilities: [0.5, 0.5]
With this configuration file, the plugin has the following behaviour:
- The plugin will activate after begin loaded for 1 server tick.
- The plugin will activate after every 1 server tick thereafter.
- The plugin will attempt to grow a plant in 1 chunk every server tick. It may not always succeed.
- The plugin will only grow plants in plains and desert biomes.
- Plants will grow twice as fast in the plains biome than the deset biome.
- In the plains biome, 75% of the time tall grass will grow and 25% of the time a fern will grow.
- In the desert biome, 50% of the time a dead bush will grow and 50% of the time a cactus will grow.











Comments