VotingPluginConfig

# VotingPlugin by Ben12345rocks
# Main Config
# See wiki for help:
# https://github.com/Ben12345rocks/VotingPlugin/wiki

# Valid Options:
# - SQLITE
# - FLAT
# - MYSQL
DataStorage: SQLITE

# Information for mysql
MySQL:
  Host: ''
  # Default port is 3306
  Port: 3306
  Database: ''
  Username: ''
  Password: ''
  # Max number of connections
  MaxConnections: 1
  # Maxium size of caching mysql
  # -1 for no limit
  # Affecting this value may affect performance
  MaxSize: -1
  # Table name prefix, for use with mutliple servers
  Prefix: ''
  #UseSSL: true

# Let players who never joined before vote
# Recommend: False (Will prevent creating random user data files)
AllowUnjoined: false

# If true, plugin will send scoreboards on some commands
SendScoreboards: true

# If true, plugin will automaticly generate votesites
# Disable this if you experience issues with sites being created randomly
AutoCreateVoteSites: true

# Automaticly download the latest version
# Will require a restart to actually update
# Note that updates take 30-40 minutes to load before they can be downloaded
AutoDownload: false

# ------------------------------------------------
# VoteReminding
# ------------------------------------------------

# Configuration for VoteReminding
# By default this should be all setup to work
# as long as vote delays are done properly
VoteReminding:
  # Enable vote reminding
  # This will remind player when he can vote on all sites
  # Requires VoteDelay's to be setup properly
  # Use /vote next to see when you can be reminded
  # Players require the perm "VotingPlugin.Login.RemindVotes" or "VotingPlugin.Player"
  Enabled: true

  # Wether or t to remind only once when the player can vote
  # Does not apply to login reminds.
  RemindOnlyOnce: true

  # Will remind player on login if he can vote
  # Ignores value above
  RemindOnLogin: true

  # Delay to remind votes in minutes
  # Only works if above is false
  RemindDelay: 30

  # Run reward files on remind
  # By default, the reward file will be created for you
  # and have the default message
  # Edit the message at AdvancedCore/Rewards/Remind.yml (or any other reward listed)
  # Can add titles and more in the reward file
  Rewards:
    Messages:
      Player: '&aRemember to vote!'
    Title:
      Enabled: false
      Title: '&cRemember to vote!'
      SubTitle: '&aType /vote'
      FadeIn: 10
      ShowTime: 50
      FadeOut: 10

Commands:
  # Wether or not the following commands will open GUIs rather than display text
  UseGUI:
    Today: true
    TopVoter: true
    Last: true
    Next: true
    Total: true
    Vote: true
    Best: true
    Streak: true

# ------------------------------------------------
# Format
# ------------------------------------------------

# Common PlacesHolders:
# Please Note: Not all are usable in all sections
# Special PlaceHolders will be commented where available
# %player% = player name
# %SiteName% = vote site name
#
# Set Message to '' (2 ') to disable message

