Config Files

Main Config

config.yml

In-depth Explenation

This may be added in the future but 'till then follow the comments in the config.yml or ask your question here.

Unedited Version

If you want to reset your config/ see what you have changed or for any other reason, here's the unedited config.yml

####################################################################################################
# +---------------------------------------------------------------------------------------------+ #
#|                                                                                               |#
#|                                                +-------------________________.                |#
#|                 ,--''--.                      | <---\    '----'    <---\|  >|                 |#
#|                '   ||   ' ,--.--' ,----.     |  | ° |  /  ^  |    |   '  | |                  |#
#|               |    ||    ||  |--´|   |  |   |  | .  < /   _   |  |  .    ||                   |#
#|                '   ||   ' |  |   |---|-.'  | <_____|<____^____> <-\|---  |                    |#
#|                 `--''--'  `--'    `----'   +-------------________________+                    |#
#|                                    --<By Hekates>--                                           |#
#|                                                                                               |#
#|     WIKI: https://github.com/Hekates/OreBan/wiki                                              |#
#|     BUG REPORTS: https://github.com/Hekates/OreBan/issues                                     |#
#|                                                                                               |#
#|                                                                                               |#
#|     Config rules:                                                                             |#
#|     - DO NOT USE TABS. You MUST use double spaces to avoid errors.                            |#
#|     - Lines starting with # are comments, so they are ignored.                                |#
#|     - Only add custom blocks/ items at the specified place.                                   |#
#|     - Feel free to remove/ comment out listed ores.                                           |#
#|                                                                                               |#
#|     Using a code editor like Notepad++ is recommended but not required.                       |#
#|                                                                                               |#
# +---------------------------------------------------------------------------------------------+ #
####################################################################################################

#-Language-#
#This is the plugin's language.
#Feel free to switch between the provided languages (en: English and de: German/ Deutsch)
language: "en"

#-Banned Ores-#
#Ores which naturally spawn in the overworld and have a deepslate variant.
#Feel free to remove any of the listed ores, but:
#!!ONLY ADD ORES WHICH HAVE A DEEPSLATE VARIANT!! (If they don't have a deepslate variant, add them under the "additional-blocks" section.)
overworld-ores:
  - "COAL_ORE"
  - "IRON_ORE"
  - "COPPER_ORE"
  - "GOLD_ORE"
  - "REDSTONE_ORE"
  - "EMERALD_ORE"
  - "LAPIS_ORE"
  - "DIAMOND_ORE"

translate-to-deepslate: true #Includes the deepslate variants of the above specified overworld ores.

#Ores that naturally spawn in the nether/ ores which don't have a deepslate variant.
nether-ores:
  - "NETHER_GOLD_ORE"
  - "NETHER_QUARTZ_ORE"
  - "ANCIENT_DEBRIS"

#-Banned Items-#
raw-variants: #If the resource has a raw variant, it's listed here.
  - "RAW_IRON"
  - "RAW_COPPER"
  - "RAW_GOD"

include-raw-variants: true #True = The above specified raw-resources count as bannable items.
include-raw-blocks: true #Includes the block variants of the raw resources specified above. You won't be able to break these blocks aswell. ||Works regardless of inclusion of raw variants||

processed-variants: #The mined/ smelted item variants of the nether- and normal ores specified on lines 34-44.
  - "COAL"
  - "DIAMOND"
  - "EMERALD"
  - "LAPIS_LAZULI"
  - "QUARTZ"
  - "IRON_INGOT"
  - "COPPER_INGOT"
  - "GOLD_INGOT"
  - "NETHERITE_SCRAP"
  - "NETHERITE_INGOT"

allow-item-pickup: false #False = player won't be able to pick up items/ ores specified above.
allow-inventory-transfer: true #False = The banned player won't be able to move the items/ ores specified above to a chest/ to his own inventory. ||Could be a better performance alternative to the possession allowance||

allow-ore-possession: true #True = Banned players are allowed to possess items/ ores specified above.
ore-possession-check-interval: 6000 #Minecraft-tick interval in which the ore possession is checked. ||20 ticks = 1 second (6000 ticks = 5 minutes)||

#-Additional Items-#
#Feel free to add or remove listed items/ blocks
additional-blocks:
  - "COAL_BLOCK"
  - "IRON_BLOCK"
  - "COPPER_BLOCK"
  - "GOLD_BLOCK"
  - "DIAMOND_BLOCK"
  - "NETHERITE_BLOCK"

additional-items:
  - "CHARCOAL"

#For a more detailed explanation and an unedited version of the config.yml file check out the wiki page (https://github.com/Hekates/OreBan/wiki/Config-Files#configyml)

Language Folder

The language folder (\plugins\OreBan\lang) contains the language-file(s). The language-file which is specified in the config gets loaded in, whenever the plugin gets (re-)loaded and there isn't a file loaded corresponding to the specified language. Without changing the language, the file en.json should be located in the mentioned directory. If the language is set to German in the config.yml after loading the plugin for the first time, there should be an en.json and a de.json located in the \lang directory.

Custom Languages

To add a custom language to the plugin, simply duplicate an existing language file and rename it. Next, you can open the new language file in a text editor like notepad++ or the built-in and change the texts to your liking. Don't forget to save the file! Next, you need to change the language in the config.yml to the new filename without the ending. Finally, reload the plugin and all the messages should be replaced.

en.json

This is the English language file. It gets loaded by default.

Unedited version

{
  "console.ore.confirm" : "Set banned ores!"
}

de.json

This is the German language file. To use it, simply change the language in the config to "de".

Unedited version

{
  "console.ore.confirm" : "Die gebannten Ertze wurden festgelegt!"
}