Configuration Files

Introduction

Here is information regarding all the important configuration files for EternalMines

config.yml

Option	Description	Default
locale	Changes the plugin languages to a langugage in the /locale/ folder.	en_US
reset-timer	These are all the options for the reset timer.
enabled	Enables the reset timer.	true
interval	The interval in ticks for when the plugin should check if a mine should be reset	20
listeners	These are all the options for the listeners.
break-block	Enables the reset percentage to checked when a block is broken	true
login	Checks whether a player is inside a mine when they login	true

example.yml

The is the example configuration file for a mine in EternalMines.

Option	Description	Example
mine-settings	All options for the mines should be under here.	mine-settings:
id	The technical id of the mine.	id: example
reset-percentage	The percentage of blocks that need to be broken before the mine resets. (reset-percentage: 20 would reset the mine once 80% of blocks are broken)	reset-percentage: 20
reset-delay	The delay in seconds before the mine resets.	reset-delay: 300
world	The world the mine is in.	world: world
spawn	The spawn location of the mine.	spawn:
spawn.x	The x coordinate of the spawn location.	x: 0
spawn.y	The y coordinate of the spawn location.	y: 0
spawn.z	The z coordinate of the spawn location.	z: 0
regions	The regions of the mine.	regions:
pos1.x	The x coordinate of the first position.	x: 0
pos1.y	The y coordinate of the first position.	y: 0
pos1.z	The z coordinate of the first position.	z: 0
pos2.x	The x coordinate of the second position.	x: 0
pos2.y	The y coordinate of the second position.	y: 0
pos2.z	The z coordinate of the second position.	z: 0
blocks	The blocks that are in the mine.	blocks:
<MATERIAL>:<PERCENTAGE>	The material and percentage of the block.	STONE: 50

Working Example

# Mine Settings
mine-settings:
  id: 'example' # ID of the mine
  reset-percentage: 20 # Reset mine once 20% of blocks left
  reset-delay: 300 # Delay in seconds before mine resets automatically
  world: disabled_world # World to spawn mine in
  spawn: # Teleport player to this location when the mine is reset
    x: 0
    y: 0
    z: 0
    yaw: 0
    pitch: 0
  region: # The place where the mine will spawn
    pos1:
      x: -10
      y: -10
      z: -10
    pos2:
      x: 10
      y: 10
      z: 10
  blocks: # List of blocks to spawn in the mine and their percentages
    STONE: 75.0 # 75% chance to spawn stone
    COBBLESTONE: 25.0 # 25% chance to spawn cobblestone