Format:
  # CommandHandler help message
  HelpLine: '&3&l%Command% - &3%HelpMessage%'

  # Broadcast vote message
  BroadcastMsg: '&6[&4Broadcast&6] &2Thanks &c%player% &2for voting on %SiteName%'

  # Broadcast only when player is online
  BroadcastWhenOnline: false

  Commands:
    # Format for /vote
    # %num% = the number of the site, for a numbered list
    # %url% = site URL
    Vote:
      Text:
      - '&4&lVote for our server!'

      # If you want to want to use the feature below where the plugin will
      # automaticly list the sites then set the message in the text above
      AutoInputSites: true
      # For each VoteSite
      # make sure to set VoteURL in your VoteSites
      # Requires above to be true
      # Text will be sent before this
      Sites: '&4%num%: &c&l%SiteName% - &c%url%'

      # Format for /vote next
      Next:
        # First line
        Title: '&3&l%player% Next Votes:'

        # How each line is setup for each vote site
        # %info% = Info - See Below
        # %SiteName% = site name from vote
        Layout: '&3%SiteName%: &6%info%'

        Info:
          # Message when player can vote
          CanVote: 'Go Vote!'
          # Time until vote msg
          # %hours% = hours until next vote
          # %minutes% = minutes until next vote
          TimeUntilVote: '%hours% Hours and %minutes% Minutes'
          # If there is an error finding out time until next vote
          Error: '&cCould not caculate time until next vote!'
          # For sites that have this, requires votedelaydaily to be set to true in the site
          VoteDelayDaily: '%hours% Hours and %minutes% Minutes'

       # Format for /vote last
      Last:
        # First line
        Title: '&3&l%player% Last Vote Times:'
        # Lines for each vote site
        # %time% = time, using timeformat below
        Line: '&3%SiteName%: &6%time%'

      # Format for /vote total
      Total:
      - '&3&l%player% Total Votes:'
      - '&3&lDaily Total: &6&l%DailyTotal%'
      - '&3&lWeekly Total: &6&l%WeeklyTotal%'
      - '&3&lMonthly Total: &6&l%MonthlyTotal%'
      - '&3&lAllTime Total: &6&l%AllTimeTotal%'

      # Format for /vote total all
      TotalAll:
      - '&3&lServer Total Votes:'
      - '&3&lDaily Total: &6&l%DailyTotal%'
      - '&3&lWeekly Total: &6&l%WeeklyTotal%'
      - '&3&lMonthly Total: &6&l%MonthlyTotal%'
      - '&3&lAllTime Total: &6&l%AllTimeTotal%'

      # Format for /vote top
      Top:
        # First line
        # %page% = current page
        # %maxpages% = max number of pages
        # %Top% = Monthly/Weekly/Daily (depending on command)
        Title: '&3Top %Top% Voters %page%/%maxpages%'
        # Line for each player in that page
        Line: '&c%num%: &6%player%, %votes%'

      # Format for /vote help
      Help:
        # Title of /vote help
        Title: '&3&lVoting Player Help'
        # Format for help message in /v help
        Line: '&3&l%Command% - &3%HelpMessage%'
        # Require permission to see command in /v help or /av help
        RequirePermission: true

      Best:
        Title: '&3&l%player% Best Votes'
        Lines:
        - '&3Highest Daily Total: &3&l%HighestDailyTotal%'
        - '&3Highest Week Total: &3&l%HighestWeeklyTotal%'
        - '&3Highest Month Total: &3&l%HighestMonthlyTotal%'

      Streak:
        Title: '&3&l%player% Vote Streak'
        Lines:
        - '&3Current Daily Streak: &3&l%DailyStreak%'
        - '&3Current Week Streak: &3&l%WeeklyStreak%'
        - '&3Current Month Streak: &3&l%MonthlyStreak%'
        - '&3&lHighest Streaks:'
        - '&3Highest Daily Streak: &3&l%BestDailyStreak%'
        - '&3Highest Week Streak: &3&l%BestWeeklyStreak%'
        - '&3Highest Month Streak: &3&l%BestMonthlyStreak%'

      # PlaceHolders:
      # %VotesRequired% = VotesRequired
      # %NeededVotes% = Number of votes needed to reach VotesRequired
      # %Votes% = Number of votes
      Party:
      - '&cCurrently at &6%Votes%&c, &6%NeededVotes% &cmore votes to go to reach &6%VotesRequired%'

      # %Points% = player points
      Points: '&a%Player% currently has &a&l%Points%&a Points!'

  # Login message if player can vote on all sites
  # Must be enabled in config.yml
  LoginMsg: '&cRemember to vote!'

  # Msg on top voter award, will only send message if that place has a reward set
  # %place% = place - 1,2,3,etc
  TopVoterAwardMsg: '&aYou came in %place% in top voters of the month! Here is an award!'

  # Time Format
  # See https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html
  TimeFormat: 'EEE, d MMM yyyy HH:mm'

  # Format for signs
  # SiteName may be all, depending on sign
  # %position% = position of player, set by sign
  # %votes% = Number of votes
  Signs:
    TopVoterSign:
      Line1: 'TopVoter: %SiteName%'
      Line2: '#%position%'
      Line3: '%player%'
      Line4: '%votes% Votes'
    # Message when right clicking sign, uses same placeholders as above
    RightClickMessage: '&c&l%player% &cis &c&l%position% &cwith &c&l%votes% &cvotes in &c&l%SiteName%'

  # Message when player tries to run command without required permissions
  NoPerms: '&cYou do not have enough permission!'

  # Message when player types a command but does not input a number where needed
  NotNumber: '&cError on &6%arg%&c, number expected!'

  # Shop messages when using the /vote shop
  ShopPurchase: '&aYou bought the %Identifier% for %Points% Points!'
  ShopFailed: '&cYou do not have %Points% points to purchase this!'

  # User not exist message, from commands such as /vote next (player)
  UserNotExist: '&cUser does not exist: %player%'

  # Text for page buttons in inventories
  PrevPage: '&aPrevious Page'
  NextPage: '&aNext Page'

  # Display text
  # Used in /vote top (GUI)
  TopVoter:
    Daily: 'Daily'
    Weekly: 'Weekly'
    Monthly: 'Monthly'
    AllTime: 'AllTime'

