Connect4Config

#
#   ____                          __ _
#  / __ \ _____ ___   ____   ____/ /(_)____ _ ____
# / / / // ___// _ \ / __ \ / __  // // __ `// __ \
#/ /_/ // /   /  __// / / // /_/ // // /_/ // /_/ /
#\____//_/    \___//_/ /_/ \__,_//_/ \__, / \____/
#                                   /____/
#                                       ohhiya
#                    V 3.2
#
#Also, I'm going to stress the importance of adding an independent CSV file Database for the script.
#Here's the format I use in my config.sk located in Skript's directory:
#
#   Connect4:
#       type: CSV
#       pattern: ~connect4.*
#       file: ./plugins/Skript/databases/Connect4.csv
#       backup interval: 2 hours
#
#This is just the format I use, you can change it to fit your need; however, the 'pattern' section must be kept the same!
#
#Placeholders:
#Varying:
#   %PREFIX% = The segment of text that predicates all other text.
#   %TARGET% = The target of the command, whether it be an invitation, or spectating.
#   %PLAYER% = The command executer.
#   %WINNER% = The winner of the game.
#   %LOSER% = The Loser of the game.
#   %OPPONENT% = The player's opponent.
#Pausing:
#   %PAUSEAMOUNT% = The amount of pauses a player has left.
#Statistics:
#   %STAT% = The setting statistic argument.
#   %INPUT$ = The setting statistic input argument.
#Most placeholders aren't used unless specified in examples below!

