gui.yml

This is the default gui.yml configuration.

# -----------------------------------------------------------------
# Welcome to the gui.yml file. Everything you see here is configurable.
#  
# Terminology: A 'raid plan' is a proposal to raid another faction. It is created
#  when a player runs '/fr raid <fac>' in the form of a gui.
# Terminology: A 'friendly raid' is the raid world that is created when two factions
#  agree to raid each other.
#  
# Contact: Kore Discord Tickets @KamikazeJAM
# -----------------------------------------------------------------

# This section configures the GUI elements on the main page of a raid plan.
raidPlan:
  # The title of the GUI, when on the main page.
  title: "&e&lFriendly&6&lRaid"
  # The amount of rows in the gui. Values: [1-6]
  rows: 4

  # This section configures the members icon.
  # Feel free to change any of the values below.
  # Lore should be kept as a list of strings.
  members:
    material: "PLAYER_HEAD"
    name: "&3&lMembers"
    lore:
      - "&7- Click to view/edit the members of the raid."
      - "&7- You&l must&7 select players for both factions."
    slot: 11

  # This section configures the base settings icon.
  # (See members for details on configuration)
  base:
    material: "OBSIDIAN"
    name: "&f&lBase Settings"
    lore:
      - "&7- Click to view/edit the base settings."
      - "&7- You can edit base size, buffer size,"
      - "&7  walls, and the ocean size."
    slot: 21

  # This section configures the record icon.
  # (See members for details on configuration)
  # Lore Placeholders: {recorded} - Replaced with recordYes or recordNo in config.yml
  record:
    # This is the material when stats recording is enabled.
    materialOn: "MUSIC_DISC_CAT"
    # This is the material when stats recording is disabled.
    materialOff: "MUSIC_DISC_CHIRP"
    name: "&5&lRecorded"
    lore:
      - "&7- Click to toggle recording."
      - "&7- When recording is on, the raid will be"
      - "&7  recorded and saved to the leaderboard."
      - " "
      - "&7- Recording: {recorded}"
    slot: 23

  # This section configures the wager icon.
  # (See members for details on configuration)
  # Lore Placeholders: {money_wager}, {exp_wager}, and {tokens_wager}
  wager:
    material: "SUNFLOWER"
    name: "&e&lWager"
    lore:
      - "&7- Click to view/edit the wager settings."
      - " "
      - "&7- The wager is currently set to:"
      - "&7    Money: &f&l${money_wager}"
      - "&7    Exp: &f&l{exp_wager} XP"
      - "&7    Tokens: &7&l{tokens_wager} Tokens"
    noCurrenciesLore:
      - "&7Wagering has been disabled"
    slot: 15

  # This section configures the confirm icon.
  # (See members for details on configuration)
  # Lore Placeholders: {plan_summary} - replaces the whole line with *summaryLore* below
  confirm:
    materialReady: "LIME_STAINED_GLASS_PANE"
    materialUnready: "RED_STAINED_GLASS_PANE"
    # This display name is used if the raidPlan is ready to be sent.
    nameReady: "&a&lConfirm Request"
    # This display name is used if the raidPlan is not ready.
    # For instance if they have to select players for a faction.
    nameUnready: "&c&lConfirm Request"
    # This is the lore of the confirm icon.
    # The line containing {plan_summary} will be completely replaced by the summaryLore below.
    lore:
      - ""
      - "{plan_summary}"

    # This replaces {plan_summary} in the lore above.
    # Placeholders:
    #   - {playerCount} = The amount of players selected
    #   - {factionPlayers}, {enemyPlayers} = The list of players for a faction
    #     - These placeholders are replaced by playerListEmpty or more lines
    #         Those lines are defined by playerListLine (one per player)
    #   - {counter} = Replaced with the name of the counter profile selected
    #   - {base_size}, {buffer_size}, {ocean}, {wall_pattern_symbols} = Base settings
    #   - {recorded} = Replaced with recordYes or recordNo in config.yml
    #   - {money_wager}, {exp_wager}, {tokens_wager} = The wager amounts
    summaryLore:
      - "&3&lPlayer Count: &f{playerCount}"
      - "&3&lFaction Players: {factionPlayers}"
      - "&3&lEnemy Players: {enemyPlayers}"
      - ""
      - "&9&lCounter Profile: &7{counter}"
      - ""
      - "&f&lBase Settings:"
      - "&7-Base Size: &7{base_size}"
      - "&7-Buffer Size: &7{buffer_size}"
      - "&7-Ocean: &7{ocean}"
      - "&7-Wall Pattern: &7{wall_pattern_symbols}"
      - ""
      - "&5&lRecorded: {recorded}"
      - ""
      - "&e&lWager:"
      - "&7-Money: &f&l${money_wager}"
      - "&7-EXP: &f&l{exp_wager}"
      - "&7-Tokens: &7&l{tokens_wager}"

    # Replaces {factionPlayers} and {enemyPlayers} when 0 members are selected.
    playerListEmpty: "&c&l[]"
    # This replaces {factionPlayers} and {enemyPlayers} with one line per member shown.
    # Placeholders: {name} - The name of the player
    playerListLine: "&7-{name}"
    slot: 31

  # This section configures the counter icon.
  # (See members for details on configuration)
  # Name Placeholders: {counter} - The name of the counter profile
  # Lore Placeholders: 
  #   {profiles} - The number of counter profiles available
  #   {counter_status} - Either *statusAvailable* or *statusUnavailable* (see below)
  counter:
    material: "TNT"
    name: "&9&lCounter Profile: &7{counter}"
    lore:
      - "&7- Available Profiles: &f{profiles}"
      - ""
      - "{counter_status}"
    statusAvailable:
      - "&bClick To Select A Counter Profile"
    statusUnavailable:
      - "&cYou do not have any available counter profiles (/fraid counter)"
      - " &cWe will attempt to generate an empty counter box you can use."
    slot: 13