# ------------------------------------------------
# GUI Options
# ------------------------------------------------

# Configure GUI's here
# Note: Slots start at 0 instead of 1, max slot is 53 (don't go over) (E.g: last slot in first row of inventory is 8)
# Item Material's can be found here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
GUI:
  # GUI for /vote gui, /vgui, votegui
  VoteGUI:
    # Items will be orders as it is below
    URL:
      # Standard item format, lore is automaticly applied
      Item:
        Material: 'BOW'
        Data: 0
        Amount: 1
        Name: '&4URL'
        # You can set skulls of the player using the following
        # Remove the # to enable
        #Skull: '%Player%'
      Slot: 0
    Next:
      Item:
        Material: 'COMPASS'
        Data: 0
        Amount: 1
        Name: '&4Next'
      Slot: 1
    Last:
      Item:
        Material: 'WATCH'
        Data: 0
        Amount: 1
        Name: '&4Last'
      Slot: 2
    Total:
      Item:
        Material: 'CHEST'
        Data: 0
        Amount: 1
        Name: '&4Total'
      Slot: 3
    Top:
      Item:
        Material: 'SIGN'
        Data: 0
        Amount: 1
        Name: '&4Top'
      Slot: 4
    Today:
      Item:
        Material: 'BOOK'
        Data: 0
        Amount: 1
        Name: '&4Today'
      Slot: 5
    Shop:
      Item:
        Material: 'DIAMOND'
        Data: 0
        Amount: 1
        Name: '&4Vote Shop'
      Slot: 6

  # GUI for /vote url
  # And /vote if enabled in Config.yml
  VoteURL:
    # GUI Name
    Name: '&cVoteURL'
    BackButton: true
    SiteName: '&c%Name%'
    SeeURL: '&cClick to see URL'
    NextVote: '&cCan Vote In: %Info%'
    ViewAllUrlsButtonEnabled: true
    AllUrlsButton:
      AlreadyVotedItem:
        Material: 'REDSTONE_BLOCK'
        Data: 0
        Amount: 1
        Name: '&4All Voting Sites'
        Lore:
        - '&cClick Me'
      CanVoteItem:
        Material: 'EMERALD_BLOCK'
        Data: 0
        Amount: 1
        Name: '&4All Voting Sites'
        Lore:
        - '&cClick Me'
    AlreadyVotedItem:
      Material: 'REDSTONE_BLOCK'
      Data: 0
      Amount: 1
    CanVoteItem:
      Material: 'EMERALD_BLOCK'
      Data: 0
      Amount: 1
    URLText: '%VoteUrl%'
  # Customize /vote reward
  # Show players what you get when you vote on each site
  VoteReward:
    # Name of votesite
    ExampleVoteSite:
      # items in /vote reward sitename
      Items:
        # Item
        # This is not the item display name
        # Do not have 2 of the same items
        Diamond:
          # Item ID
          Material: 'DIAMOND'
          # Item Data (Eg 1:4, data is 4)
          Data: 0
          # Amount of items
          # Should be greater than 0
          Amount: 1
          # Item name
          # Remove this line for no name
          Name: '&4Example'
          # Lore
          # Remove this line for no lore
          Lore:
          - '&4Line 1'
          Slot: 0
  VoteLast:
    Name: 'VoteLast: %player%'
    BackButton: true
  VoteNext:
    Name: 'VoteNext: %player%'
    BackButton: true
  VoteToday:
    Name: 'VoteToday'
    BackButton: true
  VoteTop:
    Name: 'VoteTop %topvoter%'
    BackButton: false
    Item:
      Name: '&3&l%position%: &3%player%'
      Lore: '&3&lVotes: &3%votes%'
    SwitchItem:
      Name: 'Switch TopVoter'
      Lore: 'Currently: %Top%'
      Material: 'SIGN'
      Amount: 1
      # 8 Slots over from the bottom left
      Slot: 7
    # Number of topvoters to display on page +9
    # 9 Slots on the botton are used for page buttons
    Size: 27
  VoteTotal:
    Name: 'VoteTotal: %player%'
    BackButton: true
    DayTotal:
      Item:
        Material: 'WATCH'
        Name: '&cDaily Total'
        Lore: '&c&lTotal: &c%Total%'
        Amount: 1
    WeekTotal:
      Item:
        Material: 'WATCH'
        Name: '&cWeekly Total'
        Lore: '&c&lTotal: &c%Total%'
        Amount: 1
    MonthTotal:
      Item:
        Material: 'WATCH'
        Name: '&cMonthly Total'
        Lore: '&c&lTotal: &c%Total%'
        Amount: 1
    AllTimeTotal:
      Item:
        Material: 'WATCH'
        Name: '&cAllTime Total'
        Lore: '&c&lTotal: &c%Total%'
        Amount: 1
  VoteBest:
    Name: 'VoteBest: %player%'
    DayBest:
      Item:
        Material: 'WATCH'
        Name: '&cDaily Best'
        Lore: '&c&lBest: &c%Best%'
        Amount: 1
    WeekBest:
      Item:
        Material: 'WATCH'
        Name: '&cWeekly Best'
        Lore: '&c&lBest: &c%Best%'
        Amount: 1
    MonthBest:
      Item:
        Material: 'WATCH'
        Name: '&cMonthly Best'
        Lore: '&c&lBest: &c%Best%'
        Amount: 1
  VoteStreak:
    Name: 'VoteStreak: %player%'
    BackButton: false
    CurrentDayStreak:
      Item:
        Material: 'WATCH'
        Name: '&cCurrent Daily Streak'
        Lore: '&c&lStreak: &c%Streak%'
        Amount: 1
    CurrentWeekStreak:
      Item:
        Material: 'WATCH'
        Name: '&cCurrent Weekly Streak'
        Lore: '&c&lStreak: &c%Streak%'
        Amount: 1
    CurrentMonthStreak:
      Item:
        Material: 'WATCH'
        Name: '&cCurrent Monthly Streak'
        Lore: '&c&lStreak: &c%Streak%'
        Amount: 1
    HighestDayStreak:
      Item:
        Material: 'WATCH'
        Name: '&cHighest Daily Streak'
        Lore: '&c&lStreak: &c%Streak%'
        Amount: 1
    HighestWeekStreak:
      Item:
        Material: 'WATCH'
        Name: '&cHighest Weekly Streak'
        Lore: '&c&lStreak: &c%Streak%'
        Amount: 1
    HighestMonthStreak:
      Item:
        Material: 'WATCH'
        Name: '&cHighest Monthly Streak'
        Lore: '&c&lStreak: &c%Streak%'
        Amount: 1
  VoteURLSite:
    Name: 'VoteSite: %site%'
  VoteGUIName: '&cVoteGUI: &c&l%player%'
  VoteRewardName: 'VoteReward'
  VoteShopName: 'VoteShop'

