Merge pull request #227 from PrisonTeam/release_branch_v3.2.11

Release branch v3.2.11
PrisonTeam · Jan 22, 2022 · 1a8072c · 1a8072c
2 parents fb25e53 + 4f7586d
commit 1a8072c
Show file tree

Hide file tree

Showing 272 changed files with 24,070 additions and 7,637 deletions.
diff --git a/docs/changelog_v3.2.x.md b/docs/changelog_v3.2.x.md
@@ -30,10 +30,8 @@ that you need.
 # v3.2.6 2021-04-11
 
 
-
 * **v3.2.6 2021-04-11**
 
-
 * **Start to add in a PrisonMinesBlockEventEvent class.**
 It has been disabled because it cannot be used yet; the BlockEvents need to under go some major changes to support its use.
 Currently the BlockEvents receive only references to the sources (block names and not the actual blocks), but in order to hook this up properly, all blocks and details need to be passed.  The current system for controlling the BlockEvents is unable to support that kind of an environment right now. It will be changed in the very near future to get this working.

diff --git a/docs/changelog_v3.3.x.md b/docs/changelog_v3.3.x.md
diff --git a/docs/images/prison_docs_100_setting_up_auto_configure_03.png b/docs/images/prison_docs_100_setting_up_auto_configure_03.png
diff --git a/docs/images/prison_docs_100_setting_up_auto_configure_04.png b/docs/images/prison_docs_100_setting_up_auto_configure_04.png
diff --git a/docs/images/prison_docs_100_setting_up_auto_configure_05.png b/docs/images/prison_docs_100_setting_up_auto_configure_05.png
diff --git a/docs/images/prison_docs_100_setting_up_auto_configure_06.png b/docs/images/prison_docs_100_setting_up_auto_configure_06.png
diff --git a/docs/images/prison_docs_115_blockevents_01.png b/docs/images/prison_docs_115_blockevents_01.png
diff --git a/docs/images/prison_docs_115_blockevents_02.png b/docs/images/prison_docs_115_blockevents_02.png
diff --git a/docs/knownissues_v3.3.x.md b/docs/knownissues_v3.3.x.md
diff --git a/docs/prison_changelog_v3.2.10.md b/docs/prison_changelog_v3.2.10.md
@@ -32,7 +32,9 @@ These build logs represent the work that has been going on within prison.
 
 * Provide a more robust support system in prison, in addition to the support submit features.  Can now enable more debug mode targets to better trackdown potential issues.
 
-* Prison now supports reloadable locales and auto features.  For the auto features, it also reregisters the block break events listeners that auto features use.
+* Prison now supports reloadable locales and auto features.  For the auto features, it now unregisters all previously registered block event listeners, and the re-registers them based upon the updates to the settings in the reloaded auto features.  The server no longer needs to be restarted if the configuration settings for event listeners have changed in any way.
+
+* Auto features has undergone more refactoring to prepare for future enhancements, and to streamline the existing processes.  A few undiscovered bugs were found and fixed during these enhancements.  As a result, auto features works better with other enchantment plugins.
 
 * Rewrote some of the auto features to resolve some obscure issues, and to provide performance improvements and greater flexibility.
 
@@ -43,7 +45,7 @@ These build logs represent the work that has been going on within prison.
 
 * Update many of the internal libraries.
 
-* Rewrites of the GUIs and Sellall features.
+* Performance improvements with GUIs, backpack, and Sellall features.  Includes fixs and some layout functional improvements too.
 
 * Expand Prison's utils features. Added a few more utilities.
 

diff --git a/docs/prison_changelog_v3.2.11.md b/docs/prison_changelog_v3.2.11.md
diff --git a/docs/prison_changelogs.md b/docs/prison_changelogs.md
@@ -3,20 +3,31 @@
 ## Prison Build Logs for v3.3.x
 
 ## Build logs
+
+These build logs represent the work that has been going on within prison. 
+
  - **[v3.3.0-alpha - Current](changelog_v3.3.x.md)**