# This section configures the members menu of the raid plan.
members:
  title: "&e&lF&6&lR&7: &3&lMembers"
  rows: 6

  # This is the slot index where faction1 player buttons start (Fills the next 5 slots).
  playerFactionSelectStart: 11
  # This is the slot index where faction2 player buttons start (Fills the next 5 slots).
  enemyFactionSelectStart: 29

  # This configures the icon for scrolling through players in a faction's list.
  playerSlideShowNext:
    material: "ARROW"
    name: "&3Scroll Right"
    lore:
      - "&7- Click to scroll right"
      - "&7  and view those slots."

  # This configures the icon for scrolling back through players in a faction's list.
  playerSlideShowBack:
    material: "ARROW"
    name: "&3Scroll Left"
    lore:
      - "&7- Click to scroll left"
      - "&7  and view those slots."
  
  # This configures the icon for faction1's information icon.
  playerFaction:
    material: "TNT"
    name: "&fFaction: &a{player_faction}"
    lore:
      - "&7- Select players for your"
      - "&7  faction in this row."
    slot: 9

  # This configures the icon for faction2's information icon.
  enemyFaction:
    material: "TNT"
    name: "&fFaction: {enemy_relation_color}{enemy_faction}"
    lore:
      - "&7- Select players for the other"
      - "&7  faction in this row."
    slot: 27
  selectPlayer:
    # This configures the icon for an empty fac1 player slot.
    playerFaction:
      material: "ORANGE_STAINED_GLASS_PANE"
      name: "&6&lSelect Faction Player &7(Click)"
      lore:
        - "&7- Click to select a player for your faction."
    # This configures the icon for an empty fac2 player slot.
    enemyFaction:
      material: "ORANGE_STAINED_GLASS_PANE"
      name: "&6&lSelect Enemy Player &7(Click)"
      lore:
        - "&7- Click to select a player for the enemy faction."
  lockedSlot:
    # This configures the icon for an locked fac1 player slot.
    playerFaction:
      material: "RED_STAINED_GLASS_PANE"
      name: "&c&lLocked"
      lore:
        - "&7Increase max players"
        - "&7 below to configure."
    # This configures the icon for an locked fac1 player slot.
    enemyFaction:
      material: "RED_STAINED_GLASS_PANE"
      name: "&c&lLocked"
      lore:
        - "&7Increase max players"
        - "&7 below to configure."

  # This configures the icon for a player head in a player slot.
  playerHead:
    material: "PLAYER_HEAD"
    name: "{faction_with_relation} &f{name}"
    addLore:
      - "&7- Click to&a add&7 this player."
    removeLore:
      - "&7- Click to&c remove&7 this player."

  # This configures the icon the player count information icon.
  playerCount:
    material: "PLAYER_HEAD"
    name: "&3&lPlayers: &f{playerCount}"
    lore:
      - "&7- Here you can edit the number of players."
      - "&7- You can have up to {maxRaidPlayers} players."
      - "&7- There are currently &f{playerCount}&7 slots."
    slot: 49

  # This configures the button for increasing player count.
  increasePlayers:
    material: "LIME_STAINED_GLASS_PANE"
    name: "&a&lIncrease Players"
    lore:
      - "&7- Click to&a increase&7 the number of players."
      - "&7- There is a max of {maxRaidPlayers} players per faction."
    slot: 50

  # This configures the button for decreasing player count.
  decreasePlayers:
    material: "RED_STAINED_GLASS_PANE"
    name: "&c&lDecrease Players"
    lore:
      - "&7- Click to&c decrease&7 the number of players."
      - "&7- There is a min of 1 player per faction."
    slot: 48

  # This configures the button for randomizing fac1 players.
  playerFactionRandomize:
    material: "YELLOW_STAINED_GLASS_PANE"
    name: "&e&lRandomize Faction Players"
    lore:
      - "&7- Click to&e randomize&7 your faction players."
    slot: 17

  # This configures the button for randomizing fac2 players.
  enemyFactionRandomize:
    material: "YELLOW_STAINED_GLASS_PANE"
    name: "&e&lRandomize Enemy Players"
    lore:
      - "&7- Click to&e randomize&7 the enemy players."
    slot: 35