BackButton:
  Material: 'PAPER'
  Data: 0
  Amount: 1
  Name: '&8Back to VoteGUI'

VoteShopBackButton: true
Shop:
  # Identifier
  # Used in placeholders for formats
  Diamond:
    # Item
    Material: 'DIAMOND'
    Data: 0
    Amount: 1
    Name: '&4Buy A Diamond'
    # You can set skulls of the player using the following
    # Remove the # to enable
    #Skull: '%Player%'
    Lore:
    - '&c&lCost: &c3 Voting Points'
    # Number of voting points this cost
    Cost: 3
    # Rewards to run if player buys succesfully
    Rewards:
      Items:
        Diamond:
          Material: 'DIAMOND'
          Amount: 1
    # Slot
    Slot: 0

# ------------------------------------------------
# Extra Rewards
# ------------------------------------------------

# To disable reward set value to []
# Eg:
# FirstVote: [] (All in one line)
# By default all rewards are disabled

# First vote rewards
FirstVote:
  Messages:
    Player: '&aYou voted for your first time!'
  Money: 100

# All vote rewards
# Reward for voting on all sites in one day
AllSites:
  Messages:
    Player: '&aYou voted on all sites in 1 day!'

Cumulative:
  # Number of votes required
  # Allows multiple cumulative rewards
  # Number be be around ' (E.g. '1')
  # Can have multiple listed here
  '20':
    Enabled: false
    # Wether or not votes must be made in same day/week
    # Useful if you want to require a certain number of voting sites to be voted on
    # for a daily/weekly reward instead of all of them
    VotesInSameDay: false
    VotesInSameWeek: false
    Rewards:
      Messages:
        Player: '&aYou got %cumulative% cumulative votes!'

