config.yml

The main configuration file for the Shards plugin.

License

License-Key: "YOUR-LICENSE-KEY"

Get your license key from discord.gg/pikzstudios

General Settings

Option	Type	Default	Description
Currency	String	"Shard"	The name of your currency displayed in messages
Command	String	"shard"	Main command name (e.g., /shard, /shards, /points)
pay-enabled	Boolean	true	Allow players to send shards to each other

Currency: "Shard"
Command: "shard"
pay-enabled: true

Feature Toggles

Enable or disable specific plugin features:

Features:
  AFK-Teleport: true    # /afk command and AFK teleportation system
  Shop: true            # In-game shop where players can spend shards
  Leaderboard: true     # Shard leaderboard GUI

Shard Generation (AFK Zones)

Configure passive shard generation in WorldGuard regions:

Option	Type	Description
AFK-Regions	List	WorldGuard region names where players earn shards
Shard-Delay	Integer	Time in seconds between each shard generation

AFK-Regions:
  - afk_zone
  - spawn_afk

Shard-Delay: 15

Generation Bonus Nodes

Grant bonus shards per generation based on permissions:

Gen-Nodes:
  extra_two: 2      # Permission: shard.gennodes.extra_two
  extra_three: 3    # Permission: shard.gennodes.extra_three
  vip: 5            # Permission: shard.gennodes.vip

Players with shard.gennodes.extra_two will receive +2 bonus shards per generation cycle.

Kill Rewards

Configure shards earned from PvP kills:

Option	Type	Default	Description
Shard-Kill	Integer	15	Base shards awarded for killing a player
Kill-Nodes.prevent_abuse	Boolean	true	Prevent farming by blocking rewards for killing the same player twice in a row

Shard-Kill: 15

Kill-Nodes:
  prevent_abuse: true
  extra_ten: 10       # Permission: shard.killnodes.extra_ten
  extra_twenty: 20    # Permission: shard.killnodes.extra_twenty

AFK Teleport System

Configure the /afk teleportation command:

AFK-Teleport:
  enable-commands: true      # Enable the /afk command
  command-name: "afk"        # Custom command name
  countdown-time: 5          # Seconds before teleporting
  use-action-bar: true       # Show countdown in action bar
  use-chat: true             # Show countdown in chat

Leaderboard Settings

Leaderboard:
  Refresh-Rate: 1200    # Refresh interval in seconds (20 minutes)

Note: Minimum recommended refresh rate is 300 seconds (5 minutes) to avoid performance issues.

Time Formatting

Customize how time is displayed in messages:

time-format:
  labels:
    day: "d"
    hour: "h"
    minute: "m"
    second: "s"

  formats:
    '1': "%d%%day% %h%%hour% %m%%minute% %s%%second%"   # Days remaining
    '2': "%h%%hour% %m%%minute% %s%%second%"            # Hours remaining
    '3': "%m%%minute% %s%%second%"                      # Minutes remaining
    '4': "%s%%second%"                                  # Seconds only

Database Configuration

Shards supports both SQLite and MySQL:

SQLite (Default):

Database:
  Type: SQLite

MySQL:

Database:
  Type: MySQL
  MySQL:
    host: "localhost"
    port: 3306
    database: "shards"
    user: "root"
    password: "your_password"
    max-pool: 15
    use-ssl: false
    url: ""    # Leave empty to use host/port/database