Merge pull request #175 from PrisonTeam/bleeding

Pulling in Bleeding so we can do a v3.2.2 bug release.
PrisonTeam · Nov 21, 2020 · 2996169 · 2996169
2 parents 0eb4296 + 20dcd26
commit 2996169
Show file tree

Hide file tree

Showing 178 changed files with 11,777 additions and 12,033 deletions.
diff --git a/changelog_v3.2.x.md b/changelog_v3.2.x.md
diff --git a/docs/docs-commands/images/prison_docs_commands_01_01.png b/docs/docs-commands/images/prison_docs_commands_01_01.png
diff --git a/docs/docs-commands/images/prison_docs_commands_03_01.png b/docs/docs-commands/images/prison_docs_commands_03_01.png
diff --git a/docs/docs-commands/images/prison_docs_commands_05_01.png b/docs/docs-commands/images/prison_docs_commands_05_01.png
diff --git a/docs/docs-commands/images/prison_docs_commands_05_02.png b/docs/docs-commands/images/prison_docs_commands_05_02.png
diff --git a/docs/docs-commands/images/prison_docs_commands_06_01.png b/docs/docs-commands/images/prison_docs_commands_06_01.png
diff --git a/docs/docs-commands/images/prison_docs_commands_09_01.png b/docs/docs-commands/images/prison_docs_commands_09_01.png
diff --git a/docs/docs-commands/images/prison_docs_commands_09_02.png b/docs/docs-commands/images/prison_docs_commands_09_02.png
diff --git a/docs/docs-commands/prison_docs_command_01_prison.md b/docs/docs-commands/prison_docs_command_01_prison.md
@@ -0,0 +1,38 @@
+### Prison Documentation
+[Prison Documents - Table of Contents](../prison_docs_000_toc.md)
+
+## Description:
+
+`/prison`'s the Main core command, by executing it you'll get a list of all the subcommands.  
+
+The command `/prison` also shows all of the other registered root commands that are used within prison, for example `/ranks` and `/mines`.
+
+
+## Permission:
+
+- `prison.admin`
+
+## SubCommands:
+
+- [`/prison alerts`](prison_docs_command_02_prison_alerts.md)
+- [`/prison autofeatures`](prison_docs_command_03_prison_autofeatures.md)
+- [`/prison gui`](prison_docs_command_04_prison_gui.md)
+- [`/prison modules`](prison_docs_command_05_prison_modules.md)
+- [`/prison placeholders`](prison_docs_command_06_prison_placeholders.md)
+- [`/prison reload`](prison_docs_command_07_prison_reload.md)
+- [`/prison version`](prison_docs_command_09_prison_version.md)
+
+## How to use the command
+
+Execute:
+`/prison`
+and all the subcommands will be displayed, plus the other Prison root commands.
+
+<img src="images/prison_docs_commands_01_01.png" alt="Command Example" title="Command Example" width="600" />
+
+### Command Format
+
+`/prison [Arguments]`
+
+**END of the command INFO**
+
diff --git a/docs/docs-commands/prison_docs_command_02_prison_alerts.md b/docs/docs-commands/prison_docs_command_02_prison_alerts.md
@@ -0,0 +1,26 @@
+### Prison Documentation 
+[Prison Documents - Table of Contents](../prison_docs_000_toc.md)
+
+## Description:
+
+Prison Alerts: you can clear a Prison Alert or All of them. One of the most frequently seen alerts is the notification that an update is available. 
+
+## Permission:
+
+- `prison.alerts`
+
+## SubCommands:
+
+- `/prison alerts clearall` clear all alerts
+- `/prison alerts clear` clear an alert that is specifically yours.
+
+## How to use the command
+
+Execute `/prison alerts` followed by the *argument* you want, such as `clearall` or `clear` to use the command
+
+
+### Command Format
+
+`/prison alerts <argument>`
+
+**END of the command INFO**
diff --git a/docs/docs-commands/prison_docs_command_03_prison_autofeatures.md b/docs/docs-commands/prison_docs_command_03_prison_autofeatures.md
@@ -0,0 +1,34 @@
+### Prison Documentation
+[Prison Documents - Table of Contents](../prison_docs_000_toc.md)
+
+## Description:
+
+Show a description of the AutoFeatures and some info about them.  This command only provides information about how to use autofeatures and does not provide any customizations.
+
+**NOTE:** You need to enable the autofeatures within in the **config.yml** file first, then you can edit them from the `/prison gui` or the `plugins/Prison/autoFeaturesConfig.yml`.
+
+## Permissions:
+
+- `prison.admin`
+- `prison.automanager`
+- `prison.automanager.pickup` *(configurable)*
+- `prison.automanager.smelt` *(configurable)*
+- `prison.automanager.block` *(configurable)*
+
+You can customize the permission plugins that are marked as *(configurable)* through modification of the `plugins/Prison/autoFeaturesConfig.yml` file.
+
+## SubCommands:
+
+- `none`
+
+## How to use the command
+
+Just execute the command `/prison autofeatures`
+
+### Command Format
+
+`/prison autofeatures`
+
+<img src="images/prison_docs_commands_03_01.png" alt="Command Example" title="Command Example" width="600" />
+
+**END of the command INFO**
diff --git a/...mands/prison_docs_command_4_prison_gui.md → ...ands/prison_docs_command_04_prison_gui.md b/...mands/prison_docs_command_4_prison_gui.md → ...ands/prison_docs_command_04_prison_gui.md
@@ -1,9 +1,9 @@
-### Prison Documentation - **WORK-IN-PROGRESS**
+### Prison Documentation 
 [Prison Documents - Table of Contents](../prison_docs_000_toc.md)
 
 ## Description:
 
