Merge branch 'master' of https://github.com/Artillex-Studios/Document…

…ation

Writerside/hi.tree

@@ -115,4 +115,14 @@
         <toc-element topic="AxRewards-Commands.md"/>
         <toc-element topic="AxRewards-Configuration.md"/>
     </toc-element>
+    <toc-element topic="AxSellChest.md">
+        <toc-element topic="Commands.md"/>
+        <toc-element topic="Configuration.md"/>
+        <toc-element topic="Supported-plugins_axsc.md"/>
+    </toc-element>
+    <toc-element topic="AxMines.md">
+        <toc-element topic="Commands_axmines.md"/>
+        <toc-element topic="Configuration_axmines.md"/>
+        <toc-element topic="Placeholders_axmines.md"/>
+    </toc-element>
 </instance-profile>

Writerside/topics/AxMines.md

@@ -0,0 +1,11 @@
+# AxMines
+
+## Features:
+- Fast, doesn't affect tps
+  - Get chunk sections and modify them in parallel then sync back to main thread
+- GUI editor
+- Random rewards when breaking blocks
+- PlaceholderAPI integration
+- Auto reset based on time and percentage
+- Reset commands
+- 1.18+ support

Writerside/topics/AxSellChest.md

@@ -0,0 +1,9 @@
+# AxSellChest
+
+## Features:
+- Holograms
+- Chunk collect
+- Autosell
+- Inventory sell
+- Stacker hook
+- Bank hook

Writerside/topics/Commands.md

@@ -0,0 +1,8 @@
+# Commands
+
+|-|-|
+|Command|Description|
+|/axsc give \<player\> \<chest\> \<amount\>|Give a chest to a player|
+|/axsc reload|Reload the plugin|
+|/axsc stats|Show plugin statistics|
+|/axsc convert \<voidchest\|voidchestv2\>|Convert from VoidChest or VoidChest v2|

Writerside/topics/Commands_axmines.md

@@ -0,0 +1,15 @@
+# Commands
+
+|-|-|
+|Command|Description|Permission|
+|/mines reload|Reload the configurations|axmines.command.reload|
+|/mines wand|Get a selection wand|axmines.command.wand|
+|/mines delete \<mine>|Delete a mine|axmines.command.delete|
+|/mines list|List mines|axmines.command.list|
+|/mines redefine \<mine>|Redefine a mine|axmines.command.redefine|
+|/mines teleport \<mine>|Teleport to the teleport-location of the mine|axmines.command.teleport|
+|/mines editor|Open the editor|axmines.command.editor|
+|/mines setteleport \<mine>|Set the teleport location of the mine to your location|axmines.command.setteleport|
+|/mines create \<name>|Create a new mine named \<name>|axmines.command.create|
+|/mines reset \<mine>|Reset a mine|axmines.command.reset|
+|/mines help|Get the help message|axmines.command.help|

Writerside/topics/Configuration.md

@@ -0,0 +1,31 @@
+# Configuration
+
+## \<chest>.yml
+
+### block: (default: chest)
+
+* The block of the sellchest
+
+<warning>If you set the block to a block that is not a container, the collect functionality will not put items into the inventory!</warning>
+
+### booster: (default: 1.0)
+
+* The boost of the chest.
+
+### Inventory actions:
+
+* \[toggle\]: Toggles a setting
+    * Toggleable settings: 
+      * bank, collectchunk, autosell
+
+* \[container\]: Opens the container of the chest
+
+* \[charge\]: Charge the chest
+
+* \[close\]: Close the open inventory
+
+* \[console\]: Execute a console command, %\player\% placeholder
+
+* \[player\]: Execute a command as the player
+
+* \[message\]: Send a message to the player

Writerside/topics/Configuration_axmines.md

@@ -0,0 +1,66 @@
+# Configuration
+
+## Example configuration
+```yaml
+
+display-name: "<red>Example"
+
+contents:
+  gold_block: 11
+  diamond_block: 10
+  emerald_block: 25
+  iron_block: 10
+
+selection:
+  1: "world;10;10;10;10;10"
+  2: "world;10;10;10;10;10"
+
+teleport-location: "world;10;10;10;10;10"
+
+# To top block at player's location: 0
+# To teleport to teleport-location: 1
+# To disable, set to anything else
+teleport-on-reset: 0
+
+actionbar:
+  enabled: true
+  range: 10
+
+# For broadcast in range: >= 1
+# For whole world: 0
+# For all worlds: -1
+# For silent mode: -2
+broadcast-reset: -1
+
+# How often the mine should reset
+# 20 ticks = 1 second
+reset:
+  ticks: 12000 # (10 minutes)
+  # At what percent the mine should automagically
+  # reset set to 0 to disable
+  percent: 10
+
+random-rewards:
+  - chance: 0.001
+    blocks: # If you want it to work on any block, leave it empty, or don't even add it
+      - "diamond_block"
+      - "emerald_block"
+    items: # Item reward
+      - type: stone
+        name: "oreo"
+    commands: # Command reward
+      - "eco give <player> 100000"
+
+# The commands to run when the mine is reset
+reset-commands:
+  - "say Mine A has been reset!"
+```
+
+### Random-rewards:
+You can add as many rewards as you want, all the rewards are rolled every time,
+meaning you can get more rewards from breaking one block!
+
+* Chance: The chance of the reward
+* Blocks: The blocks on which the reward will try to be rolled
+* Items: The item rewards
+* Commands: The commands that are executed when the reward is given

Writerside/topics/Placeholders_axmines.md

@@ -0,0 +1,9 @@
+# Placeholders
+
+|-|-|
+|Placeholder|Description|
+|%axmines_blocksbroken_\<mine>%|Blocks broken in the mine|
+|%axmines_percent_<mine>%|Percent of blocks in the mine|
+|%axmines_notbroken_<mine>%|Not broken blocks in the mine|
+|%axmines_total_<mine>%|All blocks in the mine|
+|%axmines_resettime_<mine>%|Time until the reset of the mine, formatted according to the config|

Writerside/topics/Supported-Plugins.md

@@ -1,28 +1,3 @@
-# Supported Plugins
+# Supported plugins
 
-## Stacker
- - RoseStacker
- - WildStacker
-
-## Protection
- - BentoBox
- - GriefPrevention
- - IridiumSkyBlock
- - KingdomsX
- - Lands
- - SuperiorSkyBlock2
- - WorldGuard
-
-## Economy
- - Vault
- - PlayerPoints
-
-## Blocks
- - ItemsAdder
- - KGenerators
-
-## Prices
- - ShopGUIPlus
- - EconomyShopGui
- - CMI
- - Essentials
+Start typing here...

Writerside/topics/Supported-plugins_axsc.md

@@ -0,0 +1,14 @@
+# Supported plugins
+
+## Bank
+* SuperiorSkyBlock2
+
+## Economy
+* Vault
+
+## Prices
+* ShopGUIPlus
+
+## Stacker
+* WildStacker
+* RoseStacker