+    - Future updates will be under the v3.3.x release
+
+
+ - [v3.2.11 - 2022-01-22](prison_changelog_v3.2.11.md)&nbsp;&nbsp;
+ - [v3.2.10 - 2021-08-23](prison_changelog_v3.2.10.md)&nbsp;&nbsp;
+ - [v3.2.9 - 2021-07-03](prison_changelog_v3.2.9.md)&nbsp;&nbsp;
+ - [v3.2.8 - 2021-06-17](prison_changelog_v3.2.8.md)&nbsp;&nbsp;
+
+
+ - [v3.2.7 - 2021-05-02](prison_changelog_v3.2.7.md)&nbsp;&nbsp;
+ - [v3.2.6 - 2021-04-11](prison_changelog_v3.2.6.md)&nbsp;&nbsp;
+ - [v3.2.5 - 2021-04-01](prison_changelog_v3.2.5.md)&nbsp;&nbsp;
+ - [v3.2.4 - 2021-03-01](prison_changelog_v3.2.4.md)&nbsp;&nbsp;
+
+
+ - [v3.2.3 - 2020-12-25](prison_changelog_v3.2.3.md)&nbsp;&nbsp;
+ - [v3.2.2 - 2020-11-21](prison_changelog_v3.2.2.md)&nbsp;&nbsp;
+ - [v3.2.1 - 2020-09-27](prison_changelog_v3.2.1.md)&nbsp;&nbsp;
  - [v3.2.0 - 2019-12-03](prison_changelog_v3.2.0.md)&nbsp;&nbsp;
-[v3.2.1 - 2020-09-27](prison_changelog_v3.2.1.md)&nbsp;&nbsp;
-[v3.2.2 - 2020-11-21](prison_changelog_v3.2.2.md)&nbsp;&nbsp;
-[v3.2.3 - 2020-12-25](prison_changelog_v3.2.3.md)&nbsp;&nbsp;
-[v3.2.4 - 2021-03-01](prison_changelog_v3.2.4.md)&nbsp;&nbsp;
-[v3.2.5 - 2021-04-01](prison_changelog_v3.2.5.md)&nbsp;&nbsp;
-[v3.2.6 - 2021-04-11](prison_changelog_v3.2.6.md)&nbsp;&nbsp;
-[v3.2.7 - 2021-05-02](prison_changelog_v3.2.7.md)&nbsp;&nbsp;
-[v3.2.8 - 2021-06-17](prison_changelog_v3.2.8.md)&nbsp;&nbsp;
-[v3.2.9 - 2021-07-03](prison_changelog_v3.2.9.md)&nbsp;&nbsp;
-[v3.2.10 - 2021-08-23](prison_changelog_v3.2.10.md)
+
 
 
-These build logs represent the work that has been going on within prison. 
 
 
diff --git a/docs/prison_docs_000_toc.md b/docs/prison_docs_000_toc.md
@@ -17,33 +17,79 @@
 
 ## Build logs
  - **[v3.3.0-alpha - Current](changelog_v3.3.x.md)**
- - [v3.2.0 through v3.2.10](prison_changelogs.md)
+
+ - [v3.2.0 through v3.2.11](prison_changelogs.md)
 
 
 
 
 <hr style="height:3px; border:none; color:#aaf; background-color:#aaf;">
 
 
