# Installation

CustomOreGen works best along with a supported SkyBlock plugin on the list below.

Without a SkyBlock plugin, CustomOreGen would use the permission of the closest player mining on the generator.

Download the latest version (opens new window) jar-File and place it into your plugin folder, then restart or reload your server.

# Supported SkyBlock plugins

Altought there are hooks implemented for all these Skyblock plugin, we found that BentoBox works best with CustomOreGen.

# Adding your own SkyBlock hook

If you're an author of a SkyBlock, you can add your hook implementation in this package (opens new window) and create a pull request. There are basically four methods to add:

public interface SkyblockAPIHook {
	/**
	 * Returns the island level for a defined player uuid
	 * 
	 * @param uuid UUID of the island owner
	 * @param in World world of the island
	 * @return island level
	 */
	public int getIslandLevel(UUID uuid, String inWorld);
	
	/**
	 * Gets the owner of an island on a certain location
	 * 
	 * @param loc location to check for island
	 * @return island owner UUID
	 */
	public Optional<UUID> getIslandOwner(Location loc);
	
	/**
	 * Obtains the names of the skyblock worlds
	 * 
	 * @return the names of the skyblock worlds
	 */
	public String[] getSkyBlockWorldNames();
	
	/*
	 * Calls the specific SkyBlock-API to make it aware of a block placement
	 * 
	 */
	public void sendBlockAcknowledge(Block block);
}