VoteParty:
  # Wether or not vote party is enabled
  Enabled: false
  # Number of votes required to give rewards
  VotesRequired: 20
  # If true, players who did not vote to reach the votes required will
  # recieve the reward
  GiveAllPlayers: false
  # If true, the vote count will reset each day
  ResetEachDay: false
  # Reset at the end of the month
  ResetMonthly: false
  # Count votes from /av vote?
  CountFakeVotes: true
  # Number of user votes that apply to vote party total the user needs to get rewards
  UserVotesRequired: 0
  # Broadcast when vote party reached
  Broadcast: '&cReached the vote party amount!'
  # List of commands to execute, these only execute once.
  Commands: []
  # Reward files to give
  Rewards: []

# Reset milestons at end of the month
ResetMilestonesMonthly: false

MileStones:
  # Number of votes required
  # Allows multiple milestones
  # Number be be around ' (E.g. '1')
  # Can have multiple listed here
  '20':
    Enabled: false
    Rewards:
      Messages:
        Player: '&aYou got %milestone% milestone votes!'

VoteStreak:
  # Valid options: Day, Week, Month
  Day:
    # Number of days in a row
    # Each day requires one vote
    # Add a - to give a reward for every multiple (e.g. 2-)
    '2':
      # Enabled or not
      Enabled: false
      # Rewards to give
      Rewards:
        Messages:
          Player: "&aYou voted for %Streak% %Type%'s in a row!"
  Week:
    # Number of weeks in a row
    # Requires atleast one vote per week
    '2':
      # Enabled or not
      Enabled: false
      # Rewards to give
      Rewards:
        Messages:
          Player: "&aYou voted for %Streak% %Type%'s in a row!"
  Month:
    # Number of months in a row
    # Requires atleast 1 vote per month
    '2':
      # Enabled or not
      Enabled: false
      # Rewards to give
      Rewards:
        Messages:
          Player: "&aYou voted for %Streak% %Type%'s in a row!"


# ONLY USE THIS FOR TITLES/SOUNDS AND OTHER EFFECTS
# IT WILL ONLY RUN ONE TIME FOR ANY NUMBER OF OFFLINE VOTES
# Any reward files listed here are ran on vote of any site
# It is recommended to add rewards to each site instead of here
# Using forceoffline won't work here
AnySiteRewards: []


# ------------------------------------------------
# Top Voter
# ------------------------------------------------

