Challenges

## Release Highlights ✨ Optional reward chance* — each challenge can now roll a configurable chance to actually grant its reward, so rewards can be made rare or gambled for. 💎 Island level rewards* — completing challenges (and levels) can raise the island level directly via the Level addon. 🔡 Biome requirement for island challenges* — island challenges can require the player to be standing in one of a chosen set of biomes, picked from a new in-GUI biome selector. 🔡 ⚙️ 🔺 Toggleable undeployed challenges* — the long-unimplemented TOGGLEABLE view mode now works: players get a button to show or hide undeployed challenges for themselves. ⚙️ Default text colour* — set one colour for all challenge description / reward text instead of prefixing every challenge by hand. 📊 Completion-percentage placeholders* — new placeholders for how far a player has progressed through the challenges. 🔡 ⚙️ Open the GUI off-island* — an option to let players open the Challenges GUI even when they aren't standing on their island. ### Compatibility BentoBox 3.14.0 Minecraft 1.21.x Java 21 ### Upgrading 1. As always, take backups just in case. (Make a copy of everything!) 2. Stop the server. 3. Replace the Challenges jar with this one. 4. Restart the server. 5. Review the notes below if you use undeployed challenges, custom locales, or a customised main panel. 6. You should be good to go!

Toggleable undeployed challenges: the new show/hide button lives in the player panel template (panels/main_panel.yml). Servers that already have that file won't see the button until they either delete it so it regenerates, or add the TOGGLE_UNDEPLOYED button to it by hand. Fresh installs get it automatically. VISIBLE and HIDDEN modes are unchanged.

New config keys: this release adds gui-settings.open-anywhere, gui-settings.description-color, gui-settings.reward-text-color, and a top-level include-undeployed. They are added to your config.yml automatically with safe defaults (no behaviour change).

Locale note: several locale keys were added (reward chance, biome selector, toggle button, confirmation instruction, and more). If you maintain custom translations, regenerate/merge them (e.g. via /sync-locales) so the new strings appear.