# This section defines the size and title of the Member Select GUI.
memberSelect:
  title: "&3&lSelect Player"
  rows: 1


# This section defines the base settings GUI.
base:
  title: "&e&lF&6&lR&7: &f&lBase Settings"
  rows: 4
  # These settings are for the {color} placeholder below.
  # If the option is currently selected, it will use one color, otherwise it will use another.
  colors:
    optionSelected: "&a"
    optionUnselected: "&7"

  # Information about placeholders:
  #   {options} is replaced by the corresponding options for the icon.
  #   The format for this placeholder is defined by optionFormat
  #   where {option} is the string after : in config.yml (options section)
  #     Example: If in config.yml baseSize has a line for '1:1x1 Chunks', the {option}
  #      text will be '1:1x1 Chunks'

  # This section defines the base size icon.
  # Name Placeholder: {base_size}
  baseSize:
    material: "OBSIDIAN"
    name: "&f&lBase Size: &7{base_size}"
    lore:
      - "{options}"
      - ""
      - "&bClick To Swap Between Choices"
    optionFormat: "{color}- {option}"
    slot: 11

  baseYHeight:
    material: "LADDER"
    name: "&f&lBase Height: &7{base_height}"
    lore:
      - "{options}"
      - ""
      - "&bClick To Swap Between Choices"
    optionFormat: "{color}- {option}"
    slot: 23

  # This section defines the buffer size icon.
  # Name Placeholder: {buffer_size}
  bufferSize:
    material: "COBBLESTONE"
    name: "&f&lBuffer Size: &7{buffer_size}"
    lore:
      - "{options}"
      - ""
      - "&bClick To Swap Between Choices"
    optionFormat: "{color}- {option}"
    slot: 21

  # This section defines the ocean icon.
  # Name Placeholder: {ocean}
  ocean:
    material: "WATER_BUCKET"
    name: "&f&lOcean: &7{ocean}"
    lore:
      - "{options}"
      - ""
      - "&bClick To Swap Between Choices"
    optionFormat: "{color}- {option}"
    slot: 13

  # This section defines the wall pattern icon.
  wallPattern:
    material: "COBBLESTONE_WALL"
    name: "&f&lWall Pattern:"
    lore:
      - "{options}"
      - ""
      - "&bClick To Edit Wall Pattern"
    optionFormat: "{color}- {option}"
    slot: 15

