Initial Configuration

Understanding config.yml:

• Detailed explanation of each section in the configuration file.

• Example configurations for:

  • Database setup (mysql).

  • Tip Jar customization (jarItemName, jarItemLore, jarSkinUrl).

  • Custom messages (localization).

Available Placeholders:

• List of placeholders (e.g., %amount%, %player%, %balance%) and how to use them.

# Specify your database credentials here.
mysql:
  host: localhost
  port: 3306
  user: root
  password: root
  database: tipme

jarItemName: "&6Tip Jar"
jarItemLore:
  - "&7Place to collect donations"
  - "&7from generous players."
  - ""
  - "&eHow to Use:"
  - "&71. &fFind a visible and accessible location"
  - "&72. &6Right-Click &fto place the Tip Jar"
  - "&73. &fPlayers can donate by interacting"
  - "&7   &fwith the placed Tip Jar"
  - ""
  - "&eAdministration:"
  - "&7- &6Right-Click &fthe placed Tip Jar"
  - "&7  &ato manage it &c(Owner only)"
  - ""
jarSkinUrl: "http://textures.minecraft.net/texture/7b32617ae031163baf549b6e113f6c401470faac4bdbe9beb75c19d9aad83f8e"

# The time in ticks that players will have to specify a donation amount through chat.
amountInputTimeout: 200

# The default value in the donation GUI.
defaultDonationAmount: 100

# By how much players are able to (in/de)crease the donation amount in the GUI with buttons.
increaseButtons:
  small: 10
  medium: 100
  large: 1000

localization:
  # Message when the player doesn't have enough money
  notEnoughMoneyMessage: "&cYou don't have enough money to perform this action!"

  # Message when a donation is successfully sent
  sentDonationMessage: "&aYou have successfully donated &e%amount% &ato &6%jar_owner%"

  # Message when a donation is received
  receivedDonationMessage: "&eYou have received a new donation of &a%amount%"

  # Message when donations are collected
  collectedDonationsMessage: "&aYou have successfully collected &e%amount% &afrom this jar!"

  # Message when there's nothing to collect
  nothingToCollectMessage: "&cThere is nothing to collect from this jar yet."

  # Message when the jar is disabled
  jarDisabledMessage: "&cThis jar is currently disabled. Please contact &6%jar_owner% &cto enable it."

  # Item name when the jar is enabled
  jarEnabledItemName: "&aClick to disable your tipjar."

  # Item name when the jar is disabled
  jarDisabledItemName: "&cClick to enable your tipjar."

  # Title for the donation inventory
  donationInventoryTitle: "&6Donations for &e%jar_owner%"

  # Title for the jar management inventory
  jarManagementInventoryTitle: "&6Your Tipjar"

  # Display name for the donation jar
  jarDisplayName: "&6⛁ &eDonate Me! &6⛁"

  # Item name for inputting the donation amount
  inputDonationAmountItemName: "&7Click to Input Donation Amount"

  # Title for inputting the donation amount
  inputDonationTitle: "&eEnter the Donation Amount"

  # Subtitle for inputting the donation amount
  inputDonationSubtitle: "&fType a number in chat within &c10 seconds"

  # Message when an invalid donation amount is entered
  invalidDonationInputMessage: "&cThe value &f%input% &cis invalid. Please enter a positive number."

  # Item name displaying the donation amount
  donationAmountItemName: "&7Donation Amount: &e%amount%"

  # Item name for submitting the donation
  submitDonationItemName: "&aDonate &e%amount% &ato &6%jar_owner%"

  # Item name displaying the jar balance
  jarBalanceItemName: "&6Current Jar Balance: &e%balance%"

  # Generic error message (e.g., database failure)
  genericErrorMessage: "&cAn error occurred. Please contact staff for assistance."

  # Lore for the jar balance item
  jarBalanceItemLore:
    - "&bClick here to collect your donations!"