Skip to content

Configs

ipiepiepie edited this page Aug 28, 2023 · 2 revisions

BiomeLimits has several configs, to customize plugin for your needs.

Here you can find all default configuration files with comments and template nodes.


blocks.yml

#################################################################################################
# +-------------------------------------------------------------------------------------------+ #
# |                               Config of Biome limited Blocks                              | #
# +-------------------------------------------------------------------------------------------+ #
#                                                                                               #
# In this config you can manage limited blocks, add or remove them.                             #
#                                                                                               #
# Each block has its unique ID, represented by Material. (block item)                           #
# Full list of available materials you can see on link below.                                   #
# - https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html                           #
#                                                                                               #
# [!] NOTE! Be sure to use BLOCK Material, instead of ITEM material. (especially with crops)    #
# For example, in Bukkit API there is two CARROT materials: 'CARROT' and 'CARROTS'              #
# 'CARROT' Material represents Carrot item, and 'CARROTS' is Carrot Block.                      #
#                                                                                               #
# [!] Some of the block limitation parameters can be removed, and it won't broke plugin.        #
# These fields marked as 'removable' in example block limitation node below.                    #
#                                                                                               #
#################################################################################################
  
#################################################################################################
#                                                                                               #
# You can use my simplified biomes instead of default minecraft biomes.                         #
#                                                                                               #
# Simplified biomes include various biomes combined on the same basis.                          #
# For example, simplified biome S_TAIGA combines biomes TAIGA, TAIGA_HILLS and TAIGA_MOUNTAINS. #
#                                                                                               #
# List of simplified biomes, that you can use:                                                  #
# · S_FOREST (FOREST, WOODED_HILLS, FLOWER_FOREST)                                              #
# · S_BIRCH_FOREST (all birch and tall birch biomes)                                            #
# · S_DARK_FOREST (all dark forest biomes)                                                      #
# · S_JUNGLE (all jungle biomes except bamboo biomes)                                           #
# · S_SWAMP (all swamp biomes)                                                                  #
# · S_PLAINS (PLAINS and SUNFLOWER_PLAINS biomes)                                               #
# · S_DESERT (all desert biomes)                                                                #
# · S_BADLANDS (all badlands biomes)                                                            #
# · S_TUNDRA (all tundra and snowy taiga biomes)                                                #
# · S_TAIGA (all taiga biomes)                                                                  #
# · S_SAVANNA (all savanna biomes)                                                              #
# · S_MOUNTAINS (all mountains biomes)                                                          #
# · S_OCEAN (all ocean biomes)                                                                  #
#                                                                                               #
#################################################################################################
  
  
# example of biome limited carrot, with explanation in comments. This template can be removed/edited.
carrots:
  # whitelisted biomes  (removable)
  # [?] default implementation means, that carrot can be placed/destroyed only in plains biomes and flower forest
  whitelist:
  - S_PLAINS
  - FLOWER_FOREST
  # blacklisted biomes  (removable)
  # [?] default implementation means, that carrot can't be placed/destroyed in all taiga, mountains and ocean biomes
  # [!] note, that blacklist won't work, since we are already using whitelist in current implementation!
  blacklist:
  - S_TAIGA
  - S_MOUNTAINS
  
  # determines if block can be destroyed in limited biomes  (removable)
  # [?] default implementation means, that carrot can be destroyed (harvested) in blacklisted/non-whitelisted biomes
  destroy: true
  # determines if block can be placed in limited biomes  (removable)
  # [?] default implementation means, that carrot can't be placed (planted) in blacklisted/non-whitelisted biomes
  place: false

settings.yml

#############################################################
# +-------------------------------------------------------+ #
# |                    Settings config                    | #
# +-------------------------------------------------------+ #
#                                                           #
# Here you can find global plugin settings.                 #
#                                                           #
#############################################################
  
  
# limited block info menu settings
limited-block-info:
  # how much Biomes would be displayed on one line in Limited Block Info menu
  # (Default: 4)
  biomes-per-line: 4
  
# toggles debug mode
# (Default: false)
debug: false

messages.yml

#############################################################
# +-------------------------------------------------------+ #
# |                    Messages config                    | #
# +-------------------------------------------------------+ #
#                                                           #
# Here you can find all BiomeLimits messages.               #
#                                                           #
# You can also define unique destroy/place messages for     #
# some limited blocks in 'blocks' section.                  #
#                                                           #
# [!] Some of the messages support built-in placeholders.   #
# If exists, these comments are noted in comments.          #
#                                                           #
# This plugin supports MineDown                             #
# Read more: https://github.com/Phoenix616/MineDown#syntax  #
#                                                           #
#############################################################
  
  
messages:
  prefix: '&8[&9BiomeLimits&8] &r'
  
  # Limited Block info message
  # [Placeholders]
  # · %block% - block Material name
  # · %whitelisted_biomes_count% - count of whitelisted biomes
  # · %whitelisted_biomes% - list of whitelisted biomes
  # · %blacklisted_biomes_count% - count of blacklisted biomes
  # · %blacklisted_biomes% - list of blacklisted biomes
  # · %destroyable% - can block be destroyed in limited biomes
  # · %placeable% - can block be placed in limited biomes
  msg_info:
  - '&8==========  &6%block%  &8=========='
  - '&7Whitelisted Biomes: &6[%whitelisted_biomes_count% Biomes](color=gold hover=&2%whitelisted_biomes%)'
  - '&7Blacklisted Biomes: &6[%blacklisted_biomes_count% Biomes](color=gold hover=&4%blacklisted_biomes%)'
  - ''
  - '[&7Destroyable: &6%destroyable%](hover=&7Can block be destroyed in limited biomes)'
  - '[&7Placeable: &6%placeable%](hover=&7Can block be placed in limited biomes)'
  
  
  # Destroy error for limited block.
  # [!] Can be overridden by unique destroy message in 'blocks' section below.
  # [Placeholders]
  # · %block% - limited block
  # · %biome% - current player's biome
  msg_limited_destroy: '&cYou can''t destroy &4%block%&c in &4%biome%&c biome!'
  
  # Place error for limited block.
  # [!] Can be overridden by unique place message in 'blocks' section below.
  # [Placeholders]
  # · %block% - limited block
  # · %biome% - current player's biome
  msg_limited_place: '&cYou can''t place &4%block%&c in &4%biome%&c biome!'
  
  
  # Plugin reload message.
  msg_reload: '&aPlugin reloaded!'
  
  
# In this section you can define unique destroy/place cancel messages
# for each limited block.
# If you don't want to have unique messages, you can delete whole 'blocks' section.
# [!] Block name in this section must be the same, as in blocks.yml (case sensitive)
blocks:
  # unique destroy and place messages for carrot. This template can be removed/edited.
  carrots:
    # destroy cancelled message for carrot
    # [Placeholders]
    # · %biome% - current player's biome
    msg_limited_destroy: '&cYou can''t harvest &4Carrot&c in &4%biome%&c biome!'
    # place cancelled message for carrot
    # [Placeholders]
    # · %biome% - current player's biome
    msg_limited_place: '&cYou can''t plant &4Carrot&c in &4%biome%&c biome!'
Clone this wiki locally