-# Prison Now Fully Supports Spigot 1.17.1 and Java 16 !!
+# Prison Supports Spigot 1.8 through Spigot 1.18.x
+# Prison Supports Java 1.8 though Java 17
+# Prison is created for the Spigot Platform, and works on other platforms based upon Spigot
 
 
-## Prison now has Access By Rank to Reduce the number of Permissions needed!
-
+With the release of Spigot 1.17.x, there were a few minor changes that were needed to be made to prison to support Java 16.  These were mostly related to a couple of NMS routines that were trying to figure out the player's default language they have selected. Due to new restrictions moving forward with Spigot, the ability to correctly identify the player's default language may not be possible, but prison will still use the selected language setting in the config files.
+
+
+Prison supports both Spigot 1.17.1 and Spigot 1.18.x, along with Java 17.  At this time there hasn't been any reports of incompatibilities.  Since prison is using a library to support the correct blocks for the version of the server that you are running, we are limited to when updates are released for that library.  Luckily they have had a couple of releases and we have applied them to the latest alpha releases.  So if you are wanting to maximize the new Spigot 1.18.x experience, please upgrade to the latest alpha release as found on our discord server in the #alpha channel. 
+
+
+### Newer features and updates in Prison:
+
+
+* Auto Configure: Even if you really don't want to use auto configure when setting up your server, it may be worth trying it out just to see what it does.  If you're not happy with it, then deleting the `plugins/Prison/` directory will remove "everything" and on the next restart of your server, prison will load for the first time.  So if you are just getting started with prison, it's worth a try.
+
+
+* Prison now has Access By Rank to reduce the number of Permissions needed! This simplifies a lot of settings and on a simple Prison server, can get you up and running much faster.
+
+* Backpacks: It is advised not to use Prison's backpacks at this time.  They will be going through a rewrite and may result in content losses when upgrading when the newer version is available.  It is suggested you give MinePacks at try.
+
+* Prison Mine Bombs!  Prison is starting to add mine bombs to the list of available features.  This is a work in progress and more enhancements and features will be added in the future.  The idea with these, is that you can configure almost every aspect of the mine bombs, and you can have as many different varieties as you want.
+
+* Prison Tokens!  Prison is starting to implement the earning of tokens within the mines as the players mine.  This is a work in progress.  Currently the hooks are added to earn tokens, and for admins to manage them.  But more features need to be added to help enable using them.
+
+* Prison Stats!  More stats are being tracked for each player.  This is a work in progress.  Prison is tracking blocks mined and even per mine.  Prison is tracking time spent mining in each mine, along with how much a player is earning per mine with both regular currency, and with tokens.  Top-n reports will be available shortly.  Rankup requirements will soon include the ability to specify blocks mined, time spent mining, and even tokens.  This will help you customize how you want your players to ranup.
+
+
+### Features planned for the near future
+
+These new features are in the planning stages...
+
+* New backpacks:  A rewrite of the backpacks that will give a little more flexibility.  You will be ble to use them as backpacks, or as vaults.  Could even sell, or trade backpacks/vaults with their contents.  ETA is unknown since a new storage management system needs to be created.
+
+* Mine Effects:  The ability to set mine effects for a given mine, or to allow players to buy effects using their earned tokens.  Effects could be simple potion effects (haste, night vision), or even effects such as no fall damage, and even flight.  Other options could be no-pvp, enable pvp, no block break, no fire, etc... The options are numerous, but will be added a little at a time, and upon request.
 
-<hr style="height:3px; border:none; color:#aaf; background-color:#aaf;">
+ * Mine Regions:  Mine regions may be added to prison soon.  They would be "area" that will control the Mine Effects and a region would/should enclose a given mine.  But mine regions could be used on their own, were no mine is involved, such as at spawn to enble flight and no fall damage for your higher ranking players, or even allow players to "buy" regions to put around their bases so they can enable nigh vision and flight.
+
+* Custom Menus: Simple custom menus could be added so admins can setup simple commands and features.  For example, custom token shop for enchantments or other in game items, or run any commands in general.  This will start off simple, but will expand upon requests.
+
+* Unlimited Prestiges: This has been a long standing requested feature.  It's close to being added.  Although the levels may be unlimited, special configurations could be added for different levels, such as adding ladder commands at specific levels (ladder commands allows you to peform any action upon rankup, even from other plugins).
+
+* Custom Shops: Custom shops will allow for an unlimited number of new shops to be created.  These shops can be tied to perms or player Ranks, or even specific mines.  Each shop could be either stand alone, or it could be based upon another shop with price modifies and new items to prevent the need to redefine all entries for each shop.  A mine shop would only be able to sell items that are retrived from mining in that mine.
+
+* Cells: They have been requested many times in the past.  At this time, we cannot add them yet, but we would like to sometime in the distant future.
+
+* Enchantments: In the past we have stated that Prison will never support enchantments for pickaxes, or other tools, or weapons and amour.  But as Prison is evolving and more features such as mine bombs and mine effects are added, along with natively supporting tokens within prison, the idea of adding enchantments is almost a no-brainer since most of the complicated details will already be supported through other features.  So in the distant future, some time after mine bombs and mine effects have matured, we may add our own Enchantments.
+
+
+
+<hr style="height:7px; border:none; color:#aaf; background-color:#aaf;">
 
 # New! Prison Fast Start
 
