Updated README.md and fixed badges
https://github.com/BentoBoxWorld/BentoBox/issues/1092
This commit is contained in:
tastybento
GitHub
parent
e290a46c4e
commit
eeeccf6781
57
README.md
57
README.md
|
|
@ -2,38 +2,27 @@
|
|||
|
||||
[](https://discord.bentobox.world)
|
||||
[](https://ci.codemc.org/job/BentoBoxWorld/job/BentoBox/)
|
||||
[](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox%3Adevelop)
|
||||
[](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox%3Adevelop)
|
||||
[](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox%3Adevelop)
|
||||
[](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox%3Adevelop)
|
||||
[](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox%3Adevelop)
|
||||
|
||||
BentoBox is an expandable Minecraft **plugin** for island-type games like SkyBlock or AcidIsland.
|
||||
[](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox)
|
||||
[](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox)
|
||||
[](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox)
|
||||
[](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox)
|
||||
[](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox)
|
||||
|
||||
## About BentoBox
|
||||
|
||||
### History
|
||||
|
||||
ASkyBlock and AcidIsland were originally created by [tastybento](https://github.com/tastybento).
|
||||
These two plugins were sharing the same codebase, which grew fastly but ultimately became hard to maintain.
|
||||
[Poslovitch](https://github.com/Poslovitch) was running a Skyblock server before starting to contribute regularly on ASkyBlock's codebase.
|
||||
|
||||
Then came the idea of *completely rewriting ASkyBlock*.
|
||||
A turning point that would be called *BSkyBlock*.
|
||||
In May 2017, tastybento agreed to the idea, and Poslovitch and him spent more time developing the code of the plugin which would become *BentoBox*.
|
||||
During summer 2018, ASkyBlock's support got dropped and development was focused on the now called plugin *BentoBox*, which would then take over ASkyBlock and AcidIsland for 1.13+ servers.
|
||||
|
||||
### Description
|
||||
|
||||
BentoBox introduces a **unique Addon system** and a **powerful API** which allows for a technically **unlimited customization** of the gamemodes.
|
||||
Therefore, BentoBox **does nothing on its own**: addons and gamemodes are bringing the features.
|
||||
BentoBox is a powerful Bukkit library plugin that provides core features for island-style games like SkyBlock, AcidIsland, SkyGrid and others.
|
||||
These games are added to it via its **unique Addon system**. Further, non-game addons can provide features across games, such as challenges or warps. This enables admins to mix and match games and features to customize their server. It also enables the same code to be run
|
||||
across games, reducing bugs and speeding updates across all games. For coders,
|
||||
BentoBox has a **powerful API** allows for quick and easy development of these addons and simplifies complex aspects such as island protection, GUIs, and team management.
|
||||
|
||||
BentoBox being totally **free and open-sourced**, we are confident in seeing this platform grow and become even more powerful in the future.
|
||||
BentoBox is **[free](https://www.gnu.org/philosophy/free-sw.en.html) and open-source software** so join us to make this platform grow, become even more powerful and popular! Admins can pay to support BentoBox and Addons via donations and sponsorship.
|
||||
|
||||
Start now to create the server you've dreamed of!
|
||||
|
||||
## Addons
|
||||
These include some popular Gamemodes:
|
||||
These are some popular Gamemodes:
|
||||
* [**AcidIsland**](https://github.com/BentoBoxWorld/AcidIsland): You are marooned in a sea of acid!
|
||||
* [**BSkyBlock**](https://github.com/BentoBoxWorld/BSkyBlock): The successor to the popular ASkyBlock.
|
||||
* [**CaveBlock**](https://github.com/BentoBoxWorld/CaveBlock): Try to live underground!
|
||||
|
|
@ -63,10 +52,20 @@ A [webtool](https://bentobox-tool.herokuapp.com/) is currently being developed t
|
|||
|
||||
## What about contributing?
|
||||
|
||||
BentoBox heavily relies on [the community that gets involved in its development](https://github.com/BentoBoxWorld/BentoBox/graphs/contributors).
|
||||
Join the BentoBox [community](https://github.com/BentoBoxWorld/BentoBox/graphs/contributors).
|
||||
You don't need to know any programming language to start helping us.
|
||||
|
||||
However, your contribution **must be in agreement** with:
|
||||
You can contribute by:
|
||||
|
||||
* Donating or sponsoring the developers
|
||||
* Coding new addons
|
||||
* Adopting an Addon and maintaining it
|
||||
* Translating text for BentoBox and Addons (We use GitLocalize to make this easier)
|
||||
* Submitting good bug reports or helpful feature requests
|
||||
* Fixing bugs and submitting Pull Requests for the fixes
|
||||
|
||||
If you contribute code it **must be in agreement** with:
|
||||
* our license
|
||||
* 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)
|
||||
|
||||
|
|
@ -110,3 +109,13 @@ dependencies {
|
|||
compileOnly 'world.bentobox:bentobox:PUT-VERSION-HERE'
|
||||
}
|
||||
```
|
||||
|
||||
### History
|
||||
|
||||
[tastybento](https://github.com/tastybento) created ASkyBlock and AcidIsland that shared the same codebase. These plugins became very popular but became hard to maintain.
|
||||
[Poslovitch](https://github.com/Poslovitch) was running a Skyblock server before starting to contribute regularly to ASkyBlock's codebase. He proposed the idea of completely rewriting ASkyBlock
|
||||
to make it easier to maintain and richer in features. In May 2017, this became the *BSkyBlock* project. As development progressed it became clear that a lot of the new core features could be used by other
|
||||
island-style games and so that core functionality was split off and renamed *BentoBox* and the addon system was created. The addons for BSkyBlock and AcidIsland became very simple to develop and much smaller.
|
||||
The community started to grow and we added new game modes like SkyGrid and CaveBlock by BONNe. BONNe also took over maintenance of Challenges and Biomes and contributed to other addons.
|
||||
|
||||
In December 2019, Poslovitch launched the BentoBox collection on SpigotMC and the story continues!
|
||||
|
|
|
|||
Loading…
Reference in New Issue