Tournaments.yml - Kunfury-blep/Blep-Fishing GitHub Wiki

Tournaments Configuration

Below is an explanation of how to fully configure your server's tournaments.

Config Options

Mode: DAY

The mode of the tournament. Current options are:

  • DAY
  • HOUR

Type: LARGEST

Which type of tournament will be created. Current options are:

  • LARGEST - Largest fish caught wins
  • SMALLEST - Smallest fish caught wins
  • EXPENSIVE - The catch that is worth the most wins (Requires Economy)
  • CHEAPEST - The catch that is worth the least wins (Requires Economy)
  • AMOUNT - Whoever catches the most fish wins
  • SCORE - The fish which is the best combination of rarity and size wins

Duration: 12

How long, in hours, the tournament will last. Non-Whole numbers are supported

Fish Type: Bluegill

The type of fish the tournament is for. This can be either the name of a fish defined in the base config or one of the following options:

  • ALL - Any fish caught will count towards this tournament
  • RANDOM - Each time the contest is run, a random fish type will be chosen

Announce New Winner: True

Defines whether or not it will be announced in chat when a player takes the top spot in a tournament.

Use Bossbar: true

Whether the tournament will have an associated bossbar displayed to players

Bossbar Timer: true

Determines if remaining time will be shown on the bossbar. (Requires the bossbar to be enabled)

Bossbar Timer Percent: 100

The percent at which the timer will show on the bossbar. (Requires the bossbar to be visible AND the timer to be enabled)

Bossbar Color: PINK

The color the bossbar will use. Available options:

  • BLUE
  • GREEN
  • PINK
  • PURPLE
  • RED
  • WHITE
  • YELLOW

Max Amount: 0

The max amount of fish that can be caught before the tournament ends. Leave to 0 for no limit

Minimum Players: 5

The number of players required to be online before the tournament will start

Minimum Fish: 1

Minimum fish a player must catch to be considered a part of the tournament

Rewards

Rewards define the different rewards players will receive depending on where they place in the tournament. Any number is viable and "DEFAULT" will be given to all participants.

Additional information on reward options, as well as how to give more complex custom items, can be found in the Treasure Config section.

 Rewards:
    1:
      - 'CASH: 1000'
      - 'ITEM: DIAMOND 4'
      - 'ITEM: DIAMOND 8'
    2:
      - 'CASH: 500'
      - 'ITEM: SEA_LANTERN 1'
      - 'ITEM: TURTLE_EGG 1'
    3:
      - 'ITEM: SEA_PICKLE 1'
    Default:
      - 'TEXT: Sorry, you did not win anything.'

Default Config

Default Tournaments Config 
'&6Weekend Tournament':
  Mode: DAY #DAY, HOUR
  Type: LARGEST #LARGEST, SMALLEST, EXPENSIVE, CHEAPEST, AMOUNT, SCORE
  Duration: 12 #How long, in hours, the tournament will last
  Fish Type: ALL
  Use Bossbar: true #Show bossbar with for time of the tournament
  Bossbar Timer: true #Show time remaining on bossbar
  Bossbar Percent: 10 #What percentage the tournament will show for
  Bossbar Timer Percent: 100 #What percentage will the timer show on the bossbar
  Bossbar Color: PINK #BLUE, GREEN, PINK, PURPLE, RED, WHITE, YELLOW
  Max Amount: 0 #Max amount of fish that can be caught before the tournament ends. Leave to 0 for no limit
  Minimum Players: 5 #Amount of players required to be online
  Minimum Fish: 1 #Minimum fish a player must catch to be considered a part of the tournament
  Start Delay: 8 #Hours to delay before starting the tournament
  Cooldown: 4 #The number of hours between each tournament
  Days: #Days of the week the tournament will run on. Only used on 'DAY' Mode
    - SATURDAY
    - SUNDAY
  Rewards:
    1:
      - 'CASH: 1000'
      - 'ITEM: DIAMOND 4'
      - 'ITEM: DIAMOND 8'
    2:
      - 'CASH: 500'
      - 'ITEM: SEA_LANTERN 1'
      - 'ITEM: TURTLE_EGG 1'
    3:
      - 'ITEM: SEA_PICKLE 1'
    Default:
      - 'TEXT: Sorry, you did not win anything.'

'&bBluegill Bonanza':
  Mode: HOUR
  Type: AMOUNT
  Duration: 4
  Cooldown: 8
  Start Delay: 0
  Fish Type: Bluegill
  Use Bossbar: true
  Bossbar Timer: true
  Bossbar Percent: 100
  Bossbar Timer Percent: 100
  Bossbar Color: BLUE
  Max Amount: 100
  Minimum Players: 0
  Rewards:
    1:
      - 'CASH: 1000'
      - 'ITEM: DIAMOND 4'
      - 'ITEM: DIAMOND 8'
    2:
      - 'CASH: 500'
      - 'ITEM: SEA_LANTERN 1'
      - 'ITEM: TURTLE_EGG 1'
    3:
      - 'ITEM: SEA_PICKLE 1'

'&bBest &3Bass':
  Mode: HOUR
  Type: SCORE
  Duration: 12
  Delay: 24 #The number of hours between each tournament. Only used on 'HOUR' Mode
  Start Delay: 8 #Hours to delay before starting the tournament
  Fish Type: Smallmouth Bass
  Use Bossbar: true
  Bossbar Timer: false
  Bossbar Percent: 5
  Bossbar Timer Percent: 5
  Bossbar Color: GREEN
  Max Amount: 0
  Minimum Players: 5
  Rewards:
    1:
      - 'CASH: 1000'
      - 'ITEM: DIAMOND 4'
      - 'ITEM: DIAMOND 8'
    2:
      - 'CASH: 500'
      - 'ITEM: SEA_LANTERN 1'
      - 'ITEM: TURTLE_EGG 1'
    3:
      - 'ITEM: SEA_PICKLE 1'
⚠️ **GitHub.com Fallback** ⚠️