+See the Auto Configure documentation for more information:
 [Prison Auto Configure / Prison Quick Start!](prison_docs_100_setting_up_auto_configure.md)
 
 Prison now has a new set of features that can help you get up and running faster than ever! With the latest version of Prison, you can even have a functional Prison server running with just two Prison commands.  See below for more information.
 
 
-**It is strongly recommended that the '/ranks autoConfigure' should always be ran first.**  Prison's Auto Configure sets up so many features, that it can help resolve many initial issues.
+**It is strongly recommended that the '/ranks autoConfigure' should always be ran first.**  Prison's Auto Configure sets up so many features, that it can help resolve many initial issues.  It's worth trying the first time you run prison since it's easy to undo: just delete the `plugins/Prison' directory and the next time you restart your server Prison will startup as if it was just installed with no settings.
 
 
-Before you try to setup Prison, you really need to install an Economy or the Ranks module will not be enabled.  It is strongly suggested you install the following plugins:  Vault, EssentialsX, EssentialsX-Chat, PlaceholderAPI, LuckPerms, WorldEdit, WorldGuard (or Fast Async World Edit, FAWE, on newer versions of Spigot).
+Before you try to setup Prison, you really need to install an Economy or the Ranks module will not be enabled.  It is strongly suggested you install the following plugins:  Vault, EssentialsX, EssentialsX-Chat, PlaceholderAPI, LuckPerms, WorldEdit (or Fast Async World Edit, FAWE, on newer versions of Spigot), WorldGuard.
 
 
 `/ranks autoConfigure`. It can auto create your ranks and virtual mines, A through Z, it will link the mines to the ranks, setup the Mine Access By Rank and TP Access By Rank.  It will also setup the Mine as a Virtual Mine will and assign blocks of increasing values to all mines.  Each mine will also be assigned a random liner.  The Ranks autoConfigure will also enable sellall and load over 90 default blocks for your shop.  Auto features will be enabled (auto pickup, auto smelt, and auto blocking).  
@@ -205,7 +251,9 @@ Auto configure can get you up and running with as little as two commands.  The f
 
 
 * [Setting up LuckPerms](prison_docs_020_setting_up_luckperms.md)
-    Setting up LuckPerms. Warning about LuckPerms Versions.
+    Setting up LuckPerms. 
+* [Setting up LuckPerms Groups & Tracks](prison_docs_030_LuckPerms_Groups_Tracks.md)
+    Using LuckPerms's groups and tracks with Prison.
 
 
 * [Setting up PermissionsEX](prison_docs_022_setting_up_PermissionsEX.md)

diff --git a/docs/prison_docs_010_setting_up_a_spigot_server.md b/docs/prison_docs_010_setting_up_a_spigot_server.md
@@ -13,6 +13,7 @@ Buildtools also allows easy setup of many test environments since all you
 would need to do is to just change the version.
 
 
+*Documented updated: 2021-12-03*
 
 <hr style="height:1px; border:none; color:#aaf; background-color:#aaf;">
 
@@ -22,8 +23,9 @@ This is intended strictly as a high-level overview on how to setup Java.
 If you need more assistance, please search for online documentation since
 there are many good resources out there.
 
-*  First install a copy of Java that is accessible from the command line.  
-	- It’s strongly suggested to use only the latest version 1.8.0_x since that is the version spigot and most other plugins are developed under.
+*  First install a copy of Java that is accessible from the command line.
+    - The current version of Java is version 17. Even if you are using jars and other plugins that were compiled with Java 1.8.x, it is recommended to use Java 17.  
+	- If you feel like you must use Java 1.8, it’s strongly suggested to use only the latest version 1.8.0_x.
 
 
 *  You can download it from [Sun SE Development Kit 8]https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html) for product that you need.