-This command will open the `/prison gui` where an admin can manage a lot of things about prison on a GUI.
+This command will open the `/prison gui` where an admin can manage Prison features.
 
 ## Permission:
 
@@ -16,7 +16,7 @@ This command will open the `/prison gui` where an admin can manage a lot of thin
 
 ## How to use the command
 
-Just execute the command himself `/prison gui`
+Just execute the command `/prison gui`
 
 ### Command Format
 

diff --git a/docs/docs-commands/prison_docs_command_05_prison_modules.md b/docs/docs-commands/prison_docs_command_05_prison_modules.md
@@ -0,0 +1,37 @@
+### Prison Documentation 
+[Prison Documents - Table of Contents](../prison_docs_000_toc.md)
+
+## Description:
+
+The Prison Modules command will list all modules and their current status.  Modules cannot be enabled or disabled through this command.  You would have to make manual changes to the configuration file `plugins/Prison/modules.yml`.
+
+## Permission:
+
+- `prison.modules`
+- `prison.admin`
+
+## SubCommands:
+
+- `none`
+
+## How to use the command
+
+Just execute the command `/prison modules`
+
+### Command Format
+
+`/prison modules`
+
+
+Example of `/prison modules` ran within the console:
+
+<img src="images/prison_docs_commands_05_01.png" alt="Command Example" title="Command Example" width="600" />
+
+
+Example of `plugins/Prison/modules.yml`:
+<img src="images/prison_docs_commands_05_02.png" alt="Command Example" title="Command Example" width="600" />
+
+
+
+
+**END of the command INFO**
diff --git a/docs/docs-commands/prison_docs_command_06_prison_placeholders.md b/docs/docs-commands/prison_docs_command_06_prison_placeholders.md
@@ -0,0 +1,41 @@
+### Prison Documentation 
+[Prison Documents - Table of Contents](../prison_docs_000_toc.md)
+
+## Description:
+
+Show a list of Prison Placeholders available.
+
+
+## Permission:
+
+- `prison.placeholder`
+
+## SubCommands:
+
+- `/prison placeholders list help` Shows a list of placeholders, including aliases.
+- `/prison placeholders list` 
+- `/prison placeholders reload` Reload placeholders and register them.
+- `/prison placeholders search help` Search for placeholders.
+- `/prison placeholders search [playerName] [pageNumber] [patterns]`
+    - `playerName` is optional and is used for player related placeholders to fill in active details
+    - The search results can contain hundreds of results, so paging allows you to control what results are shown.
+    - The `patterns` can be multiple words or fragments. If more than one pattern is used, then all patterns must exist within a placeholder to be included in the result set.
+- `/prison placeholders test help` Test a placeholder
+- `/prison placeholders test [text]` 
+
+
+<img src="images/prison_docs_commands_06_01.png" alt="Command Example" title="Command Example" width="600" />
+
+
+## How to use the command
+
+Use the `/prison placeholders`.
+
+
+### Command Format
+
+`/prison placeholders`
+
+See above subcommands for their use.
+
+**END of the command INFO**
diff --git a/docs/docs-commands/prison_docs_command_07_prison_reload.md b/docs/docs-commands/prison_docs_command_07_prison_reload.md
@@ -0,0 +1,32 @@
+### Prison Documentation
+[Prison Documents - Table of Contents](../prison_docs_000_toc.md)
+
+## Description:
+
+Prison, on a whole, is unable to be reloaded.  It is always safest to restart the server under most situations, otherwise corruption may occur.
+
+That said, placeholders are currently the only exception to that "rule".  By issuing the command `\prison reload placeholders` it will regenerate the placeholder mappings and reregister with any of the active placeholder plugins that prison is integrated with, such as PlaceholderAPI.  Reloading the placeholders is safe to run at any time.
+
+A couple of examples when you would need to use the reload command for placeholders:
+ * Added, changed the name of, or removed any mines or ranks
+ * Reloaded a placeholder plugin, which wipes out all of prison's registered plugins.
+
+## Permissions:
+
+- `prison.admin`
+- `prison.reload`
+- `prison.placeholder`
+
+## SubCommands:
+
+- `/prison reload placeholders` Regenerates all the placeholder mappings and reregisters them with the supported placeholder plugins.
+
+## How to use the command
+
+Use the command `/prison reload` for the list of subcommands.
+
+### Command Format
+
+`/prison reload`
+
+**END of the command INFO**
diff --git a/docs/docs-commands/prison_docs_command_09_prison_version.md b/docs/docs-commands/prison_docs_command_09_prison_version.md
@@ -0,0 +1,40 @@
+### Prison Documentation
+[Prison Documents - Table of Contents](../prison_docs_000_toc.md)
+
+## Description:
+
+Displays detailed information about Prison, especially about the versions of Prison, the platform (ie... Spigot, Paper, etc), and even the other plugins that are active.
+
+This view also includes detailed information on how prison is configured and what components and commands are active.  
+
+This detailed information is very useful for debugging purposes if there are any issues with the environment.  At server startup this information is included along with even more detailed information.  If you are needing to get additional help with your prison environment, it is important to provide the other startup information too.
+
+## Permission:
+
+- `prison.admin`
+
+## SubCommands:
+
+- `none`
+
+## How to use the command
+
+Run the command: `/prison version`
+
+This is an example of the `/prison version` command.
+
+<img src="images/prison_docs_commands_09_01.png" alt="Command Example" title="Command Example" width="600" />
+
+Upon startup of your server, there is additional important information that is displayed that could be very helpful in diagnosing any issues you may have with your server, or Prison itself.  This is an example of what it could look like.  
+
+Notice there are a few errors listed, since my test server  has been setup with errors on purpose so as to ensure these error reporting features are functional. For example one rank has been setup with a currency that no longer exist, there are two ranks that are not associated with any ladders, and there is a block type that was detected that is not supported.
+
+<img src="images/prison_docs_commands_09_02.png" alt="Command Example" title="Command Example" width="600" />
+
+
+
+### Command Format
+
+`/prison version`
+
+**END of the command INFO**
diff --git a/docs/docs-commands/prison_docs_command_10_sellall.md b/docs/docs-commands/prison_docs_command_10_sellall.md
@@ -1,4 +1,4 @@
-### Prison Documentation - **WORK-IN-PROGRESS**
+### Prison Documentation
 [Prison Documents - Table of Contents](../prison_docs_000_toc.md)
 
 ## Description:

