addon-challenges/README.md

# Challenges Addon
[![Discord](https://img.shields.io/discord/272499714048524288.svg?logo=discord)](https://discord.bentobox.world)
[![Build Status](https://ci.codemc.org/buildStatus/icon?job=BentoBoxWorld/Challenges)](https://ci.codemc.org/job/BentoBoxWorld/job/Challenges/)

Add-on for BentoBox to provide challenges for any BentoBox GameMode. 

## Where to find

Currently Challenges Addon is in **Beta stage**, so it may or may not contain bugs... a lot of bugs. Also it means, that some features are not working or implemented. 
Latest official **Beta Release is 0.8.1**, and you can download it from [Release tab](https://github.com/BentoBoxWorld/Challenges/releases)
But it will work with BentoBox 1.6.x and BentoBox 1.7.x.

Latest development builds will be based on **Minecraft 1.14.4** and **BentoBox 1.8.0**.
**Nightly builds** are available in [Jenkins Server](https://ci.codemc.org/job/BentoBoxWorld/job/Challenges/lastStableBuild/).

Be aware that 0.8.0 stores data differently than it is in 0.7.5 and below. It will be necessary to migrate data via command `/[gamemode_admin] challenges migrate`.

If you like this addon but something is missing or is not working as you want, you can always submit an [Issue request](https://github.com/BentoBoxWorld/Challenges/issues) or get a support in Discord [BentoBox ![icon](https://avatars2.githubusercontent.com/u/41555324?s=15&v=4)](https://discord.bentobox.world)

## Translations

As most of BentoBox projects, Challenges Addon is translatable in any language. Everyone can contribute, and translate some parts of the addon in their language via [GitLocalize](https://gitlocalize.com/repo/2896).
If your language is not in the list, please contact to developers via Discord and it will be added there.
Unfortunately, default challenges come only in English translation. But with version 0.8.0 there will be access to different challenges libraries, where everyone could share their challenges with their translations. More information will come soon.

## How to use

1. Place the addon jar in the addons folder of the BentoBox plugin
2. Restart the server
3. Edit the config.yml how you want.
4. Restart the server

#### Challenges

By default, challenges addon comes without any challenge or level. On first runtime only Admin GUI will be accessible. 
Admins can create their own challenges or import some default challenges, which importing also are available via Admin GUI. Default challenges contains 5 levels and 57 challenges.
There exist also Web Library, where users can download public challenges. It is accessible with Admin GUI by clicking on Web icon.

## Compatibility

- [x] BentoBox - 1.6.x and 1.7.x versions
- [x] BSkyBlock
- [x] AcidIsland
- [x] SkyGrid 
- [x] CaveBlock

## Information

More information can be found in [Wiki Pages](https://github.com/BentoBoxWorld/Challenges/wiki).
Update ReadMe a bit. 2019-02-12 15:16:14 +01:00			`# Challenges Addon`
Update ReadMe Add correct discord link Set correct Beta version. 2019-02-18 07:28:55 +01:00			`[![Discord](https://img.shields.io/discord/272499714048524288.svg?logo=discord)](https://discord.bentobox.world)`
Update ReadMe file 2019-02-13 10:21:07 +01:00			`[![Build Status](https://ci.codemc.org/buildStatus/icon?job=BentoBoxWorld/Challenges)](https://ci.codemc.org/job/BentoBoxWorld/job/Challenges/)`
Update README.md 2019-02-13 10:21:30 +01:00
Update ReadMe a bit. 2019-02-12 15:16:14 +01:00			`Add-on for BentoBox to provide challenges for any BentoBox GameMode.`
Added instructions on how to use the addo-on. https://github.com/BentoBoxWorld/addon-challenges/issues/31 2018-11-26 06:32:09 +01:00
Update ReadMe file 2019-02-13 10:21:07 +01:00			`## Where to find`

			`Currently Challenges Addon is in Beta stage, so it may or may not contain bugs... a lot of bugs. Also it means, that some features are not working or implemented.`
Bug fix release (#228) * Fix issue when users could not select non-block items as icons for challenges and levels. (#190) * English update (#193) * Organized imports * Minor code cleanup * Updated English locale file. * Translate zh-CN.yml via GitLocalize (#188) * Make default translation looking a bit nicer (#192) * Make default translation looking a bit nicer * Updating a few friendly names and rewording some phrases * Add generic .gitignore * Fix novice level Update `chiseledmaker` name in `novice` level. * Adapt literal style (#197) Improve translations and process as a YAML string. * Test coverage (#199) * Test coverage for Challenges Command * Added CompleteChallengeCommand test class * Added Utils test class * Added ChallengesGUI test class * Fix code smells from sonarcloud analysis * Added .gitignore * Added Travis CI config file * WIP ChallengesManager Test class * Added ChallengesManager test class * Removed debug * Removed code smells. * Added ChallengesAddon test class. * Added onDisbale test * Added new TryToComplete test class - WIP Covers inventory challenges. * Added Island Challenge entity tests to TryToComplete test class * Fix a bug with challenge deletion. If challenge has been left in a level, then system did not remove challenge from it and was kept as ghost challenge, preventing from completing level. * Fixes tests * Updated travis.yml * All strings to spanish (#200) * Translate es.yml via GitLocalize * Translate es.yml via GitLocalize * Translate es.yml via GitLocalize * Fix LevelListRequestHandler. This handler did not return list of strings but list of challenge levels, that is incorrect. Not it should work correctly. * Create ro.yml * Create id.yml * Remove blanks files now that GitLocalize is fixed. * Initial Russian translation (#207) * Translate ru.yml via GitLocalize Co-authored-by: @mt-gitlocalize @IPeredero @LoveBiscuit * Changed build character from # to b * Add German translation (#210) * Translate de.yml via GitLocalize * Translate de.yml via GitLocalize * Translate de.yml via GitLocalize Co-authored-by: xXjojojXx <36734820+xXjojojXx@users.noreply.github.com> Co-authored-by: FunnysBanana <51290016+FunnysBanana@users.noreply.github.com> Co-authored-by: mt-gitlocalize <mt@gitlocalize.com> * Czech translation. Credit @Polda18 * Added a uniqueId sanitization when creating challenges/levels This will help fixing issues with spaces, hyphens and accents in non-English languages. * Fixes bug with checking entities in nether and end (#219) https://github.com/BentoBoxWorld/Challenges/issues/218 Adds test case to check for compliance. * Add 7 new placeholders for Challenges Addon. - `[gamemode]_challenge_total_completion_count` returns number of sum of challenge completions for user. - `[gamemode]_challenge_completed_count` returns number of completed challenges (at least once) for user. - `[gamemode]_challenge_uncompleted_count` returns number of uncompleted challenges for user. - `[gamemode]_challenge_completed_level_count` returns number of completed levels for user. - `[gamemode]_challenge_uncompleted_level_count` returns number of uncompleted levels for user. - `[gamemode]_challenge_unlocked_level_count` returns number of unlocked levels for user. - `[gamemode]_challenge_locked_level_count` returns number of locked levels for user. Fixes #224 * Add 2 new placeholders: - `[gamemode]_challenge_latest_level_name` returns latest unlocked challenge level name - `[gamemode]_challenge_latest_level_id` returns latest unlocked challenge level id Fixes #226 * Fix broken tests due to placeholder additions. https://github.com/BentoBoxWorld/Challenges/commit/b5ecffb725d78c154f469d7e2868574ca7ecff30 https://github.com/BentoBoxWorld/Challenges/commit/2958ca8b6c98f9c8d389aa93c4a2846f578fff43 * Added default perms for aoneblock * Downgrade to 0.8.1 version * Add option to quit from conversation by writing "cancel" in chat. Move sanitizeInput to a GuiUtil class. * Change latest version to 0.8.1 2020-04-22 00:19:46 +02:00			`Latest official Beta Release is 0.8.1, and you can download it from [Release tab](https://github.com/BentoBoxWorld/Challenges/releases)`
Update ReadMe file. 2019-09-09 18:18:31 +02:00			`But it will work with BentoBox 1.6.x and BentoBox 1.7.x.`
Update ReadMe file 2019-02-13 10:21:07 +01:00
Update ReadMe file. 2019-09-09 18:18:31 +02:00			`Latest development builds will be based on Minecraft 1.14.4 and BentoBox 1.8.0.`
Update ReadMe a bit. 2019-08-28 12:11:03 +02:00			`Nightly builds are available in [Jenkins Server](https://ci.codemc.org/job/BentoBoxWorld/job/Challenges/lastStableBuild/).`

Update README.md 2019-09-09 18:22:02 +02:00			Be aware that 0.8.0 stores data differently than it is in 0.7.5 and below. It will be necessary to migrate data via command `/[gamemode_admin] challenges migrate`.
Update ReadMe file 2019-02-13 10:21:07 +01:00
Update ReadMe Add correct discord link Set correct Beta version. 2019-02-18 07:28:55 +01:00			`If you like this addon but something is missing or is not working as you want, you can always submit an [Issue request](https://github.com/BentoBoxWorld/Challenges/issues) or get a support in Discord [BentoBox ![icon](https://avatars2.githubusercontent.com/u/41555324?s=15&v=4)](https://discord.bentobox.world)`
Update ReadMe file 2019-02-13 10:21:07 +01:00
Add translation part 2019-09-03 20:43:59 +02:00			`## Translations`

			`As most of BentoBox projects, Challenges Addon is translatable in any language. Everyone can contribute, and translate some parts of the addon in their language via [GitLocalize](https://gitlocalize.com/repo/2896).`
			`If your language is not in the list, please contact to developers via Discord and it will be added there.`
			`Unfortunately, default challenges come only in English translation. But with version 0.8.0 there will be access to different challenges libraries, where everyone could share their challenges with their translations. More information will come soon.`

Added instructions on how to use the addo-on. https://github.com/BentoBoxWorld/addon-challenges/issues/31 2018-11-26 06:32:09 +01:00			`## How to use`

			`1. Place the addon jar in the addons folder of the BentoBox plugin`
			`2. Restart the server`
Update README.md 2019-08-30 15:29:41 +02:00			`3. Edit the config.yml how you want.`
			`4. Restart the server`
Update ReadMe with newest information. 2019-05-04 18:31:01 +02:00
			`#### Challenges`

			`By default, challenges addon comes without any challenge or level. On first runtime only Admin GUI will be accessible.`
Update README.md 2019-08-30 15:28:06 +02:00			`Admins can create their own challenges or import some default challenges, which importing also are available via Admin GUI. Default challenges contains 5 levels and 57 challenges.`
Update README.md 2019-09-09 18:21:30 +02:00			`There exist also Web Library, where users can download public challenges. It is accessible with Admin GUI by clicking on Web icon.`
Update ReadMe a bit. 2019-02-12 15:16:14 +01:00
			`## Compatibility`

Update ReadMe file. 2019-09-09 18:18:31 +02:00			`- [x] BentoBox - 1.6.x and 1.7.x versions`
			`- [x] BSkyBlock`
			`- [x] AcidIsland`
			`- [x] SkyGrid`
			`- [x] CaveBlock`
Update ReadMe with newest information. 2019-05-04 18:31:01 +02:00
			`## Information`

			`More information can be found in [Wiki Pages](https://github.com/BentoBoxWorld/Challenges/wiki).`