wallPattern:
  title: "&e&lF&6&lR&7: &f&lWall Pattern"
  rows: 6
  cobblestone:
    material: "COBBLESTONE"
    name: "&f&l+ Cobblestone Wall"
    lore:
      - "&7- Click to add a cobblestone wall."
    slot: 28
  obsidian:
    material: "OBSIDIAN"
    name: "&f&l+ Obsidian Wall"
    lore:
      - "&7- Click to add an obsidian wall."
    slot: 30
  sand:
    material: "SAND"
    name: "&f&l+ Sand Wall"
    lore:
      - "&7- Click to add a sand wall."
    slot: 32
  red_top_sand:
    material: "SAND"
    name: "&f&l+ Sand Wall"
    lore:
      - "&7- Click to add a sand wall."
    slot: -1
  minechat_regen:
    material: "LAVA_BUCKET"
    name: "&f&l+ Regen Wall"
    lore:
      - "&7- Click to add a regen wall."
    slot: 34
  straight_regen:
    material: "LAVA_BUCKET"
    name: "&f&l+ Straight Regen Wall"
    lore:
      - "&7- Click to add a straight regen wall."
    slot: 35
  info:
    material: "PAPER"
    name: "&f&lWall Pattern Info"
    lore:
      - "&7- Wall Patterns are a set of walls that"
      - "&7  will repeat in order until the entire"
      - "&7  buffer has been filled with walls."
      - "&7- Click on a wall type to add it to the set."
      - "&7- Click on a wall within the set to remove it."
    slot: 53
  wallIcon:
    name: "&f&l{material} WALL"
    lore:
      - "&7- Click to remove this wall from the set."


# This section defines the counter profiles gui.
counterProfiles:

  # This section defines the player select icon on the first page.
  # Name Placeholder: {name} - The name of the player with the profiles
  playerSelect:
    title: "&e&lF&6&lR&7: &9&lProfiles"
    rows: 3
    playerHead:
      material: "PLAYER_HEAD"
      name: "&f{name}"
      lore:
        - ""
        - "&bClick to view this player's"
        - "&b public counter profiles"

  # This section defines the profile select icon after selecting a player.
  # Name Placeholder: {name} - The name of the profile
  # Lore Placeholder: {profile_summary} - A summary of the profile (see below)
  profileSelect:
    title: "&9&lProfiles: &8{name}"
    playerProfile:
      material: "PAPER"
      name: "&f{name}"
      lore:
        - "{profile_summary}"
        - ""
        - "&bClick to select this profile"

  # This list defines the profile summary placeholder.
  # Placeholders: 
  #   {name} - The name of the profile
  #   {y_level} - The y level the counter pastes at
  #   {water} - If the inside walls will be watered
  #   {visible} - If members of their faction can see the profile too
  #   {dimensions} - The size of the counter
  profileSummary:
    - "&7 - &bName: &f{name}"
    - "&7 - &bY Level: &f{y_level}"
    - "&7 - &bInterior Water: &f{water}"
    - "&7 - &bFaction Visible: &f{visible}"
    - "&7 - &bSchematic Dimensions: &f{dimensions}"