### Legend - locale files may need to be regenerated or updated. - config options have been added, renamed, or removed. - special attention needed. --- ## New Features ### Optional per-challenge reward chance [[PR #412](https://github.com/BentoBoxWorld/Challenges/pull/412)] Fixes [#76](https://github.com/BentoBoxWorld/Challenges/issues/76) Challenges can now be given a percentage chance to grant their reward on completion. This lets you build "lucky" challenges where the reward isn't guaranteed — great for repeatable challenges and loot-style gameplay. Configurable per challenge in the admin editor. ### Island level rewards [[PR #411](https://github.com/BentoBoxWorld/Challenges/pull/411)] Fixes [#279](https://github.com/BentoBoxWorld/Challenges/issues/279) Completing a challenge or level can now increase the island's level through the Level addon, so challenges can meaningfully feed into island progression instead of only handing out items/money/XP. ### Biome requirement for island challenges [[PR #419](https://github.com/BentoBoxWorld/Challenges/pull/419)] Fixes [#335](https://github.com/BentoBoxWorld/Challenges/issues/335) Island challenges gain a "Required Biomes" option: the player must be standing in one of the chosen biomes to complete the challenge. Biomes are picked from a new paginated biome selector in the admin GUI (left-click to add, right-click to clear). Biomes are stored by key, so the data stays robust across versions and unknown biomes simply never match. ### Toggleable undeployed challenges [[PR #417](https://github.com/BentoBoxWorld/Challenges/pull/417)] Fixes [#175](https://github.com/BentoBoxWorld/Challenges/issues/175) The undeployed-view-mode: TOGGLEABLE setting was previously a no-op (it behaved like VISIBLE). It's now fully implemented: in TOGGLEABLE mode the player GUI shows a button that each player uses to show or hide undeployed challenges for themselves. The default is "shown", so it starts out like VISIBLE and players can tidy their view — handy for hyping upcoming challenges while letting players hide them. ### Default colour for description and reward text [[PR #418](https://github.com/BentoBoxWorld/Challenges/pull/418)] Two new settings — gui-settings.description-color and gui-settings.reward-text-color — apply a default colour to every line of a challenge's description / reward text, so you no longer have to prefix each challenge's text with the same colour code. A colour written in the text still overrides the default. (This re-adds, in a MiniMessage-friendly form, the useful half of the old lore-formatting PR #340.) ### Challenge completion-percentage placeholders [[PR #410](https://github.com/BentoBoxWorld/Challenges/pull/410)] Fixes [#352](https://github.com/BentoBoxWorld/Challenges/issues/352) New placeholders expose how much of the available challenges a player has completed as a percentage, for use in scoreboards, tab lists, and other placeholder-driven displays. ### Open the challenges GUI while off-island [[PR #407](https://github.com/BentoBoxWorld/Challenges/pull/407)] Fixes [#349](https://github.com/BentoBoxWorld/Challenges/issues/349) A new gui-settings.open-anywhere option lets players open the Challenges GUI without being on their island. Completion itself still requires being on the island when world protection is enabled. --- ## Bug Fixes ### Locked levels no longer show the unlock message [[PR #414](https://github.com/BentoBoxWorld/Challenges/pull/414)] Fixes [#323](https://github.com/BentoBoxWorld/Challenges/issues/323) A locked level was showing its "Congratulations…" unlock message in the lore while its status still read "locked". The unlock message is now only shown once the level is actually unlocked. ### Player GUI honours the per-challenge removeWhenCompleted flag [[PR #406](https://github.com/BentoBoxWorld/Challenges/pull/406)] Fixes [#337](https://github.com/BentoBoxWorld/Challenges/issues/337) Completed one-time challenges flagged removeWhenCompleted now disappear from the player GUI as intended, instead of only respecting the global setting. ### Level completion re-checked when an admin completes challenges [[PR #408](https://github.com/BentoBoxWorld/Challenges/pull/408)] Fixes [#385](https://github.com/BentoBoxWorld/Challenges/issues/385) Completing challenges for a player through admin mode now runs the level-completion check, so admin completions correctly count toward finishing a level. ### "Ignore meta-data" compares the base potion type [[PR #409](https://github.com/BentoBoxWorld/Challenges/pull/409)] Fixes [#320](https://github.com/BentoBoxWorld/Challenges/issues/320) With the "ignore meta-data" option, potion requirements now compare the base potion type instead of treating potions as a blank item, so a required potion is matched correctly. --- ## Other Improvements * Confirmation prompts now tell players to type confirm / cancel, so import/reset/wipe confirmations are no longer a guessing game [[PR #415](https://github.com/BentoBoxWorld/Challenges/pull/415)] Fixes [#329](https://github.com/BentoBoxWorld/Challenges/issues/329) * The include-undeployed setting (whether undeployed challenges count toward level completion) is now shipped and documented in config.yml [[PR #416](https://github.com/BentoBoxWorld/Challenges/pull/416)] Fixes [#179](https://github.com/BentoBoxWorld/Challenges/issues/179) * Added tests verifying item/block/entity/money/XP are consumed correctly on completion [[PR

## What's new Challenges 1.7.0 introduces team challenges — a brand-new class of challenge built for island teams. Team challenges only appear for players who have a team, can require a share of the team to be online, and can either pool resources or ask every member to chip in. Five ready-to-use examples ship in the bundled challenge set so you can try them straight away. This release also refreshes every translation file, makes import errors easier to spot, and includes a large code-quality tidy-up. ## Highlights 🔡 Team challenges* — a new challenge class for island teams, with online-presence gating, pooled and per-member contributions, and team-wide rewards. [[PR #401](https://github.com/BentoBoxWorld/Challenges/pull/401)] 🔡 All translations refreshed* — every locale file synced with the English source, including the new team-challenge strings. [[PR #401](https://github.com/BentoBoxWorld/Challenges/pull/401)] Clearer import errors* — failures while importing challenges are now reported to you instead of being silently logged. ### Compatibility BentoBox 3.14.0+ Minecraft 1.21+, including 26.2 Java 21 ### Upgrading 1. As always, take backups just in case. (Make a copy of everything!) 2. Stop the server. 3. Replace the Challenges jar with this one. 4. Restart the server. 5. Existing challenges are unaffected — all team behaviour is opt-in and defaults to off. 6. You should be good to go!