Connect4:
  Database:
    Enabled: false
    #Username: If you are using a database, you must specificity these values at the beginning of the actual script!
    #Password: Just open Connect4.sk in a text editor, you should see the database options near the top.
    #Port: You may need to uncomment the 'database options' and a few other lines in Connect4.sk!
    #Database:
    #Table:
  Statistics:
    #Should stats be enabled? Refer to the database message at the top of this file.
    Enabled: true
    #Should mid-game quits be considered loses or forfeits?
    Forfeits: true
    #Should players receive statistical increments for playing with bots?
    #I have this as an option to prevent stat farming.
    StatsFromBots: false
  #Should sounds be enabled?  Unfortunately I can't specify what sounds to use in the config and parse it as a sound;
  #however, YOU can change the sound via a text editor! Lines 243, 421, 422, 471, and 536 control sounds!
  #Just replace the sounds with something from here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html
  Sounds: true
  #Should the name of the player's inventory change with each turn?  If you disabled this, TitleTurn and WaitingTitle
  #NEED to be edited so that they both include the %TARGET% placeholder!!!
  TitleTurns: true
  Animations:
    #Should the game tiles have a 'sliding down' animation?
    Moves: true
    #How many ticks should pass in-between each frame of movement during a move? Yes, you need the 'ticks' at the end.
    MovesTicks: 3 ticks
    #Should the winning move display an animate flicker?
    Winning: true
    #How many ticks should pass in-between each frame during the 'Winning Move' animation? Yes, you need the 'ticks' at the end.
    WinningTicks: 10 ticks
  GUI:
    Game:
      Title:
        #The title of the game's GUI menu when it is the player's turn. Available placeholders: %PLAYER%, %TARGET%
        #If you disabled TitleTurns above, TitleTurn and WaitingTitle NEED to be edited so that they both include the %TARGET% placeholder!!!
        TitleTurn: "&1It's Your Turn!"
        #The title of the game's GUI menu when it is the opponent's turn. Available placeholders: %PLAYER%, %TARGET%
        #If you disabled TitleTurns above, TitleTurn and WaitingTitle NEED to be edited so that they both include the %TARGET% placeholder!!!
        WaitingTitle: "&1Waiting on %TARGET%..."
        #The title of the game's GUI menu while spectating someone. Available placeholders: %TARGET%, %OPPONENT%
        SpectatorTitle: "&1%TARGET% vs %OPPONENT%"
        #The title of the game's GUI menu when someone has won. Available placeholders: %WINNER%, %LOSER%
        WinningTitle: "&1%WINNER% has Won!"
        #The title of the game's GUI when the game ends in a draw.
        DrawTitle: "&1Draw!"
        #The opponent's title when the player pauses a game. %PLAYER% is the pauser.
        PauseTitle: "&1%PLAYER% has paused..."
      #what item should the background compose of?
      BackgroundBlock: light gray stained glass pane
      #What item should serve as the divider between the game and informational items in the menu?
      DividerBlock: black stained glass pane
      #What item should represent the slot next to Player1's head in the game GUI?
      DividerBlockPlayer1: sand
      #What item should represent the slot next to Player2's head in the game GUI?
      DividerBlockPlayer2: gravel
      #What item should represent Player1?
      Player1Block: sand
      #What item should represent Player2?
      Player2Block: gravel
      #What item should represent the winning move?
      WinBlock: diamond block
    Menu:
      #The title of the main GUI menu. Available placeholders: none.
      Title: "&1Connect&44 &1Menu"
      Buttons:
        #What items should represent buttons in the GUI menu?
        #I felt the names that appear in the menu should appear constant, but you can change them in the actual script itself!
        Invite: paper
        Spectate: eye of ender
        Invitations: book
        Stats: book and quill
        Resume: wait music disc
        Help: nether star
        Back: barrier block
        Next: enchanted book
        Previous: book
        #The Exit button also appears in the game GUI, and also acts as the forfeit button!
        Exit: tnt
      Stats:
        #What items should represent slots in the Statistics menu?
        Wins: diamond
        Loses: coal
        Draws: stick
        Forfeits: paper
        GamesPlayed: nether star
        Others: enchanted book
  Misc:
    #Connect4 Bots: $EasyC4Bot, $HardC4Bot, $ImpossibleC4Bot
    Bots:
      #Should C4Bots be enabled?
      Enabled: true
      #Player head from player to represent bots in the invitation menu.
      #Just a default console head I found in FreshCoal's legacy name database.
      Head: "Addelburgh"
    #Messages both players after a game for a rematch.
    Rematch:
      Enabled: true
      #Available placeholders: %TARGET% - the player's opponent.
      Message: "%PREFIX% Invite &b%TARGET%&9 to a Rematch?"
    #Broadcast a message upon ending a game.
    Broadcast:
      Enabled: true
      Wins:
        #Available placeholders: %WINNER%, %LOSER%
        - "%PREFIX% &b%WINNER%&9 has beaten &b%LOSER%&9 at Connect4!"
      Draws:
        #Use %PLAYER% and %TARGET% for the draw broadcast!
        - "%PREFIX% &b%PLAYER%&9 and &b%TARGET%&9 got a draw at Connect4!"
        #Available placeholders: %WINNER%, %LOSER%
      Forfeits:
        - "%PREFIX% &b%LOSER%&9 has forfeited to &b%WINNER%&9 at Connect4!"
    #Executes a list of commands upon winning a game.
    Commands:
      Enabled: true
      Executables:
      #Available placeholders: %WINNER%, %LOSER%
        Wins:
        #- give %WINNER% diamond 1
        #- give %LOSER% coal 1
        Draws:
        #Use %PLAYER% and %TARGET% for the draw commands!
        #- give %PLAYER% iron_ingot 1
        #- give %TARGET% iron_ingot 1
        Forfeits:
        #- give %WINNER% diamond 1
        #- give %WINNER% paper 1 name:&3Certificate_of_Forfeit lore:_&cCertificate_which_articulates|_&cthat_%LOSER%_forfeited_to|_&c%WINNER%_during_Connect4!
        #- give %LOSER% coal 1
      BotExecutables:
      #Bots are not actual players, and cannot receive items, messages, etc!  If you try to give bots an item, it will error in console!
      #Available placeholders: %PLAYERWINNER%, %PLAYERLOSER%, %BOTWINNER%, %BOTLOSER%
      #The above bot placeholders should only be used for mentioning the bot's names; nothing that involving giving items, etc.
        Wins:
        #- give %PLAYERWINNER% diamond 1
        #- give %PLAYERLOSER% coal 1
        Draws:
        #Use %PLAYER% and %BOT% for the draw commands!
        #- give %PLAYER% iron_ingot 1
        Forfeits:
        #- give %PLAYERWINNER% diamond 1
        #- give %PLAYERLOSER% coal 1
  Invitations:
    #How long should an invitation last until it times out?
    Period: 60
    #Should players be able to receive multiple invites at once?  For example, if false, PlayerA can't invite PlayerB if PlayerC has an invite pending to PlayerB.
    Multiple: true
  Pausing:
    #Length of time each pause last, in SECONDS, but do not include timespan.
    TimeLimit: 180
    #At what point should it begin notifying the player of how many pauses they have left after each pause? Pretty much to prevent it saying "YOU HAVE 999998 PAUSES LEFT".
    LimitWarning: 5
    #Permission-based pausing amounts! Just in case a staff member needs extra time for fix something while in a game.
    #Players do not have any of these permissions by default; if they don't have any of the below permissions, a pause will act as a forfeit!
    Permissions:
      - connect4.pauses.3
      - connect4.pauses.999
  Messages:
    #The string of text that predicates all other text, if wanted.
    Prefix: "&9|&3Connect4&9|"
    #Message received upon running /Connect4 Help
    Help: "&3--          %PREFIX%     &9Alias: &b/C4     &3--\n&9/Connect4 &b- Opens GUI menu\n&9/Connect4 invite <player> &b- Invites a player\n&9/Connect4 accept <player> &b- Accepts a player's invite\n&9/Connect4 deny <player> &b- Denies a player's invite\n&9/Connect4 spectate <player> &b- Spectates a game\n&9/Connect4 statistics <player> &b- Displays Connect4 stats\n&9/Connect4 leaderboards <statistic> &b- Displays a Top 10 leaderboard for a specific statistic"
    Game:
      #Message players and spectators of various endings.
      Draw: "%PREFIX% &bDraw!"
      #Available placeholders: %PREFIX%, %LOSER%, %WINNER%
      Win: "%PREFIX% &b%WINNER% has won!"
      #Available placeholders: %PREFIX%, %LOSER%, %WINNER%
      Forfeit: "%PREFIX% %LOSER% forfeited the game!"
      Error:
        NotTurn: "%PREFIX% It is not your turn to move."
    Invite:
      Sent:
        #JSON message which sends to the invitation target, allowing them to click the message to accept the invitation
        JSONInvite:
          Enabled: true
          #Available placeholders: %PLAYER% - the invitation sender
          Message: "%PREFIX% Use &b/Connect4 or click this message to accept!"
        #Messages the player and target of a successful invitation attempt.
        #Available placeholders: %PREFIX%, %TARGET%, %PERIOD% - where %PERIOD% is the amount of time before the invitation expires.
        Player: "%PREFIX% You have sent an invitation to &b%TARGET%&9.\n%PREFIX% Your invite will time out in &b%PERIOD% seconds&9."
        #Available placeholders: %PREFIX%, %PLAYER% - where %PLAYER% is the invitation sender.
        Target: "%PREFIX% &b%PLAYER%&9 has sent an invitation to you."
      Accept:
        #Messages invitation acceptance to the player and his target.
        Player: "%PREFIX% &b%TARGET%&9 has accepted your invitation!"
        Target: "%PREFIX% You have accepted &b%PLAYER%'s&9 invitation!"
      Deny:
        #Messages denial to the player and his target.
        #Available placeholders: %PREFIX%, %TARGET%
        Player: "%PREFIX% &b%TARGET%&9 has denied your invitation!"
        #Available placeholders: %PREFIX%, %PLAYER%
        Target: "%PREFIX% You have denied &b%PLAYER%'s&9 invitation!"
      Error:
        TimedOut:
          #Messages invitation timeout to the player and target.
          #Available placeholders: %PREFIX%, %TARGET%
          Player: "%PREFIX% Your invitation to &b%TARGET%&9 has timed out."
          #Available placeholders: %PREFIX%, %PLAYER%
          Target: "%PREFIX% &b%PLAYER%'s&9 invitation has timed out."
        Pending:
          #Messages the pending error to the player and target. Available placeholders: %PREFIX%, %TARGET%
          Self: "%PREFIX% You currently have an invitation pending to &b%TARGET%&9."
          Target: "%PREFIX% &b%TARGET%&9 currently has an invitation pending!"
        #When a player attempts to accept a player's invitation, but no invite exist.Available placeholders: %PREFIX%, %TARGET%
        NoInvite: "%PREFIX% You do not have any invitations from &b%TARGET%&9."
        #When the player's invitation box is empty.
        Empty: "%PREFIX% You have no current invitations"
        #When a player's target is offline. Available placeholders: %PREFIX%, %TARGET%
        Offline: "%PREFIX% &b%TARGET%&9 is not currently online."
        #When the player's target is themselves.
        Self: "%PREFIX% You can't invite yourself, silly!"
        #When a player's target is in a game. Available placeholders: %PREFIX%, %TARGET%
        InGame: "%PREFIX% &b%TARGET%&9 is currently in a game."
        #When the player does not use specificity a target.
        NoArgument: "%PREFIX% Please specificity a player or use the menus!"
        #When a player attempts to invite someone while paused.
        IsPaused: "%PREFIX% You are already in a paused game!"
    Spectate:
      Error:
        #When a player attempts to spectate themselves.
        Self: "%PREFIX% You can't spectate yourself, silly!"
        #When a player's target is not in a game. Available placeholders: %PREFIX%, %TARGET%
        NotInGame: "%PREFIX% &b%TARGET%&9 is not in a game."
    Statistics:
      #Success message sent to a player when they do /Connect4 setstats
      #Available placeholders: %PREFIX%, %TARGET%, %STAT%, %INPUT%; where %STAT% is the statistic argument, and %INPUT% is the value they're setting.
      SetStatSuccess: "%PREFIX% You have set &b%TARGET%'s %STAT% &9statistic to &b%INPUT%&9."
      #The Leader Board statistic header when doing /Connect4 leaderboard <stat> . Available placeholders: %STAT%
      LeaderBoardHeader: "&9------ &bTop 10 %STAT% Leaderboard &9------"
      Error:
        #Messages a player when they attempt to do /Connect4 setstats but don't have permissions.
        NoPermission: "%PREFIX% You do not have permission to set stats!"
        #When a set-stat arg is given which isn't a stat.
        NotStat: "%PREFIX% Available statistics: &bWins, Loses, Forfeits, and Draws"
        #Displays a How-To for setting statistics.
        DisplayGuide: "%PREFIX% /Connect4 setStats <player> <statistic=\"Wins, Loses, Forfeits, Draws\"> <number>"
        #When no statistics record exist for the player's target. Available placeholders: %PREFIX%, %TARGET%
        NoRecord: "%PREFIX% There are no Connect4 Statistics for %TARGET%."
    Pause:
      #When a player resumes a game while the opponent is still paused, this message will appear for the opponent.
      TargetResumeNotice: "%PREFIX% %PLAYER% has resumed the game!"
      #When a player pauses, this will tell them how many pauses they have left. It will only send when the amount if at or below the LimitWarning value above.
      #Available placeholders: %PREFIX%, %PAUSEAMOUNT% - where %PAUSEAMOUNT% is the amount of pauses the pauser has left.
      PlayerAmountLeft: "%PREFIX% You have &b%PAUSEAMOUNT% &9pauses left!"
      #When a player pauses, this will tell the opponent how many pauses they have left. It will only send when the amount if at or below the LimitWarning value above.
      #Available placeholders: %PREFIX%, %PLAYER, %%PAUSEAMOUNT% - where %PAUSEAMOUNT% is the amount of pauses the pauser has left.
      TargetAmountLeft: "%PREFIX% &b%PLAYER% &9has &b%PAUSEAMOUNT% &9pauses left!"
      #Messages the player when they pause the game.
      PlayerPause: "%PREFIX% You have paused your game with &b%TARGET%&9. Use &b/Connect4 resume &9to resume your game."
      #Messages the opponent telling them the player has paused.
      TargetPause: "%PREFIX% Paused by %PLAYER%."
      Error:
        #When a player attempts to resume when no game was paused.
        NoPausedGame: "%PREFIX% You have no current game paused!"
        #When a player has no more pauses left.
        NoPauseLeft: "%PREFIX% You have no more pauses!\n%PREFIX% Your next game exit will be a forfeit!"
        #When a player attempts to make a move when the game is paused
        OpponentPausedState: "%PREFIX% The game is paused!"