# Custom Ore Generator
**Welcome to CustomOreGen! CustomOreGen gives you the ability to customize your SkyBlock server's cobblestone generator!**

![](/media/CustomOreGenerator-Cobble.png) ![](/media/CustomOreGenerator-DiamondOre.png)
# Features
* Different generator presets based on permission nodes and/or island levels
* Compatibile with BentoBox, ASkyBlock, AcidIsland, and uSkyBlock
* Configurable spawning rate of any block
* Item Sub IDs are supported
* Open Source: [Source](https://github.com/mastercake10/CustomOreGen) 

# Installation
#### Choose a SkyBlock plugin

In order to run CustomOreGen, a SkyBlock plugin needs to be installed and running using Spigot 1.7-1.13. If you are using the BentoBox SkyBlock plugin, make sure you have the "Level-Addon" installed to have generators be unlocked using island level.

* BentoBox (by Tastybento) 
* ASkyBlock (by Tastybento)
* AcidIsland (by Tastybento)
* uSkyBlock (by R4zorax)

#### Downloading Custom Ore Generator

1. Download the CustomOreGen plugin [here](https://www.spigotmc.org/resources/customoregen.9532/).
2. Place the CustomOreGen.jar file into your server's plugin folder.
3. Restart your server (Using the /Reload command is not recommended!)

# Creating a Generator
#### Important notices:

* When creating generators, each category should be named "generator1", "generator2", etc. 

* 1.13 users: Make sure to use Bukkit material (block) names when choosing blocks in a generator. A list of the Bukkit material names can be found [here](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html).
 
* A generator category must include a 100.0% spawnrate. For example, in the screenshot below, STONE has a 50.0% of being produced, SANDSTONE has a 40.0% chance of being produced, and IRON_ORE has a 10.0% chance of being produced, equaling the 100.0% required (50.0% + 40.0% + 10.0% = 100.0%).

![](/media/CustomOreGenConfig.png)

#### Unlocking Generators using Island Level and Permissions
* When unlocking a generator using permission nodes, the same generator can only be used by all island members if the island owner has the permission. Though, if the island owner goes offline, the default generator in the configuration file will be used.

* When unlocking a generator using island level, the generator will only apply to all island members unless the island owners goes offline. The default generator in the configuration file will be used when the island owner is not online.

![](/media/CustomOreGenUnlock.png)

# Commands
| Command | Permission | Description |
| -------- | -------- | -------- |
| /CustomOreGen     | CustomOreGen.admin     | Reloads the configuration file     |