Default config.yml for BiomeRemap 2.2.1

# BiomeRemap
# This file must contain valid YAML code. A YAML checker may be found at http://www.yamllint.com
#
# Remap biomes to create strange new worlds.
#
# Design: SlimeDog
# Implementation: drives_a_ford
# Testing: SlimeDog
#
# Spigot version support: 1.14.4     Use BiomeRemap-1.0.1
# Spigot version support: 1.15.x     Use BiomeRemap-2.0.3
# Spigot version support: 1.16.x     Use BiomeRemap-2.1.x
#
# ========== CAVEATS AND WARNINGS ==================================================================
# BiomeRemap is provided for your enjoyment and entertainment. We cannot guarantee that the results
# will meet your needs or desires.
#
# The most important caveat: BIOME REMAPPING CANNOT BE REVERSED. Always backup the server before
# using this plugin, and test the functionality before you use it on a production server.
#
# BiomeRemap augments terrain generation by remapping biomes in the configured worlds as chunks are
# generated. Remapping previously generated chunks carries negative performance impacts and other
# potential risks. (For example, the underlying chunk populator may change, which could result in
# mismatched chunk or biome borders.) Consequently, BiomeRemap will not remap existing chunks
# automatically, even if the configuration is changed. They can be remapped manually, if desired.
# Commands to do so are described in the wiki.
#
# Due to the way Spigot world creation and chunk generation work, BiomeRemap cannot automatically
# remap the chunks initially-generated on world creation. These chunks must be remapped manually.
# Commands to do so are described in the wiki.
#
# Note that all 1.14/1.15/1.16 biomes are included in the configured biomemaps. Biomes that do not
# exist in your Spigot version will generate warnings in the console/log on server start-up; these
# may be safely ignored.
#
# Changes of this magnitude should always be performed first on a test server, in order to verify
# that the configuration and results meet expectations. We strongly recommend making a server backup
# before installing and using any new plugin.

# ========== CONFIGURATION FILE VERSION ============================================================
# Do not edit the version string unless you know what you are dolng.
file: config.yml
version: 3

# ========== CHECK FOR UPDATES =====================================================================
# If you do not want available updates announced in the console log, you may disable it here.
check-for-updates: true

# ========== BSTATS METRICS ========================================================================
# By default, the plugins collects and transmits anonymous statistics to bstats.org.
# Data collection may be disabled here, or generally in the bStats/config.yml.
#
enable-metrics: true

# ========== BIOMEMAP CONFIGURATION ================================================================
# The main configuration is a list of biomemaps, enabled in specific world(s).
# Each biomemap contains a list of assigned worlds, and a list of biomes with replacement-biomes.
#
# biomemaps:
#   NAME:
#     description: TEXT
#     enabled-worlds: LIST
#     full-chunk-remap: true|false (default:false)
#     biomes:
#        BIOME_ENUM:
#         replacement-biome: BIOME_ENUM
#
# biomeremap.NAME
#   * required, unique
#   * identifies a biomemap
#   * multiple biomemaps may be defined, and subsets of worlds assigned to them
#   * snowbound and boilerroom sample biomemaps are included in the default configuration
# biomeremap.NAME.description
#   * optional, for reference only
# biomeremap.NAME.enabled-worlds
#   * required, a list of assigned worlds
#   * a world may be assigned to more than one biomemap, if you understand the consequences
#   * may be the empty set [] if no worlds are assigned
#   * overlapping combinations of worlds and biomes will generate non-fatal warnings in the console/log
# biomeremap.NAME.full-chunk-remap
#   * Prior to MC 1.16.2, "chunk" referred to a 16x16 column, across all Y values; the biome of the
#     entire column was specified by a single BIOME_ENUM value in the base chunk (Y=0).
#   * Starting with MC 1.16.2, "chunk" refers to a 16x16x16 cube; the biome of each cubic chunk may
#     be specified independently. BiomeRemap addresses this change in the following way:
#        * biomeremap.NAME.full-chunk-remap: false (default)
#          Only the base chunk (Y=0) will be remapped. This changes weather (for example, rain vs.
#          snow) in the entire column, but changes the visual characteristics (for example, grass
#          color) in the base chunk only. So the surface terrain characteristics remain unchanged.
#        * biomeremap.NAME.full-chunk-remap: true
#          The entire column will be remapped. This changes weather in the same way, but changes the
#          the visual characteristics of the entire column, so the surface terrain characteristics
#          will reflect the new biome. This will incur a small additional computational cost to loop
#          through the entire column, but it should not be noticeable in practice, and will not affect
#          game play if the chunks are pre-generated (which we recommend in any event).
#   * WARNING: The configuration should be changed only after careful consideration and testing. The
#     consequences of TRUE cannot be reversed, except by regenerating chunks after reverting to FALSE.

