-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
481c0c7
commit f4aba70
Showing
1 changed file
with
40 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,55 @@ | ||
| # Upgrades Addon | ||
| Upgrades Addon | ||
| ========== | ||
| [](https://discord.bentobox.world) | ||
| [](https://ci.codemc.io/job/BentoBoxWorld/job/Upgrades/) | ||
|
|
||
| Add-on for BentoBox to provide Upgrades to upgrade an island of any BentoBox GameMode. | ||
| ## About | ||
| Add-on for BentoBox to provide Upgrades to an island of any BentoBox GameMode. | ||
|
|
||
| By default, this addon includes upgrades for island size, limits and commands | ||
|
|
||
| ## Soft Dependence | ||
|
|
||
| Upgrades addon can hook onto Vault as well as limits addon and level addon : | ||
| * Without Vault, Money cost will be ignored. | ||
| * Without Level addonn, Island level will be ignored | ||
| * Without Limits addon, Limits upgrades will not be displayed | ||
|
|
||
| ## Where to find | ||
|
|
||
| Currently Upgrades Addon is in **Early Alpha 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 Upgrades Addon is in **Alpha stage**, so it may or may not contain bugs. | ||
|
|
||
| You can download the last snapshot [here](https://ci.codemc.io/job/BentoBoxWorld/job/Upgrades/) | ||
|
|
||
| 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/Guillaume-Lebegue/IslandUpgrades/issues) | ||
| 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/Upgrades/issues) | ||
|
|
||
| ## How to use | ||
|
|
||
| For now, you must download the repo and compile the .jar yourself | ||
| Then add it to BentoBox Addons | ||
| 1. Download last snapshot [here](https://ci.codemc.io/job/BentoBoxWorld/job/Upgrades/). | ||
| 2. Then add it to BentoBox Addons. | ||
| 3. Restart the server. | ||
| 4. Edit the Config.yml how you want. | ||
| 5. Restart the server. | ||
|
|
||
| ## Config.yml | ||
|
|
||
| The config.yml has the following sections: | ||
|
|
||
| * **Disabled GameModes** - specify Game Modes where islandUpgrades will not work. | ||
| * **Range Upgrade Tiers** - ability to specify default Range upgrade tiers | ||
| * **GameMode Range Upgrade Tiers** - ability to specify Range upgrade tiers for specific game mode. | ||
| * **Range Upgrade Tiers** - specify default Range upgrade tiers. Upgrading this will augment island protection size | ||
| * **Block Limits Upgrade Tier** - specify default Block Limits tiers. Upgrading this will augment the block limits of the limits addon | ||
| * **Entity Limits Upgrade Tier** - specify default Entity Limits tiers. Upgrading this will augment the entity limits of the limits addon | ||
| * **Command Upgrade Tier** - specify default Command Tiers. You can link command to this upgrade. | ||
| * **GameMode** - ability to specify upgrade tiers for specific game mode. | ||
| * **Entity Icon** - This list the icons for Entity Upgrades | ||
| * **Command Icon** - This list the icons for Command Upgrades | ||
|
|
||
| ### Other Add-ons | ||
|
|
||
| Upgrades is an add-on that uses the BentoBox API. Here are some other ones that you may be interested in: | ||
|
|
||
| * [**Addons**](https://github.com/BentoBoxWorld/BentoBox/blob/develop/ADDON.md) | ||
|
|
||
| Bugs and Feature requests | ||
| ========================= | ||
| File bug and feature requests here: https://github.com/BentoBoxWorld/Upgrades/issues |