Challenges/README.md

44 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

2019-02-12 15:16:14 +01:00
# Challenges Addon
[![Discord](https://img.shields.io/discord/272499714048524288.svg?logo=discord)](https://discord.bentobox.world)
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/)
2019-02-13 10:21:30 +01:00
2023-11-27 04:04:43 +01:00
Add-on for BentoBox to provide challenges for any BentoBox GameMode. Challenges can be to collect items, to have items or blocks nearby, to amass an amount of money or island levels, or to have accomplished some player statistic. Each challenge can reward the player with money, experience points, blocks, items, or other things, like permissions, Pre-built challenges are available and there is also a Web Library of pre-built ones. Customize them to fit your needs!
2023-11-27 04:04:43 +01:00
![Challenges](https://github.com/BentoBoxWorld/Challenges/assets/4407265/9b3c5278-3a9d-45f2-9ee1-2c1fc1199a8d)
2019-02-13 10:21:07 +01:00
## How to use
1. Place the addon jar in the addons folder of the BentoBox plugin
2. Restart the server
2019-08-30 15:29:41 +02:00
3. Edit the config.yml how you want.
4. Restart the server
2023-11-27 04:04:43 +01:00
5. Run the Admin challenges command to set up challenges for your game mode.
2019-05-04 18:31:01 +02:00
2023-11-27 04:04:43 +01:00
#### Installation
2019-05-04 18:31:01 +02:00
2023-11-27 04:04:43 +01:00
By default, challenges addon comes without any challenge or level. On first run time only Admin GUI will be accessible.
Admins can create their own challenges or import some default challenges. Default challenges contains 5 levels and 57 challenges.
There also exists a Web Library, where admins can download public challenges. It is accessible from the Admin GUI by clicking on the Web icon.
2019-02-12 15:16:14 +01:00
## Compatibility
2023-11-27 04:04:43 +01:00
- [x] BentoBok
2019-09-09 18:18:31 +02:00
- [x] BSkyBlock
- [x] AcidIsland
- [x] SkyGrid
- [x] CaveBlock
2019-05-04 18:31:01 +02:00
2023-11-27 04:06:04 +01:00
## Translations
As with most of BentoBox projects, Challenges Addon is translatable into 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 the developers via Discord and it will be added there.
Unfortunately, default challenges come only be in English, but there are different challenges libraries where everyone can share their challenges with their translations.
## Documentation
2019-05-04 18:31:01 +02:00
2023-11-27 04:04:43 +01:00
More information can be found in the docs: https://docs.bentobox.world/en/latest/addons/Challenges/
## Bugs or feature requests
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)