Locale note: All translation files were regenerated for this release. If you maintain custom translations, re-check them against en-US.yml — several new keys were added (team-challenge buttons, errors, and lore).

### Legend - locale files may need to be regenerated or updated. - config options have been removed, renamed, or added. - special attention needed. --- ## New Features ### Team Challenges [[PR #401](https://github.com/BentoBoxWorld/Challenges/pull/401)] A new class of challenge that is only available to islands with a team. Team challenges can require a configurable percentage of the team to be online to complete, and support two collaborative modes: - Aggregate ("Pooled Tribute") — required items or statistics are summed across the online members. When items are consumed, the cost is split equitably across contributors ("water level" — everyone chips in equally, and anyone short gives what they have while the rest cover the difference). - Per-member ("Roll Call Feast") — every present member must contribute their own share, so no one can freeload; the configured amount is the team total, split across the members who are online. Rewards are given to every online member, completion and cooldown are shared by the whole team, and team statistic challenges only count progress earned while on the team (so a newly-recruited veteran's lifetime totals can't be borrowed). Team challenges can be shown greyed-out to soloists as a recruitment nudge, or hidden entirely. Five reference challenges — All Hands on Deck, Pooled Tribute, Synchronized Build, Combined Effort, and Roll Call Feast — ship in default.json, and the admin challenge editor gains toggles for all of the new options. --- ## Bug Fixes ### Import errors are surfaced to the user Challenge import failures were previously only written to the console log. They are now reported back to the admin running the import, with details, so problems are much easier to diagnose. --- ## Other Improvements * Synced all 14 translation files with the English reference. [[PR #401](https://github.com/BentoBoxWorld/Challenges/pull/401)] * Cleared SonarCloud findings — bug-risk fixes plus a broad low-priority code-smell cleanup, and test-suite hardening. [[PR #402](https://github.com/BentoBoxWorld/Challenges/pull/402)] * CI: added a CurseForge publish workflow and pinned the shared reusable workflow. [[PR #400](https://github.com/BentoBoxWorld/Challenges/pull/400)] * Added Minecraft 26.1.2 to the Modrinth game-versions list. [[PR #399](https://github.com/BentoBoxWorld/Challenges/pull/399)] --- ## What's Changed * Team challenges by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/401 * Clean up low-priority SonarCloud issues by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/402 * Add CurseForge publish workflow by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/400 * Add MC 26.1.2 to Modrinth game-versions by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/399 Full Changelog: https://github.com/BentoBoxWorld/Challenges/compare/1.6.1…

A hotfix release that addresses a NullPointerException flooding the server console when the web library's confirmation prompt is abandoned (e.g. after multiple clicks on a library entry, or after the inactivity timeout). ## Bug Fixes Confirmation conversations no longer NPE on abandon* — LibraryPanel and the wipe/delete prompts in the admin GUI used if (value) on a boxed Boolean, which threw a NullPointerException whenever a conversation was abandoned instead of answered (consumer.accept(null) is the documented signal for an abandon). Most visible in the web library: clicking a library entry several times before typing confirm would queue extra prompts, and every one of those would erupt with an NPE as it timed out. All six Consumer<Boolean> callsites now use Boolean.TRUE.equals(value) so abandons are silently treated as no-ops. [[PR #396](https://github.com/BentoBoxWorld/Challenges/pull/396)] ## Compatibility BentoBox API 3.14.0 Minecraft 1.21.11 Java 21 ## Upgrading 1. Stop the server (or use a plugin manager that supports addon reloads). 2. Replace BentoBox/addons/Challenges-1.6.0.jar with Challenges-1.6.1.jar. 3. Start the server. No config or locale changes are required — drop-in replacement. ## What's Changed * Fix NPE when confirmation conversations are abandoned by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/396 Full Changelog: https://github.com/BentoBoxWorld/Challenges/compare/1.6.0…

