Upstream
/
bentobox
mirror of https://github.com/BentoBoxWorld/BentoBox.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Improved README

This commit is contained in:
Florian CUNY 2018-12-29 18:23:57 +01:00
parent 48dcc79520
commit 3738c258cf
1 changed files with 37 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@ -1,5 +1,4 @@
BentoBox # BentoBox
========
[![Build Status](https://ci.codemc.org/buildStatus/icon?job=BentoBoxWorld/BentoBox)](https://ci.codemc.org/job/BentoBoxWorld/job/BentoBox/) [![Build Status](https://ci.codemc.org/buildStatus/icon?job=BentoBoxWorld/BentoBox)](https://ci.codemc.org/job/BentoBoxWorld/job/BentoBox/)
![Lines Of Code](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Abentobox%3Adevelop&metric=ncloc) ![Lines Of Code](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Abentobox%3Adevelop&metric=ncloc)
@ -8,47 +7,53 @@ BentoBox
![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Abentobox%3Adevelop&metric=security_rating) ![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Abentobox%3Adevelop&metric=security_rating)
![Bugs](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Abentobox%3Adevelop&metric=bugs) ![Bugs](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Abentobox%3Adevelop&metric=bugs)
BentoBox is an expandable Minecraft Spigot plugin for island-type games like SkyBlock or AcidIsland.
BentoBox is an expandable Minecraft Bukkit plugin for island-type games like SkyBlock or AcidIsland. It is designed to take over ASkyBlock and AcidIsland for 1.13+ Minecraft versions.
Admins can assemble the game or games how they like with a variety of add-ons. These include:
* BSkyBlock - the successor to the popular ASkyBlock. Don't fall! ## Addons
* AcidIsland - you are marooned in a sea of acid! Admins can assemble the game or games how they like with a variety of Addons.
* Level - an add-on to calculate your island level and show a top ten These include some popular Gamemodes:
* Challenges - an add-on that gives you challenges to accomplish * [**BSkyBlock**](https://github.com/BentoBoxWorld/BSkyBlock): the successor to the popular ASkyBlock.
* Welcome WarpSigns - an add-on that enables players to plant a warp sign * [**AcidIsland**](https://github.com/BentoBoxWorld/AcidIsland): you are marooned in a sea of acid!
Bentobox represents a turning point on ASkyBlock's history : Tastybento and Poslovitch thought up and designed this complete rewrite in order to provide a whole new way to play Skyblock and other island-style games. And these include Addons that are bringing incredible new features, such as:
* [**Level**](https://github.com/BentoBoxWorld/Level): calculate your island level and show a top ten.
* [**Challenges**](https://github.com/BentoBoxWorld/addon-challenges): gives you challenges to accomplish.
* [**WarpSigns**](https://github.com/BentoBoxWorld/addon-welcomewarpsigns): enables players to plant a warp sign and visit other player's islands.
Disclaimer And there are plenty of other official or community-made Addons you can try and use for your server!
==========
BentoBox and all subsequent addons made by the BentoBoxWorld team are being developped **as a hobby** without receiving any kind of remuneration. You will **never** have to pay to download BentoBox or any addon created by the BentoBoxWorld team or to get access to the source code.
Hereby, **you** and **only you** are wrong when you : ## Downloads
* insist that we should fix a bug within an irrational period of time;
* behave rudely;
* are asking for support whereas solutions have already been given or are easily accessible;
Bugs and Feature requests ### Webtool
========================= A [webtool](https://bentobox-tool.herokuapp.com/) is currently being developed to allow you to easily setup BentoBox and Addons on your server.
File bug and feature requests here: https://github.com/BentoBoxWorld/BentoBox/issues. Make sure that your issue is following the guidelines, otherwise it will be declined.
Note for developers ### Direct links
=================== * [Installation guide](https://github.com/BentoBoxWorld/bentobox/wiki/Install-Bentobox)
We consider Pull Requests from non-collaborators that contain actual code improvements or bug fixes. Do not submit PRs that only address code formatting because they will not be accepted. * [Download](https://github.com/BentoBoxWorld/BentoBox/releases)
Official Builds ### Developers
=============== * [Jenkins](https://ci.codemc.org/job/BentoBoxWorld/job/BentoBox/)
https://github.com/BentoBoxWorld/BentoBox/releases * [Javadocs](https://ci.codemc.org/job/BentoBoxWorld/job/BentoBox/javadoc/)
Development Builds ## What about contributing?
==================
**These development builds are not eligible to any kind of support. Use them at your own discretion or only under our approval.** *Most of them are __untested__. In the worst cases, they can even __corrupt your worlds and/or your databases__.*
Jenkins: https://ci.codemc.org/job/BentoBoxWorld/job/BentoBox/ BentoBox heavily relies on the community that gets involved in its development.
You don't need to know any programming language to start helping us.
API However, your contribution **must be in agreement** with:
=== * our [code of conduct](https://github.com/BentoBoxWorld/BentoBox/tree/master/.github/CODE_OF_CONDUCT.md)
* our [contribution guidelines](https://github.com/BentoBoxWorld/BentoBox/tree/master/.github/CONTRIBUTING.md)
### Report bugs and suggest features
Bugs and feature requests must be filed on our [issue tracker](https://github.com/BentoBoxWorld/BentoBox/issues).
### Pull requests
We consider Pull Requests from non-collaborators that contain actual code improvements or bug fixes.
Do not submit PRs that only address code formatting because they will not be accepted.
## API
Maven dependency: Maven dependency:
```xml ```xml
<repositories> <repositories>