@@ -48,18 +50,25 @@ there are many good resources out there.
 
 ```
   java -jar BuildTools.jar --rev 1.8.8
+  java -jar BuildTools.jar --rev 1.9.4
+  java -jar BuildTools.jar --rev 1.10.2
+  java -jar BuildTools.jar --rev 1.11
   java -jar BuildTools.jar --rev 1.12.2
   java -jar BuildTools.jar --rev 1.13.2
   java -jar BuildTools.jar --rev 1.14.4
-  java -jar BuildTools.jar --rev 1.15.1
+  java -jar BuildTools.jar --rev 1.15.2
+  java -jar BuildTools.jar --rev 1.16.5
+  java -jar BuildTools.jar --rev 1.17.1
+  java -jar BuildTools.jar --rev 1.18
 ```
 
-*  For example, with BuildTools.jar being in a root directory, create a subdirectory and then start a build within that directory.  The benefit is that you can use the same BuildTools.jar to build multiple different versions of spigot.  This example starts off with building a v1.14.4 instance and then builds a 1.8.8 instance.
+*  For example, with BuildTools.jar being in a root directory, create a subdirectory and then start a build within that directory.  The benefit is that you can use the same BuildTools.jar to build multiple different versions of spigot.  This example starts off with building a v1.17.1 instance and then builds a 1.8.8 instance.  Normally you wouldn't build multiple versions of spigot, but this shows how easy and flexible it is to build any version of spigot that has been released.
 
 ```
-  mkdir spigot-1.14.4
-  cd spigot-1.14.4
-  java -jar ../BuildTools.jar –rev 1.14.4
+  mkdir spigot-1.17.1
+  cd spigot-1.17.1
+  java -jar ../BuildTools.jar –rev 1.17.1
+  
   cd ..
   mkdir spigot-1.8.8
   cd spigot-1.8.8
@@ -78,33 +87,35 @@ there are many good resources out there.
 
 # Creating a Runnable Spigot Server
 
-*  Create a runnable server directory by creating a new directory outside of the build directory. Then copy the newly generated jar file, such as spigot-1.14.4.jar, to the new server run time directory. 
+*  Create a runnable server directory by creating a new directory outside of the build directory. Then copy the newly generated jar file, such as spigot-1.17.1.jar, to the new server run time directory. 
+
+*  NOTE: At the time when this document was updated, Spigot 1.18 was just released.  Because 1.18 requires Java 17, it is advisable to use that version of Java.  Prison, because it is still being ran on older servers and under older environments, it must try to support the widest array of Spigot versions; therefore it is built with the latest version of Java 1.8.x, and built using Spigot 1.13.2.  The environments in which Prison is built, should not impact how you build and run your server, of which it could easily be with Java 17 and Spigot 18.
 
 
 *  Windows example, if you’re still in the build directory:
 
 ```
   cd ../..
-  mkdir spigot-1.14.4_server
-  copy /B builds\spigot-1.14.4\spigot-1.14.4.jar spigot-1.14.4_server
+  mkdir spigot-1.17.1_server
+  copy /B builds\spigot-1.17.1\spigot-1.17.1.jar spigot-1.17.1_server
 ```
 
 *  Linux example, if you’re still in the build directory:
 
 ```
   cd ../..
-  mkdir spigot-1.14.4_server
-  cp builds/spigot-1.14.4/spigot-1.14.4.jar spigot-1.14.4_server
+  mkdir spigot-1.17.1_server
+  cp builds/spigot-1.17.1/spigot-1.17.1.jar spigot-1.17.1_server
 ```
 
 
-*  Run the server for the first time (see the next step). It will start to auto-generate the server environment and then will stop.  You will need to manually modify eula.txt and set eula=true.  Save.  Close.  Restart the server.  It will startup successfully now.
+*  Run the server for the first time (see the next step). It will start to auto-generate the server environment and then will stop.  You will need to manually modify the `eula.txt` file and set `eula=true`.  Save.  Close.  Restart the server.  It will startup successfully now.
 
 
 *  This is a simple example of what is needed for a windows cmd file. It sets the minimum memory to 2 GB and the max to 8 GB.  A linux script would be similar, but without the pause.
 
 ```
-    java -Xms2g -Xmx8g -jar spigot-1.14.4.jar
+    java -Xms2g -Xmx8g -jar spigot-1.17.1.jar
     pause
 ```