## Compatibility BentoBox API 3.12.0+ Paper Minecraft 26.1.0, 26.1.1 Minecraft 1.21.5 - 1.21.11 ## Updating 1. Stop server 2. Take a back up of the server, particularly the database 3. Replace the addon with this one 4. Delete the BentoBox/locales/Challenges/ folder so locale files can be regenerated with MiniMessage formatting. 5. Restart 6. That should be it! ## Changelog ### Legend - locale files may need to be regenerated or updated. - config options have been removed, renamed or added. - special attention needed. ## What's Changed * Converted all locale files from legacy &-codes to MiniMessage formatting * Word-wrap reward text to 30 characters in challenge/level lore for cleaner display * Improved Web Library panel: added language filter and word-wrapped descriptions * Show pending barrier icon on library button while catalog downloads * Handle malformed catalog entries gracefully in web library download * New settings for challenge menu by @stuffyerface in https://github.com/BentoBoxWorld/Challenges/pull/386 * Version 1.5.2 by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/390 ## New Downloadable Challenge Libraries Several new challenge libraries are now available for download directly from the in-game Web Library: Skyblock* — Modern Skyblock challenges with multiple progression paths for vanilla 1.21+ (EN, ZH-CN, DE, ES, RU, FR) AcidIsland* — Nautical challenge progression from Shipwrecked to Admiral (EN, ZH-CN, DE, ES, RU, FR) Poseidon* — Default challenges for the Poseidon game mode (EN, ZH-CN, DE, ES, RU, FR) These can be installed via the admin Web Library GUI — no manual file copying required. ## New Contributors * @stuffyerface made their first contribution in https://github.com/BentoBoxWorld/Challenges/pull/386 Full Changelog: https://github.com/BentoBoxWorld/Challenges/compare/1.5.1…

Compatibility

BentoBox API 3.4.0+ Minecraft 1.21.3 not backwards compatible

Updating

1. Stop server 2. Take a back up of the server, particularly the database 3. Replace the addon with this one 4. Remove / move the BentoBox/locales/Challenges/pl.yml file so it can be regenerated with correct placeholders. 5. Restart 6. That should be it!

Changelog

Legend

- locale files may need to be regenerated or updated. - config options have been removed, renamed or added. - special attention needed.

What's Changed

* New settings for challenge menu by @stuffyerface in https://github.com/BentoBoxWorld/Challenges/pull/386 * Translation fixes for Polish BentoBox/locales/Challenges/pl.yml * Console debug removed * Version 1.5.2 by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/390

New Contributors

* @stuffyerface made their first contribution in https://github.com/BentoBoxWorld/Challenges/pull/386 Full Changelog: https://github.com/BentoBoxWorld/Challenges/compare/1.5.1…

This release fixes a bug where potions in required items were just listed as Potion.

Compatibility

BentoBox API 3.2.4+ only - not backwards compatible Minecraft 1.21.3 not backwards compatible

Updating

1. Stop server 2. Take a back up of the server, particularly the database 3. Replace the addon with this one 4. Restart 5. That should be it! 6. (Optional) Create new challenges that use the new settings

Changelog

Legend

- locale files may need to be regenerated or updated. - config options have been removed, renamed or added. - special attention needed.

What's Changed

* Update ja.yml by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/381 * Add something for potions even if there is nothing in the translations by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/383 * Release 1.5.1 by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/384 Full Changelog: https://github.com/BentoBoxWorld/Challenges/compare/1.5.0…

This release requires the latest version of BentoBox (3.2.4+) to run, as it utilizes new features in BentoBox.

New Features in Challenges

Multiple Statistic Challenges

- Previously, only one statistic could be checked per challenge. Now, multiple statistics can be verified simultaneously. - Example: A challenge can now require defeating 10 zombies, 10 skeletons, and 10 creepers instead of just one type.

Expanded Island Challenges

- You can now use Block Groups and Entity Groups in addition to individual blocks or entities. - Example: A challenge could require placing 10 of any type of sign, bed, or door. - Similarly, it could involve defeating any raider, arthropod, or undead instead of specifying exact entities.

PAPI Placeholder Requirements in Other Challenges

- Challenges can now use PAPI placeholders as requirements. The challenge completes if the formula evaluates to true. - Example:

  
    %Level_aoneblock_island_level% > 100 OR %player_name% = tasty bento  
    

- String comparisons can be: - Case-sensitive: == (equals), != (not equals) - Case-insensitive: = (equals), <> (not equals)

Advancements as Challenge Requirements

