Challenges#

Challenges addon has 4 different types of challenges. Each type offers different things to be tested for challenge to be marked as completed. These types are:

• Inventory Challenge (INVENTORY_TYPE) - challenge that requires items in player inventory to be completed.
• Island Challenge (ISLAND_TYPE) - challenge that requires blocks or entities on the player island to be completed.
• Other Challenge (OTHER_TYPE) - challenge that requires player XP, money or island level to be completed.
• Statistic Challenge (STATISTIC_TYPE) - challenge that requires certain value from player statistic to be completed.

Unfortunately Spigot does not have a general item parsing mechanics. So plugin authors need to create their own. Challenges addon uses BentoBox Item Parser. If function is not supported by it, then you cannot. However, you can always use in-game admin GUI to set any items you want. There is not any limitation.

The statistic type you can find here: Statistic.

Some information can be found in fandom site: minecraft.fandom

However, there is not a place where you could find out what things you can specify. I would recommend to use ingame admin GUI for creating statistic challenges, as it has more options to detect which fields can fill.

To customize Challenges Addon GUI's you need to have version 1.0. This is a first version that has implemented them. Addon will create a new directory under /plugins/bentobox/addons/challenges with a name panels

Currently you can customize 3 GUI's:

• Main Challenges Panel: main_panel - panel that is opened when player can see list of challenges.
• Multiple Completion Panel: multiple_panel - panel that is opened when player wants to specify number of times challenge must be completed.
• Gamemode Selection Panel: gamemode_panel - panel that is opened when commands.global-command is enabled in settings and there are multiple gamemodes installed.

Each GUI contains functions that is supported only by itself.

This button is available in main_panel and gamemode_panel. The PREVIOUS and NEXT button types allows creating automatic paging, when you have more challenges than spaces in GUI. These types have extra parameters under data: - target - indicates if button will switch LEVEL or CHALLENGE in main_panel and GAMEMODE in gamemode_panel. - indexing - indicates if button will show page number.

Example:

    icon: TIPPED_ARROW:INSTANT_HEAL::::1
    title: challenges.gui.buttons.previous.name
    description: challenges.gui.buttons.previous.description
    data:
      type: PREVIOUS
      target: CHALLENGE
      indexing: true
    action:
      left:
        tooltip: challenges.gui.tips.click-to-previous

This button is available in main_panel. The CHALLENGE button creates a dynamic entry for a challenge. Button will be filled only if there exist a challenge. F.e. if you have only 3 challenge, but defined 7 spots for challenges in the GUI, then only 3 spots will be filled. Other spots will be left empty.

By default challenges will be ordered by their order numbers, however, you can specify a specific level to be in a specific slot with id parameter under data.

  data:
    type: CHALLENGE
    id: example_challenge

Specifying title, description and icon will overwrite dynammic generation based on database data. By default these values will be generated from database entries. This button supports 3 different action types:

• COMPLETE - just completes a challenge once.
• COMPLETE_MAX - completes a challenge as much as possible.
• MULTIPLE_PANEL - opens multiple completion panel which allows to select how many times must be completed.

Example:

  data:
    type: CHALLENGE
  actions:
    left:
      type: COMPLETE
      tooltip: challenges.gui.tips.click-to-complete
    right:
      type: MULTIPLE_PANEL
      tooltip: challenges.gui.tips.right-click-multiple-open
    shift_left:
      type: COMPLETE_MAX
      tooltip: challenges.gui.tips.shift-left-click-to-complete-all

This button is available in main_panel. The LEVEL button creates a dynamic entry for a challenge level. Button will be filled only if there exist a level. F.e. if you have only 3 levels, but defined 7 spots for level in the GUI, then only 3 spots will be filled. Other spots will be left empty.

By default levels will be ordered in their progression, however, you can specify a specific level to be in a specific slot with id parameter under data.

  data:
    type: LEVEL
    id: example_level

Specifying title, description and icon will overwrite dynammic generation based on database data. By default these values will be generated from database entries.

Example:

  data:
    type: LEVEL
  actions:
    left:
      tooltip: challenges.gui.tips.click-to-select

This button is available in main_panel. The UNASSIGNED_CHALLENGES button allows to select a button for free challenges. It does not have any extra functions or dynamic generations.

This button is available in gamemode_panel It generates a button for each GameMode addon that has Challenges installed.

This button is available in multiple_panel. These types allow increasing/reducing the number of challenge completion.

Specifying value: <number> under data allows to set different custom number of increment/reducement.

This button is available in multiple_panel. This type allows accepting input number and complete challenge that much time.

Specifying type: ACCEPT under action allows to complete challenge. Specifying type: INPUT under action allows request player to write number in chat.

You can find the comprehensive list of permissions in the addon.yml file of this addon.
If something is indeed missing from the list below, please let us know!

Please add it to the list here.

The official way is to add challenge via Admin GUI or Template file. Be aware, that template file is imported only after using proper icon in Admin GUI ("Import Template"). The GUI will allow choosing which template you will want to import into gamemode.

However, there is an option to edit exported database file. It can be done by exporting to file via: /[admin_command] challenges and clicking on "Export Database" button.

Yes, you can do it via addon config file: store-island-data: true

Yes, you can do it via addon config file: store-island-data: false

Most likely reward commands are not working because of incorrect definition. The command does not require / symbol before it.

If you want to call command from player perspective, you need to add [SELF] before command call, f.e. [SELF] kill will result in player calling /kill command.

It also could be caused by permissions. [gamemode].command.challengeexempt will prevent player to execute commands. Check if player does not have this permission.

Currently, addon do not support placeholders in reward commands. If that is necessary, you can request them in gitHub.

Only placeholder that currently is supported in reward commands is [player] which returns player who completed challenge name.

Yes, order of elements are defined in addon locales file.

Challenge Description Level Description

Switching or removing parts of lore will change the order of elemetns displayed in it.

    lore: |-
        [description]
        [status]
        [cooldown]
        [requirements]
        [rewards]

Each of these parts are generated by tags below, and you can change them too. F.e. [status] part is generated from:

status:
    # Status message for completed unrepeatable challenge
    completed: "&2&l Completed"
    # Status message that contains number of completions for unlimited repeatable challenge
    completed-times: "&2 Completed &7&l [number] &r&2 time(-s)"
    # Status message that contains number of completions from max available for repeatable challenge
    completed-times-of: "&2 Completed &7&l [number] &r&2 out of &7&l [max] &r&2 times"
    # Status message that indicates that max completion count reached for repeatable challenge
    completed-times-reached: "&2&l Completed all &7 [max] &2 times"