diff --git a/docs/docs-commands/prison_docs_command_11_ranks.md b/docs/docs-commands/prison_docs_command_11_ranks.md
@@ -3,21 +3,33 @@
 
 ## Description:
 
-Short description of the command will be here
+Main Prison Ranks command which will show all the subcommands to admins and open a GUI to players.
+
+## Permissions:
+
+- `ranks.admin` If you want to see the commands list then add it to yourself, you can still see the Player GUI for Ranks with another command: `/prisonmanager ranks`.
 
 ## SubCommands:
 
-- List
-- Of
-- Sub
-- Commands
-- With
-- Short
-- Description
+- [/ranks command](prison_docs_command_12_ranks_command.md)
+- [/ranks create \[rankName\] \[cost\] \[ladder\] \[tag\] ](prison_docs_command_13_ranks_create.md)
+- [/ranks delete \[rankName\] ](prison_docs_command_14_ranks_delete.md)
+- [/ranks demote \[playerName\] \[ladder\] \[chargePlayers\] ](prison_docs_command_15_ranks_demote.md)
+- [/ranks info \[rankName\] ](prison_docs_command_16_ranks_info.md)
+- [/ranks ladder](prison_docs_command_17_ranks_ladder_info.md)
+- [/ranks list \[ladderName\] ](prison_docs_command_18_ranks_list.md)
+- [/ranks players \[ladderName\] \[action\] ](prison_docs_command_19_ranks_players.md)
+- [/ranks player \[player\] ](prison_docs_command_20_ranks_player.md)
+- [/ranks promote \[playerName\] \[ladder\] \[chargePlayers\] ](prison_docs_command_21_ranks_promote.md)
+- [/ranks set](prison_docs_command_22_ranks_set.md)
 
 ## How to use the command