- Challenges can now require Minecraft Advancements. - Players must complete an advancement (or a set of advancements) and then will be able to complete the challenge. The challenge is not automatically completed when the Advancement is achieved. - Example: A challenge could reward players for achieving "Diamonds!" and "Enchanter" advancements. After the player has those, they can request to complete the challenge. These new features provide greater flexibility in designing challenges, making gameplay more engaging and customizable! Note: as Statistics and Advancements can be achieved in other worlds, it is highly recommended to use the InvSwitcher Addon to have them become world-specific so that players have to obtain them in the game world.

Compatibility

BentoBox API 3.2.4+ only - not backwards compatible Minecraft 1.21.3 not backwards compatible

Updating

1. Stop server 2. Take a back up of the server, particularly the database 3. Replace the addon with this one 4. Restart 5. That should be it! 6. (Optional) Create new challenges that use the new settings

Changelog

Legend

- locale files may need to be regenerated or updated. - config options have been removed, renamed or added. - special attention needed.

What's Changed

* Update en-US.yml by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/369 * Add tags by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/368 * Reduce code duplication by abstracting classes by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/371 * Enable challenges to have multiple statistic requirements by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/372 * Better icons for entities by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/373 * Add permission [gamemode].challenges.waiver-add.x to addon by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/374 * Add switch to hide reward items from the GUI list. by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/375 * Added a PAPI formula option to Other challenge types. by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/376 * Adds Advancements as an option to the Other challenges by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/377 * Add string comparison for PAPI placeholders #366 by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/378 * Release 1.5.0 by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/370 Full Changelog: https://github.com/BentoBoxWorld/Challenges/compare/1.4.0…

Compatibility

BentoBox API 2.7.1 or later Minecraft 1.21.3 or later not backwards compatible

Changelog

Legend

- locale files may need to be regenerated or updated. - config options have been removed, renamed or added. - special attention needed.

What's Changed

* Edit some unfit translation by @liaosunny123 in https://github.com/BentoBoxWorld/Challenges/pull/312 * Add locale of Chinese-Hong Kong (zh-HK) by @JamesMCL44 in https://github.com/BentoBoxWorld/Challenges/pull/313 * Create plugin.yml by @BONNe in https://github.com/BentoBoxWorld/Challenges/pull/316 * Update Hungarian translation by @gitlocalize-app in https://github.com/BentoBoxWorld/Challenges/pull/301 * Add Ukrainian locale by @gitlocalize-app in https://github.com/BentoBoxWorld/Challenges/pull/326 * Add Ukrainian locale by @gitlocalize-app in https://github.com/BentoBoxWorld/Challenges/pull/325 * Fixes enchanted book meta not displayed by @BONNe in https://github.com/BentoBoxWorld/Challenges/pull/328 * Chinese translation by @gitlocalize-app in https://github.com/BentoBoxWorld/Challenges/pull/343 * French translation by @gitlocalize-app in https://github.com/BentoBoxWorld/Challenges/pull/342 * Spanish translation by @gitlocalize-app in https://github.com/BentoBoxWorld/Challenges/pull/341 * Do not change name of objects with display name by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/346 * Chinese translation by @gitlocalize-app in https://github.com/BentoBoxWorld/Challenges/pull/348 * French translation by @gitlocalize-app in https://github.com/BentoBoxWorld/Challenges/pull/347 * German translation by @gitlocalize-app in https://github.com/BentoBoxWorld/Challenges/pull/353 * French - fix placeholders by @gitlocalize-app in https://github.com/BentoBoxWorld/Challenges/pull/355 * Czech - needs placeholder fixing by @gitlocalize-app in https://github.com/BentoBoxWorld/Challenges/pull/356 * Spanish translation by @gitlocalize-app in https://github.com/BentoBoxWorld/Challenges/pull/357 * Possible fix for #326 by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/363 * Adds protection around nulls. by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/361 * #362 ordering bug by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/364 * Update to 1.21.3 by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/365 * Updated release by @tastybento in https://github.com/BentoBoxWorld/Challenges/pull/358

New Contributors

* @liaosunny123 made their first contribution in https://github.com/BentoBoxWorld/Challenges/pull/312 * @JamesMCL44 made their first contribution in https://github.com/BentoBoxWorld/Challenges/pull/313 Full Changelog: https://github.com/BentoBoxWorld/Challenges/compare/1.3.1…