# This section defines the wager icon.
wager:
  title: "&e&lF&6&lR&7: &e&lWager Settings"
  rows: 5

  # The following sections allow you to configure the increase and decrease amounts
  #  on the buttons of the wager gui. They should be lists of integers
  # Only four numbers will fit in the gui, any more will be ignored.
  options:
    money:
      increase:
        - "10000"
        - "100000"
        - "1000000"
        - "10000000"
      decrease:
        - "-10000"
        - "-100000"
        - "-1000000"
        - "-10000000"
    exp:
      increase:
        - "1000"
        - "10000"
        - "100000"
        - "1000000"
      decrease:
        - "-1000"
        - "-10000"
        - "-100000"
        - "-1000000"
    tokens:
      increase:
        - "10"
        - "100"
        - "1000"
        - "10000"
      decrease:
        - "-10"
        - "-100"
        - "-1000"
        - "-10000"

  # This section defines the wager icon for money.
  wagerMoneyIcon:
    material: "GREEN_DYE"
    name: "&a&lMoney Wager"
    lore:
      - "&7Current Wager: &l${money_wager}"
    row: 2

  # This section defines the wager icon for exp.
  wagerExpIcon:
    material: "EXPERIENCE_BOTTLE"
    name: "&a&lExp Wager"
    lore:
      - "&7Current Wager: &l{exp_wager} EXP"
    row: 3

  # This section defines the wager icon for tokens.
  wagerTokensIcon:
    material: "SUNFLOWER"
    name: "&a&lTokens Wager"
    lore:
      - "&7Current Wager: &l{tokens_wager} Tokens"
    row: 4

  # This section defines a generic increase icon.
  # Name Placeholder: {amount} - The amount outlined in the options section
  increaseIcon:
    material: "LIME_STAINED_GLASS_PANE"
    name: "&a&l+{amount}"
    lore:
      - "&7- Click to&a increase&7 the"
      - "&7  wager by this amount."

  # This section defines a generic decrease icon.
  # Name Placeholder: {amount} - The amount outlined in the options section
  decreaseIcon:
    material: "RED_STAINED_GLASS_PANE"
    name: "&c&l{amount}"
    lore:
      - "&7- Click to&c decrease&7 the"
      - "&7  wager by this amount."

  # This section defines the information icon in the wager gui.
  infoIcon:
    material: "PAPER"
    name: "&e&lWager Info"
    lore:
      - "&7- Wagers are completely&l optional."
      - "&7- In order to wager both factions must"
      - "&7   have at least the specified amount."
      - "&7- If both factions agree upon an amount"
      - "&7   the amount will be drained from players."
      - "&7- Draining in any currency is similar to"
      - "&7   a leader draining money into the f bank."
    # The index (from 0 to 8) of where the icon should be placed, in the last row.
    spotInLastRow: 8

# This is the configuration for the filler item used in all guis
filler:
  material: "GRAY_STAINED_GLASS_PANE"
  name: " "
  lore: []

# This is the configuration for the back button used in all guis after the main one
back:
  material: "BARRIER"
  name: "&c&lBack"
  lore:
    - "&7- Click to go back to"
    - "&7  the previous menu."
  # The index (from 0 to 8) of where the icon should be placed, in the last row.
  spotInLastRow: 0

# This section defines the gui for '/fr counter edit'.
counterEdit:
  title: "&e&lF&6&lR&7: &9&lYour Profiles"

  # This section defines the icon for a player profile in the edit gui.
  # Name Placeholder: {name} - The name of the profile
  # Lore Placeholder: {profile_summary} - A summary of the profile
  playerProfile:
    material: "PAPER"
    name: "&f{name}"
    lore:
      - "{profile_summary}"
      - ""
      - "&cClick to&l delete&c this profile"


# This is the title of the menu when selecting a counter for a tournament.
# This gui is displayed to factions without a profile configured, when they run /fr join.
tournamentCounterSelect:
  title: "&e&lF&6&lR&7: &9&lTournament Counters