# Top voter blacklist
BlackList:
- 'Notch'

# If true players with the permission 'VotingPlugin.TopVoter.Ignore' will act
# as if there name was added on the the blacklist above
# This also applies for ops
TopVoterIgnorePermission: false

# /vote top default data displayed
# Valid Options: AllTime, Monthly, Weekly, Daily
VoteTopDefault: Monthly

# These are required to be enabled in order for top voter awards to work
LoadTopVoter:
  AllTime: true
  Monthly: true
  Weekly: false
  Daily: false

# When top voter awards are given (even if there are none listed) it will store top voters
# Files will created in TopVoters folder.
StoreTopVoters:
  Monthly: true
  Weekly: false
  Daily: false

EnableMonthlyAwards: true
# Rewards to give
MonthlyAwards:
  # Position. 1 is first in top voter, 2 is second, etc...
  1:
    Rewards:
      Messages:
        Player: '&aYou came in first place in %TopVoter%!'
  2:
    Rewards:
      Messages:
        Player: '&aYou came in second place in %TopVoter%!'

EnableWeeklyAwards: false
# Rewards to give on weekly top voter
WeeklyAwards:
  # Position. 1 is first in top voter, 2 is second, etc...
  1:
    Rewards:
      Messages:
        Player: '&aYou came in first place in %TopVoter%!'
  2:
    Rewards:
      Messages:
        Player: '&aYou came in second place in %TopVoter%!'

EnableDailyRewards: false
# Rewards to give on daily top voter
DailyAwards:
  # Position. 1 is first in top voter, 2 is second, etc...
  1:
    # Reward files to give
    Rewards:
      Messages:
        Player: '&aYou came in first place in %TopVoter%!'
  2:
    Rewards:
      Messages:
        Player: '&aYou came in second place in %TopVoter%!'

# ------------------------------------------------
# Advanced
# Most of these values can be left untouched
# ------------------------------------------------

# Number of points to give on vote
# Set to 0 to give no points
PointsOnVote: 1

# Set this to false to disable the plugin adding totals
# Not really recommended
AddTotals: true

# Disable checking on world change
# May improve performance
DisableCheckOnWorldChange: false

# Debug
Debug: false

# Extra Debug
# Only needed in extreme cases
ExtraDebug: false

# Debug info ingame
# Players with permission "VotingPlugin.Debug"
# will see debug info if debug is true
DebugInGame: false

# Will log debug messages to VotingPlugin/Log/log.txt
# Requires Debug to be on
LogDebugToFile: false

# Options for request api
# Current methods
# ANVIL
# BOOK
# CHAT
# This is mainly used for admin gui's to type in values
RequestAPI:
  DefaultMethod: 'Anvil'
  DisabledMethods: []

# Wether or not to log every vote to a file
# Use this if you wanna track player votes
# Not recommended though
LogVotesToFile: false

# Delay between background updates like signs and more
# Default: 3 Minutes
# Longer times result in longer wait in stuff updating after a vote, like topvoter
DelayBetweenUpdates: 3

# Clear cache on update, setting to true reduces performance
ClearCacheOnUpdate: false

# Clears cache for the player who voted only
# Only effects if using mysql
# Would recommend for some bungee setups
ClearCacheOnVote: false

# Set to true to disable no service site message on voting
# You should never have to touch this if everything is setup properly
# Will also disable a few other warnings about vote sites
DisableNoServiceSiteMessage: false

# Used in special cases
# Much slower, but may work better
AlternateUUIDLookup: false

# Shouldn't need to change this
AutoKillInvs: true

# Count fake votes
# If true fake votes will give points and totals
CountFakeVotes: true

# Give VotingPlugin.Player by default
# Requires restart to take affect
GiveDefaultPermission: true

# Remove old player files
# Happens on startup or /av purge
PurgeOldData: false

# Minimum number of days offline in order to purge
PurgeMin: 90

# Whether or not to disable checking names on mojang, disable if you hit the rate limit
# Shouldn't make a noticeable impact if set to false
CheckNameMojang: true