wip

docs/README.md

@@ -0,0 +1,53 @@
+# :book: Wiki :
+Welcome to the official wiki of **Protected DebugStick** !
+
+<br>
+
+<!-- tabs:start -->
+
+#### **Introduction**
+
+You just downloaded the plugin ? Thank you ! :tada:
+
+You must have many questions and this is the best place to give you answers. I hope that after
+you reading you'll have no answer anymore.
+
+### Where to go now ?
+The best place is the **Table of Contents** to have an explanations about each section of the wiki.
+
+
+### **Table of Contents**
+#### :house: Home
+````
+It's where you are !
+````
+#### :feather: General information
+````
+Some information about the plugin. 
+If you didn't install it, it's the place where you should go.
+````
+#### :checkered_flag: Getting started
+````
+How to install the plugin ? 
+How to make it work on your server ?
+````
+#### :book: Config
+##### :file_folder: General config
+```
+All you have to know to configure the config.yml.
+```
+##### :thought_balloon: Messages config
+```
+All you have to know to configure the messages.yml.
+```
+#### :mag: Properties
+```
+All explanations about each property.
+```
+#### :man_technologist: Contributing
+```
+You want to contribute to the plugin ? Thank you ! 
+You'll find some guidelines and info how does the plugin is structured.
+```
+
+<!-- tabs:end -->

docs/_coverpage.md

