|
|
@@ -1,23 +1,19 @@
|
|
|
-<!-- TITLE: Advanced Ore Gen -->
|
|
|
-<!-- SUBTITLE: A simple way to change the ore generator! -->
|
|
|
-
|
|
|
# Advanced Ore Gen
|
|
|
-**A simple way to change the ore generator**
|
|
|
+**A simple way of changing the default cobblestone generator**
|
|
|
|
|
|
# Features
|
|
|
-* nice looking GUI / Inventory
|
|
|
-* no config.yml needed
|
|
|
-* multiple generators presets for different permissions
|
|
|
-* support for sub ids
|
|
|
-* works with ASkyBlock, AcidIsland, uSkyBlock, IslandWorld, SkyblockEarth and Bentobox.
|
|
|
+* The whole configuration is made using the GUI
|
|
|
+* No config.yml needed
|
|
|
+* Multiple generator presets for different **permissions** or **levels**
|
|
|
+* Support for sub ids, so all block types are supported
|
|
|
+* Works with most Skyblock plugins: ASkyBlock, AcidIsland, uSkyBlock, IslandWorld, SkyblockEarth and Bentobox.
|
|
|
|
|
|
# Installation
|
|
|
|
|
|
-There are some steps needed before AdvancedOreGen can be used.
|
|
|
+### Choose a SkyBlock plugin
|
|
|
|
|
|
-### pre requirements
|
|
|
+Before getting started, you need to have one of these plugins installed on your server:
|
|
|
|
|
|
-Before getting started, you need to have at least one of these plugins installed on your server:
|
|
|
* ASkyBlock (by tastybento)
|
|
|
* AcidIsland (by teastybento)
|
|
|
* uSkyBlock (by R4zorax)
|
|
|
@@ -25,16 +21,17 @@ Before getting started, you need to have at least one of these plugins installed
|
|
|
* SkyblockEarth
|
|
|
* BentoBox (Along with the Level Addon)
|
|
|
|
|
|
-### installation of the .jar file
|
|
|
+### Installation of the .jar file
|
|
|
+
|
|
|
+1. Download the plugin .jar file that can be found at the following link: https://www.spigotmc.org/resources/advancedoregen.40527/
|
|
|
+2. Drop the .jar file in your plugin folder
|
|
|
+3. Restart your server
|
|
|
|
|
|
-1. download the plugin .jar file that can be found at the following link: https://www.spigotmc.org/resources/advancedoregen.40527/
|
|
|
-2. drop the .jar file in your plugin folder
|
|
|
-3. restart your server
|
|
|
+# Setting up a generator
|
|
|
|
|
|
-# Getting Started & Configuration
|
|
|
-The whole configuration is made through the GUI and by using certain commands.
|
|
|
+The whole configuration is made through the GUI or alternatively by using commands.
|
|
|
|
|
|
-### general generator behavior
|
|
|
+### Understanding the generator mechanics
|
|
|
|
|
|
The plugin allows you to customize different generator presets for certain permission, thus, for instance, you're able to create a default generator generating cobblestone and a vip generator creating cobblestone and gold:
|
|
|
|
|
|
@@ -43,16 +40,16 @@ The plugin allows you to customize different generator presets for certain permi
|
|
|
|
|
|
Generator #1 was set up with the permission `oregen.default` and Generator #2 with `oregen.vip`, therefor you need to provide the respective permission to your players.
|
|
|
|
|
|
-Assuming the island owner has the permission `oregen.vip` and farms at a cobblestone generator, then the player would get the last configuration preset for which the player has permission.
|
|
|
-That means the plugin basically iterates from left to right and checks if the player has permission and stops at the last generator.
|
|
|
+Assuming the island owner has the permission `oregen.vip` and mines at a cobblestone generator, then the player will get the last configuration preset for which the player has permission for.
|
|
|
+That means the plugin basically iterates from left to the right and checks if the player has permission and stops at the last generator the player has permission for.
|
|
|
|
|
|
Moreover, the plugin chooses the generator by the island owner's permission, not by the player that is mining.
|
|
|
|
|
|
-When clicking the repeater (4), the plugin will turn into **level mode**. Level mode means that the corresponding generator is choosen by the island level of the owner.
|
|
|
+When clicking the repeater (4), the plugin will turn into **level mode**. Level mode means that the corresponding generator is choosen by the corresponding island level of the owner.
|
|
|
|
|
|
-### creating new generator presets
|
|
|
+### Creating new generator presets
|
|
|
|
|
|
-You can add new generators and it's permission by typing the following exemplary commands, or by selecting the wooden button item (3).
|
|
|
+You can add new generators and it's permission by typing the following exemplary commands, or by selecting the wooden button item in the main GUI(3).
|
|
|
|
|
|
```yaml
|
|
|
/oregen generator add default oregen.default
|
|
|
@@ -68,26 +65,26 @@ After that, you may edit both generators by typing this command:
|
|
|
/oregen edit
|
|
|
```
|
|
|
|
|
|
-Now the GUI where you can choose the generator which you want to edit appears:
|
|
|
-
|
|
|
-
|
|
|
+Now the GUI where you can choose the generator which you want to edit appears. (See last image).
|
|
|
|
|
|
Another GUI will pop up if you select a generator where you can put the blocks you want to be generated:
|
|
|
|
|
|
-
|
|
|
+
|
|
|
|
|
|
-The gold nugget indicates the current percentage, which should always be at 100.0, otherwise the plugin wouldn't work correctly.
|
|
|
+The emerald indicates the current percentage, which should always be at 100.0, otherwise the plugin wouldn't work correctly.
|
|
|
|
|
|
Let's say we want this generator to create 50% cobblestone and 50% iron ore, we need to proceed the following steps:
|
|
|
1. select a cobblestone block and an iron ore block from your inventory (Add it before editing).
|
|
|
-2. click on each block in order to change the percentage; a sign will be opened, put 50 in it
|
|
|
+2. click on each block in order to change the percentage; an anvil will be opened, put 50 in it
|
|
|
3. voila, your percentage should now be at 100.0.
|
|
|
|
|
|
-
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
|
|
|
-
|
|
|
+Now you're ready to use the generator and you should now be able proceeding the same steps for the VIP generator!
|
|
|
|
|
|
-Now you're ready to go and you are now able to customize the vip generator!
|
|
|
+# Misc
|
|
|
|
|
|
### AFK feature
|
|
|
|
|
|
@@ -105,13 +102,14 @@ By default, the player is handled as AFK after 20 minutes. Keep in mind that you
|
|
|
|
|
|
|
|
|
# Commands
|
|
|
-There're some commands for managing and editing different generators.
|
|
|
-
|
|
|
-**Basic commands:**
|
|
|
-`/oregen edit` - opens the GUI where you can choose the generator to edit
|
|
|
-`/oregen edit <name>` - direct edits a generator (skips the selection GUI)
|
|
|
|
|
|
-**Generator editing commands:**
|
|
|
+There're some commands for managing and editing different generators, but as already said, you can purely use the GUI!
|
|
|
|
|
|
-`/oregen generator add <name> <permission>` - adds a new generatore preset with a defined permission
|
|
|
-`/oregen generator remove <name>` - removed a generator preset
|
|
|
+| Command | Permission | Description |
|
|
|
+|----------------------------------------------------------|----------------------|------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
+| /oregen edit | advancedoregen.admin | main GUI, lets you add new generators and edit other generators |
|
|
|
+| /oregen edit name> | advancedoregen.admin | directly edits a generator |
|
|
|
+| /oregen generator add <name> <permission> [level] | advancedoregen.admin | adds a new generator |
|
|
|
+| /oregen generator remove <name> | advancedoregen.admin | removes a generator |
|
|
|
+| /oregen generator set <name> <permission> [island level] | advancedoregen.admin | modifies an existing generator |
|
|
|
+| /oregen setmode [permission/islandlevel] | advancedoregen.admin | sets the criteria for choosing a generator regarding the permission of the island leader, or the island level. Default: permission |
|