+
+Execute the command himself to get a list of commands like in the example: `/ranks`.
+This will also open a GUI to players showing a list of the ranks, you can enable or disable this in the config.yml.
+
 ### Command Format
 
-`/prison`
+`/ranks Optional-Ladder`
 
 **END of the command INFO**
diff --git a/docs/docs-commands/prison_docs_command_12_ranks_command.md b/docs/docs-commands/prison_docs_command_12_ranks_command.md
@@ -1,24 +1,29 @@
-### Prison Documentation - **WORK-IN-PROGRESS**
+### Prison Documentation
 [Prison Documents - Table of Contents](../prison_docs_000_toc.md)
 
 ## Description:
 
-Short description of the command will be here
+Add a command which will be executed when the player rankup to the rank with the command assigned.
+
+## Permissions:
+
+- `ranks.admin`
 
 ## SubCommands:
 
-- List
-- Of
-- Sub
-- Commands
-- With
-- Short
-- Description
+- `/ranks command add` 
+- `/ranks command list`
+- `/ranks command remove`
 
 ## How to use the command
 
+Execute the command himself, and you'll get a list of the subcommands, like in the example: `/ranks command`.
+- `/ranks command add [rankName] [command]` will add a rankupCommand to a rank.
+- `/ranks command list [rankname]` will show a list of rankupCommands in a rank.
+- `/ranks command remove [rankName] [command]` will remove the rankupCommand from the rank.
+
 ### Command Format
 
-`/prison`
+`/ranks command <Arguments>`
 
 **END of the command INFO**