@@ -0,0 +1,16 @@
+<!-- _coverpage.md -->
+
+<p align="center">
+  <img width="300" height="300" src="https://raw.githubusercontent.com/MachiganMC/ProtectedDebugStick/master/plugin/src/main/resources/icon.png">
+</p>
+
+# Protected DebugStick
+
+> A plugin that adds a legit debug stick for survival servers
+
+
+[GitHub](https://github.com/MachiganMC/ProtectedDebugStick)
+[Spigot](https://www.spigotmc.org/resources/protected-debug-stick.102630/)
+[Get Started](#wiki-)
+
+![color](#f0f0f0)

docs/_sidebar.md

@@ -0,0 +1,17 @@
+* :rocket: Getting Started
+  * [:house: Home](/ "PDS | Home")
+  * [:feather: General information](/general-information/ "PDS | General information")
+
+<br>
+
+* :book: Configuration 
+
+  * [:file_folder: `config.yml`](/config/config/ "PDS | Config file")
+  * [:thought_balloon: `messages.yml`](/config/messages/ "PDS | Messages file")
+
+<br>
+
+* :books: Advanced knowledge
+
+  * [:keyboard: Commands](/advanced/commands/ "PDS | Commands")
+  * [:lock: Permissions](/advanced/permissions/ "PDS | Permission")

docs/advanced/commands/README.md

@@ -0,0 +1,68 @@
+# :keyboard: Commands
+In fact, there is only one command ... But with a lot of arguments !
+The command is ``/pds`` or if you have time to spend to write a long command `/protected-debug-stick`.
+
+!> We'll not see the permissions required to use these arguments, check the [Permissions](/advanced/permission/)'s page to get some informations.
+But you have to know that by default, all arguments are accessible only by op.
+
+<!-- tabs:start -->
+
+## **:gift: Give**
+
+### :keyboard: Command 
+``/pds give <player> [basic|infinite|inspector] <durability>``
+
+### :information_source: Explanation
+This command allows you to give one of the three items of the plugin to another player.
+
+### :speech_balloon: Arguments
+- **Player** : This argument defines which player will receive the item.
+- **Durability** : This argument is necessary when the item is the "*basic*", it defines the base durability the Basic DebugStick will have.
+
+## **:arrows_counterclockwise: Reload-config**
+
+### :keyboard: Command
+``/pds reload-config``
+
+### :information_source: Explanation
+This command allows you to reload the config after you edit it. It reloads the base config and the message config.
+
+## **:file_folder: Load**
+
+### :keyboard: Command
+``/pds load <file>``
+
+### :information_source: Explanation
+Imagine that you have deleted by accident a file of the plugin ... This command is made for you !<br>
+It give you the opportunity to load in the plugin folder any file of the plugin.
+
+### :speech_balloon: Arguments
+The tabcompleter will help you the list of the files that can be loaded, but you can found the list 
+[here](https://github.com/MachiganMC/ProtectedDebugStick/tree/master/plugin/src/main/resources) (*just ignore the `.png` files*).
+
+## **:bricks: Chunk**
+
+### :keyboard: Command
+``/pds chunk <action>``
+
+### :information_source: Explanation
+Before explaining the command, you have to know a little internal thing about the plugin ...
+
+You know that the plugin prevents changed block from being edited by natural changements (*e.g. the crops from growing*). But how the plugin does that ?
+
+It stores the list of unmodifiable blocks in the chunk data, and when there is modification that could appear, the plugin will check if the location of the block is
+present in the current chunk data (*in fact, it's more complexe, there is a cache system, but we'll keep it simple !*).
+
+Now we know that what is the purpose of the command ?<br>
+To know and edit information about the unmodifiable blocks in the current chunk. 
+
+### :speech_balloon: Arguments
+#### :information_source: Info
+If you execute the command ``/pds chunk info``, you'll have the list of all unmodifiable block presents in the chunk.
+
+### :wastebasket: Clear
+The command ``/pds chunk clear`` remove all unmodifiable blocks from the list of chunk. So, all blocks will be like before the use of the **DebugStick**.
+
+<!-- tabs:end -->
+
+<div id="preventToc"></div>

docs/advanced/permissions/README.md

@@ -0,0 +1,94 @@
+# :lock: Permissions
+Like every plugin, **Protected DebugStick** proposes you a list of permissions
+
+<!-- tabs:start -->
+### **:information_source: Explanations**
+
+## :door: General permission
+Want to have access to all content about the plugin ? the permission is ``pds.*``.
+
+## :arrows_counterclockwise: Version
+The plugin has a system to notify when a new version of the plugin is available. If you have the permission ``pds.version``, you'll receive
+a message when you'll connect and there is a new version.
+
+## :keyboard: Commands
+To access to all arguments of the command, give you the permission ``pds.commands.*``.
+
+!> Remember to check the command's page to see details of each command, because this page it's not the place to explain them.
+
+### :zap: Use 
+The permission ``pds.command.use`` is a base permission to use the command `/pds`. In addition, to see the argument in the tab completion, this
+permission is needed.
+
+### :bricks: Chunk
+To have access to all argument of the ``/pds chunk`` argument you can use the permission `pds.command.chunk.*`. Alternatively, if you want to target a specific argument :
+- ``/pds chunk info`` : `pds.command.chunk.info`
+- ``/pds chunk clear`` : `pds.command.chunk.clear`
+
+### :heavy_plus_sign: Other argument
+|Command|Permission|
+|---|---|
+|`/pds give`|`pds.command.use`|
+|`/pds reload-config`|`pds.command.reload-config`|
+|`/pds load`|`pds.command.load`|
+
+## :package: Items
+For each item you'll see there are always two more permissions : ``.see`` is the left click use of the item and `.edit` right click.<br>
+If you want to have access to all uses of all items, you'll have to have the permission ``pds.items.*``. And if you want to give access to all uses of a specific 
+item, give the permission ``pds.<item>.*``.
+- ``pds.item.basic.`` : by default, all players have access.
+- ``pds.item.infinite.``
+- ``pds.item.inspector.``
+
+## :construction: Bypass
+You should know that there are some restrictions like the blacklists or the territories. They are useful but as an administrator of a server you don't want to be
+restricted by these functionalities. These permissions are made for you !<br>
+If you want to bypass all restrictions, give you the permission ``pds.bypass.*``.
+
+### :no_entry: Blacklists
+If you want to bypass all blacklist of the plugin, give you the permission ``pds.bypass.blacklist.*``.<br>
+For specific blacklist :
+- Materials : ``pds.bypass.blacklist.material``
+- Worlds : ``pds.bypass.blacklist.world``
+
+### :world_map: Territory block
+To bypass the constraint by territory plugin use the permission ``pds.bypass.plugin-block``.
+
+## :mag: Properties
+I will not describe all property permissions. If you want to know a permission for a specific property, check the page of the property.
+
+### **:triangular_ruler: Schema**
+A little diagram to explain the nodes of permission and better handling access to a specific node.
+```
+Plugin → pds.*
+├── Version → pds.version
+├── Command → pds.command.*
+│   ├── /pds → pds.command.use
+│   ├── /pds give → pds.command.give
+│   ├── /pds reload-config → pds.command.reload-config
+│   ├── /pds chunk [info|clear] → pds.command.chunk.*
+│   │   ├── /pds chunk info → pds.command.chunk.info
+│   │   └── /pds chunk clear → pds.command.chunk.clear
+│   └── /pds load → pds.command.load
+├── Item → pds.item.*
+│   ├── Basic DebugStick → pds.item.basic.*
+│   │   ├── See → pds.item.basic.see
+│   │   └── Edit → pds.item.basic.edit
+│   ├── Infinite DebugStick → pds.item.infinite.*
+│   │   ├── See → pds.item.infinite.see
+│   │   └── Edit → pds.item.infinite.edit
+│   └── Inspector → pds.item.inspector.*
+│       ├── See → pds.item.inspector.see
+│       └── Edit → pds.item.inspector.edit
+├── Bypass → pds.bypass.*
+│   ├── Blacklists → pds.bypass.blacklist.*
+│   │   ├── Materials → pds.bypass.blacklist.material
+│   │   └── Worlds → pds.bypass.blacklist.world
+│   └── Territory → pds.bypass.plugin-block
+└── Properties → pds.property.*
+    ├── Orientable → pds.property.orientable
+    ├── Directional → pds.property.directional
+    └── ...
+```
+<!-- tabs:end -->
+