# biomes.BIOME_ENUM
#   * required, unique per biomemap
#   * identifies the vanilla biome that will be replaced
#   * an invalid biome ENUM will generate a non-fatal warning in the console/log
#   * valid biome ENUMs may be found at https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Biome.html
#   * biome descriptions may be found at https://minecraft.gamepedia.com/Biome
#   * additional information may be found at https://github.com/SlimeDog/BiomeRemap/wiki/
# biomes.BIOME_ENUM.replacement-biome
#   * optional
#   * if present, defines the replacement biome
#   * if replacement is not defined for any biome, the biome will not be replaced
#   * an invalid biome ENUM will generate a non-fatal warning in the console/log, and revert to the named biome
#
# Other configuration nodes may be added, as usage warrants.

biomemaps:
  # ======== BiomeRemap example: snowbound ===========================================================
  # The climate has turned very cold. The entire world is covered with ice and snow.
  # Map every biome to a colder biome.
  #
  # enabled-worlds must be changed to reflect your target worlds.
  #
  snowbound:
    description: "The world is cold and icy. Snow everywhere."
    enabled-worlds:
      - world_name_goes_here
    full-chunk-remap: false
    biomes:
      BADLANDS:
        replacement-biome: SNOWY_TUNDRA
      BADLANDS_PLATEAU:
        replacement-biome: SNOWY_TUNDRA
      BAMBOO_JUNGLE:
        replacement-biome: SNOWY_TAIGA
      BAMBOO_JUNGLE_HILLS:
        replacement-biome: SNOWY_TAIGA_HILLS
      BEACH:
        replacement-biome: SNOWY_BEACH
      BIRCH_FOREST:
        replacement-biome: SNOWY_TUNDRA
      BIRCH_FOREST_HILLS:
        replacement-biome: SNOWY_TAIGA_HILLS
      COLD_OCEAN:
        replacement-biome: FROZEN_RIVER
      DARK_FOREST:
        replacement-biome: SNOWY_TUNDRA
      DARK_FOREST_HILLS:
        replacement-biome: SNOWY_TAIGA_HILLS
      DEEP_COLD_OCEAN:
        replacement-biome: FROZEN_RIVER
      DEEP_FROZEN_OCEAN:
        replacement-biome: FROZEN_RIVER
      DEEP_LUKEWARM_OCEAN:
        replacement-biome: FROZEN_RIVER
      DEEP_OCEAN:
        replacement-biome: FROZEN_RIVER
      DEEP_WARM_OCEAN:
        replacement-biome: FROZEN_RIVER
      DESERT:
        replacement-biome: SNOWY_TUNDRA
      DESERT_HILLS:
        replacement-biome: SNOWY_TAIGA_HILLS
      DESERT_LAKES:
        replacement-biome: SNOWY_TUNDRA
      ERODED_BADLANDS:
        replacement-biome: SNOWY_TUNDRA
      FLOWER_FOREST:
        replacement-biome: SNOWY_TUNDRA
      FOREST:
        replacement-biome: SNOWY_TUNDRA
      FROZEN_OCEAN:
        replacement-biome: FROZEN_RIVER
      FROZEN_RIVER:
        replacement-biome: FROZEN_RIVER
      GIANT_SPRUCE_TAIGA:
        replacement-biome: SNOWY_TAIGA
      GIANT_SPRUCE_TAIGA_HILLS:
        replacement-biome: SNOWY_TAIGA_HILLS
      GIANT_TREE_TAIGA:
        replacement-biome: SNOWY_TAIGA
      GIANT_TREE_TAIGA_HILLS:
        replacement-biome: SNOWY_TAIGA_HILLS
      GRAVELLY_MOUNTAINS:
        replacement-biome: SNOWY_TAIGA_MOUNTAINS
      ICE_SPIKES:
        replacement-biome: ICE_SPIKES
      JUNGLE:
        replacement-biome: SNOWY_TUNDRA
      JUNGLE_EDGE:
        replacement-biome: SNOWY_TUNDRA
      JUNGLE_HILLS:
        replacement-biome: SNOWY_TAIGA_HILLS
      LUKEWARM_OCEAN:
        replacement-biome: FROZEN_RIVER
      MODIFIED_BADLANDS_PLATEAU:
        replacement-biome: SNOWY_TUNDRA
      MODIFIED_GRAVELLY_MOUNTAINS:
        replacement-biome: SNOWY_TAIGA_MOUNTAINS
      MODIFIED_JUNGLE:
        replacement-biome: SNOWY_TUNDRA
      MODIFIED_JUNGLE_EDGE:
        replacement-biome: SNOWY_TUNDRA
      MODIFIED_WOODED_BADLANDS_PLATEAU:
        replacement-biome: SNOWY_TUNDRA
      MOUNTAIN_EDGE:
        replacement-biome: SNOWY_TUNDRA
      MOUNTAINS:
        replacement-biome: SNOWY_TAIGA_MOUNTAINS
      MUSHROOM_FIELD_SHORE:
        replacement-biome: SNOWY_BEACH
      MUSHROOM_FIELDS:
        replacement-biome: SNOWY_TUNDRA
      OCEAN:
        replacement-biome: FROZEN_RIVER
      PLAINS:
        replacement-biome: SNOWY_TUNDRA
      RIVER:
        replacement-biome: FROZEN_RIVER
      SAVANNA:
        replacement-biome: SNOWY_TUNDRA
      SAVANNA_PLATEAU:
        replacement-biome: SNOWY_TUNDRA
      SHATTERED_SAVANNA:
        replacement-biome: SNOWY_TUNDRA
      SHATTERED_SAVANNA_PLATEAU:
        replacement-biome: SNOWY_TUNDRA
      SNOWY_BEACH:
        replacement-biome: SNOWY_BEACH
      SNOWY_MOUNTAINS:
        replacement-biome: SNOWY_TAIGA_MOUNTAINS
      SNOWY_TAIGA:
        replacement-biome: SNOWY_TAIGA
      SNOWY_TAIGA_HILLS:
        replacement-biome: SNOWY_TAIGA_HILLS
      SNOWY_TAIGA_MOUNTAINS:
        replacement-biome: SNOWY_TAIGA_MOUNTAINS
      SNOWY_TUNDRA:
        replacement-biome: SNOWY_TUNDRA
      STONE_SHORE:
        replacement-biome: SNOWY_BEACH
      SUNFLOWER_PLAINS:
        replacement-biome: SNOWY_TUNDRA
      SWAMP:
        replacement-biome: SNOWY_TUNDRA
      SWAMP_HILLS:
        replacement-biome: SNOWY_TAIGA_HILLS
      TAIGA:
        replacement-biome: SNOWY_TUNDRA
      TAIGA_HILLS:
        replacement-biome: SNOWY_TAIGA_HILLS
      TAIGA_MOUNTAINS:
        replacement-biome: SNOWY_TAIGA_MOUNTAINS
      TALL_BIRCH_FOREST:
        replacement-biome: SNOWY_TUNDRA
      TALL_BIRCH_HILLS:
        replacement-biome: SNOWY_TAIGA_HILLS
      WARM_OCEAN:
        replacement-biome: FROZEN_RIVER
      WOODED_BADLANDS_PLATEAU:
        replacement-biome: SNOWY_TUNDRA
      WOODED_HILLS:
        replacement-biome: SNOWY_TAIGA_HILLS
      WOODED_MOUNTAINS:
        replacement-biome: SNOWY_TAIGA_MOUNTAINS

  # ======== BiomeRemap example: boilerroom ==========================================================
  # Climate change is real. The entire world is warm, warmer, hot, hotter.
  # Map every biome to a warmer biome.
  #
  # enabled-worlds must be changed to reflect your target worlds.
  #
  boilerroom:
    description: "Climate change is real. The entire world is warm, warmer, hot, hotter."
    enabled-worlds: []
    full-chunk-remap: false
    biomes:
      BADLANDS:
        replacement-biome: BADLANDS
      BADLANDS_PLATEAU:
        replacement-biome: BADLANDS_PLATEAU
      BAMBOO_JUNGLE:
        replacement-biome: BAMBOO_JUNGLE
      BAMBOO_JUNGLE_HILLS:
        replacement-biome: BAMBOO_JUNGLE_HILLS
      BEACH:
        replacement-biome: DESERT
      BIRCH_FOREST:
        replacement-biome: BIRCH_FOREST
      BIRCH_FOREST_HILLS:
        replacement-biome: BIRCH_FOREST_HILLS
      COLD_OCEAN:
        replacement-biome: WARM_OCEAN
      DARK_FOREST:
        replacement-biome: DARK_FOREST
      DARK_FOREST_HILLS:
        replacement-biome: DARK_FOREST_HILLS
      DEEP_COLD_OCEAN:
        replacement-biome: DEEP_LUKEWARM_OCEAN
      DEEP_FROZEN_OCEAN:
        replacement-biome: DEEP_LUKEWARM_OCEAN
      DEEP_LUKEWARM_OCEAN:
        replacement-biome: DEEP_LUKEWARM_OCEAN
      DEEP_OCEAN:
        replacement-biome: DEEP_LUKEWARM_OCEAN
      DEEP_WARM_OCEAN:
        replacement-biome: DEEP_WARM_OCEAN
      DESERT:
        replacement-biome: DESERT
      DESERT_HILLS:
        replacement-biome: DESERT_HILLS
      DESERT_LAKES:
        replacement-biome: DESERT_LAKES
      ERODED_BADLANDS:
        replacement-biome: ERODED_BADLANDS
      FLOWER_FOREST:
        replacement-biome: FLOWER_FOREST
      FOREST:
        replacement-biome: FOREST
      FROZEN_OCEAN:
        replacement-biome: WARM_OCEAN
      FROZEN_RIVER:
        replacement-biome: RIVER
      GIANT_SPRUCE_TAIGA:
        replacement-biome: GIANT_SPRUCE_TAIGA
      GIANT_SPRUCE_TAIGA_HILLS:
        replacement-biome: GIANT_SPRUCE_TAIGA_HILLS
      GIANT_TREE_TAIGA:
        replacement-biome: GIANT_TREE_TAIGA
      GIANT_TREE_TAIGA_HILLS:
        replacement-biome: GIANT_TREE_TAIGA_HILLS
      GRAVELLY_MOUNTAINS:
        replacement-biome: GRAVELLY_MOUNTAINS
      ICE_SPIKES:
        replacement-biome: ICE_SPIKES
      JUNGLE:
        replacement-biome: JUNGLE
      JUNGLE_EDGE:
        replacement-biome: JUNGLE_EDGE
      JUNGLE_HILLS:
        replacement-biome: JUNGLE_HILLS
      LUKEWARM_OCEAN:
        replacement-biome: WARM_OCEAN
      MODIFIED_BADLANDS_PLATEAU:
        replacement-biome: MODIFIED_BADLANDS_PLATEAU
      MODIFIED_GRAVELLY_MOUNTAINS:
        replacement-biome: MODIFIED_GRAVELLY_MOUNTAINS
      MODIFIED_JUNGLE:
        replacement-biome: MODIFIED_JUNGLE
      MODIFIED_JUNGLE_EDGE:
        replacement-biome: MODIFIED_JUNGLE_EDGE
      MODIFIED_WOODED_BADLANDS_PLATEAU:
        replacement-biome: MODIFIED_WOODED_BADLANDS_PLATEAU
      MOUNTAIN_EDGE:
        replacement-biome: MOUNTAIN_EDGE
      MOUNTAINS:
        replacement-biome: MOUNTAINS
      MUSHROOM_FIELD_SHORE:
        replacement-biome: DESERT
      MUSHROOM_FIELDS:
        replacement-biome: DESERT
      OCEAN:
        replacement-biome: WARM_OCEAN
      PLAINS:
        replacement-biome: PLAINS
      RIVER:
        replacement-biome: RIVER
      SAVANNA:
        replacement-biome: SAVANNA
      SAVANNA_PLATEAU:
        replacement-biome: SAVANNA_PLATEAU
      SHATTERED_SAVANNA:
        replacement-biome: SHATTERED_SAVANNA
      SHATTERED_SAVANNA_PLATEAU:
        replacement-biome: SHATTERED_SAVANNA_PLATEAU
      SNOWY_BEACH:
        replacement-biome: DESERT
      SNOWY_MOUNTAINS:
        replacement-biome: MOUNTAINS
      SNOWY_TAIGA:
        replacement-biome: TAIGA
      SNOWY_TAIGA_HILLS:
        replacement-biome: TAIGA_HILLS
      SNOWY_TAIGA_MOUNTAINS:
        replacement-biome: TAIGA_MOUNTAINS
      SNOWY_TUNDRA:
        replacement-biome: PLAINS
      STONE_SHORE:
        replacement-biome: DESERT
      SUNFLOWER_PLAINS:
        replacement-biome: SUNFLOWER_PLAINS
      SWAMP:
        replacement-biome: SWAMP
      SWAMP_HILLS:
        replacement-biome: SWAMP_HILLS
      TAIGA:
        replacement-biome: TAIGA
      TAIGA_HILLS:
        replacement-biome: TAIGA_HILLS
      TAIGA_MOUNTAINS:
        replacement-biome: TAIGA_MOUNTAINS
      TALL_BIRCH_FOREST:
        replacement-biome: TALL_BIRCH_FOREST
      TALL_BIRCH_HILLS:
        replacement-biome: TALL_BIRCH_HILLS
      WARM_OCEAN:
        replacement-biome: WARM_OCEAN
      WOODED_BADLANDS_PLATEAU:
        replacement-biome: WOODED_BADLANDS_PLATEAU
      WOODED_HILLS:
        replacement-biome: WOODED_HILLS
      WOODED_MOUNTAINS:
        replacement-biome: WOODED_MOUNTAINS

  # ======== BiomeRemap example: hell ================================================================
  # There will be hell to pay.
  # It is unclear what you might want to do, but MC 1.16 nether biomes are listed here for reference.
  #
  # enabled-worlds must be changed to reflect your target worlds.
  #
  hell:
    description: "There will be hell to pay."
    enabled-worlds: []
    full-chunk-remap: false
    biomes:
      BASALT_DELTAS:
        replacement-biome: BASALT_DELTAS
      CRIMSON_FOREST:
        replacement-biome: CRIMSON_FOREST
      SOUL_SAND_VALLEY:
        replacement-biome: SOUL_SAND_VALLEY
      WARPED_FOREST:
        replacement-biome: WARPED_FOREST
      NETHER_WASTES:
        replacement-biome: NETHER_WASTES

# ========== REPORT REMAP PROGRESS =================================================================
# How often region commands should report progress, as a percentage of completion.
# If 0, progress will not be reported.
report-region-remap-progress: 5
report-region-scan-progress: 10