Upstream/addon-challenges
1
0
Fork 0
mirror of https://github.com/BentoBoxWorld/Challenges.git synced 2024-11-30 22:44:08 +01:00
Code Issues Projects Releases Wiki Activity

Update ReadMe file.

Browse Source
This commit is contained in:
BONNe 2019-09-09 19:18:31 +03:00
parent e83f906581
commit 0ed4eaa18a
1 changed files with 9 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -7,13 +7,13 @@ Add-on for BentoBox to provide challenges for any BentoBox GameMode.
## Where to find ## 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. 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.7.5**, and you can download it from [Release tab](https://github.com/BentoBoxWorld/Challenges/releases) Latest official **Beta Release is 0.8.0**, and you can download it from [Release tab](https://github.com/BentoBoxWorld/Challenges/releases)
But it will work with BentoBox 1.5.0 only. But it will work with BentoBox 1.6.x and BentoBox 1.7.x.
Latest development build will work with **BentoBox 1.7.0**, as it contains new functionality, that is not in 1.6 release. 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/). **Nightly builds** are available in [Jenkins Server](https://ci.codemc.org/job/BentoBoxWorld/job/Challenges/lastStableBuild/).
Be aware that 0.8.0-SNAPSHOT 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". 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) 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)
@ -37,36 +37,11 @@ Admins can create their own challenges or import some default challenges, which
## Compatibility ## Compatibility
- [x] BentoBox - 1.7.0 version - [x] BentoBox - 1.6.x and 1.7.x versions
- [x] BSkyBlock - 1.6.0 version - [x] BSkyBlock
- [x] AcidIsland - 1.6.0 version - [x] AcidIsland
- [x] SkyGrid - 1.6.0 version - [x] SkyGrid
- [x] CaveBlock - 1.6.0 version - [x] CaveBlock
## Config.yml
As most of BentoBox addons, config can be edited only when server is stopped. Otherwise all changes will be overwritten by server.
The config.yml has the following sections:
* **Commands** - ability to enable */challenges* command. This option change is possible only via configuration and requires server restart.
To enable, you should change `single-gui` to `true`.
* **History** - ability to enable completion history storing in player data object.
To enable, you should change `store-history-data` to `true`.
It is possible to change life-span of history data in days. (0 means that data will not be removed)
* **GUI Settings** - ability to change some options that are visible only in challenges GUI.
* Remove non-repeatable challenges from the challenge GUI when complete. Default is false.
* Add enchanted glow to completed challenges. Default is true.
* Locked level icon is displayed for locked levels.
* Free challenges location - You can decide, either free challenges will be at the top, or at the bottom.
* Description line length - allows to specify maximal line length in GUI icon descriptions.
* Challenge Description structure - allows to modify structure of challenge description.
* Level Description structure - allows to modify structure of Level description.
* **Store mode** - ability to store challenges completion per island or per player.
To enable storing challenges data per island change `store-island-data` to `true`. ATTENTION: progress will be lost on this option change.
* **Reset Challenges** - if this is true, player's challenges will reset when they reset an island or if they are kicked or leave a team. Prevents exploiting the challenges by doing them repeatedly. Default is true
* **Broadcast** - ability to broadcast 1st time challenge completion messages to all players. Change to false if the spam becomes too much. Default is true.
* **Title** - ability to enable showing Title screen on first challenge completion or level completion.
* **Disabled GameModes** - specify Game Modes where challenges will not work.
## Information ## Information