gradlew wrapper --gradle-version 5.0 :: Sets the new wrapper version
+ * gradlew --version :: Will actually install the new version
+ * gradlew build :: Will build project with the new version to ensure all is good. If build is good, then you can try to upgrade to the next version.
+ * Update to v5.0 was successful. Had to remove enableFeaturePreview('STABLE_PUBLISHING')
+ since it has been deprecated. It does nothing in v5.x, but will be removed in v6.0.
+ * Update to v5.1.1, v5.2.1, v5.3.1, v5.4.1, v5.5.1, v5.6.4 was successful.
+
+
+* **Minor clean up to Gradle scripts**
+The "compile" directive is actually very old and was deprecated back around version
+v2.x. The replacements for that is "implementation" or "api" instead. The use of
+api does not make sense since its use is to tag when internal functions are exposed
+to the outside world as if it will be used as an externally facing API. That
+really does not fit our use case, but what api also does is to force compiling all
+source that is associated with something marked as api, including everyone's children. So performance will suffer due to that usage, since it shuts down incremental
+building of resources.
+
+I also found that use of compileOnly may not be used correctly, but at this point
+I'm just leaving this as a mention and then revisit in the future if time
+permits, or issues appear to be related. Its a very old addition that provided
+gradle with "some" maven like behaviors. It was only intended to be strictly used
+for compile time dependencies, such as for annotations that are only needed for
+compile-time checks, of which the plugins and resources we have marked as
+compileOnly do not fit that use case.
+[discuss.gradle.org: compileOnly](https://discuss.gradle.org/t/is-it-recommended-to-use-compileonly-over-implementation-if-another-module-use-implementation-already/26699/2)
+
+
+* **Redesigned mine block generation works - Async and paged enabled**
+Redesigned how prison blocks are generated to improve performance and to allow the
+asynch generation of blocks, but more importantly, allows for paging of actual
+block updates. The paging is a major feature change that will allow for minimal
+impact on server lag, even with stupid-large mines. The idea is to chop up the
+large number of blocks that need to be regenerated in to smaller chunks that can
+be performed within one or two ticks, then defer the other updates to the future.
+Thus freeing up the main bukkit/spigot execution thread to allow other tasks
+to run to help prevent the server from lagging.
+
+* **Support for LuckPerms v5.0.x**
+In addition to supporting older versions of LuckPerms, Prison now is able to
+integrate LuckPerms v5.0.x or LuckPerms v.4.x or earlier. Take your pick.
+
+* **Minor changes to reduce the number of compiler warnings**
+Minor changes, but better code overall.
+
+
+* **Improved mine regeneration performance by 33.3%**
+Figured out how to improve performance on mine regeneration by roughly about 33.3% overall. This
+could help drastically improve performance and reduce lag since block updates must run
+synchronously to prevent server corruption (limitation is due to the bukkit and spigot api).
+
+* **Mine stats and whereami**
+Added a new command, **/mines stats**, to toggle the stats on the mine resets. Viewable with **/mines list** and **/mines info**. Stats are now within the MineManager so it can be accessed from within
+the individual mines.
+Added a new command, **/mines whereami**, to tell you what mine you are in, or up to three mines you are nearest to and the distance from their centers.
+
+
+* **Major restructuring of how Mines work - Self-managing their own workflow**
+They now are able to self-manage their own workflow for sending out notifications and for resetting automatically.
+Mines is now layered, where each layer (abstract class of its ancestors) contributes a type of behavior and business logic that allows Mines to be more autonomous.
+As a result, PrisonMines and MineManager are greatly simplified since they have less to manage.
+Because Mines are now self-managing their own workflow, and they have taken on a more expanded role, some of the mine configurations are obsolete and removed.
+Mines only notify players that are within a limited range of their center; they no longer blindly broadcast to all players within a given world or the whole server.
+Mines extend from MineScheduler, which extend from MineReset, which extend from MineData. Each layer focuses on it's own business rules and reduces the clutter in the others, which results in tighter
+code and less moving parts and less possible errors and bugs.
+
+
+* **Concept of distance added to Bound objects**
+Added the concept of distance between two Bound objects so as to support new
+functionalities between mines and players.
+
+
+* **Gradle now ready to upgrade to v5**
+Resolved the last few issues that would have caused issues when upgrading to gradle
+v5. Explored how gradle can use java fragments and variables.
+
## tag v3.2.0 - 2019-12-03
@@ -63,7 +1041,7 @@ Test server versions used in testing:
* **Minecraft 1.11**
* **Minecraft 1.12.2**
* **Minecraft 1.13.2**
- * **Minecraft 1.14.2**
+ * **Minecraft 1.14.4**
* **Major refactoring of the prison-mines package**
diff --git a/docs/docs-commands/prison_docs_command_10_sellall.md b/docs/docs-commands/prison_docs_command_10_sellall.md
new file mode 100644
index 000000000..91a56da7a
--- /dev/null
+++ b/docs/docs-commands/prison_docs_command_10_sellall.md
@@ -0,0 +1,26 @@
+### Prison Documentation - **WORK-IN-PROGRESS**
+[Prison Documents - Table of Contents](../prison_docs_000_toc.md)
+
+## Description:
+
+Show a list of subcommands for the sellall feature.
+
+## SubCommands:
+
+- `/sellall sell`
+- `/sellall gui`
+- `/sellall add`
+- `/sellall delete`
+- `/sellall multiplier`
+- `/sellall setdefault`
+
+## How to use the command
+
+Execute the command with the argument you want following the instruction, on the [main doc](../prison_docs_000_toc.md) page there's a whole guidebook for [this](../prison_docs_113_setting_up_sellall.md)!
+Example: `/sellall`
+
+### Command Format
+
+`/sellall + + +## Project Related + +* **[Prison README.md](../README.md)** +* **[Prison LICENSE.md](../LICENSE.md)** +* **[Prison Change logs](../changelog_v3.2.x.md)** Detailed changes to prison. +* **[Prison Known Issues](../knownissues_v3.2.x.md)** Known Issues and To Do's. +* **[Prison Discord Server](https://discord.gg/DCJ3j6r)** Get help here. + + +* **[Most Recent Version of Prison Documentation](https://github.com/PrisonTeam/Prison/blob/bleeding/docs/prison_docs_000_toc.md)** Docs change frequently, but GITHUG's master versions do not. These are the latest docs! + + +
+ + + +# Table of Contents for this Document + +* [Commands Shortcut Help](#commands-shortcut-help) + +* [Guides - Setting up the Server Basics](#guides-setting-up-the-server-basics) +* [Guides - Configuring Prison](#guides-configuring-prison) + +* [Guides - Working with other Plugins](#guides-working-with-other-plugins) +* [Guides - Configuring Other Plugins for Prison](#guides-configuring-other-plugins-for-prison) +* [Guides - FAQs](#guides-faqs) + +
+ + + +### Commands Shortcut help + +*Adding the `help` argument as the first parameter of any command will show additional help.* + + +**PRISON COMMANDS:** +(Work-In-Progress) + +- [/prison](docs-commands/prison_docs_command_1_prison.md) +- [/prison alerts](docs-commands/prison_docs_command_2_prison_alerts.md) +- [/prison autofeatures](docs-commands/prison_docs_command_3_prison_autofeatures.md) +- [/prison gui](docs-commands/prison_docs_command_4_prison_gui.md) +- [/prison modules](docs-commands/prison_docs_command_5_prison_modules.md) +- [/prison placeholders](docs-commands/prison_docs_command_6_prison_placeholders.md) +- [/prison reload](docs-commands/prison_docs_command_7_prison_reload.md) +- [/prison version](docs-commands/prison_docs_command_9_prison_version.md) + + +**RANKS COMMANDS: _Guidebook TO-DO_** (Work-In-Progress) + +- [/ranks \[ladder\] ](docs-commands/prison_docs_command_11_ranks.md) +- [/ranks command](docs-commands/prison_docs_command_12_ranks_command.md) +- [/ranks create \[rankName\] \[cost\] \[ladder\] \[tag\] ](docs-commands/prison_docs_command_13_ranks_create.md) +- [/ranks delete \[rankName\] ](docs-commands/prison_docs_command_14_ranks_delete.md) +- [/ranks demote \[playerName\] \[ladder\] \[chargePlayers\] ](docs-commands/prison_docs_command_15_ranks_demote.md) +- [/ranks info \[rankName\] ](docs-commands/prison_docs_command_16_ranks_info.md) +- [/ranks ladder](docs-commands/prison_docs_command_17_ranks_ladder_info.md) +- [/ranks list \[ladderName\] ](docs-commands/prison_docs_command_18_ranks_list.md) +- [/ranks players \[ladderName\] \[action\] ](docs-commands/prison_docs_command_19_ranks_players.md) +- [/ranks player \[player\] ](docs-commands/prison_docs_command_20_ranks_player.md) +- [/ranks promote \[playerName\] \[ladder\] \[chargePlayers\] ](docs-commands/prison_docs_command_21_ranks_promote.md) +- [/ranks set](docs-commands/prison_docs_command_22_ranks_set.md) + +**MINES COMMANDS: _Guidebook TO-DO_** (Work-In-Progress) + +- [/mines](docs-commands/prison_docs_command_23_mines.md) +- [/mines block](docs-commands/prison_docs_command_24_mines_block.md) +- [/mines command](docs-commands/prison_docs_command_25_mines_command.md) +- [/mines create \[mineName\] ](docs-commands/prison_docs_command_26_mines_create.md) +- [/mines delete \[mineName\] \[confirm\] ](docs-commands/prison_docs_command_27_mines_delete.md) +- [/mines info \[mineName\] \[page\] ](docs-commands/prison_docs_command_28_mines_info.md) +- [/mines list \[page\] ](docs-commands/prison_docs_command_29_mines_list.md) +- [/mines reset \[mineName\] ](docs-commands/prison_docs_command_30_mines_reset.md) +- [/mines set](docs-commands/prison_docs_command_31_mines_set.md) +- [/mines stats](docs-commands/prison_docs_command_32_mines_stats.md) +- [/mines tp \[mineName\] ](docs-commands/prison_docs_command_33_mines_tp.md) +- [/mines wand](docs-commands/prison_docs_command_34_mines_wand.md) +- [/mines whereami](docs-commands/prison_docs_command_35_mines_whereami.md) + +**MORE COMMANDS: _Guidebook TO-DO_** (Work-In-Progress) + +- [/sellall](docs-commands/prison_docs_command_10_sellall.md) +- [/prisonmanager](docs-commands/prison_docs_command_36_prisonmanager.md) +- [/prestiges](docs-commands/prison_docs_command_37_prestiges.md) +- [/prestige](docs-commands/prison_docs_command_38_prestige.md) +- [/rankupMax \[ladder\]](docs-commands/prison_docs_command_39_rankupmax.md) +- [/rankup \[ladder\]](docs-commands/prison_docs_command_40_rankup.md) + + + +
+ + + + + + +# Guides: Setting Up the Server Basics + + +* [Setting up a Spigot Server](prison_docs_010_setting_up_a_spigot_server.md) + Setting up Java. Setting up and running BuildTool. Creating a runnable Spigot Server. + + +* [Setting up Prison - Basics](prison_docs_012_setting_up_prison_basics.md) **Required** + Adding the plugin to your server. + + +* [Prison - Getting Help](prison_docs_013_Prison_Help.md) **Important** + Commands. Getting help for issues. Upgrading Prison. + + +* [Prison - Prison Configuration Files](prison_docs_014_Prison_Configs.md) **Important** + Customizing how Prison works by changing the Config files. + + + + +* **Setting up Vault** - (coming soon) + Including Vault is Strongly Suggested. + Hint: Download from spigotmc.org and copy jar to plugin folder. Zero setup. + + +* [Setting up EssentialsX](prison_docs_0xx_setting_up_EssentialsX.md) - + Including EssentialsX is Strongly Suggested - Configuring EssentialsX Chat placeholders - Recommend which modules to include. + + +* [Setting up LuckPerms](prison_docs_020_setting_up_luckperms.md) + Setting up LuckPerms. Warning about LuckPerms Versions. + + +* [Setting up PermissionsEX](prison_docs_022_setting_up_PermissionsEX.md) + Setting up PermissionsEX. Warning about being obsolete. + + +* [Setting up Ultra Permissions](prison_docs_024_setting_up_Ultra_Permissions.md) + Setting up Ultra Permissions. Compatible with Prison 3.2+ + + +* [Setting up WorldGuard & WorldEdit](prison_docs_026_setting_up_worldguard_worldedit.md) + Installing the plugins + + +* [Setting up PlaceholderAPI](prison_docs_0xx_setting_up_PlaceholderAPI.md) - Strongly Suggested if using placeholders. Troubleshooting. + +
+ + + +# Guides: Configuring Prison + +These guides cover the core fundamentals of Prison. They may reference other plugins, but these guides will not go in to depth on how to install or use the other plugins; those details will be a focused guide of their own. + + + +* [Setting up Mines](prison_docs_101_setting_up_mines.md) + Basics of creating. Searching for Blocks. Customizing. One-block mine example with HolographicDisplays. + + + +* [Setting up Ranks & Ladders](prison_docs_102_setting_up_ranks.md) + **-+= New! Work In Progress! =+-** Configuring and using Ranks and Ladders. + + + +* [Setting up Prestiges](prison_docs_107_setting_up_pestiges.md) + Configuring and using Prestiges. + + + +* [Mine Commands](prison_docs_111_mine_commands.md) + What they are. Setting up. Working with Mine Commands. + + + +* [Setting up SellAll](prison_docs_113_setting_up_sellall.md) + What's SellAll, how to use it and set up (Including sellall **multipliers**). + + + +
+ + + + + + +# Guides: Working with other Plugins + + +* [Guide: Prison Placeholders](prison_docs_310_guide_placeholders.md) How to use. Includes HolographicDisplays. + + +**Work In Progress** + + + +
+ + + + +# Guides: Configuring Other Plugins for Prison + +This section of guides will focus more on other plugins and how they can integrate with Prison. They may use a few aspects of the prison API or command interface, but these guides will spend the majority of their time covering the other technologies that can help give Prison your own character. + + +* [Configuring and Using WorldGuard with LuckPerms to Protect Mines](prison_docs_626_configuring_worldguard_regions.md) + This guide uses LuckPerms in the examples, but any other permission plugin will work just as well. + + +* [Setting up EssentialsX Warps for Players](prison_docs_630_configuring_warps.md) + + +* [Ideas on Setting up Donor Mines and Private Mines](prison_docs_628_configuring_private_mines.md) + + + +* **Work In Progress** + + + + + + +
+ + + +# Guides: FAQs + +This section of guides will focus on FAQs; short helps for common problems. + + +* [FAQ - Other Plugins](prison_docs_810_faq_other_plugins.md) + CMI Plugin. Prison fails to load. No modules. + + +* [FAQ - Miscellaneous Questions](prison_docs_880_faq_misc_01.md) + Is Paper Supported? Setting the Currency symbol. + +
diff --git a/docs/prison_docs_010_setting_up_a_spigot_server.md b/docs/prison_docs_010_setting_up_a_spigot_server.md new file mode 100644 index 000000000..12d6f9419 --- /dev/null +++ b/docs/prison_docs_010_setting_up_a_spigot_server.md @@ -0,0 +1,128 @@ + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## Setting up a Spigot Server + +The Prison documentation covers how to setup a Spigot server for use as either +a test environment, a production server. These instructions covers how to +use the spigotmc's buildtools to simplify not only the initial setup, +but also provides easy updates. + +Buildtools also allows easy setup of many test environments since all you +would need to do is to just change the version. + + + +
+ + +# Setting up Java +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. + + +* 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. + + +* You can also use Open JDK if Sun's license does not fit your needs. [OpenJDK Install](https://openjdk.java.net/install/) + + +* Test the java install with `java -version` from a command line + +
+ + + +# Setting Up and Running BuildTools + +* Download the spigot `BuildTools.jar` file. Follow the directions from here: + [https://www.spigotmc.org/wiki/buildtools/](https://www.spigotmc.org/wiki/buildtools/) + + +* Once you have downloaded BuildTools.jar, you will run *one* of the following commands (only one) from the command line. Multiple versions are shown as an example of how by simply specifying different versions, the same BuildTool will generate the different environments. The Windows and linux command line usage are the same. See the provided URL in the first step above for the list of valid versions that are supported by the BuildTools.jar file. + + java -jar BuildTools.jar --rev 1.8.8 + 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 + + +* 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. + + mkdir spigot-1.14.4 + cd spigot-1.14.4 + java -jar ../BuildTools.jar –rev 1.14.4 + cd .. + mkdir spigot-1.8.8 + cd spigot-1.8.8 + java -jar ../BuildTools.jar –rev 1.8.8 + + +* **Updating BuildTools:** Once in a while you will be prompted to update the BuildTools.jar file. To do update it, all you need to do is to just download it, and replace the older one you were using. + + +* **Updating the built servers:** Every once in a while, when you are starting a server, there may be a notification that the server software needs to be update. Just rerun the BuildTools for the same version within the original build directory. The build tools will update all of the changed resources and then generate the new server jars that you copy to the actual server (see the next step). + + +
+ + + +# 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. + + +* 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 + + +* 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 + + + +* 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. + + +* 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 + pause + +* Let the server fully start for the first time, then stop it by entering “stop” in the open server console. The server is now ready to be customized. + + +This should give you a functional server for which to run the Prison plugin. + + +
+ + + +# Customizing your Server + +You can now customize the server, such as by adding plugins, etc... + + +
+ + + +# Other Server Platforms + +The same general instructions apply to paper server, but the big difference is that you download the runnable paper jar file from https://papermc.io/downloads and then place them in to your server runtime directory, and then follow the steps under **Creating a Runnable Spigot Server** but use the resources for the other platform. Then run the same general startup scripts. + + diff --git a/docs/prison_docs_012_setting_up_prison_basics.md b/docs/prison_docs_012_setting_up_prison_basics.md new file mode 100644 index 000000000..b4d835409 --- /dev/null +++ b/docs/prison_docs_012_setting_up_prison_basics.md @@ -0,0 +1,162 @@ + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## Setting up Prison - The Basics + +This document provides a quick overview on how to install Prison and get it running. + +
+ + + +# Dependencies + +* **None - No hard dependencies** - There are no hard dependencies for Prison. + +There may be no hard dependencies that will prevent Prison from running, but there are some core plugins that will make it easier to use. This short list is just a suggestion, but alternatives do exist and may be outside of our ability to comment or assist in their usage. + + +* **Vault** - Optional, but STRONGLY Suggested - This is perhaps the most important plugin. This plugin provides a common way to access other plugins running on your server, but without having to write any code within Prison to support them. Vault provides the mapping of a plugin's unique APIs to a common Vault API. Vault helps support Economy, Permissions, and Placeholders. Because of Vault, Prison can work flawlessly with dozens of other plugins. Please refer to Vault's documentation for what it supports. + + +* **EssentialsX** - Optional, but STRONGLY Suggested - Provides many of the basic commands and behaviors that you would expect from a Spigot server such as chat, warps, and even some moderation commands. EssentialsX is not Essentials, since Essentials is an older abandoned project, and EssentialsX is a forked project that is still maintained. Unfortunately, internally it is identified as simply Essentials, but you can tell it's EssentialsX if the version is greater than 2.15.x. + + +* **EssentialsX Chat** - Optional - Enhanced Chat experience. + + +* **EssentialsX Spawn** - Optional - Enhanced support for Spawns. + + +* **A permissions plugin of your choice** - Required - Prison works with many different permission plugins through Vault. I strongly suggest LuckPerms since it is free and is under active development so bugs and performance issues will be addressed. + * Warning: LuckPerms v5.0.x crashes older versions of prison, such as V3.2.0 and earlier. + * Notice: Prison v3.2.1 (including the pre-release versions) supports all versions of LuckPerms. + * Strongly suggest using LuckPerms v5.0.x with latest pre-release version of Prison. + + +* **PlaceholderAPI** - Used through Vault, it is free and provides the core interfaces in to the usage of placeholders. Prison also has a special integration setup for PlaceholderAPI to register all of the Prison placeholders dynamically upon startup. You do not need to download anything from the cloud for prison to work with this plugin. + + +
+ + +# Download Prison + +Download Prison from [spigotmc.org's Prison History Page](https://www.spigotmc.org/resources/prison.1223/history). + + +Setting up Prison is simple: + +* Download Prison - Current Releases + - Go to the SpigotMC.org LuckPerm's resource page: + - [Prison Downloads](https://www.spigotmc.org/resources/prison.1223/history "Prison download can be found under the Version History tab") + - Click on the Version History tab + - Choose the version to download + +* **Download Prison's Pre-Release Version** + - Useful to access newer features and fixes + - You can usually find a build on the Discord Server: + - [Prison Discord Server](https://discord.gg/DCJ3j6r) + +* Copy to your server's plugin directory + +* Restart the server + +* Follow Prison's documentation on customization, but at this point it's ready for use. + + +
+ + + +# Important Prison Information + +Upon starting up, Prison will display a lot of information in the server's console. +This information is intended to help you configure and confirm that prison started +correctly with all of the related resources that it is using. It also provides you +with valuable information that is needed to help troubleshoot issues, if you should +happen to encounter any. + +Some of the important details that are listed: +* Versions of Prison, Spigot, and other plugins +* Which modules were successfully loaded +* The root commands that are available +* The integration status of all related plugins that are supported +* The list of active placeholders +* Startup error messages, if any. Examples would be if a rank is configured to use a +custom currency and that currency cannot be found in any economy. + + +
+ + + +# Getting Help + +If you should run in to any questions or issues, please first review all online documentation first. + + +If you cannot find what you need within the documentation, please visit our Discord server to get the quickest responses there. +[Prison Discord Server](https://discord.gg/DCJ3j6r) + + +In order to provide the best support, the prison startup screen provides most of the information that is needed to help trouble shoot your issues. Please take a screen print and provide on discord with a detailed explanation of the issue. + + + +If you do encounter an issue, and the startup information is requested, please include +everything from the first line to the last. Please take a screen print and provide on +discord with a detailed explanation of the issue. Include everything from: + +``` + [16:21:30 INFO]: [Prison] Enabling Prison v3.2.1-alpha.13 +``` + +through: + +``` + [16:21:31 INFO]: | Prison | Prison - Finished loading. +``` + + + +# Prison Commands + +On the startup screen, prison shows all of the base commands that are active. From these commands, they will provide you with sub-listings of all the other commands. + +* **/prison** +* **/mines** +* **/ranks** +* **/rankup** + + +These commands are intended to run in game, but most can be ran from the system console. Sometimes the system console is easier to displays longer listings, such as **/mines list**. Also the console is better with wider text, and with easier to read text since it's not trying to display over a mc world. + + +
+ + +# Getting Started + +There is a lot to do get your server up and running. But here are some ideas on what to get started on first. It may even be a good idea to create a couple of small mines in an area that you have not spent much time with your final builds. Plan on creating a couple of test mines and ranks, then deleting them. You can quickly get a good understanding of how prison can be setup by playing around with a lot of the setting within a few minutes. + + +Remember that the command **/prison version** will show all the available root level commands by the modules. Entering those commands will show all of the related sub commands. + + +* Create a couple of small mines. About 10x10x5 blocks in size would work well. Above ground is easy too. +* Play around with adding blocks, removing them, searching for blocks to add. +* Try to resize the mines, and even deleting them. + +* Go ahead and create a couple of ranks. +* Setup the permissions (see the WorldGuard and LuckPerms document for examples) +* Add some simple permissions to the rank commands +* Test the ranks and the /rankup commands. + +* To clean up, you can remove the test ranks (or keep them) +* Remove the mines. + + +
+ diff --git a/docs/prison_docs_013_Prison_Help.md b/docs/prison_docs_013_Prison_Help.md new file mode 100644 index 000000000..caef5c56a --- /dev/null +++ b/docs/prison_docs_013_Prison_Help.md @@ -0,0 +1,187 @@ + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## Prison - Getting Help + +This document provides some important information on how to find help in setting up your prison server, and ultimately, how and where to ask for help. + +
+ +# Overview + +If you are having problem, please take a quick look at the following documents as found in the Table of Contents: + +* Setting up prison and various plugins - If special conditions for their configurations become apparent in order for prison to work, notes will be added there. +* Review topics that may address your issue +* At the end of the table of contents are some FAQs. Special situations may be added to them. +* Known Issues & A TO DO List - This is also a TO DO list, but at the bottom are some known issues with prison. + +
+ + +# General Information on Prison Commands + +All of the commands for Prison can be ran in-game, and most can be ran from the console. When running commands from the console, you do not have to prefix the commands with a **/**. But within these documents, all commands will be referenced with a prefixed **/** so it is clear that it's a command. Just don't include it when running within the console. + +Personal preference is to run the commands from the console since there are less restrictions on width or number of lines shown, and they are easier to see without the busy background of the game. + +Within most of these documents, the console will be used to screen print from for those reasons. + +The only commands that cannot be ran from the console are the commands that expect you to be an in-game player. Examples are **/mines whereami** and **/mines tp
+ + +# Prison Commands and Using "help" + +It may be helpful to know what commands are available, and what options exist for those commands. + +Upon startup, prison lists many details about the environment, and one set of those details, are the base commands that are available within Prison. See the area pertaining to the modules, since the commands generally are tied to modules. + + +
+
+
+Many commands within prison are compound commands, such that they start with a base command, followed by one or more other commands. When Prison lists the available commands, if there are sub commands, that information is included in the command listing, including the sub command count. For example:
+
+* **/mines**
+* **/mines set**
+* **/mines set spawn**
+
+If for a given set of commands, such as **/mines set**, has sub commands, then Prison will present a listing of all sub commands and their parameters.
+
+
+
+In this screen print, you can see the hierarchy of **/mines** and **/mines set**. The parameter listing is helpful, but it does not provide all the information that is available.
+
+Let's take a closer look at **/mines set notification** and how the **help** keyword can provide a lot more meaningful details. If you just enter that command, without any parameters, Prison reports an error message, depending upon which parameter failed. See the next screen print and the related *Error* message. It's not helpful in the least, especially if you are not certain what each parameter is supposed to be.
+
+
+
+
+But notice within the above screen print, the same command has been entered, but this time with the keyword **help** added as if it were the first parameter. For example, **/mines set notification help**. Prison recognizes that you are requesting help for that command, and then it displays all of the information it has for each parameter. Finally, that is truly help.
+
+
+Prison automatically inserts the **help** keyword if you enter the base commands. So **/mines** is really injecting the **help** keyword for you so it will generate the list. It's like you've entered **/mines help**.
+
+
+
++ + + +# Where to ask for help: The Prison Discord Server + +The best place to ask for help, and to get answers quickly (within a few hours) would be without a doubt the Prison Discord Server. + +[Prison Discord Server](https://discord.gg/DCJ3j6r) + + +You can also submit a help ticket on the Prison github Issues tab, but the response may be slower and less detailed + + +
+ + + +# Asking for Help + +Before you actually ask for help, take a look at some of the documents presented here. You may find your answer, or at least become a little more familiar with Prison. There is a good chance that if your question is a common one, then you will just be referred to this documentation anyway. + +When you do ask for help, please realize if you can provide a clear description of the problems you are experiencing, plus the versions of Prison, Spigot, etc, then we can help you faster and more accurately. To help provide you with answers to these questions, see the next section of this document for information on what you can copy and paste to provide all those much needed details. + + + +
+ + +# Prison v3.2.1 and it's Pre-Release Versions + + +The Prison startup screen contains a lot of information that can be used help identify issues that are detected by Prison on start up, and can provide useful information about the general environment. See the screen prints below. + +If you are having problems and need to ask for help, please provide all of this information when requested. Screen prints are preferred. When asked what versions of prison and platform that you are running, copying the following three lines is what is needed to answer that question: + +``` +[18:40:20 INFO]: | Prison | Loading Prison version: 3.2.1-alpha.12 +[18:40:20 INFO]: | Prison | Running on platform: SpigotPlatform +[18:40:20 INFO]: | Prison | Minecraft version: git-Spigot-21fe707-e1ebe52 (MC: 1.8.8) +``` + +
+
+
+
+These screen prints may not contain the most recent enhancements to prison, since they are based upon an alpha release. Please see your server's console for details pertaining to your environment.
+
+
++ + + +# Prison v3.1.0 and Earlier - General Information + +There is zero support available for these earlier versions of Prison. It is therefore highly recommended that you upgrade to the latest release of Prison. Once a version of prison is released, we cannot go back and apply any fixes; fixes will be applied to the next release. + + +My suggestions are based upon what I have seen within the code for Prison, and best guesses on how the older versions **may** have worked. These are guesses. Proceed carefully and make backups at each upgrade to ensure you can retry a step if something should go wrong. - Blue + + +To upgrade prison, the process should be rather simple. But there are general steps that you must follow to help ensure a smoother transition to the latest release. + + +It is highly suggested that you should first backup your whole server, especially the data within your plugins folder. Please be aware that upgrading Prison may require you to upgrade other pugins that you have, and those plugins may require other plugins to be upgraded. + + +DO NOT just install the latest plugin(s) you find on the internet! Most plugins have specific versions of Spigot/Bukkit/Minecraft that they will work with! Get them only from trusted servers such as spigotmc.org, bukkit.org, or etc... Those sites should have multiple versions and should identify what server engines they are compatible with. + + +If you want to also upgrade to a newer version of the server software that you are running, such as spigot, bukkit, paper, etc..., first upgrade the plugins for your current version of the server. So if you are running Spigot 1.8.8 and a plugin has a newer version available that works with 1.8.8, install that first and then start the server and make sure everything is working well. Usually if there is a major change in a plugin from one version to the next, the "last" version may have code to "convert" your data to prepare for the next higher version. If there is an important intermediate step that will convert your data, or require you to make major changes, there should be some notes in documents somewhere. Spending a few minutes reading the release notes on these websites could save you hours of work trying to recover from a messed up upgrade. Remember to make backups! + + +
Upgrading from Prison v3.2.0 to Prison v3.2.1
+ +If you are running Prison v3.2.0, then upgrading to v3.2.1, or it's pre-release editions, you don't have to take any special precautions other than backing up your server and the plugin's data folders. + +The internal files remain the same between these two versions. Version 3.2.1 has a lot of new additions to the internal file formats, but nothing will break if using v3.2.0 data with v3.2.1. Matter of fact, if for some reason, you want to down grade from v3.2.1 to v3.2.0 you can. Any new data elements from v3.2.1 will be lost if any of the data items are rewriting to the file system. If a mine is not modified, as an example, then it will not write the mine data back to the file system. + + +Upgrading from Prison v3.1.1 to Prison v3.2.1 or Prison v3.2.0
+ +Upgrading from Prison v3.1.1 to either Prison v3.2.0 or Prison v3.2.1 requires no special procedures or processes. The internal file formats are pretty close to being the same that it should work with no problems. Just make sure you perform a backup of the server and the plugins data folders to provide that extra level of insurance and protection. + + +It is inadvisable to try to down grade to Prison v3.1.1 if running Prison v3.2.0 or later. It may work, but there could possibly be potential internal failures due to the addition of the new fields. If you try to do this, you assume all risks and no help will be provided. + + +Upgrading from v3.0.0 to Newer Versions of Prison
+ +Honestly I cannot advise you on actual steps to take, since I do not know what file formats were used with v3.0.0. I suspect they are compatible 100% with v3.1.1. If this is true, you can just jump to Prison v3.2.1 with no problems. + +If there is an incompatibility, then its strongly suggested that you upgrade to v3.1.1 first and let it perform its own conversions, then shut down the server carefully. If it is not shutdown cleanly, then the data files will not be saved to the file system. Once you update to v3.1.1 then you can update to v3.2.1 without any issues. + + + + +Upgrading from Earlier Versions Prior to v3.0.0
+
+For prison releases prior to Prison v3.0.0, the data structures they uses to store all the data on the file system was different. I do not know how it was different, I just know it was. I saw there were remains of a conversion utility in Prison v3.0.0 that I **think** was able to convert Prison v2.x data to Prison v3.x formats. If you are upgrading from Prison v2.x it is VERY IMPORTANT that you first upgrade to Prison v3.0.0!! Once up start up that server, use the command **/prison** and confirm there is a command **/prison convert**, and if there is, run that command to convert your old data to the new Prison v3.0.0 format. Make sure you take backups BEFORE and AFTER upgrading your data! Also do a "clean" shutdown on prison v3.0.0 to finalize the changes.
+
+
+**Please NOTE:** It needs to be understood that changes made to mines, ranks, ladders, or player data, in versions of Prison prior to v3.2.0 did NOT save those changes until the server shutdown. So if the server should happen to crash, the changes could have been lost. So this is important to understand, because if you are upgrading from an older version of prison to Prison v3.0.0, a version prior to Prison v3.2.0, then you MUST ensure the server shuts down cleanly or the conversions and/or changes to the prison data may not have been written to the server file system. After you shut down the server, if performing an upgrade to v3.0.0, please review all the files under the plugins/Prison directory and make sure the last modify date reflects when you shut down the server. If the files have not been updated, try restarting the server, and maybe make a change to mine or rank to force a save when the server shuts down. I cannot help with this process other than these suggestions. Sorry.
+
+
+Once you are running Prison v3.x.x then you can safely upgrade to Prison v3.2.0, or better yet, to Prison v3.2.1 (or the pre-release edition).
+
+
+
+
+
+
+
diff --git a/docs/prison_docs_014_Prison_Configs.md b/docs/prison_docs_014_Prison_Configs.md
new file mode 100644
index 000000000..c27bc78e0
--- /dev/null
+++ b/docs/prison_docs_014_Prison_Configs.md
@@ -0,0 +1,27 @@
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Prison - Prison Configuration Files
+
+This document provides some important information on the various Prison configuration files.
+
+
+Some of the config files requires manual changes to the file itself, and others are fully managed within the server. All of these files are listed below along with how to change each one and what the various configs do.
+
+
+
+
+
+# Overview
+
+
+Coming soon. This is a work in progress.
+
+
+
+
+
+
+
+
diff --git a/docs/prison_docs_020_setting_up_luckperms.md b/docs/prison_docs_020_setting_up_luckperms.md
new file mode 100644
index 000000000..e00ce9331
--- /dev/null
+++ b/docs/prison_docs_020_setting_up_luckperms.md
@@ -0,0 +1,55 @@
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Setting up LuckPerms
+
+This document provides a quick overview on how to install LuckPerms.
+
+
+
+
+
+# Dependencies
+
+* **Vault** - **Required** - Provides the permission integration with Prison
+
+
+
+
+
+# Setting up LuckPerms
+
+Setting up LuckPerms is simple:
+
+* Download LuckPerms
+ - Go to the SpigotMC.org LuckPerm's resource page:
+ - [LuckPerms Downloads](https://www.spigotmc.org/resources/luckperms-an-advanced-permissions-plugin.28140/history "LuckPerms download can be found under the Version History tab")
+ - Click on the Version History tab
+ - Choose the version to download
+
+* Copy to your server's plugin directory
+
+* Restart the server
+
+* Follow LuckPerm's documentation on customization, but at this point it's ready for use with the Prison plugin.
+
+
+
+
+
+
+
+# Warning about LuckPerms Versions
+
+Due to how LuckPerms registers with the Spigot Plugin Manager, it will cause plugins to fail if they were designed for the older LuckPerms version. Therefore, plugins can only be used with the version of LuckPerms that they were designed for and it's up to the server owner to be able to figure that out on their own.
+
+**Prison plugin v3.2.0** *only* works with LuckPerms v4.4.1 and older. Luckperms v4.4.1 is the suggested version and can be downloaded here:
+[LuckPerms v4.4.1](https://www.spigotmc.org/resources/luckperms-an-advanced-permissions-plugin.28140/history "LuckPerms v4.4.1 can be found under the Version History tab")
+
+**Prison plugin v3.2.1** and newer works with *any* version of LuckPerms. It is suggested that LuckPerms v5.0.x is used, but you may also use LuckPerms v4.4.1.
+
+
+
+
+
diff --git a/docs/prison_docs_022_setting_up_PermissionsEX.md b/docs/prison_docs_022_setting_up_PermissionsEX.md
new file mode 100644
index 000000000..f113ceaa5
--- /dev/null
+++ b/docs/prison_docs_022_setting_up_PermissionsEX.md
@@ -0,0 +1,46 @@
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Setting up PermissionsEX
+
+This document provides a quick overview on how to install PermissionsEX.
+
+
+
+
+
+# Dependencies
+
+* **Vault** - **Required** - Provides the permission integration with Prison
+
+
+
+
+
+# Setting up PermissionsEX
+
+Setting up PermissionsEX is simple:
+
+* Download PermissionsEX
+ - Search for a downloadable copy.
+ - The bukkit.org resource page has been disable and suggests using LuckPerms instead.
+
+* Copy to your server's plugin directory
+
+* Restart the server
+
+* Follow PermissionsEX's documentation on customization, but at this point it's ready for use with the Prison plugin.
+
+
+
+
+
+
+# Obsolete Warning for PEX
+
+Since PEX has been abandoned and has no support, it is strongly suggested that you use LuckPerms or another permission manager instead. If you do decide to use PEX then you do so at your own risk. We reserve the right not to spend time addressing issues that may be resolve with a more modern permission manager.
+
+
+
+
diff --git a/docs/prison_docs_024_setting_up_Ultra_Permissions.md b/docs/prison_docs_024_setting_up_Ultra_Permissions.md
new file mode 100644
index 000000000..698046691
--- /dev/null
+++ b/docs/prison_docs_024_setting_up_Ultra_Permissions.md
@@ -0,0 +1,52 @@
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Setting up Ultra Permissions
+
+This document provides a quick overview of how to install Ultra Permissions. Please keep in mind that this is a paid plugin, and is in no way associated with the Development team of Prisons.
+
+
+
+
+
+# Dependencies
+
+* **Vault** - **Required** - Provides the permission integration with Prison
+
+
+
+
+
+# Setting up Ultra Permissions
+
+To set-up Ultra Permissions, please follow the instructions listed below:
+
+* Download Ultra Permissions:
+ - Go to the SpigotMC.org Ultra Permissions resource page:
+ - [Ultra Permissions Download](https://www.spigotmc.org/resources/ultra-permissions.42678/)
+ - All versions appear to be compatible with Prison v3.2.x, so download the latest release.
+
+
+* Copy to your server's plugin directory.
+
+
+* Restart your server. Do not use **/reload** (see below).
+
+
+* The plugin is ready to use as-is, but if you want to customize the settings, please follow the Ultra Permissions documentation that is available on their [wiki page](https://ultrapermissions.com/wiki/).
+
+
+
+
+
+
+# Special Notices
+
+* Do not use **/reload** with this plugin since it may not correctly grab all the required permission nodes.
+
+
+* You are required to add yourself as a super user by running the following command `upc addsuperadmin [player]` if you wish to use the in-game GUI or run any Ultra Permissions related commands.
+
+
+
+
diff --git a/docs/prison_docs_026_setting_up_worldguard_worldedit.md b/docs/prison_docs_026_setting_up_worldguard_worldedit.md
new file mode 100644
index 000000000..23c0694b2
--- /dev/null
+++ b/docs/prison_docs_026_setting_up_worldguard_worldedit.md
@@ -0,0 +1,45 @@
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Setting up WorldGuard and WorldEdit
+
+Although Prison does not directly utilize WorldGuard or WorldEdit, both of these plugins can be critical in setting up a functional Prison server.
+
+WorldGuard requires WorldEdit to work.
+WorldGuard can be used to restrict players from entering and using mines that they should not have access to.
+
+
+This short document just explains how to install these plugins. Other documents will go in to greater detail on how to setup and use WorldGuard regions to protect your mines and to limit players from going in to mines they do not have access to.
+
+Of course you don't need to use WorldGuard and WorldEdit, these are just presenting one possibility for your sever. Other options exist.
+
+
+
+
+
+# Installing the Plugins
+
+
+* Download WorldEdit
+ - Go to the bukkit.org WorldEdit's resource page:
+ - [WorldEdit plugin Download](https://dev.bukkit.org/projects/worldedit/files "WorldEdit downloads can be found under the File tab")
+ - Click on the File tab
+ - Choose the version to download that matches the minecraft version of your server
+
+* Download WorldGuard
+ - Go to the bukkit.org WorldGuard's resource page:
+ - [WorldGuard Plugin Download](https://dev.bukkit.org/projects/worldguard/files "WorldGuard downloads can be found under the File tab")
+ - Click on the File tab
+ - Choose the version to download that matches the minecraft version of your server
+
+* Copy to your server's plugin directory
+
+* Restart the server
+
+* Follow WorldGuard documentation on customization, but at this point it's ready for use with the Prison plugin.
+
+
+
+
+
diff --git a/docs/prison_docs_0xx_setting_up_EssentialsX.md b/docs/prison_docs_0xx_setting_up_EssentialsX.md
new file mode 100644
index 000000000..18f8849ce
--- /dev/null
+++ b/docs/prison_docs_0xx_setting_up_EssentialsX.md
@@ -0,0 +1,108 @@
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Setting up EssentialsX
+
+This document provides a quick overview on how to install EssentialsX and add the Prison Rank Tag to your chat.
+
+
+
+
+
+# Optional Dependencies
+
+It is highly recommended to install [Vault](https://www.spigotmc.org/resources/vault.34315/). Vault will allow many different economies, permissions, and placeholders to works with Prison. If no other economy is detected, then Prison will default to using EssentialsX as a backup.
+
+
+
+
+
+# Setting up EssentialsX
+
+Setting up Essentials is easy, but you've to choose which plugins to add.
+
+* Download the EssentialsX's Zip, which contains various jars plugins.
+* Download from the SpigotMC.org EssentialsX **Version History** tab for the EssentialsX Resource:
+ - [EssentialsX Download page](https://www.spigotmc.org/resources/essentialsx.9089/)
+* Unzip the download.
+* Copy the jar files of your choice to your server's `plugin/` directory.
+* The zip file contains multiple jars of the same version. Always use the same versions with each other, but never mix one EssentialsX jar version with another version.
+* Available Modules and what is recommended:
+ * EssentialsX - Main jar - **Required**
+ * EssentialsXAntiBuild - *Optional* - Don't use if using WorldGuard?
+ * EssentialsXChat - **Recommended** - Provides chat based placeholders (see below)
+ * EssentialsXGeoIP - *Optional* - Provide geo locations for players IP addresses
+ * EssentialsXProtect - *Optional* - Not sure, but shouldn't be used with WorldGuard?
+ * EssentialsXSpawn - *Optional* - Not sure, but provides special behaviors for spawn? Not sure.
+ * EssentialsXXMPP - *Don't Use* - Google XXMPP for spigot to confirm if you really have a need to use this. You probably never will.
+
+* Prison does not require you to change any settings in EssentialsX, but you may if you want to customize some things.
+* List of possible items to modify:
+ * Chat prefixes (see below)
+ * Item prices if you will be using the shop functions through EssentialsX. If you do, I suggest you remove the entries for armor, weapons, tools, food, etc. Otherwise players may accidentally sell things they need. Also you can add new items to be sold.
+ * Customize kits
+ * etc...
+* Restart your server
+
+
+
+
+
+## Add the Prison placeholder *Rank Tag* to Player's Chat Prefix
+
+* EssentialsX's plugin folder on the server
+* Path: `plugins\Essentials\`
+* Edit the `config.yml` file:
+ - Search for the section pertaining to chat by using the keyword: **EssentialsChat**
+ - Add the placeholders {prison_rank_tag} or {prison_rank} to the "format:" line.
+ * The placeholders should be entered in all lower case
+ * The curly braces is used by EssentialsX chat engine, not Prison. Other chat plugins may use percent symbols instead.
+ * {prison_rank} is the rank name without special formatting
+ * {prison_rank_tag} is the defined tag (with formatting) for that rank
+ - Example:
+ ```
+ format: '<{prison_rank_tag}:{DISPLAYNAME}>{MESSAGE}'
+ ```
+
+Reload EssentialsX settings, or restart the server.
+
+
+
+
+
+# Applying Settings and Reloading Essentials
+
+* Restart the server. Or use **/essentials reload**.
+
+
+* Notice: **Don't use /reload to reload the whole server!** Using /reload or another tool such as plugman could corrupt plugins. Prison was not designed to do soft reloads and as such mines, ranks, ladders, and even some player settings and histories could be corrupted.
+
+
+
+
+
+
+
+
+
+
+# Essentials Currency Commands
+
+
+Eventually you may have to deal with currency, so here are the esstentals commands.
+
+* `/eco` - Show the EssentialsX economy commands
+* `/eco give ` - Give a player money
+* `/eco take ` - Take away money from a player
+* `/eco set ` - Set a player's balance to an amount. Resets the balance to a given amount.
+* `/bal ` - Shows the balance for a given player.
+
+
+
+
+
+
+**End of the guide**
+
+
+
diff --git a/docs/prison_docs_0xx_setting_up_PlaceholderAPI.md b/docs/prison_docs_0xx_setting_up_PlaceholderAPI.md
new file mode 100644
index 000000000..40222f51d
--- /dev/null
+++ b/docs/prison_docs_0xx_setting_up_PlaceholderAPI.md
@@ -0,0 +1,84 @@
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Setting up PlaceholderAPI
+
+This document provides a quick overview on how to install PlaceholderAPI.
+
+Additional documentation on placeholders:
+
+* [Guide: Prison Placeholders](prison_docs_310_guide_placeholders.md)
+ How to use placeholders. Includes HolographicDisplays.
+
+* [Setting up Mines](prison_docs_101_setting_up_mines.md)
+ This has a placeholder example using a One-block mine example with HolographicDisplays.
+
+
+
+
+
+
+# Optional Dependencies
+
+* If you want to use placeholders with plugins without placeholderAPI support you should also install the right version of [Protocollib](https://www.spigotmc.org/resources/protocollib.1997/) for you server and the [PlaceholderAPI ChatInjector](https://www.spigotmc.org/resources/chatinjector.38327/)
+
+
+
+
+
+
+# Setting up PlaceholderAPI
+
+Setting up PlaceholderAPI just need couple of steps:
+
+* Download PlaceholderAPI
+ - Go to the SpigotMC.org PlaceholderAPI download page
+ - [PlaceholderAPI Download page](https://www.spigotmc.org/resources/placeholderapi.6245/)
+
+* Copy to your server's plugin directory
+
+* Restart your server. Do not use **/reload** or you'll break Prison Placeholders. Prison registers all of the placeholders upon server startup so the registrations will be lost.
+
+
+
+
+
+# Placeholders Commands
+
+Use the command **/prison placeholders** for a listing the placeholder commands. These include:
+
+* **/prison placeholders list**
+* **/prison placeholders search **
+* **/prison placeholders test **
+
+* **/prison version**
+
+The listing of all the placeholders is available within the Prison startup information, and through `/prison version`.
+
+
+
+
+# Troubleshooting Possible Compatibility Issues
+
+There are no known issues with Prison and PlaceholderAPI, but out of the interest to help get your servers up and running, here are a couple of tips that could help with your environment.
+
+
+Issue with PlaceholderAPI not working with Economy and Scoreboard
+
+There was an issue with an economy placeholder not working with the QuickBoard placeholder.
+
+The solution was to download from PlaceholderAPI, their modified version of Vault and Essentials. Followed by a server restart, or use `/papi reload`.
+
+```
+/papi ecloud download Vault
+/papi ecloud download Essentials
+/papi reload
+```
+
+As a note, I'm not sure how well Prison behaves with the use of `/papi reload`. It may be good to test with, but safer to just restart the server, once everything appears to be working and looks good. The point is that any plugin reload is good to test with, but if you're going to let your server run for months, its probably best to do a clean restart.
+
+With this example of installing the PlaceholderAPI and downloading their version of Vault and Essentials, the player reported that once the economy placeholder was working, another placeholder stopped working. Their solution was to reinstall all of the papi (PlaceholderAPI) plugins (not sure if that includes reinstalling papi's version of Vault and Essentials) and then restarted the server. The point here, is a clean start is probably helpful.
+
+
+
diff --git a/docs/prison_docs_101_setting_up_mines.md b/docs/prison_docs_101_setting_up_mines.md
new file mode 100644
index 000000000..acd380626
--- /dev/null
+++ b/docs/prison_docs_101_setting_up_mines.md
@@ -0,0 +1,476 @@
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Prison - Setting Up Mines
+
+This document provides some highlights to how to setup mines. It is a work in progress so check back for more information. Initially it will cover the basics, but hopefully will expand to more advanced topics.
+
+
+
+# Overview
+
+This document should be able to provide the basic information to get your mines configured. There are many options available within Prison, and also through the use of other plugins, and these advanced topics are beyond the scope of this document.
+
+
+Items to add to this document:
+* Use of **/mines set area** to change the mine size without deleting it.
+* Use of **/mines delete** how it works and how to recover a deleted mine.
+* Use of **/mines list**
+* Use of **/mines reset** provide a little information about how it works in relationship to the other settings and commands. There are some internal things that happen and this will help clarify how the other settings are impacted.
+
+
+
+
+# Getting Started
+
+Please review the Prison's [Table of Contents](prison_docs_000_toc.md) for information on how to configure your server, and which plugins are required, or at least suggested.
+
+It is also strongly suggested that you review the documentation on [Configuring and Using WorldGuard with LuckPerms to Protect Mines](prison_docs_626_configuring_worldguard_regions.md) since that explains a lot on how to setup the basics with your world, which will not be covered here. There will be references to this document, but this will be the only link provided.
+
+These instructions assume you are OP'd since that is part of the above document pertaining to WorldGuard. If not, go ahead and OP yourself.
+
+To follow along with this documentation, you may want to crate your first mine as a test, with intentions of deleting it later. It may be easier to remove it, than to convert it over to a final product. The instructions here are informational, not focused on perfection. So after you figure out how to create your mines, you may want to provide more attention to the details to ensure they are perfect. But for now, the focus is on the commands.
+
+Please note that all command provide in this document will be written as if they were entered within the game. If you use some of them from the console, then do not include the slash prefix. I always include the slash prefix in the documentation so the commands stand out as being commands.
+
+It should also be strongly noted that you should never modify the save files for the mines, ranks, or ladders, since that could easily lead to corruption and undefined failures and problems. We cannot support misuse of the files.
+
+
+
+
+# Create Your First Mine
+
+Being OP'd, find a good location for your mines.
+
+Also the following commands may help setup the environment. Optional of course. Having some block in your inventory can be useful for use as scaffolding or selecting. I personally like to use sealanterns because they are not a common block and they stand out well in low light conditions and are easier to see in screen prints. Giving yourself `/fly` and `/god` may not be necessary, but it could help if you need to find a good location, or if there are mobs in the area when you drop out of creative mode and back in to survival.
+
+```
+/op
+/fly
+/god
+/gamemode creative
+/time day
+/give sealantern 64
+
+```
+
+The wand
+
+Now give yourself a Prison wand.
+
+```
+/mines wand
+```
+
+
+Laying Out the New Mine
+
+For the sake of this document, and to keep things simple, the mines we are creating will be very small and will not be deep within the ground.
+
+
+First mark out the dimensions of your mine. As you can see here, I've marked my first mine out with sealanterns to show you how big it will be. You really only need to mark opposing corners since that defines a cuboidal region. I've cleared away some of the dirt so you can see the lower blocks. This mine will be 5 x 5 x 5 in size.
+
+
+
+
+
+Define the New Mine
+
+Then holding the Prison's wand (blaze rod), left-click in one corner, and then right-click in the opposite corner. In this example, I've left-clicked the lowest sealantern block, then right-clicked the highest sealantern block. You should see a message indicating that you have successfully selected a region.
+
+
+
+
+Then create the mine with:
+```
+/mines create test1
+```
+
+It will default to 100% air. So then follow up creating the new mine with a reset to confirm everything is replaced with air.
+
+
+
+Reset the New Mine to Test it Exists
+
+Go ahead and reset the mine. All of the sealanterns that were used to mark the mine are now gone, and so are the two layers of dirt. That confirms success with our first mine since the only default block that exists in the mines when created is air.
+
+```
+/mines reset test1
+```
+
+
+
+
+
+
+
+
+
+# Mine Commands Overview
+
+Now that we've created a mine, let's take a moment and review some of the available commands. There are a lot of options available, and many of those options have numerous features, so this will just be an overview so you have a better idea of what you could possibly do with your new mines. This listing is generated within the console so it's easier to see. This includes the main grouping of commands, which is displayed with `/mines`. Remember, when using commands within the console drop the leading slash. Then two sub-groups: `/mines block` and also `/mines set`.
+
+
+For the following commands, we can use the console, which is also easier to see for this documentation. But these commands can just as easily be ran within game.
+
+
+
+
+
+
+Some of the highlights of these commands are as follows:
+* `/mines create` : Create the mine based upon the wand selection.
+* `/mines command` : **Now active!** **Take your mines to the next level!** See the document on [Mine Commands](prison_docs_111_mine_commands.md) for more information. Every time a mine resets, you can now control what commands run right before a reset, and what runs right after a reset. These commands are similar to the Rank Commands, since they can be any command that you can run from the console. The idea is that you can have unique mines that have not been possible before, such as randomly spawned forests or specific builds.
+* `/mines delete` : Deletes a mine. You can always undelete a mine by going in to the server file system and rename the deleted mine, then restart the server.
+* `/mines info` : Very useful in viewing all information related to the mine.
+* `/mines list` : Displays all mines on your server.
+* `/mines reset` : Resets the mine. Forces a regeneration of all the blocks, even if the mine is in skip reset mode.
+* `/mines stats` : Toggles the display of stats that pertain to how long it takes to reset the mines. View /mines info or /mines list to see the stats. Use this command again to turn it off.
+* `/mines tp` : tp to a mine's spawn point, or the center of the mine if no spawn has been set. If players are given the permissions, they too can use this command. Use `/mines tp help` for a list of the perms.
+* `/mines whereami` : Shows you what mine you are in, or how far away you are from other mines in the area. If you have a lot of mines, it's easy to lose track of where you are, and this may help get your bearings.
+
+
+* `/mines block add` : Add a new block type to a mine. It's easier to start off with block search and have it fill in the commands for you.
+* `/mines block remove` : Remove a block type from a mine.
+* `/mines block search` : Search for a block type based up on a search string.
+* `/mines block set` : Edit the block's percentage within the mine. A percent of zero will remove. If the block does not already exist, it will be added. (Can replace add and remove).
+
+
+* `/mines set area` : Redefine the area of the mine. Careful, this can wipe out builds if set incorrectly.
+* `/mines set notification` : Can turn off the notifications on a per-mine basis. Or set the notification radius, or only notify players within the mine. This command cannot change the message.
+* `/mines set resetTime` : Changes the time between resets, as expressed in seconds. Applies to each mine independently.
+* `/mines set skipReset` : When enabled, can prevent a mine from resetting if it has no activity. Can set a threshold before the mine is reset, such as 80% will require 20% of the blocks be mined before being reset. Can also set a bypassLimit so that if the reset is skipped X number of times, it will force a reset anyway.
+* `/mines set spawn` : Sets the mines spawn point. Whatever you are looking at is what the players will be looking at when they tp to that spot.
+* `/mines set zeroBlockResetDelay` : If the mine runs out of blocks, when enabled, it will force a manual reset after the specified delay. The delay can be zero for instant reset.
+
+Adding the term `help` to the end of any of the above listed commands will display additional information that is available for each command, including the parameters and also all permissions that are associated with the commands.
+
+
+
+
+# Customizing Your Mines
+
+Now that we have a mine created, let's go ahead and customize it.
+
+Inspect our New Mine
+
+Let's first take a quick look at the new mine with this command. Let's view it now, before we start making changes.
+
+```
+/mines info test1
+```
+
+
+
+
+
+
+
+Select a Few Blocks
+
+The easiest way to select blocks is to search for them. Let's add a few such as cobble, glowstone, gold ore, and coal ore. Use the block search with cobble:
+
+```
+/mines block search cobble
+```
+
+
+
+When using the console with block search limits what you can do with the block search. If you are in game, you can click on a block type that is displayed, and it will auto fill out the block add command for you, such that all you need to do is add the percentage at then end of the command. Also in game, you can page through the results.
+
+This is an example of in game use of this command. Notice by clicking on cobble it pre-fills all the parameters for the `/mines block add`, including the most recently used mine name and the selected block. This screen print shows that I added the value of `20` right after the percent sign.
+
+
+
+Then let's take a look at the `/mines info test1 all` command, where all indicates all pages should be displayed in-line without paging. Notice how Prison automatically provides the balance of air so the total percent is equal to 100.0%.
+
+
+
+
+Now if we perform a `/mines reset test1` then we can see how the cobble is randomly placed at a rate of 20%, and the remainder is air.
+
+
+
+
+Let's add the other blocks, each at 20% then take a look at the mine info and how it generates. Please notice that you can add a single block with as little as 0.01%. You can also add as many different blocks as you please too. There are no meaningful restrictions.
+
+
+With the additions of the other ores, including 1/2 a percent of sealanterns:
+
+
+
+
+
+
+
+Example of a mine reset including a sealantern. Notice that there is still 19.5% air.
+
+
+
+
+
+
+
+
+
+
+# Next Steps - Skipping Resets, Notifications, and Zero Blocks
+
+
+The mine is now usable as-is, but there are still a lot of options that we can add to enhance the mine's behavior to better suit our needs. For example, we can set a spawn point so we can control where players are teleported to when the mine resets, or if they tp to the mine.
+
+For our example, let's use the console to set the notification, resetTime, skipRest, and the zeroBlockResetDelay. We must be in game to set the spawn point since it uses where your player is standing and where you are looking.
+
+
+
+Customizing the Mine
+
+Issuing all these commands through the console, such as the following. Note that the spawn point has been set in game, and the reset time has not be changed.
+
+
+
+Mine info showing all changes. Observe the spawn location now shows an actual location, but yet it does not show the pitch or yaw. The information also shows that the mine has reset 30 times since there server started, and that you must be standing within the mine to receive reset notifications.
+
+
+
+
+
+Notifications Explained
+
+In the example above, the notifications for that mine was set to only provide them to the players that are within the mine. The other options are disabled and radius from the center of the mine.
+
+```
+/mines set notification test1 within
+```
+
+
+
+Skip Reset Explained
+
+To better explain what the skipReset does, is it uses the threshold percent as the trigger to allow the mine to auto reset. Once the **blocks remaining** value hits that value, or is less than that value, it will alloow the mine to rest at it's normal reset time. If the blocks remaining is higher than the threshold, then it skips the reset and increments the skip counter (not shown in this screen print since it is zero). Once the number of skips reaches, or exceeds, the Skip Limits value, then it will allow the mine to reset.
+
+This behavior allows unused, or barely used, mines to avoid from always being reset. This can reduce the server load and prevent lag on larger servers, or if there are many mines.
+
+This feature never will force a mine to reset early, nor will it ever make it reset. The only active behavior it can alter, is to skip the automatic reset behavior.
+
+If a mine is manually reset, then this feature will never prevent a manual reset from happening. A manual reset will also reset the counter for how many times the mine skipped the automatic resets.
+
+
+Zero Blocks Reset Delay Explained
+
+The feature zero blocks reset delay identifies what should happen when Prison detects that there are no more blocks within the mine. The only action actually is to force an early reset if this feature is enabled, but more specifically, it identifies how many seconds it should delay before forcing the reset.
+
+If this feature is enabled, and the delay value is set to Zero, then the mine is forced to reset with no delay. If there is a light load of jobs running on the server, then it will be instantly reset, otherwise there will be a delay for the job to wait its turn to run.
+
+If the reset delay is non-zero, the value is measured in seconds, with a valid value of 0.01 seconds. But keep in mind that in reality the seconds are converted to ticks and is scheduled within the Bukkit job queue. Therefore, since there are 1000 milliseonds within one second, and 20 ticks within one second, one tick is the smaller possible value, which equates to 50 milliseconds. This is equivalent to 0.05 seconds. When the seconds are converted to ticks, the values will be rounded down to a whole integer value. So if a value is provide such as 0.049 it will be submitted as 0 ticks, which will result in zero delay (if possible) before running.
+
+The bottom line is that this feature can force an earlier reset of the mine when it becomes totally empty of blocks. A delay may be needed, or desired, to reach your perfection for the mine.
+
+
+
+
+
+# Notifications - Config File & Settings
+
+
+The global `resetMessages`, `resetTime` and `resetWarningTimes`, as found in the configuration file `plugins/Prison/module_conf/mines/config.json` needs a little explanation in what they do.
+
+The `resetMessages` is used only upon the server startup, and if it is disabled, then it will not use the `resetWarningTimes` and will skip all notifications pertaining to mine resets. The `resetWarningTimes` are global and cannot be customized per mine. If an individual mine's reset time is less than a warning time, then the reset warning will be skipped for that mine.
+
+The `resetTime` in this configuration file is only used during the creation of a mine and is used to set the initial value for the mine's reset time. If the configuration file's value is changed, it will never effect any preexisting mines, but only ones created after it has been changed.
+
+All mines use their internal reset time and can be customized on a per mine basis using the following command. The command's time value is expressed in seconds.
+
+```
+/mines set resetTime
+```
+
+There are a number of options available for mine notifications, and they are on a per mine basis to allow better control over how to configure everything. The command is as follows. The value for **mode** can be **disabled**, **within**, or **radius**. When radius mode is specified then the radius value must be supplied, and it is expressed as whole blocks (integer).
+
+```
+/prison set notification
+```
+
+The **disabled** option is pretty much self explanatory; messaging for that mine is disabled.
+
+The **within** the mine notification only provides notifications to the players that are within the boundaries of the mine, including players standing upon the top of the mine. One of the behaviors to this mode, is that all players within the mine will be notified that the mine will be reset, but once they are teleported out of the mine to the spawn point they cannot be notified that the mine has been reset (because they are no longer within the mine). But then again, the fact they were teleported to the spawn point should be a big clue the mine reset.
+
+The **radius** setting notifies players that are within the specified distance from the center of the mine, ignoring the Y axis. So if the distance is set to 30 blocks, and they are within that radius, but 200 blocks above the mine, they will be notified. Since the center point of the mine is calculated to be the, um, center, it is possible to make the radius smaller than some points of the mine and still be outside of the mine in other places. So this can provide some nice controls at far distances away from the mine, but could produce some odd behaviors (if you don't understand how it works) if the radius is much smaller in size.
+
+
+Perhaps the last point pertaining to resets has to do with the actual timers. Once a mine is reset, either by automatic resets, zero block resets, or a manual reset, the timer will always reset and start over. This means if there is 30 seconds left on the timer and you do a manual reset, the automatic reset will not happen 30 seconds later.
+
+
+
+
+
+# Listing All Mines
+
+
+As you start to build your mines, you may find it useful to list them all, or use the listing to search for a specific mine.
+
+
+Here are some basic usages of the command. First let's review the help for the `/mines list` command to see what perms are needed and what parameters are available. If you are in game, clicking on `TP` will teleport you to the mine. Clicking on the name will show you the info on the mine, which is the same as using the `/mines info` command. Of course, clicking on these items only works in game, and not from the console.
+
+
+```
+/mines list help
+
+/mines list
+
+/mines list 4
+```
+
+
+As we can see in the screen print of the help, the command takes optional parameters for the page number. It also has the option of `ALL` which will display the list of all mines, which could be helpful in the console.
+
+
+
+
+
+
+
+There is some useful information in the listing too. This listing shows how soon a mine will **Reset**, and what the reset frequency is. It will show you how many times it has been reset since the server started (**RCnt**). It even shows the percent blocks remaining too (**Rem**). If you've added any **mine commands**, those will indicated in a red **Cmds** entry; see the mine named **trees**. Also if a mine is disabled, it will be listed here too.
+
+
+
+
+This listing also shows more details if you have `/mines stats` enabled. Remember that mine stats is a toggled setting. Run it once to enable it. Run it a second time to disable it.
+
+
+With it enabled, it shows stats on mine resets in mine list, mine info, and when mines reset in general. The following screen print within the console shows how these may look, with the addition of the stats.
+
+
+
+
+
+.
+
+
+
+
+
+# Deleting Mines
+
+Mines can be deleted with the `/mines delete` command.
+
+It will prompt you for confirmation. If you are in game you can click on the link then it will fill out the command for you with the parameter `cancel` and you need to rename it to `confirm`. You have one minute to confirm a delete.
+
+When you successfully delete a mine, it will remove it from memory and from loading. The mine is only virtually deleted, since it will still exist in the server's directory. To undelete it, just rename the file back to a normal mine file name, and it will be loaded the next time the server starts.
+
+
+
+
+
+# The Mine Data Files
+
+The mine data files (and also the ranks and ladders) are stored on the server's file system as a way to store each mine's configurations. These files are intended for internal use only and should never be manually modified. When undeleting mines, you may have to rename the files so they are used the next time the server is started, but you should not change the contents.
+
+There are many commands that have interdependancies to multiple settings, and those settings are validated only through the use of the commands. Making changes directly to the files bypasses the validation of the commands and may lead to server corruption and failures.
+
+You are solely responsible for any problems you create by making changes directly to these files. We cannot help undo any problems, issues, failures, or undefined behaviors that may be caused with such tampering.
+
+
+
+
+
+# Advanced Topics
+
+
+
+### Changing the Size of a Mine
+
+
+
+
+
+# Example: A Single Block Mine Grinder
+
+
+To provide a slightly different perspective as to what you can do with your Prison mines, let's build a one block mine and demonstrate the power of what we can down with a few of these settings. We're also going to tie this in to HolographicDisplays and use of the placeholders.
+
+So let's first setup a temporary placeholder for our new mine. I want it to be a one block mine, one block off the ground. So stack two blocks like this. Added a platform, because why not?
+
+
+
+
+
+
+
+Next, using the Prison wand, right-click and left-click on the top block. This will create a one block selection. Then create the mine, naming it **one**.
+
+```
+/mines create one
+/mines block search ore
+```
+
+Then select the following ores and add them to the new mine, all at 10%. Add gold_ore, iron_ore, coal_ore, Lapis ore, redstone_ore, emerald_ore, diamond ore, etc... Then setup the reset time, turn off notifications, and set zero blocks reset delay to zero.
+
+
+
+
+Now let's test our new mine. But first let's make an OP pick. Open the config file `/plugins/Essentials/config.yml` and search for `unsafe-enchantments` and set the value to `true` and then save and exit the file. You can either restart the server, or use `/essentials reload` to apply those changes. Then issue the commands in game, holding the pick after you get it.
+
+```
+/essentials reload
+/give diamondpick 1
+/enchant efficiency 20
+/enchant durability 20
+/enchant fortune 5
+```
+
+Remove the block under the one block mine, then reset it with `/mines reset one`.
+
+Install HolographicDisplays as described in our documentation (see table of contents... must include HolographicExtensions and ProtocolLib). Next we want to create two holographic displays for our one block mine, one above the block, and one below. Do the `/mines info one` to find the *Center* of the mine, and let's use that to modify the HolographicDisplay scripts below. In this example, our coordinates are `(-81, 70, -320)`. Add these to the file `/plugins/HolographicDisplays/database.yml`...
+
+```
+oneTop:
+ location: world, -80.5, 72.5, -319.5
+ lines:
+ - 'Mine: one'
+ - 'Reset Interval: {slowest}%prison_mines_interval_one%'
+ - 'Reset Time Left: {fast}%prison_mines_timeleft_one% - {fast}%prison_mtlf_one%'
+ - 'Blocks Remaining: {slowest}%prison_mr_one% {slowest}%prison_mp_one%%'
+oneBottom:
+ location: world, -80.5, 69.8, -319.5
+ lines:
+ - 'Blocks Mined: {fast}%prison_mbm_one%'
+ - 'Reset Count: {fast}%prison_mines_reset_count_one%'
+
+```
+
+Once you make these changes and save them, reload bolographic displays with `/hd reload`. You can then tweak the position of the HolographicDisplays so they are just centered on the mine, and keep reloading until you get it right. The X and Z axis should be x.5 and z.5, or "point 5", or half blocks to exactly center them. First get them centered on the mine, you can walk around the mine to confirm it looks centered. Then move each one up, or down, as needed. With the results looking like the following:
+
+
+
+
+
+Now to complete this mine, let's enable auto manager. We can do that by turning on Auto Manager for all of our mines, or we can just add a few ore entries to our OP pick. For this example, let's go with the lore. Enter these commands (assuming you have Essentials installed). Using `/prison autofeatures` command to review the correct names for the lore. Please note for this example I'm using 100% since no numbers are specified with these Lore names.
+
+It should be noted that Prison's Auto Features is currently in a state of development and may change with how these settings should be applied. Efforts will be made to keep these instructions up to date, but they may be missed. If you notice that this has happened, then please contact RoyalBlueRanger on the discord server and he will get this corrected. ### Auto Features are not needed to demonstrate this one block mine, but it does illustrate a few more capabilities that exist within Prison and how a few settings can provide a different experience.
+
+```
+/prison autofeatures
+/i diamondpick 1 efficiency:20 durability:20 fortune:5 lore:Pickup|Smelt|Block
+```
+
+More information on the EssentialX's lore settings can be found here: [EssentialsX Item_Meta](http://ess.khhq.net/wiki/Item_Meta).
+
+
+
+
+Note, because we are using Lore on your pickaxe, we don't have to enable the auto features, such as with `AreEnabledFeatures`, but the individual elements should be all be set to `true`, or the `AllBlocks` should be set to `true`. The Lore on a tool can bypass the global settings. Also make sure you drop back in to survival mode to get the normal speed for your OP pick.
+
+```
+/gamemode survival
+```
+
+
+
+
+
+And that's it for now. This is what I would consider a draft copy, and I will come back in a few days to refine this document (and remove this comment).
+
+
+
diff --git a/docs/prison_docs_102_setting_up_ranks.md b/docs/prison_docs_102_setting_up_ranks.md
new file mode 100644
index 000000000..573eec30c
--- /dev/null
+++ b/docs/prison_docs_102_setting_up_ranks.md
@@ -0,0 +1,549 @@
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Prison - Setting Up Ranks & Ladders
+
+This document provides information how to setup and use ranks and ladders.
+
+Information on how to use Prestiges is provided in a separate document: [Setting up Prestiges](prison_docs_107_setting_up_pestiges.md)
+
+
+The use of Ranks, Ladders, and Prestiges are all optional. You can either use these Prison based items, or you can use some other plugin to provide these functionalities. The choice is yours.
+
+
+
+
+
+# Overview
+
+
+Prison is more than just mines. Mines provides the physical content of your server. It's the ranks and the ladders that ties everything together. It's the Ranks that provides the hooks in to all of your server's other plugins through the use of Rank Commands. And it's the ladders that provides a logical progression from one rank to the next.
+
+
+Prison Ranks can be very simple in that they don't have to do much. They don't even need to have any Rank Commands, but its through the Rank Commands that provides the power to customize your server in almost any way you can dream.
+
+
+Ladders are a way to logically organize your ranks. The concept is a just like a ladder where you start at the bottom, and to progress up the ladder, one rank (rung) at a time. You cannot skip ranks, but you can also go back down the ladder too. Only admins can demote players, since that's not part of the normal Prison game play.
+
+
+Prison also provides a number of Admin based commands to manage ranks and ladders. Obviously the standards on how to create and edit the Ranks and Ladders, but also Prison provides the tools to manage players within the various ranks and ladders too.
+
+
+
+
+#Ranks
+
+There are many different ways you can setup your Prison server and ranks is just one small part of how you can customize everything.
+
+
+One way to do ranks is to have a few prison ranks, with working to a "free" rank and beyond. Example would be ranks in the following order: D (default), C, B, A, Free, Citizen, Elite, Rules, Emperor. Where ranks D through A are restricted to the mines within the prison, but then Free and higher have access to the free worlds to gather resources, build bases, and other things such as even factions. A few examples provides screen prints with this design since it's generally fewer overall ranks.
+
+
+Another type of prison game mode is more along the lines of an OP based Prison server where ranks run from A through Z with prestiges and even rebirths. Where the costs of ranking up becomes significantly higher with each rank, but yet the ores and blocks you can mine have much greater worth. The tools are generally very OP and beyond the normal safe enchantments.
+
+
+This documentation uses setups that are fairly simple. The mine names also matches the rank names, but they don't have to. Matter of fact, the rank name and mine names can be almost anything to allow the most flexibility for your setup.
+
+
+
+
+
+#Adding Ranks
+
+
+Adding Ranks is pretty simple.
+
+
+The command to add a rank is as follows, along with the help generated for it:
+
+```
+/ranks create [rankName] [cost] [ladder] [tag]
+
+/ranks create help
+```
+
+The first rank you add will become the default rank on the ladder in which you add the rank. As you add more ranks, they will be added to the ladder in the order in which they were added.
+
+
+If you need to change the order of a rank, or even move it to another ladder, you can use the command: `/ranks ladder addrank`. Ranks do not have to be associated with a ladder and with this command, you can actually remove the ladder from the rank, or move it around. See that command under ladders for more information.
+
+
+The `cost` for the default rank, or the first rank on a ladder, should have a value of zero if you expect new players to gain this rank when they join the server. It doesn't have to have a zero cost, but it depends upon what your needs are. If the ladder is not the **default** ladder, then the odds are that the rank is not going to be zero.
+
+
+The `ladder` field for this command is the ladder name to which the new rank will be assigned. If it is a rank that is based upon prison mining and advancement, then the **default** ladder should be used. The **default** ladder name is simply **default** and it does not have to be provided if there are no other parameters that follows. If you want to provide a `tag` name then just use a value of `default` for that parameter.
+
+
+The `tag` parameter is the fancy display name for this given rank. You do not have to specify it on this create command, since you can always add it, or change it later with the `/ranks set tag` command. The tag generally contains additional formatting characters such as color codes and even brackets or other characters. It does not have to contain the rank's name. The tag is what is generally used in placeholders for its special formatting.
+
+For example a default prestige rank may simply be something like this with the emphasis on the plus sign: `&d[&6+&d]`
+
+
+
+
+
+
+
+
+
+
+
+#Rank Information
+
+Information on a rank can be viewed by using the following command:
+
+```
+/ranks info [rankName]
+
+/ranks info help
+```
+
+This example of rank information includes a rank that has a custom currency. *See more information below on custom currencies.* If a rank does not have a custom currency, then it will not show the currency information.
+
+
+
+
+
+
+#Rank Listings
+
+To list all ranks for a given ladder use the following command:
+
+```
+/ranks list [ladderName]
+
+/ranks list help
+```
+
+The `ladderName` parameter is optional and will default to a value of **default**. To view ranks on another ladder, then you must use that ladder's name. But please notice, that at the bottom of the listing, it shows what other ladders are available to be used with this command. If you use this command in game, then you can click on those displayed commands to show those listings.
+
+
+
+
+
+
+
+
+
+
+#Deleting Ranks
+
+Ranks can be deleted, but when they are, they are simply just removed from Prison and no longer loaded. Deleted Ranks can be undeleted.
+
+To delete a rank, use the following command:
+```
+/ranks delete [rankName]
+```
+
+Ranks are stored within the server's file system in the following path starting from the server's main directory:
+
+```
+/plugins/Prison/data_storage/ranksDb/ranks/
+```
+
+Internally, all ranks are assigned a serial number which is used to identify the rank. The number starts with a 0 and is incremented as more ranks are added. Ranks that are deleted, may have new ranks reuse the same number.
+
+
+This internal serial number is what Mojang would consider a magic number. In a future version of prison, these magic numbers will probably be eliminated. Their elimination will not impact preexisting prison configurations moving forward, but could impact the ability to down grade prison to an older release.
+
+When a rank is deleted, it is removed from memory, and the file that is saved in the above directory path is renamed and ignored the next time prison is started. For example, if a rank's file name is **rank_2.json** then when it is deleted it will be renamed **.deleted_rank_2.json_.del**. Such that it may look like this: **.deleted_rank_2.json_2020-08-16_13-49-27.del**
+
+To undelete a deleted rank, first shut down the server. Then go in to the server's directory above and rename the deleted file back to it's original name. If that name is taken by another rank, then you must rename it to have a magic number that is not being used by another rank, plus you must also change the internal value of the field "id" in that json file to match the new number that you assigned to it.
+
+For example, with the file name originally being **rank_2.json** and it was deleted and assigned the new name of **.deleted_rank_2.json_2020-08-16_13-49-27.del**. Plus if numbers 0 through 36 are taken, and you must rename it with the serial number of 37: **rank_37.json** then change the internal value of "id" to match:
+
+```
+{
+ "cost": 3500000.0,
+ "name": "guardian_of_zool",
+ "currency": "zoolian_hearts",
+ "id": 37,
+ "tag": "&4[&b&ka&bGuardian of &eZool&b&ka&4]",
+ "commands": []
+}
+```
+
+The above shows how "id" has been updated to a value of `37`. It also shows that this rank uses a custom currency named **zoolian_hearts**.
+
+
+
+
+
+#Changing a Rank's Cost
+
+The Rank's cost is initially set when creating a rank, but it can be changed at any time. The command to change the cost is:
+
+```
+/ranks set cost [rankName] [cost]
+
+/ranks set cost help
+```
+
+The cost of the rank can be any value, up to the max value allowed by a Java double. The limitations of what can be stored in a double is also constrained by Java too.
+
+As an example, you can be able to use a really large value for a cost, but you may not be able to set the one's digit of that value. For example if you assign a cost of 214748364952382342, note that the last three digits are 342. But when you view the cost that is actually assigned to the rank, it will show the last three digits as 336. This is not an error, but a limitation with how floating numbers, such as doubles, work within computers in general. This is related to the fact the number is stored in more than one part, of which the mantissa and exponent are most significant for costs. If you're going to use really huge values for a cost, you must understand you cannot control some of the digits of a double.
+
+
+
+
+
+
+
+If you are going to assign the rank a custom currency, then you can set the currency at any time, before or after changing the cost.
+
+
+
+
+
+#Changing a Rank's Currency
+
+
+Prison supports custom currencies, instead of the default currency that is used with most plugins such as Vault or Essentials.
+
+
+In order to use any default currency, you first must have a plugin that prison recognizes that supports multiple currencies and that must be a valid currency within that plugin prior to its use.
+
+
+Currently the only plugin that Prison supports for custom currencies is GemsEconomy. GemsEconomy can be used in addition to the default currency as accessed through Vault. At this time, Vault does not support custom currencies, so Prison must be have an integration that supports it.
+
+
+All custom currencies will be validated when they are assigned, changed, or loaded upon server startup. If a custom currency has been added to a Rank, but then removed from the server (removal of the plugin or deletion within the plugin) then Prison will prevent usage of that Rank by the players, even if they had sufficient amounts of that currency since there is no way to perform any of the transactions against it. Upon server startup, if Prison detects that a currency is no long supported, it will display a warning with related details.
+
+
+When Prison is looking for support of a custom currency, it checks all registered economy plugins that have support for custom currencies, and then checks each of those economy plugins to see if any of them supports the custom currency. This actually allows a server environment to use many different economy plugins, even multiple custom currency plugins.
+
+
+To add a currency to a Rank, first create the rank and give it a cost. You cannot assign a custom currency initially, but that's alright and that's expected.
+
+
+Then associate a custom currency with the rank:
+
+```
+/ranks set currency [rankName] [currency]
+
+/ranks set currency help
+```
+
+The currency must exist in one of your economies. How to add it is beyond the scope of Prison's support and this documentation.
+
+
+To currency can be changed to any other custom currency by using this command again.
+
+
+The currency can also be removed, and set back to the default, by leaving the currency name blank. For example this removes a custom currency and returns it to a standard currency.
+
+
+```
+/ranks set currency [rankName]
+```
+
+
+The following is an example of a custom currency, named "puurr" that no long exists with in the server since the GemsEconomy plugin is not currently active.
+
+
+
+
+
+Even though in the above example the custom currency "puurr" does not exist, players cannot rank up to the **Free** rank since Prison cannot confirm that it is a valid currency. But admins can use `/ranks promote`, `/ranks demote`, and even `/ranks set rank` to force a player to have those ranks.
+
+
+
+
+
+
+#Changing a Rank's Tag
+
+
+A Rank's tag is a formatted String value that is intended to be used with placeholders when special formatting is needed, or desired, for a given Rank. The tag value can be set when the Rank is initially created, or at any other time. If a tag is not defined, then any access of the tag through placeholders will only return the Rank's name.
+
+
+To change a tag use the following command:
+
+```
+/ranks set tag [rankName] [tag]
+
+/ranks set tag help
+```
+
+All valid color and formatting codes that are based upon the `&` symbol can be used.
+
+
+For example: &0 - &9, &a - &f, &k (magic), &l (bold), &m (strike through), &n (underline), &o (italic), and &r (reset). Google Image search "minecraft color codes" for graphic represtations for what those codes represent. Note that the magic value is controlled by the character that follows it. So if you have `&kaaaa` it will cycle through four magic values and they will all be in sync. But if you have `&kabca` then only the first and fourth digits will be sync'd and `b` and `c` will be viewed as different values.
+
+
+
+
+
+#Showing a Player's Ranks
+
+A player may only have zero or one active rank per ladder. But since a player can have active ranks in more than one ladder, this command will show all ranks within all ladders that are available for the given player.
+
+```
+/ranks player [playerName]
+
+/ranks player help
+```
+
+This command will show the Player's name, the given ladder and the rank name. If the player is not at the highest rank, then it will also show what the next rank's name is, along with the cost to achieve that rank. If the rank has a custom currency, that too will be displayed.
+
+
+The following screen print shows the status of two different players. The **default** ladder is the main ladder for doing the prison ranking. The mobs ladder is a non-related ladder that could represent anything, such as side quests. The Donor ladder represents a ladder used for donors, of which it could have donor specific mines for the players to use. And this also shows that one player has prestiged once but the other player has not.
+
+
+
+
+
+
+
+
+
+
+#Promote, Demote, and Set Rank Commands
+
+
+Perhaps the most important thing to understand about these three commands is that it is strongly suggested that you should **never** use the `ranks set rank` command. This will be explained later, and is related to the rank commands that are associated with your ranks.
+
+
+The following commands are intended for the use of admins only. They are to be used for setting up test accounts to see how their server is working, and to help address rank issues that players may be experiencing.
+
+
+```
+/ranks promote [playerName] [ladder] [chargePlayers]
+/ranks demote [playerName] [ladder] [chargePlayers]
+/ranks set rank [playerName] [rankName] [ladder]
+
+/ranks promote help
+/ranks demote help
+/ranks set rank help
+```
+
+
+**Warning: Risk of corruption of player ranks:**
+Promote and demote changes the player's rank by just one rank. This is important because if you need to promote a player 3 ranks, and you run this command three times, then all rankup commands are properly ran for the player and when you promote then to the final rank, they will have the correct permissons. If you were to just use `/ranks set rank` and skip the other two ranks, then you risk the player missing important permissions and as such, may require more interventions to correct their ranks. The `/ranks set rank` command is there in case it needs to be used, but as owner/admin, you need to understand it may corrupt the players rank.
+
+
+Demote is just as important as promote. Especially since it has been strongly suggested that when you create a rank command, that you include the commands to take away permissions that a player may have gotten in the next higher rank. If a given rankup command set includes all the commands required for that rank, and all the commands to remove the permissions from the next higher rank, then using `promote` and `demote` will never corrupt any player's rank and will lead to less problems.
+
+
+For the commands's parameter **playerName** is obviously the player's name.
+
+
+The parameter **ladder** is optional, and if not specified will default to the `default` ladder. If you need to use any other ladder you need to supply the ladder name.
+
+The parameter **rankName** is required and identifies what rank to set the player to. If there is more than one level of promotion or demotion, then there is a risk of corruption of the player's rank and missing permissions with promotions, or permissions the player should not have access to with demotions.
+
+
+The parameter **chargePlayers** will require that the player has enough of the specific currency for promotions, and will subtract that amount from their bank balance. If they do not have enough funds, then they will not be ranked up, just as if they ran the command. If the player is being demoted and this parameter is used, then the player will be issued a refund for the prior rank.
+
+
+The parameter **chargePlayers** when dealing with custom currency: If this parameter is enabled and the currency for the rank is not valid (removed from the economy, or the economy plugin was removed) then the promotion, or demotion, cannot be ran. If this parameter is **NOT** used and the custom currency does not exist on the server any longer, then the promote, or demote, commands will be ran ignoring the currency. The lack of this command can force a player to a rank where there is a custom currency error.
+
+
+
+
+
+
+#Ladder Overview
+
+
+By default, Prison automatically creates two default ladders so you do not have to create them, you just use them. These two ladders are called **default** and **prestiges**. The **default** ladder contains all of the ranks that are associated with the normal Prison play and ranking. The **prestiges** ladder is strictly for the prestige behavior within prison.
+
+
+
+
+
+
+
+#Create Ladder Command
+
+This command will create new ladders. Ladders do not need to have any ranks associated with them.
+
+```
+/ranks ladder create [ladderName]
+
+/ranks ladder create help
+```
+
+The parameter **ladderName** is the name of the new ladder.
+
+
+
+
+#Add Rank to a Ladder
+
+This command will add a rank to the specified ladder. If the rank was on a different ladder, it will be removed and added to the specified ladder. The added rank will be added to the end of the ladder if **position** is not specified. If **position** is specified then this command can be used to move a rank to another position within the ladder.
+
+```
+/ranks ladder addrank [ladderName] [rankName] [position]
+
+/ranks ladder addrank help
+```
+
+The parameter **ladderName** and **rankName** are as expected and described above in the prior commands that have these same parameters.
+
+
+The parameter **position** is optional. If not specified the specified rank will be added at the end of the ladder. If specified, it will insert the rank at the specified position, or if it does not exist, then at the end of the ladder.
+
+
+If the rank already exists within the specified ladder, then this command will move the rank to the specified **position**. If **position** is not specified, then it will move the rank to the end of the ladder.
+
+
+If the rank already exists in another ladder, it will be moved to the specified ladder to the specified position.
+
+
+
+
+
+#Ladder Delete Command
+
+This command will delete the specified ladder. The ranks that are within the ladder will be unassociated with the removed ladder and all of the ranks will then be ladderless. Any player that has that rank will be unable to be promoted or demoted until the ranks are added to another ladder, or the ranks are deleted.
+
+```
+/ranks ladder delete [ladderName]
+
+/ranks ladder delete help
+```
+
+*Note: Ladders are treated similar to ranks as far as how they are saved on the server's file system. The following information is identicial to the ranks.**
+
+
+
+Ladders are stored within the server's file system in the following path starting from the server's main directory:
+
+```
+/plugins/Prison/data_storage/ranksDb/ladders/
+```
+
+Internally, all ladders are assigned a serial number which is used to identify the ladder. The number starts with a 0 and is incremented as more ranks are added. Ladders that are deleted, may have new ladders reuse the same number.
+
+
+This internal serial number is what Mojang would consider a magic number. In a future version of prison, these magic numbers will probably be eliminated. Their elimination will not impact preexisting prison configurations moving forward, but could impact the ability to down grade prison to an older release.
+
+
+When a ladder is deleted, it is removed from memory, and the file that is saved in the above directory path is renamed and ignored the next time prison is started. For example, if a ladder's file name is **ladder_3.json** then when it is deleted it will be renamed **.deleted_ladder_3.json_.del**. Such that it may look like this: **.deleted_ladder_3.json_2020-08-16_13-49-27.del**
+
+To undelete a deleted ladder, first shut down the server. Then go in to the server's directory above and rename the deleted file back to it's original name. If that name is taken by another ladder, then you must rename it to have a magic number that is not being used by another ladder, plus you must also change the internal value of the field "id" in that json file to match the new number that you assigned to it.
+
+For example, with the file name originally being **ladder_3.json** and it was deleted and assigned the new name of **.deleted_ladder_3.json_2020-08-16_13-49-27.del**. Plus if numbers 0 through 4 are taken, and you must rename it with the new serial number of 5: **ladder_5.json** then change the internal value of "id" to match:
+
+```
+{
+ "ranks": [
+ { "position": 0, "rankId": 7 },
+ { "position": 1, "rankId": 8 },
+ { "position": 2, "rankId": 11 },
+ { "position": 3, "rankId": 13 },
+ { "position": 4, "rankId": 6 },
+ { "position": 5, "rankId": 15 }
+ ],
+ "maxPrestige": 0,
+ "name": "mobs",
+ "id": 5
+}
+```
+
+The above shows how "id" has been updated to a value of `5`.
+
+
+As a warning, you must ensure that no other active ladders have the same name, and that none of the specified ranks that are contained in this deleted ladder, are being used within any other ladders. If either one of these fields are used in another ladder, then you can corrupt your server's list of ranks and ladders and it is unknown how the corruption will impact your server, or what data loss will be permanent and unrecoverable. In other words, the full extent of the corruption is unknown.
+
+
+If you have any doubts on possible conflicts or corruption, then its safer to just create a new ladder and manually move all ranks back in to it.a
+
+Please note that the ladder's use of magic numbers can cause a great deal of problems when undeleting a ladder since it is not obvious which rank is which, or if it they are even used elsewhere without a lot of manual checking of each rank within the file system. Deleted ranks may be virtually deleted, but if any amount of time has passed such that ranks can be reassigned or deleted and new ones added, then it could be dangerous to undelete a ladder. Undeleting a ladder is best done before any other changes have happened on the server. Undeleting a ladder servers as a fail-safe way of undoing an accidental deletion that you may have second thoughts on a few minutes later.
+
+
+# The Ladders and Ranks Data Files
+
+The ladders and ranks data files (and also the mines) are stored on the server's file system as a way to store each mine's configurations. These files are intended for internal use only and should never be manually modified. When undeleting ladders or ranks, you may have to rename the files so they are used the next time the server is started, but you should not change the contents with the exception for their IDs.
+
+Even changing the IDs is a highly risky operation, since if you use an id that is already in existence, then it could corrupt your server. Also the same goes for specifying the wrong ID, or a non existant id on a ladder.
+
+There are many commands that have interdependancies to multiple settings, and those settings are validated only through the use of the commands. Making changes directly to the files bypasses the validation of the commands and may lead to server corruption and failures.
+
+You are solely responsible for any problems you create by making changes directly to these files. We cannot help undo any problems, issues, failures, or undefined behaviors that may be caused with such tampering.
+
+
+#Ladder Remove a Rank
+
+This command will remove a rank from a ladder. In removing the rank, it will not delete the rank, and the given rank will not be associated with any ladder. Any players that are active on that Rank will be removed fro that rank, such as they would be if the Rank was deleted.
+
+```
+/ranks ladder delrank [ladderName] [rankName]
+
+/ranks ladder delrank help
+```
+
+
+
+#Ladder List
+
+The ladder list command will list all active ladders on the server.
+
+
+```
+/ranks ladder list
+
+/ranks ladder list help
+```
+
+No other information is provided for the ladders listed. For more information on a ladder use `/ranks list [ladderName]` or `/ranks ladder listranks [ladderName]` but this last one has less information provided.
+
+
+#Ladder Ranks Listings
+
+This command provides a simple list of ranks associated with the given ladder.
+
+It is suggested that you use `/ranks list [ladder]` instead of this command since it provides a lot more information than this command.
+
+```
+/ranks ladder listranks [ladderName]
+
+/ranks ladder listranks help
+```
+
+
+
+
+
+
+
+
+
+
+#Rank Commands
+
+The use of Rank Commands is what hooks everything together within Prison. It ties Ranks to mines and even hooks it up to other plugins and custom behaviors.
+
+A good example of how to use it with LuckPerms can be found in the documentation for [Configuring and Using WorldGuard with LuckPerms to Protect Mines](prison_docs_626_configuring_worldguard_regions.md). LuckPerms and WorldGuard is just one use case, but the information provided in that documentation can be applied to any other plugin or another permission plugin.
+
+
+(more information to be added later, for for now, the WorldGuard and LuckPerms document covers a lot of the key features)
+
+
+
+
+
+#Example of using Ranks
+
+(coming soon an example on how to use ranks)
+
+
+
+
+
+
+
+#This is a work in progress!
+
+More coming soon!
+
+
+Please visit our discord server to ask for help if you need it.
+
+Sorry this document is not yet available.
+
+
+
+
diff --git a/docs/prison_docs_107_setting_up_pestiges.md b/docs/prison_docs_107_setting_up_pestiges.md
new file mode 100644
index 000000000..c6e0060c3
--- /dev/null
+++ b/docs/prison_docs_107_setting_up_pestiges.md
@@ -0,0 +1,199 @@
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Prison - Setting Up Prestiges
+
+This document provides information how to setup and use prestiges.
+
+
+
+
+# Overview
+
+This document should be able to provide the basic information to get the built in prestiges configured and working.
+
+
+
+
+
+# Enabling Prestiges
+
+By default, prestiges are disabled and must be enabled before you can use them. Edit the following file:
+
+```
+plugins/Prison/config.yml
+```
+
+Then set the following item to `true` and then save the file and restart the server.
+
+```
+prestiges: true
+```
+
+
+
+
+
+
+
+# The Prestige Ladder
+
+
+The prestige ladder is created by default and is named `prestiges`, even if prestiges are not enabled. Ranks can be added to the presetige ladder, even if it is not enabled.
+
+
+In order to use prestiges, you need to create new ranks for each prestige level. Add them as you would for the default ladder and the normal ranks, but you need to specify the prestige ladder name within the commands.
+
+
+To show all the ladders that are available, use the following command. This can help confirm that the ladder exists (it should be created as default) and it can confirm the correct spelling too.
+
+```
+/ranks ladder list
+```
+
+
+
+
+
+
+
+# Adding Prestige Ranks
+
+In order to add prestige ranks, you add them just like you add ranks, but you specify the prestige ladder within the command.
+
+
+You can name them anything you want, but in our example below we are using p1, p2, etc, with the prestige tag values of `+` for the first prestige rank, then the following would be `+2`, `+3`, etc., wrapped in square brackets and colored.
+
+
+Here is an example of adding the first two prestige ranks. These are the commands:
+
+```
+/ranks create p1 5000000 prestiges &d[&5+&d]
+/ranks info p1
+/ranks create p2 8500000 prestiges &d[&5+2&d]
+/ranks info p2
+```
+
+This screen print shows the results of the above four commands.
+
+
+
+
+
+
+
+
+
+
+# Setting up the Chat Placeholders or Prestige Ranks
+
+You can add placeholders to the chat prefixes. Please consult your chat documentation on how to do this, but here is an example for Esstentials-X Chat plugin.
+
+
+Enabling the chat placeholder just requires editing one line within the `config.yml` file. Search for the keyword **EssentialsChat** in that file, then edit the `format:` tag. For example:
+
+ format: '<{prison_rank_tag}:{DISPLAYNAME}>{MESSAGE}'
+
+
+Once setup, restart the server. Or use **/essentials reload**. Do not force all the plugins to be reloaded with a tool such as plugman since Prison (and other plugins) may fail to re-load properly.
+
+
+The placeholder `prison_rank_tag` will include all placeholders that are active for the player, including the prestige chat prefixes. The only issue is that you cannot control the order of how they will display.
+
+
+It is possible to manually set the order by using the individual placeholders for each rank you want to show. This allows you to omit certain placeholders too. You can preview all of the placeholders with the placeholder search command.
+
+
+```
+/prison placeholder search rank_tag
+
+/prison placeholder search RoyalCoffeeBeans rank_tag
+/prison placeholder search RoyalCoffeeBeans 2 rank_tag
+```
+
+Please notice the first placeholder that is displayed in this screen print. The `prison_rank_tag` shows prestige as second, and default is third. It also shows a donor rank first. This order is not controllable and may vary from server to server. If you need another order, then you will have to manually set them up.
+
+
+
+
+
+In our example, to customize the chat prefixes, we are interested in the following prefixes: `prison_rank_tag_pretiges` and `prison_rank_tag_default`.
+
+
+So to set them up in the EsstentialsX Chat prefix would be as follows:
+
+```
+ format: '<{prison_rank_tag_prestiges}{prison_rank_tag_default}:{DISPLAYNAME}>{MESSAGE}'
+```
+
+
+
+
+
+
+# Prestiging
+
+Prestiging is simple to do. If the player is at the highest default rank, then they can rankup the prestige ladder. Prestiging will reset the player's balance to zero. Currently there is no warning or confirmation so proceed carefully.
+
+```
+/prestige
+```
+
+The following screen print is from performing the following commands, where the player does a prestige, then sends a chat message to show the chat prefixes.
+
+```
+/ranks player
+/prestige
+
+```
+
+Note the following ranks on this server goes from E (the lowest) to A (second highest), then Free (highest). The first command `/ranks player` shows the player is at Free rank.
+
+
+
+
+
+
+Prestige is only available through a gui interface. You have to hover over the blocks to see the lore, which provides additional information.
+
+
+
+
+
+Showing the Confirm Prestige button.
+
+
+
+
+Showing the cancel button.
+
+
+
+
+
+
+
+
+# The prestiges Command
+
+This command shows the prestige ranks. There are a few ways to get a listing of all of the prestige ranks.
+
+```
+/prestiges
+/prisonmanager prestiges
+
+/ranks list prestiges
+/ranks ladder listranks prestiges
+```
+
+This command is intended for players and can be enabled, or disabled, within the `plugins/Prison/GuiConfig.yml` file. The command `/prestiges` is less configurable, but not sure why.
+
+
+
+
+
+
+
+
+
diff --git a/docs/prison_docs_111_mine_commands.md b/docs/prison_docs_111_mine_commands.md
new file mode 100644
index 000000000..6f11fbc15
--- /dev/null
+++ b/docs/prison_docs_111_mine_commands.md
@@ -0,0 +1,172 @@
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Prison - Mine Commands
+
+This document provides information how to setup and use Mine Commands.
+
+
+
+
+# Overview
+
+Mine Commands can allow you to take your mine to the next level. You have control to run a series of commands before, or after, then mine actually resets. You can even disable the replacement of individual blocks that is traditionally associated with a mine reset.
+
+The mine commands operate like rank commands, except that they run during a mine reset event. They are ran as console, so they have full perms within the server. They can also run any command that you have access to from the console, so it may be best to test all the commands from the console prior to adding them.
+
+This document will show a simple example, but your imagination can take it to the next level.
+
+My personal goals to use this new feature was to dynamically build a large forest. Then upon reset, it would erase all the trees and leaves, including any that grew outside of the mine, then randomly plant new trees. The results would be a new random forest that would be generated each time. Unfortunately, I have most of the details worked out on how it will work, but not 100% done yet, so I do not have this example to share at this time. :(
+ - Blue
+
+
+
+
+
+# Adding and Listing Mine Commands
+
+The family of mine commands are as follows:
+
+```
+/mines command
+```
+
+
+
+
+Add a mine command with the following command. I'll add the same command twice just to illustrate that you can have a command run before, or after a mine reset.
+
+```
+/mines command add
+
+/mines command add trees before ping
+/mines command add trees after ping
+
+/mines command list trees
+```
+
+Running these three commands looks like the following.
+
+
+
+
+
+The `/mines info trees` command shows how many commands are associated with the mine. It shows that there are two commands at the bottom of the listing.
+
+
+
+
+
+
+
+
+# Mine Command Listing Information
+
+
+One point that needs to be explained has to do with the actual listing of commands. The listings will be in the order that you add them, and that is the order in which they will be ran. But it does not matter if you mix together the **before** and **after**. The whole list is processed in order each time, but a filter only runs the correct command.
+
+It should also be understood that the **before: ** and **after: ** is actually part of the command and is stored that way. If a command does not have either of those prefixes, then it will never be ran. This is a warning if you are tempted to manually change the commands (could happen).
+
+
+
+
+
+
+# Mine Resets
+
+
+To test these commands, just perform an manual reset.
+
+```
+/mines reset trees
+```
+
+
+
+
+
+
+
+
+
+
+
+# Deleting Mine Commands
+
+Deleting is simple, but it may not be quite as obvious.
+
+First it is suggested that you list all of the commands associated with your mine, then copy the command you want to delete. To copy the command, select everything between the single quotes. Then paste that in to the delete command.
+
+As a tip, if you are in game and you list the mine commands, clicking on the command in the listing will delete it. This could be dangerous, so because when listing commands in game. This example will showcase the command usage from within the console.
+
+
+Using the these commands to illustrate removing a command, with listing all of the commands before and after removal. Then performing a mine reset to show that only one command is ran.
+
+
+```
+/mines command list trees
+/mines command remove trees before: ping
+/mines command list trees
+
+/mines reset trees
+```
+
+
+
+
+
+
+
+
+
+
+
+
+# Parent Mine Control
+
+One feature of interest that was requested by a few people, was to have the ability to use Parent mines to control the child mines.
+
+A parent mine is a large mine, that has smaller mines nested inside it, or the children could be elsewhere outside of the parent mine. The options are numerous, but the idea is that all the mines reset at the same time as if they are connected.
+
+To accomplish this, let's use the following for our example. The mines will be based upon the name of **doggo**. Of course, you may have a better name in mind, so let your imagination rule!
+
+* **Parent Mine:** doggo
+* **Child Mine 1:** doggo1
+* **Child Mine 2:** doggo2
+
+Create the mines... of course do the selections first. The set the mine reset times, making sure that the children reset times are larger than the parent's. This will ensure that the children will actually never be reset automatically on their own.
+
+```
+/mines create doggo
+/mines create doggo1
+/mines create doggo2
+
+/mines set resettime doggo 900
+/mines set resettime doggo1 1000
+/mines set resettime doggo2 1000
+```
+
+Then setup the commands on the parent to manually reset the children.
+
+```
+/mines command add doggo after mines reset doggo1
+/mines command add doggo after mines reset doggo2
+```
+
+Now since we are assuming the children are nested within the parent mine, let's prevent the parent mine from destroying the child mine's blocks. We can do that by using the block type IGNORE at 100% within the parent mine.
+
+```
+/mines block add doggo IGNORE 100.0
+```
+
+Then set the blocks in the child mines.
+
+And that's it. You can tweak some of the other settings on the mines, but this accomplishes what we set out to do: have a parent mine reset the children mine at the same time. Since the children's reset times are much longer than the parents, they will never reset on their own because when they are manually reset, it resets the timer, which will never reach zero.
+
+
+
+
+
+
+
diff --git a/docs/prison_docs_113_setting_up_sellall.md b/docs/prison_docs_113_setting_up_sellall.md
new file mode 100644
index 000000000..fc96ac1b6
--- /dev/null
+++ b/docs/prison_docs_113_setting_up_sellall.md
@@ -0,0 +1,116 @@
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Prison - SellAll info
+
+This document provides info about how to use the SellAll feature and set it up
+
+
+
+# Overview
+
+SellAll's a feature with the goal of sell and clear the player inventories from ores or blocks for money.
+Essentially, while mining you'll fill your inventory and once full you need to sell what you've mined
+to get money and rankup or buy stuff, SellAll will do all the job and give you the money.
+
+There's also a Multiplier feature which will modify the sellall values of all blocks depending on your prestige but before
+using it you should enable ```prestiges: true``` in your ```config.yml```
+
+
+
+# Getting started
+
+First of all, if you want to use this feature, you'll need to enable it in your ```config.yml``` by editing ```sellall: false``` to ```sellall: true``` (by default's on false) and restart the server.
+Also if you want give a look to the ```sellallconfig.yml``` and customize it.
+
+*THE CONFIG SHOULD LOOKS LIKE THIS:*
+_It might even be slightly different but it doesn't matter_
+
+```
+Options:
+ GUI_Enabled: 'true'
+ GUI_Permission_Enabled: 'true'
+ GUI_Permission: prison.admin
+ Sell_Permission_Enabled: 'false'
+ Sell_Permission: prison.admin
+ Add_Permission_Enabled: 'true'
+ Add_Permission: prison.admin
+ Delete_Permission_Enabled: 'true'
+ Delete_Permission: prison.admin
+ Player_GUI_Enabled: 'true'
+ Player_GUI_Permission_Enabled: 'false'
+ Player_GUI_Permission: prison.sellall.playergui
+ Multiplier_Enabled: 'true'
+ Multiplier_Default: '1'
+ Multiplier_Command_Permission_Enabled: 'true'
+ Multiplier_Command_Permission: prison.admin
+```
+
+### Then, you can do two things:
+* If you're lazy or just don't want to do a ton of math like me, there's a default setup command which will add all the blocks
+you should need for a Prison server with preset values, the command's ```/sellall setdefault```.
+Then you could also edit these values if you don't like them with the command ```/sellall edit ```, for example ```/sellall edit COAL_ORE 75``` ; or
+remove blocks with the command ```/sellall delete ```.
+
+* You can edit values or remove blocks even from the GUI ```/sellall gui```, there's a _similar GUI_ with the _same command_ for
+players **without** special permissions with just the blocks and their values as an info.
+
+**OR**
+
+* Add all the blocks by yourself with your values with the command ```/sellall add ```, for example ```/sellall add COAL_ORE 75```.
+
+
+
+
+
+# ADVANCED FEATURES
+
+**Multipliers:**
+
+To use this feature, you'll need to enable prestiges in your ```config.yml``` by editing ```prestiges: false``` to ```prestiges: true```, add some Prestiges and enable
+multipliers in your sellallconfig.yml by editing ```Multiplier_Enabled: false``` to ```Multiplier_Enabled: true```.
+
+The command ```/sellall multiplier``` will show all the sub-commands of this feature, right now there're only 2 commands:
+```
+/sellall multiplier add
+/sellall multiplier delete
+```
+
+
+The first one will add a Multiplier to a Prestige and the second will remove it.
+
+How Multipliers work -> they'll just multiply the value of what you sold, for example: Your items worth ```$1000``` and you have a multiplier of ```1```,
+so ```1000 * 1 = 1000``` is what you'll get (by default this's the value in the sellallconfig.yml), but if you've a Prestige with a multiplier of maybe ```1.5```, then
+you'll get ```1000 * 1.5 = 1500```, this isn't even hard math but could make you some confusion.
+
+# LIST OF COMMANDS
+```
+/sellall
+Will show a list of commands to admin and sell items to those who aren't admins or players with special permissions.
+
+/sellall sell
+Will sell the items of your inventory.
+
+/sellall add
+Add an ITEM/BLOCK to the sellall config.
+
+/sellall delete
+Delete an ITEM/BLOCK from the sellall config.
+
+/sellall edit
+Edit an ITEM/BLOCK of the sellall config.
+
+/sellall GUI
+Open an ADMIN GUI to admins where you can edit blocks values or remove them or open a PLAYERS GUI to player where they can see values of blocks.
+
+/sellall multiplier
+Will show a list of multiplier sub-commands.
+
+/sellall multiplier add
+Will setup a multiplier to that prestige.
+
+/sellall multiplier delete
+Will remove a multiplier from the prestige.
+```
+
+And this's all, I hope this will help you all and also hope I didn't miss something, feel free to report your issues in our discord server or here on github!
diff --git a/docs/prison_docs_310_guide_placeholders.md b/docs/prison_docs_310_guide_placeholders.md
new file mode 100644
index 000000000..93290ab24
--- /dev/null
+++ b/docs/prison_docs_310_guide_placeholders.md
@@ -0,0 +1,279 @@
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Prison - Placeholder Guide
+
+This document covers different aspects of placeholders within Prison. It explains how they work, how to use them, and different ways to use them.
+
+
+
+
+# Overview
+
+Placeholders allow the sharing of data from one plugin with another plugin, and without either plugin knowing anything about each other.
+
+On the surface they appear to be simple, but there are a lot of moving parts below the surface, and with Prison Mines, there are even more things going on.
+
+Add in to the mix, that different plugins deal with placeholders in slightly different ways, and you can wind up with a challenge to get them to work under different circumstances.
+
+
+
+
+# Requirements
+
+There is always more than one way to do things, and the same goes for having more than one way to use placeholders. This documentation, and our test servers, primarily rely on the use of PlaceholderAPI as the core component to making placeholders work. Depending upon other plugins that you may use, they may have other dependencies too.
+
+**PlaceholderAPI** - [Setting up PlaceholderAPI](prison_docs_0xx_setting_up_PlaceholderAPI.md) - Strongly Suggested if using placeholders.
+
+
+
+
+# Placeholder Theory for Prison
+
+There are two major types of placeholders in prison: Player based and Mine based.
+
+The player based placeholders can only report on the player that is initiating the command, or request. These placeholders pertain to the player's attributes, such as rank or next rank. Internally, all of these requests must include the player's UUID, which is why you cannot just add them to a sign, since the sign does not know any player's UUID.
+
+There are actually two kinds of player based placeholders. Rank placeholders that returns all of the player's current attributes for all active ladders they are associated with. For example, if they are active on four ladders, then they will have four active ranks on four ladders with possible values. So it may look something like this: `[mod][Zeus][+2][B]`, of which the ladders could be mod, donor, prestige, and default. The thing to remember about player rank placeholders is that they may return more than one value, and you cannot control the order of the values (yet).
+
+The other player based placeholders are similar to the player rank placeholders, but are specific to a single ladder. This allows you to get single placeholder, and control the order of placeholders, at the expense of having to specify multiple placeholders.
+
+The Mine based placeholders provide details about mines, and the mine name becomes part of the placeholder name. Out of all of the possible mine based placeholders, each one is duplicated for each mine. So, in rough terms, if there are different mine placeholders and you have 40 mines, then prison will generate about 400 place holders: 40 mines x 10 placeholders each = 400 placeholders for prison.
+
+Prison has integrations for direct use of providing placeholder values to to the other plugins. Some of those other plugins request placeholder values using partial placeholder names. Therefore to improve performance and to prevent having to always reconstructing the full placeholder names, prison precomputes the fragments for all placeholders. Therefore, with our example of 40 mines and 10 placeholders, the actual internal number of placeholder combinations that prison will respond to is 800: 40 mines x 10 placeholders per mine x 2 for aliases = 800 placeholders for prison.
+
+Off hand this may sound bad, but Prison utilizes enumerations for identifying placeholders, so they may be objects, but they are lightweight and helps ensure placeholders align with the code at compile time. This not only provides better performance, and less memory consumption, but programming errors and typos are caught at compile time and not runtime, so they also provide for a more stable and reliable Prison environment.
+
+Internally, placeholders within Prison are case insensitive. But Prison uses lower cased placeholder names to register with any placeholder integration. Therefore, although prison may be case insensitive, the placeholder plugins may not recognize the placeholders unless you use them as all lower case names.
+
+Also, internally, prison only responds to the placeholder name without the escape characters. The escape characters are generally curly braces { }, or percents % %, but may be other characters. All placeholder plugins strip off the escape characters before passing anything to prison. So proper use of placeholders is dependent upon what is being required by your placeholder plugin and may require a mix of escape characters.
+
+
+
+
+# Rank Command Placeholders
+
+The Rank Commands recognize only two placeholders, but they are not considered part of the standard placeholders. There are also only two placeholders that are recognized and both are case sensitive, and must also include curly braces too.
+
+* {player}
+* {player_uid}
+
+This is mentioned here since these rank command placeholders are not part of all the other placeholders, so as such, it may be difficult to find information for these items.
+
+
+
+
+
+# Placeholder Commands
+
+*Since Prison v3.2.1-alpha.13*
+
+There are a few commands within prison that will allow you list placeholders, search for placeholders, and to test random text that includes placeholders.
+
+* **/prison placeholders**
+
+
+* **/prison placeholders list**
+* **/prison placeholders search**
+* **/prison placeholders test**
+
+
+* **/prison version** Provides the same placeholder listing as /prison placeholders list.
+
+
+
+Prison Placeholder Command Listing
+
+
+
+Example of placeholder command listings
+
+
+Prison Placeholder Listings
+
+
+
+Example of the list of placeholders that is available through **/prison version** and **/prison placeholders list**. Please note that this list may evolve as new placeholders are added. Use these commands to get the current listing that is available on your server.
+
+
+Prison Placeholder Search with Two Search Patters
+
+
+
+This is an example of searching for placeholders using two search patterns: *temp5* and *format*. The term temp5 is the name of a mine and is an example of a the dynamic construction of placeholders, and that you can still perform a search with them. The search patters can be any String fragment found in either the placeholder, or it's alias.
+
+If more than one search pattern is provided, then all patters must hit on the same placeholder to be included in the results. They behave as a logical AND relationship.
+
+
+
+Prison Placeholder Listings - All Placeholders
+
+
+
+In this contrived example, since all placeholders begin with "prison", this search returns a listing of all placeholders. In this example, using the current Prison v3.2.1-alpha.13 release, it has generated 65 pages of results, at 6 placeholders per page which includes the alias.
+
+
+Prison Placeholder Listings
+
+
+
+
+
+
+
+
+# Chat Placeholders
+
+There are two major ways a placeholder can be resolved within Prison: through chat or through a placeholder integration.
+
+Chat based placeholders do not rely on other plugins for them to work. Instead they use the org.bukkit.event.player.AsyncPlayerChatEvent, of which Prison will respond and provide translations to prison related placeholders that it find with the chat message.
+
+Although no plugin is required for Prison to properly handle chat based placeholders, other plugins may be required to generate their use. Such as EssentialsX's Chat plugin. It provides a way to prefix chat messages with placeholders.
+
+
+
+
+
+
+
+# Enabling EssentialX's Chat Placeholders
+
+Set up the EssentialX's Chat plugin: [Setting up EssentialsX](prison_docs_0xx_setting_up_EssentialsX.md).
+
+Enabling the chat placeholder just requires editing one line within the `config.yml` file. Search for the keyword **EssentialsChat** in that file, then edit the `format:` tag. For example:
+
+ format: '<{prison_rank_tag}:{DISPLAYNAME}>{MESSAGE}'
+
+Once setup, restart the server. Or use **/essentials reload**. Do not force all the plugins to be reloaded with a tool such as plugman since Prison (and other plugins) may fail to re-load properly.
+
+
+This will include all placeholders that are active for the player, including the prestige chat prefixes. The only issue is that you cannot control the order of how they will display.
+
+
+It is possible to manually set the order by using the individual placeholders for each rank you want to show. This allows you to omit certain placeholders too. Please see the next section of this document to learn how to set them up.
+
+
+You can preview all of the placeholders with the placeholder search command.
+
+
+```
+/prison placeholder search rank_tag
+
+/prison placeholder search RoyalCoffeeBeans rank_tag
+/prison placeholder search RoyalCoffeeBeans 2 rank_tag
+```
+
+
+
+
+
+The placeholders are interested in are: `prison_rank_tag_pretiges` and `prison_rank_tag_default`.
+
+
+So to set them up in the EsstentialsX Chat prefix would be as follows:
+
+
+ format: '<{prison_rank_tag_prestiges}{prison_rank_tag_default}:{DISPLAYNAME}>{MESSAGE}'
+
+
+
+Ladder Specific Placeholders
+
+One of the newer features available for placeholders has to do with ladder specific placeholders. This is similar to the mines placeholders but for ladders specifically. These player ladder placeholders are just the same a the player rank, but only for one ladder. The player rank placeholders will return all ranks on all ladders for that placeholder.
+
+This is an example of specifying the rank tag for both the prestige and default ladder. This ensures the expected order of these two tags, but it will also exclude other tags from other ladders, such as donor ladders or mod ladders.
+
+ format: '<{prison_rank_tag_prestiges}{prison_rt_default}:{DISPLAYNAME}>{MESSAGE}'
+
+
+Use the placeholder tools under `/prison placeholders` for more information and to see what is available for use.
+
+
+
+For example, to preview all of the placeholders with the placeholder search command.
+
+
+```
+/prison placeholder search rank_tag
+
+/prison placeholder search RoyalCoffeeBeans rank_tag
+/prison placeholder search RoyalCoffeeBeans 2 rank_tag
+```
+
+
+
+
+
+
+
+
+
+
+
+
+# Enabling HolographicDisplays Placeholders
+
+Follow directions on how to install and configure the HolographicDisplays plugin.
+
+
+An important detail to realize, is that HolographicDisplays can only use placeholders that related to the server. It cannot access any of the prison placeholders on its own. It needs the help of other plugins to extend it's functionality.
+
+* [HolographicDisplays Download](https://dev.bukkit.org/projects/holographic-displays)
+* [HolographicDisplays' Documentation](https://filoghost.me/docs/holographic-displays)
+
+* [HolographicExtension](https://www.spigotmc.org/resources/holographicextension.18461/)
+* [PlaceholderAPI Setup Details](prison_docs_0xx_setting_up_PlaceholderAPI.md)
+* [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/)
+
+The simple directions on how to get everything to work is to download these plugins, and place them all in to your server's plugin directory. There is no need to modify any config files to get them to work with prison. Prison will register all of the internal placeholders with PlaceholderAPI so it knows they are valid and where to find them (where to send them to be resolved).
+
+The simplest way to create a HolographicDisplay would be to stand where you want one. Then enter the following command:
+
+```
+/hd create test
+```
+
+Then on the server file system, open the file:
+
+```
+plugins\HolographicDisplays\database.yml
+```
+
+Then edit the file. Keep in mind it is a yml file and must be valid yml.
+
+This is an example of a holographic sign:
+
+```
+temp5:
+ location: world, -99.832, 74.500, 191.215
+ lines:
+ - 'Welcome to Prison Mine: temp5'
+ - 'Reset Interval: {slowest}%prison_mines_interval_temp5% - {slowest}%prison_mines_interval_formatted_temp5%'
+ - 'Reset Time Left: {medium}%prison_mines_timeleft_temp5% - {fast}%prison_mtlf_temp5%'
+ - 'Reset Count: {medium}%prison_mines_reset_count_temp5%'
+ - 'Mine Size: {slowest}%prison_mines_size_temp5%'
+ - 'Blocks Remaining: {slowest}%prison_mr_temp5% {slowest}%prison_mp_temp5%%'
+ - 'Players in Mine: {slowest}%prison_mines_player_count_temp5%'
+```
+
+Notice that the prison placeholders are wrapped in the % % escape characters. The prefixed placeholders such as {slowest} and {fast} are for the plugin HolographicExtensions and they control how frequently the placeholders are refreshed.
+
+Once you update and save the database.yml file, you can have HolographicDisaplys reload from the files:
+
+```
+/hd reload
+```
+
+The above example will produce a holograph that is too tall and the bottom part will be underground. You can raise it up by manually increasing the **Y** value stored in *location:*. As you raise it up, and save the file, then you use **/hd reload** to refresh. It's also easier to make changes directly to the database.yml file. Repeat until it looks right.
+
+
+One word of warning about editing the yml file, is that it must be valid yml, if not, then it could fail to load, or it may reset to a default file. If you're unsure about the file being proper yml, make sure you save a backup before trying to reload the HolographicDisplays settings. You can also run it through an online yml validator to fix any issues. To find an online yml validator, search for: "online yaml lint" or "online yaml validator".
+
+
+
+
+
+
+
+
diff --git a/docs/prison_docs_315_guide_scoreboard-r.md b/docs/prison_docs_315_guide_scoreboard-r.md
new file mode 100644
index 000000000..363a05368
--- /dev/null
+++ b/docs/prison_docs_315_guide_scoreboard-r.md
@@ -0,0 +1,12 @@
+
+
+
+
+
+
+https://www.spigotmc.org/resources/scoreboard.14754/
+
+
+
+Animated Scoreboard" (only 1.16.2 scoreboard I could find)
+
diff --git a/docs/prison_docs_626_configuring_worldguard_regions.md b/docs/prison_docs_626_configuring_worldguard_regions.md
new file mode 100644
index 000000000..22ad4b8ae
--- /dev/null
+++ b/docs/prison_docs_626_configuring_worldguard_regions.md
@@ -0,0 +1,611 @@
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Configuring and Using WorldGuard with LuckPerms to Protect Mines
+
+This document explains how to setup WorldGuard to protect your mines and how to prevent players from accessing it when they don't have the correct permissions. It also explains how to setup the permissions in the Prison's **/ranks command add
+
+# Please READ This
+
+This document is a work in progress.
+
+Sorry for the state of this document. We found a flaw in the original document in which the protections did not work as expected. The original documents were using region templates to help reduce the amount of typing you would have to do per mine and rank. But it turns out that once that region template was tied to a permission, then it opened up all mines to be mined by any player that has access to any mine. In other words, if someone gained access to A they could mine in Z if they could get there. Therefore I'm in the process of redesigning the permissions to work properly (which they now do).
+
+But updating this document will take a little more time because I'm needing to rewrite everything a few times.
+
+In the mean time, I've indicated some content that no longer applies with an `x` as the first character on the line.
+
+
+
+
+
+# Dependencies
+
+* Vault - Interfaces with the Permission Plugins
+* [Install WorldGuard and WorldEdit](prison_docs_026_setting_up_worldguard_worldedit.md)
+* Install a Permissions Plugin that is compatible with Vault
+ * This guide uses LuckPerms. See [Setting up LuckPerms](prison_docs_020_setting_up_luckperms.md) for more information.
+
+
+
+
+
+# Setting up WorldGuard and WorldEdit:
+
+Install both WorldGuard and WorldEdit as required for your version of the server and Minecraft. Follow the general directions in the link above. If you require additional help, there should be plenty of good resources if you search for them.
+
+
+
+
+
+# In Game versus In Console
+
+**Important to understand:** When you add commands to the **/ranks command add** then they will be executed as if they were being entered through the console. Any references to players within a rank command must be replaced with `{player}` or `{player_uid}`.
+
+Please note that for WorldEdit and WorldGuard there is a slightly different way of entering commands **in game** versus **in console**. This is very important to understand, because most of the commands may be entered in game, but when you add some of these commands to the **/ranks command add** then they will be executed as if they were being entered through the console.
+
+When you are in game, the world you are in will be used as a default value in any command that requires a world parameter. When you are entering commands from the console, you must specify the world parameter. Failure to specify the world will prevent the command from running. This will cause problems during the running of the **/rankup** commands.
+
+The WorldGuard documentation says the following about the `-w` flag.
+
+```
+-w can be specified to run this command for a different world or from console
+```
+
+There are a number of WorldEdit and WorldGuard commands that cannot be ran from the console. For example, WorldEdit's //pos1 and //pos2 are used to set two points that can be used to define a WorldGuard region. The problem is that you cannot speicify the world with those commands, so therefore they cannot be used in any rank commands.
+
+
+Please note **from console**.
+
+**Please Note about other Plugins:** Although this example is using WorldGuard from the console, which requires the use of the **-w** flag, other plugins may also require the use of special considerations when being ran from the console. If the in-game command does not work, then review that plugin's documentation to see if there is any special requirements to run from console.
+
+
+
+
+
+
+# Naming conventions to Consider
+
+
+Please note that whatever you choose to use for the region names or the permissions is up to you. It may be easier to understand what is what, if it has some kind of context such as a region named **mine_** when compared with **mine_area_**. Same with permissions. If they begin with **prison.mines.** you will easily understand it role versus a **prison.tp.**, or a permission for notifications, or even enchantments.
+
+Putting thought in to the naming of resources, such as regions and permissions, can help make managing your server easier, especially if you have someone joining your staff well after your server has been released.
+
+
+
+
+
+
+# Enable Yourself - Op'ing and Wanding
+
+To simplify things, make sure you are **op**. You should also know how to **deop** yourself too. You can **deop** yourself in game too, just prefix the command with a slash.
+
+From console:
+
+ op
+ deop
+
+
+Then **in game**, give yourself a WorldEdit wand:
+
+ //wand
+
+
+
+
+
+# Protecting the World from Players
+
+**Purpose:** This prevents players from breaking any blocks in the world. It also prevents mobs from spawning.
+
+
+As op, protect the whole world with a passthrough flag set to deny. This will prevent building, PVP, and everything else. Basically, any action that “passthrough” all over defined regions, will be denied. The command with the **-w world** parameter has been added to the following list too. Use that version from console, the other without **-w world** in game. And where the name **world** is the actual name of your world.
+
+In game commands:
+
+ /rg flag __global__ passthrough deny
+ /region flag __global__ mob-spawning deny
+ /gamerule doMobSpawning false
+
+Console commands:
+
+ /rg flag -w __global__ passthrough deny
+ /region flag -w __global__ mob-spawning deny
+ /gamerule doMobSpawning false
+
+
+Note that the **/gamerule doMobSpawning false** may also help prevent mobs from spawning, and may help reduce the overhead of WorldGuard from having to deny the spawning events. Kind of double protection.
+
+
+
+
+
+# Various LuckPerm Commands for Templates and Mines
+
+The WorldGuard region templates are covered below, but first you need to setup the groups within LuckPerm or the permissions on the child groups will not be tied back to the parent groups within LuckPerms.
+
+
+For prison, we will use the prefix of `prison.mines` so we know what these groups and permissions are related to the mines.
+
+
+LuckPerms commands to create a group, and how to have a child group inherit permissions from a parent. The first command should be used twice, first for the parent, then the child group. The the next command shows how to assign a parent group to a child group.
+
+ /lp creategroup
+ /lp group parent add
+
+
+
+We **must** create a LuckPerms group for every mine. Only mine `a` and `b` are shown here, but create one for each mine.
+
+ /lp creategroup prison.mines.a
+ /lp creategroup prison.mines.b
+
+
+
+To check to see if these groups are setup properly, you can inspect them with the following commands.
+
+ /lp listgroups
+ /lp group prison.mines.a info
+
+
+To grant permission to the players, you need to use the following since we need to add the player to the group.
+
+ /lp user parent set
+ /lp user parent set prison.mines.a
+
+
+And to now hook this up to prison, you do same command, dropping the leading slash, but with adding a rank command prefix and use the {player} placeholder (more on this later)
+
+
+ /ranks command add a lp user {player} parent set prison.mines.a
+
+
+
+
+
+
+
+# Unprotecting a Mine for its members - Required for all Mines
+
+**Purpose:** This will actually give members the ability to perform mining related tasks within the mine. They need to be able to break the blocks within the mine, and to pickup items, XP, and allows item drops.
+
+
+This defines a WorldGuard region, and needs to be applied to all mines.
+
+
+Select the same area of the mine with the WorldEdit **wand**, then use the following commands to define a mine. It will define a region with the mine’s name, and set the parent to mine_template, with the only member ever being the permission group **prison.mines.**. Never add a player to a WorldGuard region since it will get messy. Always use permission based groups and then add the player to that group.
+
+
+In this example I have included an owner of this mine which is group owner. And added the group admin as a member so the admins will have full access to this mine, even if they do not personally have the player's rank to access this mine. The actual members you add are up to you, but these are just two examples that you should consider.
+
+
+ /region define prison_mine_
+ /region addmember prison_mine_ g:prison.mines.
+
+
+ /region setpriority prison_mine_ 10
+
+ /region flag prison_mine_ block-break allow
+ /region flag prison_mine_ item-pickup allow
+ /region flag prison_mine_ exp-drops allow
+ /region flag prison_mine_ item-drop allow
+
+ /region addowner prison_mine_ g:owner
+ /region addmember prison_mine_ g:admin
+
+
+Set the *priority* to a value of 10 to take higher precedence of other lower regions that may overlap.
+
+
+The following region setting for access and deny may *appear* to be useful, but don't use them. Explanations follow. **Do not use the following:**
+
+ ~~/region flag prison_mine_ entry -g nonmembers deny~~
+
+ ~~/region flag prison_mine_ x allow~~
+ ~~/region flag prison_mine_ entry-deny-message You must rank-up to access this mine.~~
+
+**NOTE:** The use of `~~` above are invalid and are added since markdown documentation *usually* uses them as strike though, but that does not work with github markdown. Nonetheless, i've kept them there just to add emphasis that it's wrong.
+
+**NOTE:**
+
+It’s a bad idea to deny access to the mines through these regions. Such as with **-g nonmembers deny** on the **prison_mine_** regions. If the players doesn't have access to the mines, and they try to enter from the top, WorldGuard will continually prevent them from entering, or more specifically it will prevent them from falling in to the mine. This will basically keep them floating in the air which will trigger a fly event within anti-hacking tools. It will be far more professional to protect the area that contains the mine, thus you can protect it over the whole y-axis too. Players can also get caught in a rapid loop where WorldGuard is trying to kick them out of the mine when restricting just the mine; could possibly cause a lot of lag, depending upon how many event’s are being triggered.
+
+
+
+
+
+
+
+
+# Protecting a Mine's Area - Required for all Mine Areas
+
+**Purpose:** To keep out all non-members from a mining area. The mining area, as in this context, is the area that immediately surrounds a mine, and generally non-members should not have access to it.
+
+
+In general, it may be tempting to restrict access to the mine itself so non-members cannot mine it. But there is a serious problem with just protecting the mine, and that’s when non-members walk on top of the mine. They will fall in to the mine, as expected, but WorldGuard will try to keep them out, so they will be bumped back above the mine, thus triggering a “fly” event, or a “hover” event. This action may trigger anti-hacking software to auto kick them, or auto ban the players, or the players could get stuck, and it may even cause a lot of lag on the server too.
+
+This also happens really fast, in a very repeated action, so it could lock up the player so they cannot jump back out before they get banned. I do not know if this could contribute to server lag, but a lot of processing appears to be happening so it is possible.
+
+The suggested action is to create a new region around the mine and protect that from entry from non-members. This region can then be extended from y=0 to y=255 with the WorldEdit command `//expand vert``. If anyone does get past it, they still won’t be able to mine.
+
+
+The primary purpose is to keep non-members out of the region. It will also prevent non-members from TP'ing in to the area too. It will also supply the player with an error message to inform them they don't have the rn
+
+
+Select the an area around the mine with the WorldEdit **wand**. Only select a rectangle area around the mine, ignoring the **y** axis. Then use the following commands to define a mine. It will define a region with the mine’s name, and set the parent to mine_template, with the only member ever being the permission **g:prison.mines.**:
+
+
+The command **//expand vert** will take your selection and extend the **y** to cover the whole vertical range in your region. This is why you don't have to be concerned with the *y* axis when defining your mine area regions.
+
+
+Just like **prison_mine_** WorldGuard region, we need to add the **g:prison.mines.**.
+
+ //expand vert
+ /region define prison_mine_area_
+ /region addmember prison_mine_area_ g:prison.mines.
+
+
+ /region setpriority prison_mine_area_ 10
+ /region flag prison_mine_area_ entry -g nonmembers deny
+ /region flag prison_mine_area_ entry-deny-message You must rank-up to access this mine.
+
+ /region addowner prison_mine_area_ g:owner
+ /region addmember prison_mine_area_ g:admin
+
+
+You would need to repeat these settings for each mine.
+
+
+Notice we are using the same permission permission for both the mine and the mine area: **g:prison.mines.**. This keeps it simple by reducing the number of permissions we have to give the players.
+
+
+Of course, just like **prison_mine_** region, we also give `owner` and `admin` access too.
+
+
+
+
+
+
+
+
+
+# Granting Access to a Mine and Removal of the access
+
+**Purpose:** From either the console, or from within game, manually grant a player access to a mine.
+
+To add a player to the mine regions is as simple as giving the user the permission associated with the mine region.
+
+It's important to understand that you never add a player as a direct member of a mine region, since if you have thousands of players, it will make your configuration files messy, and could add to lag dealing with such large data files per region.
+
+Instead, you add the players to a permission group that has access to use the mine regions. One way to look at this is that a permission is like a key, and you're giving players a copy of the key access the mines. With a slight twist on that analogy, since we're dealing with groups, everyone within that group shares the same key for the mine regions.
+
+
+The correct way to add a player to a mine region. Indirectly by giving them access to the "keys". Or in other words, since we hooked up the LuckPerms group `g:prison.mines.` then all we need to do is add them to the group and they will have access to the proper regions.
+
+
+Template:
+
+ /lp user parent set true
+
+ /lp user parent set g:prison.mines. true
+
+
+It is important to know how to remove access from a player so they can be demoted or removed from an area that they should no longer access.
+
+Template:
+
+ /lp user parent unset
+
+ /lp user parent unset g:prison.mines.
+
+
+
+The **wrong** way to add a player to a mine region. Incorrectly by adding them as a direct member.
+
+ /region addmember prison_mine_
+
+This will result is potentially hundreds, or thousands, of members being added directly to the mine's region.
+
+
+
+And also, the wrong way to add a player to a LuckPerms group. This won't work correctly.
+
+ /lp user permission set g:prison.mines. true
+ /lp user permission unset g:prison.mines.
+
+
+
+
+
+
+
+
+# Adding Rank Commands to run when /rankup is Performed
+
+**Purpose:** Adds the permission to access the mine area and to mine within a mine, when a player successfully runs /rankup.
+
+
+Based upon the above documentation, and from within game, we would use the following to *manually* give a player a permission:
+
+ /lp user parent set g:prison.mines. true
+
+
+For example, if you have a player named *AHappyPrisoner* And you have a mine named "a" you would use the following command:
+
+ /lp user AHappyPrisoner parent set g:prison.mines.a true
+
+
+To run the **a** rank commands when the player uses **/rankup**, the following is the command for **/ranks command add **:
+
+ /ranks command add a lp user {player} parent set g:prison.mines.a true
+
+
+Notice how the manually entered command is used with the **/ranks command add **? Just drop the leading slash and it should be good.
+
+
+If you want to be able to **demote** a player from rank "b" back down to rank "a" you would need add the following **/ranks command add** to the rank **a** which removes access to the **b** mine.
+
+ /ranks command add a lp user {player} parent unset g:prison.mines.b
+
+
+So to recap, for every rank, ideally you should add the new perms for that rank, and remove the perms for the next higher rank so as to enable the proper functioning of **/ranks demote**.
+
+
+
+
+
+# Alternatives
+
+There are many ways to accomplish the same goals and that's what makes Minecraft so versatile and interesting to play. The Prison Plugin does not want to impose a specific way to do most things, since it may not be the ideal way for your sever.
+
+One of the primary focuses for this document has been protecting the area around your mine to prevent players who should not access the mine, from enter that region. One alternative to needing to protect a mine, would be to limit the access to the mine so it does not have to be protected. One simple way of accomplishing that, is to have the mines in a void world, and then each mine would be a separate island. Then all that would need to be protected, or controlled, would be the warping to that location.
+
+
+
+
+
+
+
+
+
+
+
+# WG LP Commands - Overview
+
+These are entered in a step by step process, intended for you to follow.
+
+These can, and probably will, be translated in to a runnable script within prison that will set everything up for you. Well, once you take care of the basics.
+
+You should be in game when you run these commands, otherwise you may have to specify the world name with almost all LuckPerm commands. When these are converted to scrips, the world parameter will be added.
+
+Some code chunks will have **In Game:** which is intended to run from within minecraft. The **Console:** is intended to be ran from the console, where there is no player, so you have to provide the "world". Note that if your world is not named "world" then you will have to change that. If there are any code chunks that are marked as "script" then those provide an example of what kind of placeholders would have to be used.
+
+
+
+
+
+
+## WG LP Command - Global for whole world
+
+Run once.
+
+
+In game:
+
+ /rg flag __global__ passthrough deny
+ /region flag __global__ mob-spawning deny
+ /gamerule doMobSpawning false
+
+
+Console:
+
+ /rg flag -w world __global__ passthrough deny
+ /region flag -w world __global__ mob-spawning deny
+ /gamerule doMobSpawning false
+
+
+
+
+
+
+
+## WG LP Command - Setting up LuckPerm Groups
+
+Run once. You must know what your mines and ranks will be. Mines are just a simple letter like A through Z. The ranks generally have the same name.
+
+
+For the sake of this document we will assume they will range from A to Z, but we will only create permissions and regions for only one mine, a. Be certain to duplicate this for all of the mines that you have. There could be donor mines too, but for now let's ignore those.
+
+For each mine, there will be
+
+ /lp creategroup prison.mines.a
+
+ /lp creategroup prison.mines.b
+
+ ...
+
+ /lp creategroup prison.mines.z
+
+
+
+## LuckPerms Adding Permissions to the Groups
+
+Run once for each mine/rank.
+
+There will be other permissions that players will require in order to use your server. You can add some of these permissions to the LuckPerm groups so when a player becomes a member of that group, then they will inherit the permissions that are in that group.
+
+A good example of these permissions are of course rank based, such as access to the mine's warp, or even other permissions that everybody should have.
+
+In this example we will give the group `prison.mines.a` the standard prison rank related permissions, but also other permissions that everyone should have.
+
+
+ /lp group prison.mines.a permission set prison.tp.a
+ /lp group prison.mines.a permission set prison.gui
+ /lp group prison.mines.a permission set prison.user
+
+
+ /lp group prison.mines.a permission set warp
+ /lp group prison.mines.a permission set warp.list
+ /lp group prison.mines.a permission set warp.a
+
+
+You can also add in a lot of EsentialX's permissions to fine tune what your players can do. A nice listing of permissions can be found here: https://essinfo.xeya.me/permissions.html
+
+Since rank A will always be a permission group all your players have, you can use this group as a container for those permissions.
+
+Then all other ranks would only need what is required of the new ranks. Such as:
+
+ /lp group prison.mines.b permission set prison.tp.b
+ /lp group prison.mines.b permission set warp.b
+
+
+
+
+
+
+## Creating the Mine's WorldGuard Region
+
+
+You can either use the worldEdit wand to select what you want to set as a region, or you can use other WorldEdit features to set them.
+
+
+These are a WorldEdit method that can be used in game if you know the x, y, z coordinate. This will not work with scripting because you cannot specify the world to apply it to.
+
+
+ //pos1 x, y, z
+ //pos2 x, y, z
+
+
+Once you have a WorldEdit selection then you can create a WorldGuard region.
+
+ /region define prison_mine_a
+ /region setpriority prison_mine_a 10
+
+ /region flag prison_mine_a block-break -g members allow
+
+ /region flag prison_mine_a item-pickup -g members allow
+ /region flag prison_mine_a exp-drops -g members allow
+ /region flag prison_mine_a item-drop -g members allow
+
+ /region addowner prison_mine_a g:owner
+ /region addmember prison_mine_a g:admin
+
+ /region addmember prison_mine_a g:prison.mines.a
+
+
+Repeat the same for mine b.
+
+
+
+
+
+
+## Creating the Mine Area WorldGuard Region
+
+The mine area is an area that surrounds the mine to protect the area from players who should not have access. This area should be at least 5 blocks larger in the X and Z axis than the mine, so as to prevent non-member players from being able to attempt mining.
+
+You need to select the area like the prior region and then define it with the following commands. The following `//pos1` and `//pos2` is just an example of making the selection. The `//expand vert` is required (strongly suggested) to ensure the region extends from the lowest to the highest blocks.
+
+ //pos1 x, y, z
+ //pos2 x, y, z
+
+
+ //expand vert
+
+ /region define prison_mines_area_a
+ /region setpriority prison_mines_area_a 10
+ /region flag prison_mines_area_a entry -g nonmembers deny
+ /region flag prison_mines_area_a entry-deny-message You must rank-up to access this mine.
+
+ /region addowner prison_mines_area_a g:owner
+ /region addmember prison_mines_area_a g:admin
+
+ /region addmember prison_mines_area_a g:prison.mines.a
+
+
+Please notice that we have defined two WorldGuard regions: prison_mines_a and prison_mines_area_a. But for both of them, we've assigned the LuckPerms group g:prison.mines.a as members. This means, all we need to do is add the player to that LuckPerms group and they will have access to both the mine_area and also the mine.
+
+
+
+
+
+
+# Adding the Prison Rank Commands
+
+
+So finally for our example of setting up mines a and b, we now need to add the Rank Commands to active the permission for both.
+
+For rank a:
+
+ /ranks command add a lp user {player} parent set g:prison.mines.a true
+ /ranks command add a lp user {player} parent unset g:prison.mines.b
+
+
+For rank b:
+
+ /ranks command add b lp user {player} parent set g:prison.mines.b true
+ /ranks command add b lp user {player} parent unset g:prison.mines.c
+
+
+And that's it! Just repeat for all your other mines.
+
+
+
+
+
+# Other Commands That May Be Important:
+
+ /region redefine mine_
+ /region removeowner prison_mine_
+ /region removemember prison_mine_
+
+
+
+Set’s the WorldEdit selection to the dimensions of the given mine:
+
+ /region select prison_mine_
+ /region select prison_mine_area_
+
+ /region info prison_mine_
+ /region info prison_mine_area_
+
+ /region list
+ /region list -w world
+ /region list -p
+
+
+Some LuckPerm commands that may be useful.
+
+ /lp group prison.mines. listmembers
+ /lp user group add
+
+ /lp listgroups
+ /lp group prison.mines.a info
+
+ /lp user parent set
+
+ /lp group parent add
+
+
+
+
+# WorldGuard And LuckPerms Info
+
+https://worldguard.enginehub.org/en/latest/regions/global-region/
+
+https://worldguard.enginehub.org/en/latest/regions/flags/
+
+https://worldedit.enginehub.org/en/latest/usage/regions/selections/
+
+https://bukkit.org/threads/how-to-use-the-entry-group-flag-in-worldguard.124066/
+
+
+https://github.com/lucko/LuckPerms/wiki/Command-Usage
+
+
+
+
+
diff --git a/docs/prison_docs_628_configuring_private_mines.md b/docs/prison_docs_628_configuring_private_mines.md
new file mode 100644
index 000000000..1440f41c2
--- /dev/null
+++ b/docs/prison_docs_628_configuring_private_mines.md
@@ -0,0 +1,133 @@
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Setting up Private Mines
+
+This document explains how to setup private mines that are not accessible to
+other players. This document provides an *idea*, but it's up to your to
+figure out the details to make it all work.
+
+
+This applies to both personal mines (one player) and also special groups such
+as donors or clans or other in-game groups.
+
+
+This process will be a very manual process with a lot of manual steps that
+must be repeated over and over again.
+
+
+
+
+
+# Dependencies
+
+* Vault - Interfaces with the Permission Plugins
+* [Install WorldGuard and WorldEdit](prison_docs_026_setting_up_worldguard_worldedit.md) Understanding this document is critical for getting things to work.
+* Install a Permissions Plugin that is compatible with Vault
+* This guide uses LuckPerms. See [Setting up LuckPerms](prison_docs_020_setting_up_luckperms.md) for more information.
+
+It is very important to understand how to use WorldGuard and LuckPerms with Prison. The
+above document explains one way to do that, and it's something that will be expanded
+upon in this document.
+
+
+
+
+# Performance Considerations
+
+As more mines are added to your server, they will have an impact on performance overall.
+Here are some possible concerns if you are adding hundreds of private mines.
+
+* The reset process of replacing blocks is time consuming and processing intensive. The more mines that exist, the more frequent resets will run. Having hundreds of mines will ensure more are resetting every minute, and you could have multiple that try to reset at the same time.
+* Mine resets cannot be done asynchronously. Asynchronous replacement of blocks could cause corruption of the world. Even asynchronous reading of block types can corrupt the world IF there are entities in chunks that are loaded to check the blocks. Entities include mobs and even items thrown to the ground, or drops from mining. The point is that mine resets can be expensive.
+* Prison "tries" to do as much as possible to minimize the load on the server when doing a mine reset. For example performing precalculations in an asynchornous thread before attempting to replace the blocks. Also it pages the block placements to allow other processes to run on the server which may increase the reset time, but it should minimize impact on TPS when many events are going on at the same time.
+* Many mines will require more memory on your server. The amount will be small, but more mines will require more memory. Prison even with hundreds of mines, should not consume a ton of memory, but it will consume more than just a dozen mines.
+* Having many mines will slow down the searching for the "right" mine. There are some processes that have to locate which mine is being "used". Unfortunately, the only way to do so, is to go through each mine one at a time looking for a "hit". If you have hundreds of mines and the "hit" is on the last one in the list, then the dealy may be slightly longer than if it "hits" on the first item.
+
+
+
+
+
+
+
+# Mine Names, Permission Names, and Region Names
+
+You need to figure out how you want to name everything. This includes the name of
+the mines, the permissions, and regions. Their names are overall
+arbitrary, but they need to make sense to you. There may be a large number that are
+needed so it would make sense to use an incrementing number.
+
+For the purpose of this document, and to keep the mine names simple,
+let's name the mines as follows. This will allow for up to 10,000 mines.
+* mine0001
+* mine0002
+* mine0003
+* mine0004
+
+
+Examples of what will be used in this document:
+* prison.mines.private.mine0001
+* prison.mines.private.mine0002
+* prison.mines.private.mine0003
+* prison.mines.private.mine0004
+
+
+Permissions are critical in that it allows you to associate a player with a mine.
+When the mine is properly configured with WorldGuard, it will prevent other players
+from being able to access it.
+
+
+Region names should follow the same pattern as provided in the WorldGuard documentation.
+* mine_mine0001
+* mine_mine0002
+* mine_mine0003
+* mine_mine0004
+
+
+In the WorldGuard documentation above, the region names used were based upon
+
+
+
+
+
+# Creating Mines Using Schematic Files
+
+If you will provide personal mines, that implies you will have to have a lot of
+mines to sell. You can build them individually, but it may be worth figuring out how
+to use WorldEdit to save a mine as a schematic File. Once saved as a schematic file, you can
+then copy and paste it in your world many, many times. If you need more information on
+how to do this, please google: **worldedit using schematics**.
+
+
+
+
+# Hooking it up to BuyCraft or Enjin
+
+Whatever your store front you use, to provide the players with access and ownership to their
+private mines, all you would have to do is provide the player with the permission that
+was used to configure that mine. It would be as simple as that. Once the player has
+the permission, everything should work fine.
+
+If you are naming the permission in a sequential order, see above, then the store
+fronts may be able to "sell" a range of permissions. Otherwise you would have to
+configure each one independently.
+
+
+
+
+# Another Idea on how to Setup Private Mines
+
+There may be a way to setup a plot world to help with this.
+A plot world plugin could generate the repeating patterns of the mines,
+and take care of some of the management of them, but it would have to be a manual
+process to hook them up to the prison plugin. Such an exercise is far beyond
+the scope of this document, or the prison plugin being able to provide an automation
+process to manage all of them for you. Good luck, you're on your own
+in trying to figure this out.
+
+
+
+
+
+
diff --git a/docs/prison_docs_630_configuring_warps.md b/docs/prison_docs_630_configuring_warps.md
new file mode 100644
index 000000000..11dbefc41
--- /dev/null
+++ b/docs/prison_docs_630_configuring_warps.md
@@ -0,0 +1,127 @@
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## Configuring EssentialsX Warps for Mines
+
+*Note that this is a work in progress and does not include all steps yet.**
+
+This document explains how to setup the EssentialsX Warps so players can warp when to the mines that they should have access to.
+
+Please note that within Prison there is the **/mines tp ** command, but that is intended for use by admins only. There is no way to limit players to have access to specific
+mines. Anyone who is giver access to that command has access to tp to any mine.
+
+
+
+
+
+# Dependencies
+
+* EssentialsX - for the */warps* and */warp* commands.
+
+
+
+
+
+# Configuring EssentialsX
+
+Download and install EssentialsX.
+
+
+In the `plugins/Essentials/config.yml` is this:
+
+```
+// Set this true to enable permission per warp.
+per-warp-permission: false
+```
+
+Set that to `true`.
+
+
+Then restart the server.
+
+
+
+
+
+# Permissions for Warps
+
+
+* **essentials.warp** - Allow access to the /warp command.
+* **essentials.warp.list** - Specifies whether you can view warp list with /warp.
+* **essentials.warps.[warpname]** - If you have per-warp-permission set to true in the config.yml then you can limit what warps players can use. This also controls what players would see with /warp.
+
+In the EssentialsX config file, set:
+
+```
+per-warp-permission: true
+```
+
+Then use the following permissions. The first two are required, but the last three are examples based upon the three warp names: a, b, and c. These three warp names happen to be the same as the mine's names, but they don't have to be. There is no direct connection between warp names and mine names. And there are no direct connections between warp permissions and mine permissions.
+```
+essentials.warp
+essentials.warp.list
+essentials.warps.a
+essentials.warps.b
+essentials.warps.c
+```
+
+
+# How to set the warps
+
+
+First you need to set up each warp. Use the `/setwarp [mineName]` command to accomplish that.
+
+
+If you want it to be exactly the same as your prison mine warps (ie... `/mines tp [mineName]`), first tp to that location and do not move or change where you are looking. Next issue the EssentialsX's command `/setwarp [mineName]` to set the warp location.
+
+
+Then add them to the rank commands. Using LuckPerms from within game will look something like this:
+
+```
+/lp user [playerName] permission set essentials.warps.a true`
+
+```
+
+And adding them to the ranks commands but instead of specifying the actual player name, use the `{player}` placeholder and Prison will substitute the player's name at runtime:
+
+```
+/ranks command add a lp user {player} permission set essentials.warps.a true
+/ranks command add b lp user {player} permission set essentials.warps.b true
+/ranks command add c lp user {player} permission set essentials.warps.c true
+```
+
+Note that with LuckPerms, the add user permission has an optional Boolean value of true at the end. If omitted, it defaults to true, but it is included here since most documentation includes it.
+
+
+# Using PEX permissions with Warps
+
+If you're using PEX, the rank commands are similar, but using the pex notation.
+
+From within game the pex command will look something like this:
+
+```
+/pex user [playerName] add essentials.warps.a
+```
+
+And adding them to the ranks commands:
+
+```
+/ranks command add a pex user {player} add essentials.warps.a
+/ranks command add b pex user {player} add essentials.warps.b
+/ranks command add c pex user {player} add essentials.warps.c
+```
+
+
+
+# Links
+
+[http://ess.khhq.net/wiki/Command_Reference](http://ess.khhq.net/wiki/Command_Reference)
+
+[http://wiki.mc-ess.net/doc/](http://wiki.mc-ess.net/doc/)
+
+[https://luckperms.net/wiki/Permission-Commands](https://luckperms.net/wiki/Permission-Commands)
+
+
+
+
diff --git a/docs/prison_docs_810_faq_other_plugins.md b/docs/prison_docs_810_faq_other_plugins.md
new file mode 100644
index 000000000..dc2a5c6cb
--- /dev/null
+++ b/docs/prison_docs_810_faq_other_plugins.md
@@ -0,0 +1,81 @@
+
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## FAQ - Other Plugins
+
+This document covers some common issues that pertain to other plugins, but may not actually be related to Prison.
+
+
+
+# CMI - Used for the Economy within Prison
+
+**Symptoms of Issues**
+
+Symptoms of issues with CMI is when it appears like Vault is using CMI has successfully loaded, but yet the Ranks module fails to load.
+
+
+**Overview of CMI**
+
+CMI Is a premium plugin and costs about 15.00 Euros. It is a very extensive plugin that covers many aspects of what you could possibly do with a server. The developers claim it is a worthy replacement for EssentialsX. The primary aspects CMI with what Prison needs to use is their economy and permissions.
+[CMI on spigotmc.org](https://www.spigotmc.org/resources/cmi-270-commands-insane-kits-portals-essentials-economy-mysql-sqlite-much-more.3742)
+
+
+**How to Resolve the Issues**
+
+In order to use CMI with prison, it is required that you use Vault. Prison does not have any direct integrations to CMI. Since it is a premium plugin, the CMI integration for Vault is not publicly available in the original Vault plugin. Instead CMI offers their own modified version of Vault that has been recompiled with their hooks added, or an injector that will add it to the original Vault plugin.
+
+
+On their spigotmc.org resource page, they identify there are two way to enable a working version of Vault:
+1. Install and use their modified version of Vault (recommended)
+2. Or use the CMIEInjector to modify an original Vault (not recommended)
+
+
+**Common Problems**
+
+1. Make sure you are using the CMI modified version of Vault
+2. The CMIEInjector has problems, or will cause problems. So don't use it.
+3. Do not use both the CMI modified version of Vault and the CMIEInjector. They were never intended to be used together and they will cause problems with prison.
+
+
+
+
+
+# Prison Won't Load - No Modules Loaded - LuckPerms is the Cause
+
+**Symptoms of Issues**
+
+Symptoms of issues is that Prison fails to start up and load properly. The biggest symptom is that there are no active modules and most of the prison commands fail to work.
+
+
+**Cause**
+
+This is caused by LuckPerms. More specifically, trying to use LuckPerms v5.0.x with Prison v3.2.0 or older. LuckPerms v5.0.x is not supported with older version of Prison.
+
+
+**How to Resolve the Issues**
+
+There are two major ways to resolve this issue.
+
+1. Down grade to LuckPerms v4.4.1 for use with Prison v3.2.0 and older.
+
+2. Upgrade Prison to v3.2.1 (or the pre-release version of v3.2.1) or newer. Prison v3.2.1 supports both the newer LuckPerms v5.0.x and the older LuckPerms v4.4.1 and older.
+
+**Suggested action:** Upgrade Prison to v3.2.1 or newer and use the latest version of LuckPerms.
+
+
+**Background**
+
+Basically the fault of this issues lies with LuckPerms in using the same registered
+plugin name with the bukkit/Spigot Plugin Manager for v5.0.x. By using the same registered
+plugin name and the same class name, but an altogether different package name, that broke
+the standard way of using the plugin manager to get an instance of the plugin. This would
+have caused any plugin to generate a Class Not Found exception.
+
+They shouldn't have used the same signatures for v5.0.x as they did with v4.x.
+If they would have chosen a new signature, such as LuckPerms5, then there would have been no issues since the plugin manager would not falsely report that the old version of LuckPerms
+is available and will not try to cast the new packages in to the old variables.
+
+
+
diff --git a/docs/prison_docs_880_faq_misc_01.md b/docs/prison_docs_880_faq_misc_01.md
new file mode 100644
index 000000000..fb729bf93
--- /dev/null
+++ b/docs/prison_docs_880_faq_misc_01.md
@@ -0,0 +1,107 @@
+
+
+### Prison Documentation
+[Prison Documents - Table of Contents](prison_docs_000_toc.md)
+
+## FAQ - Miscellaneous Questions
+
+This document covers some miscellaneous questions pertain to Prison in general.
+
+
+
+# Paper - Is it supported?
+
+**Quick Q & A:** Does it work? Yes it should work, but Paper is not supported.
+
+Although Paper servers are not officially supported, there is a strong interest in making sure Prison will work with Paper. Theoretically since Paper is a direct fork from Spigot, it should always be 100% compatible. So if issues are found with Paper, efforts will be made to fix those issues.
+
+The primary reason why paper servers are not directly supported has to do with the number of minecraft versions that are supported, and the number of test servers that requires to perform testing upon. By adding in paper as an officially supported platform, that would increase the complexities of testing. Therefore, buy not supporting paper directly, it simplifies the testing phase of development, but at the risk that there may be an ever slight chance of something not working correctly with paper.
+
+
+
+
+# Configuring the Correct Currency Symbol for Prison
+
+
+**Symptoms of Issues**
+
+The wrong currency symbol is used when showing monetary values.
+
+
+**How to Resolve the Issues**
+
+Prison can use a standard national currency symbol. It cannot use a custom symbol
+for a custom currency.
+This FAQ explains how to change the national currency symbol.
+
+
+The current prison plugin is using java internals to set the currency symbol.
+As such, currencies within prison may show the wrong currency symbol.
+
+For example, in RankUpCommand it is using this reference:
+
+ RankUtil.doubleToDollarString(result.rank.cost));
+
+which is using this:
+
+ public static String doubleToDollarString(double val) {
+ return NumberFormat.getCurrencyInstance().format(val);
+ }
+
+
+If the currency that is shown is not what is configured on the server,
+then you currently MUST change the java startup variables to set it
+the language and location that you are needing to use. Otherwise
+it will be pulling from the file system, which may not match your
+in game settings.
+
+ -Duser.language=en -Duser.country=US -Duser.variant=US
+
+In context the server startup may now look like this:
+
+ java -Xms2g -Xmx8g -Duser.language=en -Duser.country=US -Duser.variant=US -jar spigot-1.13.2.jar
+
+In the future, Prison may need to switch this over to use either a language config in
+a config file somewhere, or use what is defined, or set, within the
+currency plugin, such as vault, or EssentialsX.
+
+
+
+
+
+# Information on Groupmanager and using it with Rank Commands
+
+
+**Information provided by ChrisGames**
+
+**groupmanager**
+
+So what i was trying to do was do this command:
+
+ manuaddp {player} essentials.warps.a
+
+manuaddp is for 1 specific player, then just the node for warping to a mine
+when you give a rank or a specific player a permission you need to do
+
+ /manselect [Worldname]
+
+To get it to work with the prison ranks you need to have it do manselect (world) before it does the other command.
+
+if the manuaddp command is higher in the config than the manselect (world) it will not work.
+
+.
+
+The commands, as ran from the console, for a player named *TestPlayer* in the world named *PrisonWorld*:
+
+ manselect PrisonWorld
+ manuaddp TestPlayer essentials.warps.a
+
+
+These are the same commands, but are in the format that is needed to be added to the Prison Rank commands for a rank named "a". Please note that the order in which these commands are entered are the way they will be ran upon rankup.
+
+ ranks command add a manselect PrisonWorld
+ ranks command add a manuaddp {player} essentials.warps.a
+
+
+
+
diff --git a/gradle.properties b/gradle.properties
index 636353e94..88361bce4 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -1,4 +1,9 @@
+## define the global gradle version:
+## # This is actually the "correct" place to define the version for the project.
+## # Used within build.gradle with ${project.version}.
+## # Can be overridden on the command line: gradle -Pversion=3.2.1-alpha.3
+version=3.2.1-alpha.20
## org.gradle.warning.mode=(all,none,summary)
org.gradle.warning.mode=all
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
index 0d4a95168..5c2d1cf01 100644
Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
index ae45383b6..0ebb3108e 100644
--- a/gradle/wrapper/gradle-wrapper.properties
+++ b/gradle/wrapper/gradle-wrapper.properties
@@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.3-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-all.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
diff --git a/gradlew b/gradlew
index cccdd3d51..8e25e6c19 100644
--- a/gradlew
+++ b/gradlew
@@ -1,5 +1,21 @@
#!/usr/bin/env sh
+#
+# Copyright 2015 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
##############################################################################
##
## Gradle start up script for UN*X
@@ -28,7 +44,7 @@ APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS=""
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
diff --git a/gradlew.bat b/gradlew.bat
index f9553162f..9618d8d96 100644
--- a/gradlew.bat
+++ b/gradlew.bat
@@ -1,3 +1,19 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@@ -14,7 +30,7 @@ set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS=
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
diff --git a/knownissues_v3.2.x.md b/knownissues_v3.2.x.md
new file mode 100644
index 000000000..7b22aff0a
--- /dev/null
+++ b/knownissues_v3.2.x.md
@@ -0,0 +1,702 @@
+[Prison Documents - Table of Contents](docs/prison_docs_000_toc.md)
+
+# Prison Known Issues and To Do's for v3.2.x
+
+This document is intended to keep track of known issues and also provide for
+a short list of To Do's. This list is intended to help work through known
+issues, and/or to serve as items that should be added, or fixed.
+
+
+# To Do Items - During Beta v3.2.1
+
+
+* **Rename Mines**
+Been a few requests to be able to rename mines. Since so much can go wrong with manually changing the files, this should be a reasonable new feature added before beta.
+
+
+* **New Block Model - Implement in parallel**
+Implement and have a fully functional new block handling mechanism that operate in complete parallel to the old method. This way admins can turn it on when they want to use it, otherwise their server will continue to use the old code.
+
+ 1. Done: Create core classes for new block types. String based so 100% flexible. Names based upon XMaterial enums so easy mapping to XMaterial then to system version dependency.
+
+ 2. Done: Available blocks based upon XMateral and spigot version they are running. Create the initial list to be used for block searches.
+
+ 3. Done: Needs Review: Disable MineData.getBlocks() and use that to write all the main parallel code. Reenable.
+
+ 4. Disable BlockType and write parallel code. Reenable.
+
+ 5. Hookup block search.
+
+
+
+* **Rework commands within the spigot module so all user facing commands are routed through Prison's Command Interface**
+ Blue should work on this.
+
+
+
+
+
+ * **Problem with rank removal from Ladders**
+Create a new rank to the default ladder. Add a player to it. Then remove the rank from the ladder.
+
+The ladder no longer contains the rank. But the player is still associated with the rank, but yet ranks cannot contain players if they are not on a ladder. The commands expect a valid ladder name. Also there does not appear to be any checks and balances when ranks are moved from one ladder to the other since ranks have no idea what ladder they are in.
+
+This could cause major corruption if moving ranks between ladders, removing ranks from a ladder, and players being associated with those ranks.
+
+Create a "void" ladder and prevent ladders from being named: default, void, and prestige. When a rank is removed from a ladder, place it in to none and update all players that use that rank so the rank is still valid. Do not include void ladders in placeholders.
+
+
+
+* **Update config.yml when changes are detected**
+Preserving the current settings, replace the out of date config.yml file with the latest that is stored within the jar. Updating the settings as it goes.
+
+
+* **Ladder commands - global for all ranks in that ladder**
+Add new placeholders for ladder commands to be able to have generic ladder commands that will apply and be ran for all ranks. May be able to eliminate the need for most rank commands.
+
+
+* **Rank Commands - Edit and delete**
+Add line numbers and enable the ability to edit and delete by line number.
+
+
+
+
+GABRYCAToday at 3:46 PM
+3.2.1 -> Nothing to fix
+
+3.3.0 before ->
+Bug: Bug fixes which will be reported by the user, if nothing will be reported in a month, then some of the next planned features will be integrated within this:
+New:
+- Add Ranks, Mines, Prestiges and RankupCommands presets
+- Add a walktrough GUI and Command to set up Prison presets on first start in the server
+- , , , placeholders for RankupCommands
+
+3.3.0 ->
+New:
+- Add close GUI Button
+- Next page button for ranks, ladders, rankupcommands and mines
+- Eventually add some features which are missing in the GUIs
+- Enhanced GUI listeners and management system (I'll need this for the next feature)
+- Tracker and "cache" of the previous open GUI (will be deleted if there aren't Open GUIs... to sort this out)
+- Go Back button to go to the previous GUI
+
+
+
+
+
+Enable zero block counts for parent mines.
+if 100% block type of IGNORE, then after reset do an full mine air count so zero block reset works. :)
+
+
+
+
+[Plugin Prison - To be able to manage at which layer such or such block appears]
+- For example if I create a mine of 10 high, with iron_ore, gold_ore, emerald_ore,... I would like choose between which layers a particular bloc appears.
+
+ "blocks": [
+ "STONE-20.0-0", 0 when not configured = all layers
+ "IRON_ORE-25.0-0,5", 0,5 for all layers up to the layer 5
+ "GOLD_ORE-25.0-4,7", 4,7 for layers between layer 4 and 7
+ "EMERALD_ORE-25.0-8,0" 8,0 for all layers after layer 8 (in example : so up to layer 10)
+ ],
+
+
+
+
+# To Do Items - Post v3.2.1
+
+
+ Major tasks
+
+
+
+* **Integration in to WordEdit & WorldGuard**
+Largest problem with providing a solution is that prison supports 1.8 through 1.17!!
+WE and WG has a strict policy that they only support the current version of spigot/mc. They do not support older versions, but their older versions that worked with older versions still exists to be used.
+The major problem is that you cannot run scripts from console since WG and WE require to know what world the actions are in, and they get that from the active player.
+There is an API that can be used, but they warn that there are changes to the API from version to version, so it may not be possible to provide the same API calls from 1.8 through 1.17. Will not know until we try to use them?
+
+Just had this idea... What if for these main commands, for configuration purposes, the player would have to be in game. When they run these commands we TP the admin to the mines' spawn point, then run them through the console on behalf of that player? That way WE and WG could get the world from the on line player. But this will not work for mine resets... :(
+
+
+
+
+
+```
+ Note: May be spread out over multiple releases.
+ 1. New Block handling if not fully apart of v3.2.1.
+ 2. New Multi-language support.
+ 3. New Wizard Configuration support.
+ A. Basic Prison functions.
+ B. Basic Mine behaviors
+ C. Basic Rank and Ladder behaviors
+ D. Basic prestige behaviors
+ 4.Creation of new scripting language for automation tied to wizards
+ A. When creating a mine perform scripted actions to configure each one
+ B. When creating a rank perform scripted actions to configure each rank
+ C. Create the permission group within the permission plugin selected
+ D. Add perms for that permission group, including warp support (prison/warps)
+ E. Auto generate rank commands to add and remove group perms from each rank
+```
+
+.
+
+
+ Higher Priority TO DO Items
+
+
+* **Need to figure out how to better handle the Spigot commands that bypass the prison command interface**
+They are inconsistent and non-standard to prison. They do not support the `help` keyword, nor do they show what perms they need.
+
+
+* **Refactor GUI?**
+Performance updates and validation to ensure computationally expensive processes are not running constantly.
+
+
+
+* **Possible Issue with delete Mine**
+Delete a mine and try to add a new one right away with the same name. A user said it would not allow them, that the mine already exists.
+* Tested on a few versions and could not reproduce. Keeping this entry here to retest in the near future.
+
+
+To consider - Lower priority
+
+
+
+* **When creating a new mine, register that mine with the placeholders**
+Might be easier to just reregister all mines? Not sure if that will work?
+Right now, if a mine is added, in order for it to show up in the placeholders, you would have to restart the server so all the placeholders are reregistered.
+ * * maybe just automatically run reset when vital elements change? * *
+
+
+
+* **Add WorldGuard Support**
+This is a work in progress. The biggest problem is that although older versions exist, they only support the latest version, and they have removed the older documentation and maven repositories. So access is highly limited to functional resources for performing builds. The current documentation identifies that major functional changes exist even between minor versions. So one API for v6.1 (supports mc 1.7 through 1.8 only) may not work WG v6.2.2 (supports only mc 1.12), and may not even be close to support v7.0.2 (supports 1.14 through 1.15).
+
+Not knowing what "range" of WorldGuard behaviors are supported through the API, or if they are even the same, the initial range of supported integrations for WorldGuard will be very limited until it can be fully tested to see where those limits are.
+
+List of features that could be nice to have, ordered from easiest to most difficult to implement, with the possibility of never being able to do any of these:
+ * Using prison's mine boundaries, set a WorldEdit selection to those same dimensions so the user does not have to reselect the same area.
+ * Using prison's mine boundaries, define, or resize, a given WorldGuard region. Using a Prison defined naming schema.
+ * If a prison is deleted, then remove the Prison's WorldGuard region.
+ * Auto define the WorldGuard global templates and permissions, then auto define, update, and remove all mine related regions as the mines are added, changed, or removed. * Detect if there is an out of sync situation between prison and worldGuard.
+
+
+* **Get started on new Multi-Language Support**
+This is put on hold for the v3.2.2 release.
+
+
+
+* **Upon startup validate all Blocks that are defined in the mines**
+
+Upon loading prison, validate that all blocks that are defined within each mine are actually valid for that version of minecraft. This will be important in that it may help eliminate possible errors when the server owner upgrades the server, or other plugins. Also it will be very helpful when Prison's block handling is enhanced since it will be a tool used to verify and maybe even fix incorrect block types.
+
+
+
+* **Add to the Command annotations an option of *async* to run that command asynchronously**
+Check to see if the commands are being ran sync or async. Add a parameter support so
+commands that can be ran async.
+
+
+* **Add prison Placeholders to papi's website for downloads**
+Prison is already using papi (PlaceholderAPI). But see if we can add prison to the supported
+plugis for papi's cloud. Should time this with the v3.2.1 release so there are more
+placeholder to use.
+
+DeadlyKill: This what he needs ita
+Papi
+Hook Plugin
+They have those expansions which hook other plug-ins
+
+https://github.com/help-chat/PlaceholderAPI/wiki/Placeholders
+
+
+
+* **Improve some of the display pages for ranks and ladders***
+Can add more information to the listings so they have more value.
+
+
+* **Tab Completion***
+Hook up tab completion on the prison commands.
+
+
+* **Better logging of major events***
+Need to log major events such as rankups, both to the server log, and also
+to the community. Server logs for these events, especially when money is
+involved, is important.
+
+
+
+
+* **Possible new feature: Track how many blocks a player mines, including types***
+Stats could be interesting over time, and could also be used for in game
+bonuses and rewards and incentives.
+
+
+* **Redesign the save files to eliminate the magic numbers***
+Most of the save files within prison, for players, ranks, and ladders, are
+using magic numbers which is highly prone to errors and is considered
+very dangerous. Also prison would benefit from a redesign in file layout
+to improve efficiencies in loading and saving, not to mention greatly reduce
+the complexities within the actual prison code, which in turn will help
+eliminate possible bugs too and give tighter code.
+
+
+
+* **Notification that inventory is full***
+In progress!
+
+
+* **Built in selling system***
+
+* **Custom Mine reset messages per mine***
+
+
+* **Enhancement: Multi-Language Support***
+
+Offers for translation:
+ Italian : Gabryca
+ Greek : NerdTastic
+ German: DeadlyKill ?? Did not ask, but a possibility?
+ French: LeBonnetRouge
+ Portuguese: 1Pedro ?
+
+
+* **Auto-Config of other Prison Related Plugins***
+
+GABRYCA: [Idea]
+
+Not sure if it's possible, but an hook with worldguard on mine making, like a region where the mine region's made automatically with basic permissions'd be neat
+
+RoyalBlueRanger:
+
+Gabryca... yes. I think a "clean" integration in to WorldGuard regions and WorldEdit selection tools would be a great improvement. I've been wanting to do this from day one actually. But I'm not 100% sure how much "automation" can be done here.
+
+I guess if the first thing you do when you activate prison, is to "confirm" that you want prison that you want to "link" prison to WorldGuard and your Permission plugin (assuming supported ones exist), then auto generate all of the "step" that are outlined in the document that I create on github for WorldGuard. That would really help everyone setup their basic servers.
+
+A lot of work there.... but it would be VERY beneficial for sure. It could be the foundation of an automated setup where prison "proactively" works with other plugins to help build and configure the server.
+
+Areas of possibilities in "Auto-Configure Prison Environment":
+ * WorldGuard - Regions for mines
+ * WorldEdit - Selection tools
+ * LuckPerms - Perms
+ * EssentialsX - Warps tied to mine warps
+ * QuickSell - Place a [Sell All} sign at the mine warp
+ * Citizens - NPC generated to replace the QuckSell Sign
+ * CitizensCMD - Links the Citizen NPC to the QuickSell "tiered" pricing (requires Citizens)
+
+I think those few integrations could really provide a huge bootstrap to getting the basics of a prison server up and running.
+
+
+
+# Features recently added:
+
+
+
+* **Done: Prestige references**
+Add the prestige command to the /prison version page; rework the commands layout.
+Add the documentation for prestige. Gabryca provided the base docs.
+
+
+* **Done: Prestige Fixes**
+The existing prestige command is GUI only. That may be an issue with 1.8.x. When testing, it appears to work, but may need an non-gui way to rank up.
+
+The /prestige command does not show the cost. The cost must be shown, along with a warning that the player's balance will be set to zero.
+
+Since the player loses their balance, which may be far more than what the prestige may cost, there really must be a confirmation added confirming the cost, and the player's balance. It should also identify that the excess amount of money the player will lose.
+
+Must change the cancel button lore. It's grammatically incorrect with a double negative. Should only be: "Cancel Prestige". Likewise the confirmation button should just be "Confirm Prestige" since the colon is grammatically ambiguous.
+
+
+
+**Done! Parameterize Sort order for /mines list.**
+Default sort order should probably be alphabetical.
+Currently it is alphabetical with most active mines since restart at the top of the list, based upon blocks mined.
+
+
+
+* **Done!! Add GUI support for v1.8.x**
+ Might be able to add GUI support for 1.8.x with a few simple lines of code?
+
+
+
+* **Done: Autosell feature**
+Be able to allow the players to toggle it on or off. Will not sell what is in inventory, but only the blocks that they are mining. Use /autosell .
+What would be nice is if you could look up all permissions that start with prison.sellall.1.05 where the number at the end is the multiplier. So you setup the multiplier based upon permissions and no other configs. Then take all the multipliers and multiply them together. So if they have a 1.05 (donor), 1.03 (special limited time), 0.97 (prestige penalty... more difficult the higher you go) would have a total of 1.049. So basically different ranks, or even different tools could increase or decrease payout.
+
+
+
+
+* **FIXED: BUG? Able to add more than 100% in one mine?**
+User reported having three copies of everything which totaled more than 300%.
+Used the /mines block add function?
+
+
+
+* **DONE: Add player names to the player file**
+ Have no idea who is who in the player files.
+ Make it an array of a new object, player name that has name and timestamp.
+ When the file is loaded and the player is online, check name, and if not recorded, then add it.
+
+
+
+* **DONE: Add permissions on notifications for mine resets **
+Only send a message to the player if they have the permission set, and follow the other notification settings too.
+Add permission `mines.notification.[mineName]` and have each mine have a boolean field to indicate that it should check for permissions on the players prior to sending the message.
+
+
+* **DONE: Broadcast all rankups**
+Option to disable it in config settings.
+
+
+
+* **DONE: Placeholders - Reregister**
+Add a new command `/prison placeholders reload` that will reregister all placeholders. I don't think there is a clean way to unload the registrations, but just going through registration may be good enough. Deleted, or obsolete, placeholders may still be registered, but at least the new ones will get registered too.
+
+
+* **DONE: Placeholders - Add placeholder counts to startup**
+Counts on how many placeholders are generate and registered.
+
+
+* **DONE: Placeholders - Add new placeholders**
+prison_rankup_cost_remaining
+Such that `prison_mines_*_minename` will also be mapped to `prison_mines_*_player` and will only report the values when a player is in a mine.
+I think that will be super cool, since you could put some current mine stats in your placeholder such as `prison_mines_timeleft_formatted_player` `prison_mines_remaining_player` and even `prison_mines_player_count_player`.
+
+NOTE this was added: the new ones are playermines and there are a total of 24 new ones. Will work great with scoreboards.
+
+
+
+
+ * **Not an issue: Prison Wand breaks blocks**
+ Should probably monitor block break events and cancel breakage with wand.
+ This was caused by a conflict with a scoreboard plugin that advertised as supporting 1.16.2, but broke a few different plugins.
+
+
+
+* **DONE! Complete the new Mines Reset Paging**
+ Holding up release v3.2.1.
+
+
+* **DONE: Enhance AutoManager**
+Make auto manager more like vanilla on the drops and support silking. Try to make more consistent between versions.
+This is a lot closer to the vanilla. May need to revisit in the future to enhance even more.
+
+
+* **DONE: Add permissions to the AutoManger***
+Add permission checking to AutoManager to allow a per-mine selection of which mines to enable it in or to tie it to some rank or donor rank. Could also put lore checking in place so tools could be enchanted to perform these functions too. Could have it so there is a percent chance related to the permission or lore.
+
+
+* **DONE: Prestige and Rebirth**
+
+
+
+* **Already Exists: Update the Prison command handlers to support help context**
+-= Note I was unaware if you use the command `help` as the only parameter it shows the help =-
+This would show the parameter details for the commands. Right now the annotations that defines the command parameters has descriptions for the command and the parameters, but they are not displayed anywhere useful.
+
+
+
+* **DONE: Add support for player use of /mines tp**
+
+Could be done through other perms and then checking to see if they have access t
+
+that mine. Perm: mines.tp (all mines) or mines.tp..
+
+
+
+* **DONE: Add a placeholder test command**
+Create a command, like under **/prison** that can be used to test placeholders.
+Have one where the user can enter any free text and then translate it.
+Also have a page(s) that goes through all of them printing the place holder name and the current values.
+
+
+
+* **Improve the prestige laddering system***
+A plugin named EZprestige has been attempted to be used with prison. Not sure if successful?
+-= Prison now has its own prestige system =-
+
+
+
+* **DONE: Remove world check before loading mine***
+Now supports deferred world loading, where the world loads after prison initializes.
+This is a problem with Multiverse-core plugin since a softdepend loads way before a hard depend. As such, the worlds that were created with Multiverse-core have not yet been added to the bukkit list of worlds.
+
+If the world is checked after the server is running, they will be available. Put in a class variable that identifies if the world was verified, and if not, then check.
+
+Problem is that at startup time, we won't know if there is a problem with missing worlds.
+
+
+* **DONE: Add /ranks remove currency [rankName] [currency]**
+Done. Currently no way to remove a currency from a Rank to return it to normal currency.
+
+
+* **DONE: Add onBlockBreak monitor to prison mines to count blocks mined**
+Set EventPriority to monitor. Don't change anything. Just confirm block was changed to air and increment the count.
+Do not have to precheck if the block was air before, since air cannot trigger a block break event. Just confirm it is air when monitoring to ensure it was removed. If this works, then this would allow the elimination of the air counts.
+
+
+* **DONE: Delay Mine Resets based upon blocks remaining**
+ Done: This is the Skip Mine Reset processing. It will not do a reset until enough blocks are mined.
+
+
+* **DONE: Skip Mine Resets - Based upon usage and percent remaining**
+ * If a mine is not being used, this can greatly reduce the processing needs within the server. If there are about 30 mines, and no players are online for hours, then it can greatly reduce the server loads and reduce the number of chunk updates.
+ * Placeholder added percent mined so data exists to use for this calculation.
+ * At reset time, if enabled, check to see how many blocks were mined.
+ * If more than threshold percentage, such as 10%, then reset the mine.
+ * Even if one block is mined, and it is below the threshold, may want to reset the mine after X number of *skipped* resets.
+ * Do not count as skipped if zero blocks are mined.
+ * All mines will reset after server reload, after the timer expires the first time, since in-mine block data and stats are not saved to the file system.
+
+ * Fields to add to the Mine data:
+ * skipReset - true = enabled, false = disabled
+ * skipResetPercent - double - threshold to reset based upon blocks mined. Does not include original air-blocks.
+ * skipResetBypassThreshold - int - number of *skips* before a forced reset.
+ * skipResetBypassCount - transient - int - counts the number of times a reset is skipped. This is transient value and is never saved.
+
+
+
+
+
+
+* **Not needed: Exclude specific Prison commands**
+NOTE: The player asking for this was able to disable the ranks module and that was able to solve their problem. There are no other reasons to cause this much trouble and redesign of the command handling internally, so this is being removed from consideration.
+Ability to exclude, or ignore, specific commands upon startup.
+NOTE: this may not be needed. Disabling the Prison Ranks module solved the problem, which was trying to use EZRanksPro and prison's /rankup command was conflicting with that plugin's /rankup command
+
+
+
+
+* **OBSOLETE: Sellall is now internal. Support QuickSell project for use with Prison *Only* ***
+
+*Goal:* Something to consider. See if it can work with 1.15.x. This would provide a solution for prison servers to use with the full range of our supported platform versions. Intentions of pushing changes back in to the main project and not maintaining a new project.
+
+QuickSell has be abandoned, but could be very useful for prison to provide a simplified integration of features.
+
+Quickly reviewed code and it looks fairly good and probably has very low maintenance. Base initial support could be updating dependencies within Maven. Goal to get QuickSell to work with all supported versions of Prison and all supported versions of spigot.
+
+Explicit support going forward would be directly related to Prison. If a support issue has to do with another 3rd party plugin, then support "could" be refused or unsupported 3rd party plugins could be removed. Primary focus would be for the support of Prison and to provide a QuickSell feature to users of the Prison plugin.
+
+https://www.spigotmc.org/resources/quicksell.6107/
+
+https://github.com/TheBusyBiscuit/QuickSell
+Currently 15 forks. Activity unknown.
+
+
+
+
+* **Obsolete: New block handling system - put on hold**
+-= Using XMaterial so this is covered, except for possibility of custom blocks =-
+
+Current system is based upon enumerations which are static and may not reflect the actual run time environment. Prison is compiled with 1.9.4, but yet the list may not include all blocks for all versions of bukkit/spigot/minecraft
+
+
+If the new block handling system gets all blocks from org.bukkit.Material.values(), then it should reflect what's available on the server version that is running. If the server owner decides to upgrade, or down grade, their server version, then they will be responsible for "correcting" any block name that is no longer supported. This would be the negative for such a system
+
+
+The benefits would be less to manage within prison; attitude of do what you want to do, instead of micro managing the list of blocks. Dynamic to support newest blocks available on minecraft/bukkit/spigot, or another platform. Ability to pickup custom blocks if they have been injected in to the Material enumeration
+
+
+Currently there is a HUGE problem. Upon testing, I have determined that although a block exists within the server's org.bukkit.Material enum, Prison cannot select it. I do not know why. It could be related to the fact that prison is built with Gradle using spigot v1.9.4 and that imposes restrictions upon what enumerations can be accessed at runtime? That makes no sense since no artifacts of org.bukkit.Material should be carried over outside of the compile time instance. Until this issue can be addressed, there will be no work around or implmentation.
+
+
+
+* **Obsolete: Block Types for Specific Versions of Minecraft**
+-= Using XMaterial going forward =-
+Add in support for the loss of magic values, and also provide for newer block types too. Basically have a minecraft version selector that can tailor the list of available block types that can be used, based upon the minecraft version that is running
+
+
+
+* **DONE: Add parameter to charge player for Promote command**
+On /ranks promote you can now charage a player for that rank. Also on /ranks demote you can issue a refund to the player too. See the actual commands for usage.
+
+
+* **DONE: New Feature: Upon block break events, log block changes**
+This will allow dynamic live tracking of mine stats, such as how many blocks
+remain and relating percentages. The new async processing will enable this
+to actually track individual blocks.
+
+
+* **DONE: Document how to use essentials warps for each mine**
+See documentation within github for these details.
+
+
+* **DONE: Add placeholder aliases so they are not as long**
+Done.
+
+
+* **DONE: Eliminate the internal Placeholders**
+Done. Performance improvement.
+
+
+* **DONE: Integrate GUI in to bleeding**
+Done. More GUI features will be added in the next release.
+
+
+* **DONE: Setup GUI to use /prison gui**
+Done.
+
+
+* **DONE: Mine Placeholders**
+Added a number of placeholders for mines.
+
+
+* **DONE: Player Placeholder - prison_rankup_rank_tag**
+When adding the new placeholder code, the prison_rankup_rank was set to return the
+rank name and not tag. So added a prison_rankup_rank_tag so there would be access
+to both to give the most flexibility.
+
+* **DONE: New Feature: List all registered plugins**
+To better support server owners when they have issues with Prison, it would
+be very helpful if **/prison version** would list all registered plugins in
+a concise listing. In progress. Included now in bleeding.
+All integrations are now listed with their version.
+The spigot command **/pl** (plugin list) shows all active plugins.
+
+* **DONE: New feature: Track how many blocks are mined from the mines**
+Stats on how many blocks are mined from each mine. May be bad to track,
+but could open the door to interesting stats.
+**DONE:** this is a whole mine sweep to count air blocks and is being performed
+for the benefit of placeholders. This could be improved with block break
+event tracking.
+
+* **DONE: New Feature: Add Placeholders for Mine related items**
+Examples would be place holders for all mines, and their stats such as
+size, dimensions, percent remaining, reset duration, time left until reset,
+players currently within the mine, ect...
+
+* **DONE: Offline player support**
+Was not possible to get offline users through the prison API.
+
+* **DONE: New Feature: Admin reset of Player Ranks**
+Bypass the costs for the players. The admins can now use
+/ranks promote, /ranks demote, and /ranks set rank.
+
+* **DONE: Eliminate support for Sponge**
+It's not being used, so eliminate it and allow prison to possibly eliminate the
+extra layers of indirection it currently has to improve performance and to
+possibly reduce the possibilities for errors.
+
+
+* **DONE: List currencies that are used in Ranks**
+
+On startup, gather all currencies that are defined within the Ranks, confirm there is a economy that supports it, and then print the list with the ranks module.
+
+
+
+## Known Issues - v3.2.1-alpha.9 - 2020-04-26
+
+
+* **Multiverse-core prevents worlds from loading**
+Multiverse-core when it is a softdepend prevents prison from being able to access all of the worlds that it will normally load. When it is a softdepend Prison loads prior to multiverse-core so bukkit has no knowledge of those worlds.
+
+To fix this problem, you must manually add Multiverse-core as a hard dependency.
+
+**NOTICE** the line that starts with **depend:** since that line does not exist in the normal config.yml file.
+
+```
+website: https://mc-prison.tech
+softdepend: [Essentials, Vault, LuckPerms, Multiverse-Core, Multiworld, MVdWPlaceholderAPI, PlaceholderAPI, GemsEconomy, WorldEdit, WorldGuard, ProtocolLib, PerWorldInventory, Multiverse-SignPortals, Multiverse-NetherPortals ]
+depend: [Multiverse-Core]
+commands:
+```
+
+
+* **Prison v3.2.0 (and older) has limited Placeholder Support**
+
+Prison v3.2.0 only has one chat placeholder and it is {PRISON_RANK}, which must be in all uppercase.
+
+The only Prison integrations supported with this version are PlaceholderAPI and MVdWPlaceholder.
+
+The placeholders supported by PlaceholderAPI are prison_rank, prison_rankup_cost, and prison_rankup_rank. Supported case is unknown, so use lowercase.
+
+The actual placeholders for MVdWPlaceholder is actually unknown, but may be the same as listed for PlaceholderAPI, but I cannot confirm it.
+
+
+* **Prison v3.2.1 Placeholder Support**
+
+The best way to find the available placeholders is to use the command **/prison version**. Keep in mind that any placeholder that ends with **minename** will be expanded for each mine, substituting the mine name for the suffix **minename**. For example, if there are 30 mines, then Prison will register 30 placeholders for each listed placeholder under **/prison version**.
+
+The placeholders will be registered as shown, in lowercase. They actually are case insensitive, but since they are registered in lowercase, the various placeholder APIs may only recognize lowercase entries. Also Prison's placeholders are registered without any brackets. Most placeholder tools use {} and a few others use %%; refer to the placeholder's documentation on correct usage.
+
+Prison's Ranks has a chat handler that now supports all placeholders.
+
+Support for PlaceholderAPI is through the prefix of "prison", of which it will route all placeholders with prefixes of "prison" through prison. When PlaceholderAPI makes calls to Prison, it strips the prefix. Therefore, Prison's placeholders will respond to the full placeholder, or the the placeholder minus the prefix. The list of all existing placeholders within Prison are not pre-registered.
+
+The MVdWPlaceholder api requires all placeholders be registered.
+
+
+* **Some block types may not work for 1.15.x**
+Since prison is not currently using the correct block names for 1.15.x, some
+block types may not work. Prison is still using magic numbers for the
+block types and those no longer work for 1.15.x. Symptom would be that
+you set a block type such as birch block, but with the loss of the magic
+number, it will revert back to just an oak block. ETA may be with
+release v3.2.2?
+
+
+* **Unable to change language on all Aspects of Prison**
+Currently the number of phrases that can be changed to support other
+languages is very limiting and requires a decent amount of manipulation
+of extracting files from the Prison Jar. Future releases will allow just
+about all uses of English to be replaced by external language files.
+This will include error messages for players and mods (console errors),
+command descriptions, and even replacement of the English commands as
+aliases. The implementation of this will help ensure "errors" are caught
+at compile time, and not runtime to help improve stability of the game.
+Also the way the language files are structured at runtime will make it
+easier to edit them.
+
+
+
+* **Information: Setting the correct currency for Prison**
+
+ Note: Moved to FAQ docs.
+
+
+
+* **Known issue with LuckPerms v5.0.x Causing Prison Load Failures**
+
+ Note: Moved to FAQ docs.
+
+
+
+* [ ] **Reports that other plugins may cause issues with Prison**
+It's been mentioned that a plugin or two, named something like
+"nohunger or nofalldmg", may have been causing issues with Prison.
+Not sure if its the loading or running, but it behaved as if the
+mines and ranks module was not loaded since those commands were not
+functional. Only /prison was working. This appears as the same general
+effect of LuckPerms v5.x failures, where they caused a failure that
+prevented prison from performing a normal load.
+I have not looked in to these plugins, but I would suggest that
+WorldGuard should be used instead of these plugins to eliminate possible
+conflicts.
+
+
+
+* [x] **REMOVED: No support for sponge - appears like it never had it**
+Note: Support for sponge was commented out in two gradle files. The source code
+remains, but it will not impact the builds anymore.
+
+There is a sponge module, but there is so little code that has been written,
+that it does not appear to be hooked up. There is no way it could have ever worked
+correctly since so many core components needed for the functionality of prison
+are dependent upon Spigot internals, of which those same function calls under
+Sponge's API are just empty or returning null values.
+
+For example, getScheduler() and dispatchCommand() both are empty, but they
+are currently heavily used in both the mine reset process and also for
+ranking up.
+
+It would be a really major effort to hook up the missing parts. I don't even
+think anyone is trying to run it under sponge. Maybe best in the long run to
+eliminate the sponge module and just focus on making prison better overall.
+I think if I do get around to disabling it, it will just be commented out of the
+gradle build such that the source will still be there, but it will be excluded
+from the build. Otherwise as new features are added, and existing ones under go
+major changes, then the Sponge components will have to be revisited and would be
+wasting resources (and time) for no reasonable purpose.
+
+
diff --git a/prison-core/build.gradle b/prison-core/build.gradle
index c7c6433d7..240e78d0f 100644
--- a/prison-core/build.gradle
+++ b/prison-core/build.gradle
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -19,6 +19,14 @@
apply plugin: 'eclipse'
apply plugin: 'idea'
+repositories {
+ mavenCentral()
+}
+
+dependencies {
+ implementation 'org.apache.commons:commons-lang3:3.9'
+}
+
processResources {
from(sourceSets.main.resources.srcDirs) {
include 'items.csv'
@@ -27,7 +35,7 @@ processResources {
shadowJar {
dependencies {
- include(dependency('org.apache.commons:commons-lang3:3.9'))
+ include(dependency('org.apache.commons:commons-lang3:3.10'))
include(dependency('com.google.code.gson:gson:2.8.6'))
}
classifier 'API'
diff --git a/prison-core/out/production/resources/lang/core/cs_CZ.properties b/prison-core/out/production/resources/lang/core/cs_CZ.properties
new file mode 100644
index 000000000..924971ba6
--- /dev/null
+++ b/prison-core/out/production/resources/lang/core/cs_CZ.properties
@@ -0,0 +1,34 @@
+#
+# Prison is a Minecraft plugin for the prison game mode.
+# Copyright (C) 2017 The Prison Team
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see An instance of Prison can be retrieved using the static
* {@link Prison#get()} method, however in order to use the core libraries, you must call
@@ -48,19 +49,34 @@
* @author Faizaan A. Datoo
* @since API 1.0
*/
-public class Prison implements PluginEntity {
-
+public class Prison
+ implements PluginEntity {
+
+ /**
+ *
This is not exactly a Prison module, but it's name is used within
+ * the LocaleManager to correct the generation of an incorrect directory
+ * path for the locale language files for this "core" module. Basically
+ * this provides consistency in the location of all language files that
+ * the admins can easily edit and know where to find them.
+ *
+ *
+ */
+ public static final String PSEDUO_MODLE_NAME = "core";
+
public static final int SPIGOTMC_ORG_PROJECT_ID = 1223; //72740;
// Singleton
public static final int API_LEVEL = 3;
private static Prison instance = null;
+
+ private String minecraftVersion;
// Fields
private Platform platform;
private File dataFolder;
private ModuleManager moduleManager;
+ private PrisonCommand prisonCommands;
private CommandHandler commandHandler;
private SelectionManager selectionManager;
private EventBus eventBus;
@@ -92,50 +108,69 @@ public static Prison get() {
*
* Note that modules should not call this method. This is solely for the implementations.
*/
- public boolean init(Platform platform) {
+ public boolean init(Platform platform, String minecraftVersion) {
long startTime = System.currentTimeMillis();
this.platform = platform;
+ this.minecraftVersion = minecraftVersion;
+
sendBanner();
- Output.get().logInfo("Enable start...");
+ Output.get().logInfo("Enabling and starting...");
// Initialize various parts of the API. The magic happens here :)
if (!initDataFolder()) {
+ Output.get().logInfo("&cFailure: &eInitializing the Prison Data Folders!" );
+ Output.get().logInfo("&e&k!=&d Prison Plugin Terminated! &e&k=!&7" );
return false;
}
initManagers();
if (!initMetaDatabase()) {
+ Output.get().logInfo("&cFailure: &eInitializing the Prison Database!" );
+ Output.get().logInfo("&e&k!=&d Prison Plugin Terminated! &e&k=!&7" );
return false;
}
Alerts.getInstance(); // init alerts
- this.commandHandler.registerCommands(new PrisonCommand());
+ this.prisonCommands = new PrisonCommand();
+ this.commandHandler.registerCommands(prisonCommands);
+ long stopTime = System.currentTimeMillis();
+
Output.get()
.logInfo("Enabled &3Prison v%s in %d milliseconds.", getPlatform().getPluginVersion(),
- (System.currentTimeMillis() - startTime));
+ (stopTime - startTime));
registerInbuiltTroubleshooters();
if (getPlatform().shouldShowAlerts())
scheduleAlertNagger();
-
+
+
+ // Disabled for now. The integrations cannot properly support this yet.
+// List integrations = Prison.get().getIntegrationManager().toStrings();
+// for ( String intgration : integrations ) {
+// Output.get().logInfo( intgration );
+// }
+
+
return true;
}
// Initialization steps
private void sendBanner() {
- PrisonAPI.log("");
- PrisonAPI.log("&6 _____ _ ");
- PrisonAPI.log("&6| __ \\ (_) ");
- PrisonAPI.log("&6| |__) | __ _ ___ ___ _ __ ");
- PrisonAPI.log("&6| ___/ '__| / __|/ _ \\| '_ \\");
- PrisonAPI.log("&6| | | | | \\__ \\ (_) | | | |");
- PrisonAPI.log("&6|_| |_| |_|___/\\___/|_| |_|");
- PrisonAPI.log("");
- PrisonAPI.log("Loading version %s on platform %s...", PrisonAPI.getPluginVersion(),
- platform.getClass().getSimpleName());
+ Output.get().logInfo("");
+ Output.get().logInfo("&6 _____ _ ");
+ Output.get().logInfo("&6| __ \\ (_) ");
+ Output.get().logInfo("&6| |__) | __ _ ___ ___ _ __ ");
+ Output.get().logInfo("&6| ___/ '__| / __|/ _ \\| '_ \\");
+ Output.get().logInfo("&6| | | | | \\__ \\ (_) | | | |");
+ Output.get().logInfo("&6|_| |_| |_|___/\\___/|_| |_|");
+ Output.get().logInfo("");
+ Output.get().logInfo("&7Loading Prison version: &3%s", PrisonAPI.getPluginVersion());
+ Output.get().logInfo("&7Running on platform: &3%s", platform.getClass().getSimpleName());
+ Output.get().logInfo("&7Minecraft version: &3%s", getMinecraftVersion());
+ Output.get().logInfo("");
}
private boolean initDataFolder() {
@@ -206,7 +241,12 @@ public void deinit() {
// Getters
- @Override
+ public String getMinecraftVersion()
+ {
+ return minecraftVersion;
+ }
+
+ @Override
public String getName() {
return "PrisonCore";
}
@@ -269,8 +309,13 @@ public EventBus getEventBus() {
public ModuleManager getModuleManager() {
return moduleManager;
}
+
- /**
+ public PrisonCommand getPrisonCommands() {
+ return prisonCommands;
+ }
+
+ /**
* Returns the command handler, where command methods can be registered using the {@link
* CommandHandler#registerCommands(Object)} method.
*
diff --git a/prison-core/src/main/java/tech/mcprison/prison/PrisonAPI.java b/prison-core/src/main/java/tech/mcprison/prison/PrisonAPI.java
index 4e11157e6..d04a3b099 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/PrisonAPI.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/PrisonAPI.java
@@ -1,6 +1,14 @@
package tech.mcprison.prison;
+import java.io.File;
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.UUID;
+
import com.google.common.eventbus.EventBus;
+
import tech.mcprison.prison.commands.CommandHandler;
import tech.mcprison.prison.commands.PluginCommand;
import tech.mcprison.prison.gui.GUI;
@@ -17,9 +25,6 @@
import tech.mcprison.prison.util.ItemManager;
import tech.mcprison.prison.util.Location;
-import java.io.File;
-import java.util.*;
-
/**
* A static way to access {@link Platform} and {@link Prison} methods.
* Much easier and recommended over using the aforementioned classes.
@@ -83,6 +88,10 @@ public static List getCommands() {
public static void dispatchCommand(String cmd) {
Prison.get().getPlatform().dispatchCommand(cmd);
}
+
+ public void dispatchCommand(tech.mcprison.prison.internal.CommandSender sender, String cmd) {
+ Prison.get().getPlatform().dispatchCommand( sender, cmd);
+ }
public static Scheduler getScheduler() {
return Prison.get().getPlatform().getScheduler();
diff --git a/prison-core/src/main/java/tech/mcprison/prison/PrisonCommand.java b/prison-core/src/main/java/tech/mcprison/prison/PrisonCommand.java
index 0a3d0d4b4..24d31fd45 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/PrisonCommand.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/PrisonCommand.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -18,13 +18,27 @@
package tech.mcprison.prison;
+import java.text.DecimalFormat;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+import java.util.TreeMap;
+import java.util.UUID;
+
+import tech.mcprison.prison.autofeatures.AutoFeaturesFileConfig.AutoFeatures;
import tech.mcprison.prison.commands.Arg;
import tech.mcprison.prison.commands.Command;
+import tech.mcprison.prison.commands.CommandPagedData;
+import tech.mcprison.prison.commands.Wildcard;
+import tech.mcprison.prison.integration.IntegrationManager;
import tech.mcprison.prison.integration.IntegrationType;
import tech.mcprison.prison.internal.CommandSender;
+import tech.mcprison.prison.internal.Player;
import tech.mcprison.prison.modules.Module;
+import tech.mcprison.prison.modules.ModuleStatus;
import tech.mcprison.prison.output.BulletedListComponent;
import tech.mcprison.prison.output.ChatDisplay;
+import tech.mcprison.prison.output.DisplayComponent;
import tech.mcprison.prison.output.Output;
import tech.mcprison.prison.troubleshoot.TroubleshootResult;
import tech.mcprison.prison.troubleshoot.Troubleshooter;
@@ -38,35 +52,280 @@
*/
public class PrisonCommand {
- @Command(identifier = "prison version", description = "Displays version information.", onlyPlayers = false)
+ private List registeredPlugins = new ArrayList<>();
+
+ private TreeMap registeredPluginData = new TreeMap<>();
+
+
+ @Command(identifier = "prison version", description = "Displays version information.",
+ onlyPlayers = false )
public void versionCommand(CommandSender sender) {
+ ChatDisplay display = displayVersion();
+
+ display.send(sender);
+ }
+
+ /**
+ * This class contains the data that is used to log the plugins, commands, and their aliases,
+ * that may be setup on the server. This is setting the ground work to store the command
+ * data that can be used to trouble shoot complex problems, such as conflicts, that are
+ * occuring with the prison plugin.
+ *
+ *
+ * This is just the data, and does not interact, or modify, any of the other commands.
+ *
+ *
+ */
+ public class RegisteredPluginsData {
+ private String pluginName;
+ private String pluginVersion;
+ private List registeredCommands;
+
+ private boolean registered = false;
+ private int aliasCount = 0;
+
+ public RegisteredPluginsData( String pluginName, String pluginVersion, boolean registered ) {
+ super();
+
+ this.pluginName = pluginName;
+ this.pluginVersion = pluginVersion;
+ this.registered = registered;
+
+ this.registeredCommands = new ArrayList<>();
+ }
+
+ public void addCommand( String commandName, List commandAliases ) {
+ RegisteredPluginCommandData command =
+ new RegisteredPluginCommandData( commandName, commandAliases );
+
+ getRegisteredCommands().add( command );
+
+ setAliasCount( getAliasCount() + commandAliases.size() );
+ }
+
+
+ public Object formatted()
+ {
+ String message = String.format( "&7%s &c%s&3(&a%s &7c:&a%s &7a:&a%s &3)",
+ getPluginName(),
+ (isRegistered() ? "" : "*"),
+ getPluginVersion(),
+ Integer.toString(getRegisteredCommands().size()),
+ Integer.toString(getAliasCount()));
+ return message;
+ }
+
+
+ public String getdetails() {
+ StringBuilder sbCmd = new StringBuilder();
+ StringBuilder sbAlias = new StringBuilder();
+ for ( RegisteredPluginCommandData cmd : getRegisteredCommands() )
+ {
+ if ( sbCmd.length() > 0 ) {
+ sbCmd.append( " " );
+ }
+ sbCmd.append( cmd.getCommand() );
+
+ for ( String alias : cmd.getAliases() )
+ {
+ if ( sbAlias.length() > 0 ) {
+ sbAlias.append( " " );
+ }
+ sbAlias.append( alias );
+ }
+
+ }
+
+ return "Plugin: " + getPluginName() + " cmd: " + sbCmd.toString() +
+ (sbAlias.length() == 0 ? "" :
+ " alias: " + sbAlias.toString());
+ }
+
+ public String getPluginName() {
+ return pluginName;
+ }
+ public void setPluginName( String pluginName ) {
+ this.pluginName = pluginName;
+ }
+
+ public String getPluginVersion() {
+ return pluginVersion;
+ }
+ public void setPluginVersion( String pluginVersion ) {
+ this.pluginVersion = pluginVersion;
+ }
+
+ public boolean isRegistered() {
+ return registered;
+ }
+ public void setRegistered( boolean registered ) {
+ this.registered = registered;
+ }
+
+ public List getRegisteredCommands() {
+ return registeredCommands;
+ }
+ public void setRegisteredCommands( List registeredCommands ) {
+ this.registeredCommands = registeredCommands;
+ }
+
+ public int getAliasCount() {
+ return aliasCount;
+ }
+ public void setAliasCount( int aliasCount ) {
+ this.aliasCount = aliasCount;
+ }
+
+
+ }
+
+ public class RegisteredPluginCommandData {
+ private String command;
+ private List aliases;
+
+ public RegisteredPluginCommandData( String command, List aliases ) {
+ super();
+
+ this.command = command;
+ this.aliases = aliases;
+ }
+
+ public String getCommand() {
+ return command;
+ }
+ public void setCommand( String command ) {
+ this.command = command;
+ }
+
+ public List getAliases() {
+ return aliases;
+ }
+ public void setAliases( List aliases ) {
+ this.aliases = aliases;
+ }
+ }
+
+ public ChatDisplay displayVersion() {
+
ChatDisplay display = new ChatDisplay("/prison version");
- display
- .text("&7Version: &3%s &8(API level %d)", Prison.get().getPlatform().getPluginVersion(),
- Prison.API_LEVEL);
+ display.text("&7Prison Version: &3%s", Prison.get().getPlatform().getPluginVersion());
- display.text("&7Platform: &3%s", Prison.get().getPlatform().getClass().getName());
+ display.text("&7Running on Platform: &3%s", Prison.get().getPlatform().getClass().getName());
+ display.text("&7Minecraft Version: &3%s", Prison.get().getMinecraftVersion());
+
+ display.text("");
+
+ display.text("&7Commands: &2/prison");
+
+ for ( Module module : Prison.get().getModuleManager().getModules() ) {
+
+ display.text( "&7Module: &3%s&3 : %s %s", module.getName(),
+ module.getStatus().getStatusText(),
+ (module.getStatus().getStatus() == ModuleStatus.Status.FAILED ?
+ "&d[" + module.getStatus().getMessage() + "&d]" : "")
+ );
+ display.text( " &7Base Commands: %s", module.getBaseCommands() );
+ }
+
+ List disabledModules = Prison.get().getModuleManager().getDisabledModules();
+ if ( disabledModules.size() > 0 ) {
+ display.text( "&7Disabled Module%s:", (disabledModules.size() > 1 ? "s" : ""));
+ for ( String disabledModule : Prison.get().getModuleManager().getDisabledModules() ) {
+ display.text( "&a &cDisabled Module: &7%s&a. Related commands and placeholders are non-functional. ",
+ disabledModule );
+ }
+ }
+
+
+ display.text("");
display.text("&7Integrations:");
+ IntegrationManager im = Prison.get().getIntegrationManager();
String permissions =
- Prison.get().getIntegrationManager().hasForType(IntegrationType.PERMISSION) ?
- "&a" + Prison.get().getIntegrationManager().getForType(IntegrationType.PERMISSION)
- .get().getProviderName() :
- "&cNone";
+ (im.hasForType(IntegrationType.PERMISSION) ?
+ "&a" + im.getForType(IntegrationType.PERMISSION).get().getDisplayName() :
+ "&cNone");
display.text(Text.tab("&7Permissions: " + permissions));
- String economy = Prison.get().getIntegrationManager().hasForType(IntegrationType.ECONOMY) ?
- "&a" + Prison.get().getIntegrationManager().getForType(IntegrationType.ECONOMY).get()
- .getProviderName() :
- "&cNone";
+ String economy =
+ (im.hasForType(IntegrationType.ECONOMY) ?
+ "&a" + im.getForType(IntegrationType.ECONOMY).get().getDisplayName() :
+ "&cNone");
display.text(Text.tab("&7Economy: " + economy));
+
+
+ List integrationRows = Prison.get().getIntegrationManager().getIntegrationComponents();
+ for ( DisplayComponent component : integrationRows )
+ {
+ display.addComponent( component );
+ }
+
+ Prison.get().getPlatform().identifyRegisteredPlugins();
+
+ // NOTE: This list of plugins is good enough and the detailed does not have all the info.
+ // Display all loaded plugins:
+ if ( getRegisteredPlugins().size() > 0 ) {
+ display.text( "&7Registered Plugins: " );
+ StringBuilder sb = new StringBuilder();
+ for ( String plugin : getRegisteredPlugins() ) {
+ if ( sb.length() == 0) {
+ sb.append( " " );
+ sb.append( plugin );
+ } else {
+ sb.append( ", " );
+ sb.append( plugin );
+ display.text( sb.toString() );
+ sb.setLength( 0 );
+ }
+ }
+ if ( sb.length() > 0 ) {
+ display.text( sb.toString());
+ }
+ }
+
+ // This version of plugins does not have all the registered commands:
+// // The new plugin listings:
+// if ( getRegisteredPluginData().size() > 0 ) {
+// display.text( "&7Registered Plugins Detailed: " );
+// StringBuilder sb = new StringBuilder();
+// Set keys = getRegisteredPluginData().keySet();
+//
+// for ( String key : keys ) {
+// RegisteredPluginsData plugin = getRegisteredPluginData().get(key);
+//
+// if ( sb.length() == 0) {
+// sb.append( " " );
+// sb.append( plugin.formatted() );
+// } else {
+// sb.append( ", " );
+// sb.append( plugin.formatted() );
+// display.text( sb.toString() );
+// sb.setLength( 0 );
+// }
+// }
+// if ( sb.length() > 0 ) {
+// display.text( sb.toString());
+// }
+// }
+
+
+// RegisteredPluginsData plugin = getRegisteredPluginData().get( "Prison" );
+// String pluginDetails = plugin.getdetails();
+//
+// display.text( pluginDetails );
+
- display.send(sender);
+
+ Prison.get().getPlatform().getWorldLoadErrors( display );
+
+
+ return display;
}
- @Command(identifier = "prison modules", description = "Lists the modules that hook into Prison to give it functionality.", onlyPlayers = false, permissions = "prison.modules")
+ @Command(identifier = "prison modules", onlyPlayers = false, permissions = "prison.modules",
+ description = "Lists the modules that hook into Prison to give it functionality.")
public void modulesCommand(CommandSender sender) {
ChatDisplay display = new ChatDisplay("/prison modules");
display.emptyLine();
@@ -83,7 +342,8 @@ public void modulesCommand(CommandSender sender) {
display.send(sender);
}
- @Command(identifier = "prison troubleshoot", description = "Runs a troubleshooter.", onlyPlayers = false, permissions = "prison.troubleshoot")
+// @Command(identifier = "prison troubleshoot", description = "Runs a troubleshooter.",
+// onlyPlayers = false, permissions = "prison.troubleshoot")
public void troubleshootCommand(CommandSender sender,
@Arg(name = "name", def = "list", description = "The name of the troubleshooter.") String name) {
// They just want to list stuff
@@ -107,7 +367,8 @@ public void troubleshootCommand(CommandSender sender,
}
- @Command(identifier = "prison troubleshoot list", description = "Lists the troubleshooters.", onlyPlayers = false, permissions = "prison.troubleshoot")
+// @Command(identifier = "prison troubleshoot list", description = "Lists the troubleshooters.",
+// onlyPlayers = false, permissions = "prison.troubleshoot")
public void troubleshootListCommand(CommandSender sender) {
ChatDisplay display = new ChatDisplay("Troubleshooters");
display.text("&8Type /prison troubleshoot to run a troubleshooter.");
@@ -123,9 +384,330 @@ public void troubleshootListCommand(CommandSender sender) {
display.send(sender);
}
- @Command(identifier = "prison convert", description = "Convert your Prison 2 data to Prison 3 data.", onlyPlayers = false, permissions = "prison.convert")
- public void convertCommand(CommandSender sender) {
- sender.sendMessage(Prison.get().getPlatform().runConverter());
+
+ @Command(identifier = "prison placeholders test",
+ description = "Converts any Prison placeholders in the test string to their values",
+ onlyPlayers = false, permissions = "prison.placeholder")
+ public void placeholdersTestCommand(CommandSender sender,
+ @Wildcard(join=true)
+ @Arg(name = "text", description = "Placeholder text to test" ) String text ) {
+
+ ChatDisplay display = new ChatDisplay("Placeholder Test");
+
+ BulletedListComponent.BulletedListBuilder builder =
+ new BulletedListComponent.BulletedListBuilder();
+
+ Player player = getPlayer( sender );
+ UUID playerUuid = (player == null ? null : player.getUUID());
+ String translated = Prison.get().getPlatform().getPlaceholders()
+ .placeholderTranslateText( playerUuid, sender.getName(), text );
+
+ builder.add( String.format( "&a Include one or more Prison placeholders with other text..."));
+ builder.add( String.format( "&a Use { } to escape the placeholders."));
+ builder.add( String.format( "&7 Original: %s", text));
+ builder.add( String.format( "&7 Translated: %s", translated));
+
+ display.addComponent(builder.build());
+ display.send(sender);
+ }
+
+ private Player getPlayer( CommandSender sender ) {
+ Optional player = Prison.get().getPlatform().getPlayer( sender.getName() );
+ return player.isPresent() ? player.get() : null;
+ }
+
+
+ /**
+ * Gets a player by name. If the player is not online, then try to get them from
+ * the offline player list. If not one is found, then return a null.
+ *
+ *
+ * @param sender
+ * @param playerName is optional, if not supplied, then sender will be used
+ * @return Player if found, or null.
+ */
+ private Player getPlayer( CommandSender sender, String playerName ) {
+ Player result = null;
+
+ playerName = playerName != null ? playerName : sender != null ? sender.getName() : null;
+
+ if ( playerName != null ) {
+ Optional opt = Prison.get().getPlatform().getPlayer( playerName );
+ if ( !opt.isPresent() ) {
+ opt = Prison.get().getPlatform().getOfflinePlayer( playerName );
+ }
+ if ( opt.isPresent() ) {
+ result = opt.get();
+ }
+ }
+ return result;
+ }
+
+ @Command(identifier = "prison placeholders search",
+ description = "Search all placeholders that match all patterns",
+ onlyPlayers = false, permissions = "prison.placeholder")
+ public void placeholdersSearchCommand(CommandSender sender,
+ @Arg(name = "playerName", description = "Player name to use with player rank placeholders (optional)",
+ def = "." ) String playerName,
+ @Arg(name = "pageNumber", description = "page number of results to display", def = "." ) String pageNumber,
+ @Wildcard(join=true)
+ @Arg(name = "patterns", description = "Patterns of placeholders to search for" ) String patterns ) {
+
+
+
+ // blank defaults do not work when there are more than one at a time. So had to
+ // default to periods. So convert periods to blanks initially:
+ playerName = (playerName.equals( "." ) ? "" : playerName );
+ pageNumber = (pageNumber.equals( "." ) ? "" : pageNumber );
+ patterns = (patterns.equals( "." ) ? "" : patterns );
+
+ Player player = getPlayer( null, playerName );
+ if ( player == null ) {
+ // No player found, or none specified. Need to shift parameters over by one:
+ if ( pageNumber != null && pageNumber.trim().length() > 0 ) {
+
+ // playerName should be moved to the pageNumber, after pageNumber is moved to patterns:
+ patterns = (pageNumber.trim() + " " + patterns).trim();
+ }
+ pageNumber = playerName;
+ }
+
+
+ int page = 1;
+
+ /**
+ * Please note: Page is optional and defaults to a value of 1. But when it is not
+ * provided, it "grabs" the first pattern. So basically, if pageNumber proves not
+ * to be a number, then we must prefix whatever is in patterns with that value.
+ */
+ if ( pageNumber != null ) {
+
+ try {
+ page = Integer.parseInt( pageNumber );
+ }
+ catch ( NumberFormatException e ) {
+ // If exception, add pageNumber to the beginning patterns.
+ // So no page number was specified, it was part of the patterns
+ patterns = (pageNumber.trim() + " " + patterns).trim();
+ }
+
+ }
+
+
+ // Cannot allow pages less than 1:
+ if ( page < 1 ) {
+ page = 1;
+ }
+
+ ChatDisplay display = new ChatDisplay("Placeholders Search");
+
+
+ if ( patterns == null || patterns.trim().length() == 0 ) {
+ sender.sendMessage( "&7Pattern required. Placeholder results must match all pattern terms." );
+ return;
+ }
+
+ BulletedListComponent.BulletedListBuilder builder =
+ new BulletedListComponent.BulletedListBuilder();
+
+ if ( player == null ) {
+ // playerName was not provided, or was invalid. So use sender.
+ player = getPlayer( sender );
+ }
+ UUID playerUuid = (player == null ? null : player.getUUID());
+
+ List placeholders = Prison.get().getPlatform().getPlaceholders()
+ .placeholderSearch( playerUuid, (player == null ? null : player.getName()),
+ patterns.trim().split( " " ) );
+
+ builder.add( String.format( "&a Include one or more patterns to search for placeholders. If more"));
+ builder.add( String.format( "&a than one is provided, the returned placeholder will hit on all."));
+ builder.add( String.format( "&a Player based placeholders will return nulls for values if ran from console,"));
+ builder.add( String.format( "&a unless player name is specified. Can view placeholders for any player."));
+
+ if ( player != null ) {
+ builder.add( String.format( "&a Player: &7%s &aPlayerUuid: &7%s", player.getName(),
+ (playerUuid == null ? "null" : playerUuid.toString())));
+
+ }
+
+
+ DecimalFormat dFmt = new DecimalFormat("#,##0");
+ builder.add( String.format( "&7 Results: &c%s &7Original patterns: &3%s",
+ dFmt.format(placeholders.size()), patterns ));
+
+
+ CommandPagedData cmdPageData = new CommandPagedData(
+ "/prison placeholders search", placeholders.size(),
+ 0, Integer.toString( page ), 12 );
+ // Need to provide more "parts" to the command that follows the page number:
+ cmdPageData.setPageCommandSuffix( patterns );
+
+ int count = 0;
+ for ( String placeholder : placeholders ) {
+ if ( cmdPageData == null ||
+ count++ >= cmdPageData.getPageStart() &&
+ count <= cmdPageData.getPageEnd() ) {
+
+ builder.add( String.format( placeholder ));
+ }
+ }
+
+ display.addComponent(builder.build());
+
+ cmdPageData.generatePagedCommandFooter( display );
+
+ display.send(sender);
+ }
+
+
+ @Command(identifier = "prison placeholders list",
+ description = "List all placeholders templates",
+ onlyPlayers = false, permissions = "prison.placeholder")
+ public void placeholdersListCommand(CommandSender sender
+ ) {
+
+ ChatDisplay display = new ChatDisplay("Placeholders List");
+
+ display.text( "&a Placeholders are case insensitive, but are registered in all lowercase.");
+ display.text( "&a Chat based placeholders use { }, but others may use other escape codes like %% %%.");
+ display.text( "&a Mine based placeholders uses the mine name to replace 'minename'.");
+
+ for ( String disabledModule : Prison.get().getModuleManager().getDisabledModules() ) {
+ display.text( "&a &cDisabled Module: &7%s&a. Related placeholders maybe listed but are non-functional. ",
+ disabledModule );
+ }
+
+ List placeholders = new ArrayList<>();
+ Prison.get().getIntegrationManager().getPlaceholderTemplateList( placeholders );
+
+
+ for ( DisplayComponent placeholder : placeholders ) {
+ display.addComponent( placeholder );
+ }
+
+ display.send(sender);
+ }
+
+
+ @Command(identifier = "prison reload placeholders",
+ description = "Placeholder reload: Regenerates all placeholders and reregisters them.",
+ onlyPlayers = false, permissions = "prison.placeholder")
+ public void placeholdersReloadCommandAlias(CommandSender sender ) {
+ placeholdersReloadCommand( sender );
+ }
+
+ @Command(identifier = "prison placeholders reload",
+ description = "Placeholder reload: Regenerates all placeholders and reregisters them.",
+ onlyPlayers = false, permissions = "prison.placeholder")
+ public void placeholdersReloadCommand(CommandSender sender ) {
+
+ Prison.get().getPlatform().getPlaceholders().reloadPlaceholders();
+
+ String message = "Placeholder reload was attempted. " +
+ "No guarentees that it worked 100%. Restart server if any doubts.";
+
+ sender.sendMessage( message );
}
+
+
+ /**
+ * This command does not do anything, except to provide a command placeholder to
+ * make owners aware that there is auto features enabled within prison.
+ * Running this command will show the permissions needed to use these auto features.
+ *
+ *
+ * Cannot use the @Command altPermissions parameter since the permissions can be
+ * dynamically altered to fit the needs of the owner's server. Using the command
+ * altPermissions will also require a server restart to reflect any online changes,
+ * not to mention a recompile since the end users cannot make these changes.
+ *
+ *
+ * @param sender
+ */
+ @Command(identifier = "prison autofeatures",
+ description = "Autofeatures for prison: pickup, smelt, and block",
+ onlyPlayers = false )
+// , altPermissions = { "prison.autofeatures.pickup", "prison.autofeatures.smelt" ,
+// "prison.autofeatures.block" })
+ public void autoFeaturesInformation(CommandSender sender) {
+
+ ChatDisplay display = new ChatDisplay("Auto Features Information");
+
+ display.text( "&a Prison auto features provide the following options:");
+ display.text( "&7 Auto pickup - &aUpon block break, items are placed directly in to player inventory.");
+ display.text( "&7 Auto smelt - &aItems that can be smelted will be smelted automatically.");
+ display.text( "&7 Auto block - &aConverts ores to blocks.");
+ display.text( "&7 Tool lore starts with: Pickup, Smelt, or Block. Only one per line." );
+ display.text( "&7 Tool lore 100 percent with just name. Can have value 0.001 to 100.0 percent." );
+ display.text( "&7 Tool lore examples: Pickup, Pickup 7.13, Smelt 55, Block 75.123" );
+
+ display.text( "&a To configure modify plugin/Prison/autoFeaturesConfig.yml");
+ display.text( "&a Or use &7/prison gui");
+
+ List afs = AutoFeatures.permissions.getChildren();
+ StringBuilder sb = new StringBuilder();
+ for ( AutoFeatures af : afs ) {
+ if ( sb.length() > 0 ) {
+ sb.append( " " );
+ }
+ sb.append( af.getMessage() );
+ }
+ display.text( "&3Permissions:" );
+ display.text( "&b %s", sb.toString() );
+
+ display.send(sender);
+
+ // altPermissions are now a part of this command.
+// // After displaying the help information above, rerun the same command for the player
+// // with the help keyword to show the permissions.
+// String formatted = "prison autofeatures help";
+// Prison.get().getPlatform().dispatchCommand(sender, formatted);
+
+ }
+
+
+
+// This functionality should not be available in v3.2.1! If someone is still running Prison 2.x.x
+// then they must first upgrade to
+// prison v3.0.0 and perform the upgrade, at the most recent, then v3.1.1.
+// @Command(identifier = "prison convert", description = "Convert your Prison 2 data to Prison 3 data.",
+// onlyPlayers = false, permissions = "prison.convert")
+// public void convertCommand(CommandSender sender) {
+// sender.sendMessage(Prison.get().getPlatform().runConverter());
+// }
+
+ public List getRegisteredPlugins() {
+ return registeredPlugins;
+ }
+
+ public TreeMap getRegisteredPluginData() {
+ return registeredPluginData;
+ }
+
+ public RegisteredPluginsData addRegisteredPlugin( String pluginName, String pluginVersion ) {
+ RegisteredPluginsData rpd = new RegisteredPluginsData( pluginName, pluginVersion, true );
+ getRegisteredPluginData().put( pluginName, rpd);
+ return rpd;
+ }
+
+ public RegisteredPluginsData addUnregisteredPlugin( String pluginName, String pluginVersion ) {
+ RegisteredPluginsData rpd = new RegisteredPluginsData( pluginName, pluginVersion, false );
+ if ( !getRegisteredPluginData().containsKey( pluginName ) ) {
+ getRegisteredPluginData().put( pluginName, rpd);
+ }
+ return rpd;
+ }
+
+ public void addPluginDetails( String pluginName, String pluginVersion,
+ String command, List commandAliases ) {
+
+ // just in case this plugin was not registered before:
+ addUnregisteredPlugin( pluginName, pluginVersion );
+
+ RegisteredPluginsData plugin = getRegisteredPluginData().get( pluginName );
+
+ plugin.addCommand( command, commandAliases );
+ }
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/autofeatures/AutoFeaturesFileConfig.java b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/AutoFeaturesFileConfig.java
new file mode 100644
index 000000000..6fb90d89a
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/AutoFeaturesFileConfig.java
@@ -0,0 +1,503 @@
+package tech.mcprison.prison.autofeatures;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+
+import tech.mcprison.prison.Prison;
+import tech.mcprison.prison.file.YamlFileIO;
+import tech.mcprison.prison.output.Output;
+
+public class AutoFeaturesFileConfig {
+
+ public static final String FILE_NAME__AUTO_FEATURES_CONFIG_YML = "/autoFeaturesConfig.yml";
+ private File configFile;
+// private FileConfiguration config;
+
+ private Map config;
+
+ public enum AutoFeatures {
+
+
+ messages,
+
+ inventoryIsFull(messages, "&cWARNING! Your inventory's full!"),
+ inventoryIsFullDroppingItems(messages, "&cWARNING! Your inventory's full and you're dropping items!"),
+ inventoryIsFullLosingItems(messages, "&cWARNING! Your inventory's full and you're losing items!"),
+
+
+ options,
+
+ general(options),
+
+ isAutoManagerEnabled(general, false),
+
+ isCalculateDurabilityEnabled(general, false),
+ isCalculateFortuneEnabled(general, true),
+ isCalculateSilkEnabled(general, true),
+
+ dropItemsIfInventoryIsFull(general, true),
+ playSoundIfInventoryIsFull(general, true),
+ hologramIfInventoryIsFull(general, false),
+
+
+ permissions(options),
+ permissionAutoPickup(permissions, "prison.automanager.pickup"),
+ permissionAutoSmelt(permissions, "prison.automanager.smelt"),
+ permissionAutoBlock(permissions, "prison.automanager.block"),
+
+
+ lore(options),
+ isLoreEnabled(lore, true),
+ lorePickupValue(lore, "&dPickup&7"),
+ loreSmeltValue(lore, "&dSmelt&7"),
+ loreBlockValue(lore, "&dBlock&7"),
+
+ loreTrackBlockBreakCount(lore, false),
+ loreBlockBreakCountName(lore, "&dPrison Blocks Mined:&7 "),
+ loreBlockExplosionCountName(lore, "&dPrison Blocks Exploded:&7 "),
+
+ loreDurabiltyResistance(lore, false),
+ loreDurabiltyResistanceName(lore, "&dDurability Resistance&7"),
+
+ autoPickup(options),
+ autoPickupEnabled(autoPickup, true),
+ autoPickupAllBlocks(autoPickup, true),
+
+ autoPickupCobbleStone(autoPickup, true),
+ autoPickupStone(autoPickup, true),
+ autoPickupGoldOre(autoPickup, true),
+ autoPickupIronOre(autoPickup, true),
+ autoPickupCoalOre(autoPickup, true),
+ autoPickupDiamondOre(autoPickup, true),
+ autoPickupRedStoneOre(autoPickup, true),
+ autoPickupEmeraldOre(autoPickup, true),
+ autoPickupQuartzOre(autoPickup, true),
+ autoPickupLapisOre(autoPickup, true),
+ autoPickupSnowBall(autoPickup, true),
+ autoPickupGlowstoneDust(autoPickup, true),
+
+
+ autoSmelt(options),
+ autoSmeltEnabled(autoSmelt, true),
+ autoSmeltAllBlocks(autoSmelt, true),
+
+
+ autoSmeltGoldOre(autoSmelt, true),
+ autoSmeltIronOre(autoSmelt, true),
+
+
+ autoBlock(options),
+ autoBlockEnabled(autoBlock, true),
+ autoBlockAllBlocks(autoBlock, true),
+
+
+ autoBlockGoldBlock(autoBlock, true),
+ autoBlockIronBlock(autoBlock, true),
+ autoBlockCoalBlock(autoBlock, true),
+ autoBlockDiamondBlock(autoBlock, true),
+ autoBlockRedstoneBlock(autoBlock, true),
+ autoBlockEmeraldBlock(autoBlock, true),
+ autoBlockQuartzBlock(autoBlock, true),
+ autoBlockPrismarineBlock(autoBlock, true),
+ autoBlockLapisBlock(autoBlock, true),
+ autoBlockSnowBlock(autoBlock, true),
+ autoBlockGlowstone(autoBlock, true),
+
+ ;
+
+
+ private final AutoFeatures parent;
+ private final boolean isSection;
+ private final boolean isBoolean;
+ private final boolean isMessage;
+ private final boolean isInteger;
+ private final boolean isLong;
+ private final boolean isDouble;
+
+ private final String path;
+ private final String message;
+ private final Boolean value;
+ private final Integer intValue;
+ private final Long longValue;
+ private final Double doubleValue;
+
+ private AutoFeatures() {
+ this.parent = null;
+ this.isSection = true;
+ this.isBoolean = false;
+ this.isMessage = false;
+ this.isInteger = false;
+ this.isLong = false;
+ this.isDouble = false;
+ this.path = null;
+ this.message = null;
+ this.value = null;
+ this.intValue = null;
+ this.longValue = null;
+ this.doubleValue = null;
+ }
+ private AutoFeatures(AutoFeatures section) {
+ this.parent = section;
+ this.isSection = true;
+ this.isBoolean = false;
+ this.isMessage = false;
+ this.isInteger = false;
+ this.isLong = false;
+ this.isDouble = false;
+ this.path = section.getKey();
+ this.message = null;
+ this.value = null;
+ this.intValue = null;
+ this.longValue = null;
+ this.doubleValue = null;
+ }
+ private AutoFeatures(AutoFeatures section, String message) {
+ this.parent = section;
+ this.isSection = false;
+ this.isBoolean = false;
+ this.isMessage = true;
+ this.isInteger = false;
+ this.isLong = false;
+ this.isDouble = false;
+ this.path = section.getKey();
+ this.message = message;
+ this.value = null;
+ this.intValue = null;
+ this.longValue = null;
+ this.doubleValue = null;
+ }
+ private AutoFeatures(AutoFeatures section, Boolean value) {
+ this.parent = section;
+ this.isSection = false;
+ this.isBoolean = true;
+ this.isMessage = false;
+ this.isInteger = false;
+ this.isLong = false;
+ this.isDouble = false;
+ this.path = section.getKey();
+ this.message = null;
+ this.value = value == null ? Boolean.FALSE : value;
+ this.intValue = null;
+ this.longValue = null;
+ this.doubleValue = null;
+ }
+
+ public AutoFeatures getParent() {
+ return parent;
+ }
+ public boolean isSection() {
+ return isSection;
+ }
+ public boolean isBoolean() {
+ return isBoolean;
+ }
+ public boolean isMessage() {
+ return isMessage;
+ }
+ public boolean isInteger() {
+ return isInteger;
+ }
+ public boolean isLong() {
+ return isLong;
+ }
+ public boolean isDouble() {
+ return isDouble;
+ }
+
+ public String getPath() {
+ return path;
+ }
+ public String getMessage() {
+ return message;
+ }
+ public Boolean getValue() {
+ return value;
+ }
+
+ public Integer getIntValue() {
+ return intValue;
+ }
+ public Long getLongValue() {
+ return longValue;
+ }
+ public Double getDoubleValue() {
+ return doubleValue;
+ }
+
+ public String getKey() {
+ return (path != null ? path + "." : "") + this.name();
+ }
+
+ public AutoFeatures fromString( String autoFeature ) {
+ AutoFeatures results = null;
+
+ for ( AutoFeatures af : values() ) {
+ if ( af.getKey().equalsIgnoreCase( autoFeature )) {
+ results = af;
+ break;
+ }
+ }
+ return results;
+ }
+
+ public void setFileConfig( Map conf ) {
+ if ( isSection() ) {
+ // Skip this. The full path will be resolved in each key value for leaf nodes;
+
+ } else if ( getMessage() != null ) {
+ // create a message entry:
+ TextNode text = TextNode.valueOf( getMessage() );
+ conf.put(getKey(), text);
+
+ } else if ( getValue() != null ) {
+ // create a boolean entry:
+ BooleanNode bool = BooleanNode.valueOf( getValue().booleanValue() );
+ conf.put( getKey(), bool );
+
+ }
+ }
+
+ /**
+ * Get a String message from the FileConfiguration, and if the key
+ * does not exist, return the default value associated with the enum
+ * entry, if it does not exist, then it returns a blank string value.
+ *
+ *
+ * @param conf
+ * @return
+ */
+ public String getMessage( Map conf ) {
+ String results = null;
+
+ if ( conf.containsKey(getKey()) && conf.get( getKey() ).isTextNode() ) {
+ TextNode text = (TextNode) conf.get( getKey() );
+ results = text.getValue();
+ }
+ else if ( getMessage() != null ) {
+ results = getMessage();
+ }
+
+ return results;
+ }
+
+ /**
+ * Get's the boolean value from the FileConfiguration, and if the key
+ * does not exist, then it returns the default value associated with the
+ * enum entry, if it does not exist, then it returns false.
+ * @param conf
+ * @return
+ */
+ public boolean getBoolean( Map conf ) {
+ boolean results = false;
+
+ if ( conf.containsKey(getKey()) && conf.get( getKey() ).isBooleanNode() ) {
+ BooleanNode bool = (BooleanNode) conf.get( getKey() );
+ results = bool.getValue();
+ }
+ else if ( getValue() != null ) {
+ results = getValue().booleanValue();
+ }
+
+ return results;
+ }
+
+ /**
+ * Get the children nodes to the given item.
+ *
+ *
+ * @return
+ */
+ public List getChildren() {
+ return getChildren(this);
+ }
+
+ /**
+ * Get the children for the specified node.
+ *
+ *
+ * @param parent
+ * @return
+ */
+ public List getChildren(AutoFeatures parent) {
+ List results = new ArrayList<>();
+
+ for ( AutoFeatures af : values() ) {
+ if ( af.getParent() == parent ) {
+ results.add( af );
+ }
+ }
+
+ return results;
+ }
+
+ }
+
+ public AutoFeaturesFileConfig() {
+
+ this.config = new LinkedHashMap<>();
+
+
+ // The following is strictly not needed to ensure that the configs are
+ // created, but this, somehow, does ensure that the order in which
+ // the sections are written are in the order in which they are defined
+ // within the enum.
+ for ( AutoFeatures autoFeat : AutoFeatures.values() ) {
+ autoFeat.setFileConfig( getConfig() );
+ }
+
+
+
+ // This may sound counter intuitive if the config file does not exist,
+ // but when trying to load the yaml with the
+ // config fully loaded with the default values will trigger a save if
+ // anyone of them do not exist in the config file.
+ // So do not perform any special first time processing here since it
+ // is handled within the loadYamlAutoFeatures code.
+
+ YamlFileIO yamlFileIO = Prison.get().getPlatform().getYamlFileIO( getConfigFile() );
+ List dne = yamlFileIO.loadYamlAutoFeatures( getConfig() );
+
+ dne.size();
+
+// Set keys = getConfig().keySet();
+// for ( String key : keys ) {
+// ValueNode value = getConfig().get( key );
+// Output.get().logInfo( "AutoFeaturesFileConfig: ### %s %s",
+// key, value.toString() );
+// }
+
+ }
+
+
+ /**
+ * This updates AutoFeatures with a String value.
+ *
+ *
+ * @param feature
+ * @param value
+ */
+ public void setFeature( AutoFeatures feature, String value ) {
+
+ if ( feature.isSection() ) {
+ Output.get().logError(
+ String.format( "Error: AutoFeature %s is a section (path) and cannot be " +
+ "used with a value. value = [%s]",
+ feature.getKey(),
+ ( value == null ? "null" : value )) );
+
+ }
+ else if ( value == null || value.trim().length() == 0 ) {
+ Output.get().logError(
+ String.format( "Error: AutoFeature %s value cannot be null or empty.",
+ feature.getKey()) );
+ }
+ else if ( !feature.isMessage() ) {
+ Output.get().logError(
+ String.format( "Error: AutoFeature %s value is not a message type so it " +
+ "cannot be assigned a message.",
+ feature.getKey()) );
+ }
+ else {
+
+ TextNode text = TextNode.valueOf( value );
+
+ getConfig().put( feature.getKey(), text );
+ }
+
+ }
+
+ /**
+ * This updates AutoFeatures with a boolean value.
+ *
+ *
+ * @param feature
+ * @param value
+ */
+ public void setFeature( AutoFeatures feature, boolean value ) {
+
+ if ( feature.isSection() ) {
+ Output.get().logError(
+ String.format( "Error: AutoFeature %s is a section (path) and cannot be " +
+ "used with a value. value = [%s]",
+ feature.getKey(),
+ Boolean.valueOf( value ).toString() ) );
+
+ }
+ else if ( !feature.isBoolean() ) {
+ Output.get().logError(
+ String.format( "Error: AutoFeature %s value is not a boolean type so it " +
+ "cannot be assigned a boolean value.",
+ feature.getKey()) );
+ }
+ else {
+
+ BooleanNode bool = BooleanNode.valueOf( value );
+
+ getConfig().put( feature.getKey(), bool );
+ }
+
+ }
+
+
+ /**
+ * This returns the config's feature value if it is a boolean. If it is not
+ * a boolean config value, it will return a value false.
+ *
+ * @param feature
+ * @return
+ */
+ public boolean isFeatureBoolean( AutoFeatures feature ) {
+ return feature.getBoolean( getConfig() );
+ }
+
+ public String getFeatureMessage( AutoFeatures feature ) {
+ return feature.getMessage( getConfig() );
+ }
+
+ public boolean saveConf() {
+ return saveConf( getConfig() );
+ }
+
+ /**
+ * This function attempts to save the AutoFeatures configurations to the
+ * file system. This function uses a temporary file to initially perform the save,
+ * then when it is successfully finished, it then deletes the original file, and
+ * renames the temp file to the correct file name. This swapping of files
+ * will prevent the loss of configuration data if something should go wrong in the
+ * initial saving of the data since the original file will not be deleted first.
+ *
+ *
+ * @param afConfig
+ * @return
+ */
+ private boolean saveConf( Map config ) {
+
+ YamlFileIO yamlFileIO = Prison.get().getPlatform().getYamlFileIO( getConfigFile() );
+ return yamlFileIO.saveYamlAutoFeatures( config );
+ }
+
+
+ public File getConfigFile() {
+ if ( this.configFile == null ) {
+
+ this.configFile = new File(
+ Prison.get().getDataFolder() + FILE_NAME__AUTO_FEATURES_CONFIG_YML);
+ }
+ return configFile;
+ }
+ public void setConfigFile( File configFile ) {
+ this.configFile = configFile;
+ }
+
+ public Map getConfig() {
+ return config;
+ }
+
+ public void setConfig( Map config ) {
+ this.config = config;
+ }
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/autofeatures/BooleanNode.java b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/BooleanNode.java
new file mode 100644
index 000000000..a3b0a672c
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/BooleanNode.java
@@ -0,0 +1,61 @@
+package tech.mcprison.prison.autofeatures;
+
+/**
+ * Roughly based upon Jackson's class by the same name.
+ *
+ */
+public class BooleanNode
+ extends ValueNode {
+ private static final long serialVersionUID = -1L;
+
+ public final static BooleanNode TRUE = new BooleanNode(true);
+ public final static BooleanNode FALSE = new BooleanNode(false);
+
+ private final boolean value;
+
+ protected BooleanNode(boolean v) { value = v; }
+
+
+ public static BooleanNode getTrue() { return TRUE; }
+ public static BooleanNode getFalse() { return FALSE; }
+
+ public static BooleanNode valueOf(boolean b) { return b ? TRUE : FALSE; }
+
+
+ @Override
+ public String toString() {
+ return Boolean.toString( getValue() );
+ }
+
+ public boolean getValue() {
+ return value;
+ }
+
+ @Override
+ public boolean isBooleanNode() {
+ return true;
+ }
+
+ @Override
+ public NodeType getNodeType() {
+ return NodeType.BOOLEAN;
+ }
+
+
+ @Override
+ public int hashCode() {
+ return value ? 3 : 1;
+ }
+
+ @Override
+ public boolean equals(Object o)
+ {
+ if (o == this) return true;
+ if (o == null) return false;
+ if (!(o instanceof BooleanNode)) {
+ return false;
+ }
+ return (value == ((BooleanNode) o).value);
+ }
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/autofeatures/DoubleNode.java b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/DoubleNode.java
new file mode 100644
index 000000000..16fef124d
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/DoubleNode.java
@@ -0,0 +1,53 @@
+package tech.mcprison.prison.autofeatures;
+
+/**
+ * Roughly based upon Jackson's class by the same name.
+ *
+ */
+public class DoubleNode
+ extends ValueNode {
+ private static final long serialVersionUID = -1L;
+
+ protected final double value;
+
+ public DoubleNode(double v) { value = v; }
+
+ public static DoubleNode valueOf(double d) { return new DoubleNode(d); }
+
+ @Override
+ public String toString() {
+ return Double.toString( getValue() );
+ }
+
+ public double getValue() {
+ return value;
+ }
+
+ @Override
+ public boolean isDoubleNode() { return true; }
+
+ @Override
+ public NodeType getNodeType() {
+ return NodeType.DOUBLE;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (o == this) return true;
+ if (o == null) return false;
+ if (o instanceof DoubleNode) {
+ // We must account for NaNs: NaN does not equal NaN, therefore we have
+ // to use Double.compare().
+ final double otherValue = ((DoubleNode) o).value;
+ return Double.compare(value, otherValue) == 0;
+ }
+ return false;
+ }
+
+ @Override
+ public int hashCode() {
+ // same as hashCode Double.class uses
+ long l = Double.doubleToLongBits(value);
+ return ((int) l) ^ (int) (l >> 32);
+ }
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/autofeatures/IntegerNode.java b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/IntegerNode.java
new file mode 100644
index 000000000..96a98a8c6
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/IntegerNode.java
@@ -0,0 +1,48 @@
+package tech.mcprison.prison.autofeatures;
+
+public class IntegerNode
+ extends ValueNode {
+
+ private static final long serialVersionUID = -1L;
+
+ protected final int value;
+
+ public IntegerNode(int v) { value = v; }
+
+ public static IntegerNode valueOf(int i) { return new IntegerNode(i); }
+
+ @Override
+ public String toString() {
+ return Integer.toString( getValue() );
+ }
+
+ public int getValue() {
+ return value;
+ }
+
+ @Override
+ public boolean isIntegerNode() {
+ return true;
+ }
+
+ @Override
+ public NodeType getNodeType() {
+ return NodeType.INTEGER;
+ }
+
+ @Override
+ public boolean equals(Object o)
+ {
+ if (o == this) return true;
+ if (o == null) return false;
+ if (o instanceof IntegerNode) {
+ return ((IntegerNode) o).value == value;
+ }
+ return false;
+ }
+
+ @Override
+ public int hashCode() {
+ return ((int) value) ^ (int) (value >> 32);
+ }
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/autofeatures/LongNode.java b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/LongNode.java
new file mode 100644
index 000000000..d68335a69
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/LongNode.java
@@ -0,0 +1,51 @@
+package tech.mcprison.prison.autofeatures;
+
+/**
+ * Roughly based upon Jackson's class by the same name.
+ *
+ */
+public class LongNode
+ extends ValueNode {
+ private static final long serialVersionUID = -1L;
+
+ protected final long value;
+
+ public LongNode(long v) { value = v; }
+
+ public static LongNode valueOf(long l) { return new LongNode(l); }
+
+ @Override
+ public String toString() {
+ return Long.toString( getValue() );
+ }
+
+ public long getValue() {
+ return value;
+ }
+
+ @Override
+ public boolean isLongNode() {
+ return true;
+ }
+
+ @Override
+ public NodeType getNodeType() {
+ return NodeType.LONG;
+ }
+
+ @Override
+ public boolean equals(Object o)
+ {
+ if (o == this) return true;
+ if (o == null) return false;
+ if (o instanceof LongNode) {
+ return ((LongNode) o).value == value;
+ }
+ return false;
+ }
+
+ @Override
+ public int hashCode() {
+ return ((int) value) ^ (int) (value >> 32);
+ }
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/autofeatures/NullNode.java b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/NullNode.java
new file mode 100644
index 000000000..d826410ad
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/NullNode.java
@@ -0,0 +1,45 @@
+package tech.mcprison.prison.autofeatures;
+
+/**
+ * Roughly based upon Jackson's class by the same name.
+ *
+ */
+public class NullNode
+ extends ValueNode
+{
+ private static final long serialVersionUID = -1L;
+
+ public final static NullNode instance = new NullNode();
+
+ public static NullNode getInstance() { return instance; }
+
+ public boolean isNull() {
+ return true;
+ }
+
+ @Override
+ public String toString() {
+ return Boolean.toString( true );
+ }
+
+ @Override
+ public boolean isNullNode() { return true; }
+
+ @Override
+ public NodeType getNodeType() {
+ return NodeType.NULL;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ return o == null ||
+ o == this ||
+ (o instanceof NullNode);
+ }
+
+ @Override
+ public int hashCode() {
+ return -13;
+ }
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/autofeatures/TextNode.java b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/TextNode.java
new file mode 100644
index 000000000..3a7813c94
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/TextNode.java
@@ -0,0 +1,74 @@
+package tech.mcprison.prison.autofeatures;
+
+/**
+ * Roughly based upon Jackson's class by the same name.
+ *
+ */
+public class TextNode
+ extends ValueNode
+{
+ private static final long serialVersionUID = -1L;
+
+ final static TextNode EMPTY_STRING_NODE = new TextNode("");
+
+ protected final String value;
+
+ public TextNode(String v) {
+ super();
+ value = v;
+ }
+
+ @Override
+ public String toString() {
+ return getValue();
+ }
+
+ /**
+ * Factory method that should be used to construct instances.
+ * For some common cases, can reuse canonical instances: currently
+ * this is the case for empty Strings, in future possible for
+ * others as well. If null is passed, will return null.
+ *
+ * @return Resulting {@link TextNode} object, if v
+ * is NOT null; null if it is.
+ */
+ public static TextNode valueOf(String v)
+ {
+ if (v == null) {
+ return null;
+ }
+ if (v.length() == 0) {
+ return EMPTY_STRING_NODE;
+ }
+ return new TextNode(v);
+ }
+
+ public String getValue() {
+ return value;
+ }
+
+ @Override
+ public NodeType getNodeType() {
+ return NodeType.STRING;
+ }
+
+ @Override
+ public boolean isTextNode() {
+ return true;
+ }
+
+ @Override
+ public boolean equals(Object o)
+ {
+ if (o == this) return true;
+ if (o == null) return false;
+ if (o instanceof TextNode) {
+ return ((TextNode) o).value.equals(value);
+ }
+ return false;
+ }
+
+ @Override
+ public int hashCode() { return value.hashCode(); }
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/autofeatures/ValueNode.java b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/ValueNode.java
new file mode 100644
index 000000000..698787d0e
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/ValueNode.java
@@ -0,0 +1,44 @@
+package tech.mcprison.prison.autofeatures;
+
+import java.io.Serializable;
+
+/**
+ * Roughly based upon Jackson's class by the same name.
+ *
+ */
+public abstract class ValueNode
+ implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ public enum NodeType {
+ NULL,
+ STRING,
+ BOOLEAN,
+ LONG,
+ INTEGER,
+ DOUBLE
+ ;
+ }
+
+ public boolean isNullNode() { return false; }
+
+ public boolean isTextNode() { return false; }
+
+ public boolean isBooleanNode() { return false; }
+
+ public boolean isIntegerNode() { return false; }
+
+ public boolean isLongNode() { return false; }
+
+ public boolean isDoubleNode() { return false; }
+
+
+ public abstract NodeType getNodeType();
+
+ public abstract boolean equals(Object o);
+
+ public abstract int hashCode();
+
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/autofeatures/ValueNodeFactory.java b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/ValueNodeFactory.java
new file mode 100644
index 000000000..d21ab838c
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/ValueNodeFactory.java
@@ -0,0 +1,63 @@
+package tech.mcprison.prison.autofeatures;
+
+import java.util.regex.Pattern;
+
+public class ValueNodeFactory {
+
+ public Pattern LONG_PATTERN = Pattern.compile("^-?\\d{1,19}$");
+ public Pattern DOUBLE_PATTERN = Pattern.compile("^[\\+\\-]{0,1}[0-9]+[\\.\\,]{1}[0-9]+$");
+
+
+ public ValueNode getValueNode( String value ) {
+
+ if ( value == null ) {
+ return NullNode.getInstance();
+ }
+
+ // trim off leading and trailing spaces:
+ value = value.trim();
+
+ if ( value != null &&
+ ("true".equalsIgnoreCase( value.trim() ) ||
+ "false".equalsIgnoreCase( value.trim() ))) {
+
+ try {
+ boolean b = Boolean.parseBoolean( value.trim() );
+ return BooleanNode.valueOf( b );
+ }
+ catch ( Exception e ) {
+ // ignore since not a boolean... let another parser try to consume it.
+ }
+ }
+
+ if ( LONG_PATTERN.matcher( value ).matches() ) {
+
+ try {
+ long l = Long.parseLong( value );
+ return LongNode.valueOf( l );
+ }
+ catch ( NumberFormatException e ) {
+ // ignore since not a long... let another parser try to consume it.
+ }
+
+ }
+
+
+ // Note that the regex pattern does not match to scientific notations
+ // such as 123.45E2.
+ if ( DOUBLE_PATTERN.matcher( value ).matches() ) {
+
+ try {
+ double d = Double.parseDouble( value );
+ return DoubleNode.valueOf( d );
+ }
+ catch ( NumberFormatException e ) {
+ // ignore since not a long... let another parser try to consume it.
+ }
+
+ }
+
+ return TextNode.valueOf( value );
+ }
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/chat/ArrayWrapper.java b/prison-core/src/main/java/tech/mcprison/prison/chat/ArrayWrapper.java
index 3ba54655d..86341b48d 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/chat/ArrayWrapper.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/chat/ArrayWrapper.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/chat/FancyMessage.java b/prison-core/src/main/java/tech/mcprison/prison/chat/FancyMessage.java
index fce0b463d..92e1ddeeb 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/chat/FancyMessage.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/chat/FancyMessage.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/chat/JsonRepresentedObject.java b/prison-core/src/main/java/tech/mcprison/prison/chat/JsonRepresentedObject.java
index afaa35ac0..7ddbe8f61 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/chat/JsonRepresentedObject.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/chat/JsonRepresentedObject.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/chat/JsonString.java b/prison-core/src/main/java/tech/mcprison/prison/chat/JsonString.java
index 84cf261be..eb82a0792 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/chat/JsonString.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/chat/JsonString.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/chat/MessagePart.java b/prison-core/src/main/java/tech/mcprison/prison/chat/MessagePart.java
index 40872455f..4d960ff7d 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/chat/MessagePart.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/chat/MessagePart.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/chat/TextualComponent.java b/prison-core/src/main/java/tech/mcprison/prison/chat/TextualComponent.java
index a1153758f..ebb75522f 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/chat/TextualComponent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/chat/TextualComponent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -216,7 +216,7 @@ public void setValue(String value) {
writer.name(getKey()).value(getValue());
}
- @SuppressWarnings("serial") public Map serialize() {
+ @SuppressWarnings({ "serial", "unused" }) public Map serialize() {
return new HashMap() {{
put("key", getKey());
put("value", getValue());
@@ -290,7 +290,7 @@ public void setValue(Map value) {
writer.endObject();
}
- @SuppressWarnings("serial") public Map serialize() {
+ @SuppressWarnings({ "serial", "unused" }) public Map serialize() {
return new HashMap() {{
put("key", getKey());
for (Entry valEntry : getValue().entrySet()) {
diff --git a/prison-core/src/main/java/tech/mcprison/prison/chat/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/chat/package-info.java
index 0bc9ff723..7d6988884 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/chat/package-info.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/chat/package-info.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/Arg.java b/prison-core/src/main/java/tech/mcprison/prison/commands/Arg.java
index 425766a7c..f88b91747 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/Arg.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/Arg.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/ArgumentHandler.java b/prison-core/src/main/java/tech/mcprison/prison/commands/ArgumentHandler.java
index 576fcd583..b663ebad3 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/ArgumentHandler.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/ArgumentHandler.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/ArgumentVariable.java b/prison-core/src/main/java/tech/mcprison/prison/commands/ArgumentVariable.java
index f1147ef38..04b7395c2 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/ArgumentVariable.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/ArgumentVariable.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/ArgumentVerifier.java b/prison-core/src/main/java/tech/mcprison/prison/commands/ArgumentVerifier.java
index 51d810188..20346dc37 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/ArgumentVerifier.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/ArgumentVerifier.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/Arguments.java b/prison-core/src/main/java/tech/mcprison/prison/commands/Arguments.java
index 8c0a631fd..181e0e793 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/Arguments.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/Arguments.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/Command.java b/prison-core/src/main/java/tech/mcprison/prison/commands/Command.java
index 50fe05f33..42174d4fa 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/Command.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/Command.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -25,7 +25,8 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface Command {
+@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD)
+public @interface Command {
/**
* The description of this command
@@ -55,4 +56,26 @@
* error message stating that they do not have permission to use the command.
*/
String[] permissions() default {};
+
+
+ /**
+ * AltPermissions are alternative permissions that are not checked internally, or automatically.
+ * It is up to the programmer to put hooks in to the code to check on these altPermissions.
+ * This field of altPermissions is strictly for displaying helpful information to the end users
+ * and it is only helpful if it is included.
+ *
+ * For example the command /rankup has an optional parameter ladderName. If a ladderName is
+ * provided, then it checks to see if the player has the permission: ranks.rankup.[ladderName].
+ *
+ * Because these permissions are not ever used to check for actual permissions, it is very
+ * important to provide parameters such as [ladderName] to signify where the server owner, or
+ * admin, must place the real ladder name within the permission.
+ *
+ * This is such a critically helpful feature because otherwise the only way you would know
+ * that you need this permission is to look at the source code, of which many cannot do, and
+ * those who can, may not know where to look. So this provides very important information that
+ * was not available before.
+ *
+ */
+ String[] altPermissions() default {};
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/CommandArgument.java b/prison-core/src/main/java/tech/mcprison/prison/commands/CommandArgument.java
index 4d3862016..27bafd4dc 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/CommandArgument.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/CommandArgument.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/CommandError.java b/prison-core/src/main/java/tech/mcprison/prison/commands/CommandError.java
index 4188dd5e4..bfd8996c5 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/CommandError.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/CommandError.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/CommandHandler.java b/prison-core/src/main/java/tech/mcprison/prison/commands/CommandHandler.java
index 00be0e578..bbf55a00f 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/CommandHandler.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/CommandHandler.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -36,7 +36,8 @@ public class CommandHandler {
private Prison plugin;
private Map, ArgumentHandler> argumentHandlers =
- new HashMap, ArgumentHandler>();
+ new HashMap, ArgumentHandler>();
+
private Map rootCommands = new HashMap<>();
private PermissionHandler permissionHandler = (sender, permissions) -> {
@@ -69,7 +70,8 @@ private String formatArgument(CommandArgument argument) {
+ ChatColor.DARK_AQUA + argument.getDescription();
}
- @Override public String[] getHelpMessage(RegisteredCommand command) {
+ @Override
+ public String[] getHelpMessage(RegisteredCommand command) {
ArrayList message = new ArrayList();
if (command.isSet()) {
@@ -99,15 +101,79 @@ private String formatArgument(CommandArgument argument) {
}
}
}
+ if ( command.getPermissions() != null && command.getPermissions().length > 0 ||
+ command.getAltPermissions() != null && command.getAltPermissions().length > 0 ) {
+
+ StringBuilder sb = new StringBuilder();
+
+ if ( command.getPermissions() != null && command.getPermissions().length > 0 ) {
+ for ( String perm : command.getPermissions() ) {
+ if ( sb.length() > 0 ) {
+ sb.append( " " );
+ }
+ sb.append( perm );
+ }
+ }
+ if ( command.getAltPermissions() != null && command.getAltPermissions().length > 0 ) {
+ for ( String altPerm : command.getAltPermissions() ) {
+ if ( sb.length() > 0 ) {
+ sb.append( " " );
+ }
+ sb.append( altPerm );
+ }
+ }
+
+ if ( sb.length() > 0 ) {
+ message.add(ChatColor.DARK_AQUA + "Permissions:");
+
+ sb.insert( 0, ChatColor.AQUA );
+ sb.insert( 0, " " );
+ message.add( sb.toString() );
+ }
+
+ }
}
List subcommands = command.getSuffixes();
if (subcommands.size() > 0) {
message.add(ChatColor.DARK_AQUA + "Subcommands:");
+ // Force a sorting by use of a TreeSet. Collections.sort() would not work.
+ TreeSet subCommandSet = new TreeSet<>();
for (RegisteredCommand scommand : subcommands) {
- message.add(scommand.getUsage());
+ String subCmd = scommand.getUsage();
+
+ int subCmdSubCnt = scommand.getSuffixes().size();
+
+ subCommandSet.add(subCmd + (subCmdSubCnt <= 1 ? "" :
+ ChatColor.DARK_AQUA + " (" + subCmdSubCnt +
+ " Subcommands)"));
}
+
+ for (String subCmd : subCommandSet) {
+ message.add(subCmd);
+ }
+ }
+
+ if ( command.getLabel().equalsIgnoreCase( "prison" ) && rootCommands.size() > 1 ) {
+ message.add(ChatColor.DARK_AQUA + "Prison Root Commands:");
+ // Force a sorting by use of a TreeSet. Collections.sort() would not work.
+ TreeSet rootCommandSet = new TreeSet<>();
+
+ // Try adding in all other root commands:
+ Set rootKeys = rootCommands.keySet();
+
+ for ( PluginCommand rootKey : rootKeys ) {
+ String rootCmd = rootKey.getUsage();
+
+ rootCommandSet.add( rootCmd );
+
+ }
+
+ for (String rootCmd : rootCommandSet) {
+ message.add(rootCmd);
+ }
}
+
return message.toArray(new String[0]);
}
@@ -264,4 +330,30 @@ public boolean onCommand(CommandSender sender, PluginCommand command, String lab
return true;
}
+
+/*
+ * ###Tab-Complete###
+ *
+ * Disabled for now until a full solution can be implemented for tab complete.
+ *
+ public List getRootCommandKeys() {
+ List results = new ArrayList<>();
+
+ Set keys = rootCommands.keySet();
+ for ( PluginCommand pluginCommand : keys ) {
+ // These are the core command sets:
+ results.add( pluginCommand.getLabel() );
+
+ // Then expand them to all the sub commands that are assoicated with the cores:
+ RootCommand cmd = rootCommands.get( pluginCommand );
+ List regCmds = cmd.getSuffixes();
+ for ( RegisteredCommand regCmd : regCmds ) {
+ results.add( pluginCommand.getLabel() + " " + regCmd.getLabel() );
+ }
+
+ }
+
+ return results;
+ }
+ */
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/CommandPagedData.java b/prison-core/src/main/java/tech/mcprison/prison/commands/CommandPagedData.java
new file mode 100644
index 000000000..9a759176b
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/CommandPagedData.java
@@ -0,0 +1,181 @@
+package tech.mcprison.prison.commands;
+
+import tech.mcprison.prison.chat.FancyMessage;
+import tech.mcprison.prison.output.ButtonComponent;
+import tech.mcprison.prison.output.ButtonComponent.Style;
+import tech.mcprison.prison.output.ChatDisplay;
+import tech.mcprison.prison.output.RowComponent;
+
+public class CommandPagedData {
+ public static final int MAX_PAGE_SIZE = 10;
+
+ private String pageCommand;
+ private String pageCommandSuffix;
+
+ private int curPage = 1;
+ private boolean showAll = false;
+
+ private int pageSize = MAX_PAGE_SIZE;
+ private int pages = 1;
+ private int extraPages = 1;
+
+ private int pageStart = 1;
+ private int pageEnd = 1;
+
+ public CommandPagedData( String pageCommand, int itemSize, int extraPages, String page) {
+ this( pageCommand, itemSize, extraPages, page, MAX_PAGE_SIZE );
+ }
+
+ /**
+ *
+ * @param command The command to run to show the same command, minus the page
+ * number, but including the leading slash.
+ * @param itemSize The total number of items that need to be paged through
+ * @param extraPages Extra pages to be displayed with the the item pages. Example
+ * would be the /prison info command with the mine details being on page 1.
+ * @param page The raw page String from the command interface. May contain invalid data.
+ */
+ public CommandPagedData( String pageCommand, int itemSize, int extraPages, String page, int pageSize ) {
+ super();
+
+ this.pageCommand = pageCommand;
+
+ if ( "all".equalsIgnoreCase( page )) {
+ this.showAll = true;
+ }
+
+ this.curPage = 1;
+ this.pageSize = isShowAll() ? itemSize : pageSize;
+ this.pages = isShowAll() ? 1 : (itemSize / getPageSize()) +
+ (itemSize % getPageSize() == 0 ? 0 : 1);
+ this.extraPages = isShowAll() ? 0 : extraPages;
+
+
+ try {
+ curPage = Integer.parseInt(page);
+ }
+ catch ( NumberFormatException e ) {
+ // Ignore: Not an integer, will use the default value.
+ }
+
+ curPage = ( isShowAll() || curPage < 1 ? 1 :
+ (curPage > (pages + getExtraPages()) ? (pages + getExtraPages()) : curPage ));
+
+ // Just set to defaults for the pre-list pages:
+ this.pageStart = 0;
+ this.pageEnd = (itemSize < getPageSize() ? itemSize : getPageSize());
+
+ if ( isShowAll() ) {
+ this.pageEnd = itemSize;
+ this.pages = 1;
+ }
+ else if ( (curPage - getExtraPages()) >= 1 ) {
+ this.pageStart = (curPage - getExtraPages() - 1) * getPageSize();
+ this.pageEnd = ((pageStart + getPageSize()) > itemSize ? itemSize : pageStart + getPageSize());
+ }
+
+// Output.get().logInfo( "CommandPagedData: pageStart=" + pageStart + " pageEnd=" + pageEnd);
+ }
+
+ public void generatePagedCommandFooter( ChatDisplay display ) {
+ generatePagedCommandFooter( display, null );
+ }
+
+ public void generatePagedCommandFooter( ChatDisplay display, String message ) {
+ // Need to construct a dynamic row of buttons. It may have no buttons, both, or
+ // a combination of previous page or next page. But it will always have a page
+ // count between the two.
+ RowComponent row = new RowComponent();
+ if ( getCurPage() > 1 )
+ {
+ row.addFancy(
+ new ButtonComponent( "&e<-- Prev Page", '-', Style.NEGATIVE)
+ .runCommand(pageCommand + " " + (getCurPage() - 1) +
+ (getPageCommandSuffix() == null ? "" : " " + getPageCommandSuffix()),
+ "View the prior page of search results").getFancyMessage() );
+ }
+ row.addFancy(
+ new FancyMessage(" &9< &3Page " + curPage + " of " +
+ (getPages() + getExtraPages() ) + " &9> " +
+ (message == null || message.trim().length() == 0 ? "" : " " + message ) + "&3"));
+
+ if ( getCurPage() < (getPages() + getExtraPages()) )
+ {
+ row.addFancy(
+ new ButtonComponent( "&eNext Page -->", '+', Style.POSITIVE)
+ .runCommand(pageCommand + " " + (getCurPage() + 1) +
+ (getPageCommandSuffix() == null ? "" : " " + getPageCommandSuffix()),
+ "View the prior page of search results").getFancyMessage() );
+ }
+ display.addComponent( row );
+ }
+
+
+
+ public String getPageCommand() {
+ return pageCommand;
+ }
+ public void setPageCommand( String pageCommand ) {
+ this.pageCommand = pageCommand;
+ }
+
+ public String getPageCommandSuffix() {
+ return pageCommandSuffix;
+ }
+ public void setPageCommandSuffix( String pageCommandSuffix ) {
+ this.pageCommandSuffix = pageCommandSuffix;
+ }
+
+ public int getCurPage() {
+ return curPage;
+ }
+ public void setCurPage( int curPage ) {
+ this.curPage = curPage;
+ }
+
+ public boolean isShowAll() {
+ return showAll;
+ }
+ public void setShowAll( boolean showAll ) {
+ this.showAll = showAll;
+ }
+
+ public int getPageSize() {
+ return pageSize;
+ }
+ public void setPageSize( int pageSize ) {
+ this.pageSize = pageSize;
+ }
+
+ public int getPages() {
+ return pages;
+ }
+ public void setPages( int pages ) {
+ this.pages = pages;
+ }
+
+ public int getExtraPages() {
+ return extraPages;
+ }
+
+ public void setExtraPages( int extraPages ) {
+ this.extraPages = extraPages;
+ }
+
+ public int getPageStart() {
+ return pageStart;
+ }
+ public void setPageStart( int pageStart ) {
+ this.pageStart = pageStart;
+ }
+
+ public int getPageEnd() {
+ return pageEnd;
+ }
+ public void setPageEnd( int pageEnd ) {
+ this.pageEnd = pageEnd;
+ }
+
+
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/CommandUtil.java b/prison-core/src/main/java/tech/mcprison/prison/commands/CommandUtil.java
index e678b2049..597cc8fd0 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/CommandUtil.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/CommandUtil.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/ExecutableArgument.java b/prison-core/src/main/java/tech/mcprison/prison/commands/ExecutableArgument.java
index ba00d0463..3bf273e2e 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/ExecutableArgument.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/ExecutableArgument.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/Flag.java b/prison-core/src/main/java/tech/mcprison/prison/commands/Flag.java
index 6e0ba4a03..ad4f13d97 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/Flag.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/Flag.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/FlagArg.java b/prison-core/src/main/java/tech/mcprison/prison/commands/FlagArg.java
index c4995bc1b..acf290c11 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/FlagArg.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/FlagArg.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/FlagArgument.java b/prison-core/src/main/java/tech/mcprison/prison/commands/FlagArgument.java
index 3a7878bcc..49200ed32 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/FlagArgument.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/FlagArgument.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/Flags.java b/prison-core/src/main/java/tech/mcprison/prison/commands/Flags.java
index 2ff928798..c95c78d2f 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/Flags.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/Flags.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/HelpHandler.java b/prison-core/src/main/java/tech/mcprison/prison/commands/HelpHandler.java
index 4ba776f36..c19c61515 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/HelpHandler.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/HelpHandler.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/InvalidVerifyArgument.java b/prison-core/src/main/java/tech/mcprison/prison/commands/InvalidVerifyArgument.java
index 838deacb3..944540f44 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/InvalidVerifyArgument.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/InvalidVerifyArgument.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/PermissionHandler.java b/prison-core/src/main/java/tech/mcprison/prison/commands/PermissionHandler.java
index 93c966ca6..36b64347f 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/PermissionHandler.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/PermissionHandler.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/PluginCommand.java b/prison-core/src/main/java/tech/mcprison/prison/commands/PluginCommand.java
index 642da6731..a559cad56 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/PluginCommand.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/PluginCommand.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/ReflectionUtil.java b/prison-core/src/main/java/tech/mcprison/prison/commands/ReflectionUtil.java
index f4bc84126..973c893a2 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/ReflectionUtil.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/ReflectionUtil.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/RegisterCommandMethodException.java b/prison-core/src/main/java/tech/mcprison/prison/commands/RegisterCommandMethodException.java
index 1e8441a72..68a39002b 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/RegisterCommandMethodException.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/RegisterCommandMethodException.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/RegisteredCommand.java b/prison-core/src/main/java/tech/mcprison/prison/commands/RegisteredCommand.java
index f29dd6f90..ab8b9cdd0 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/RegisteredCommand.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/RegisteredCommand.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -35,6 +35,7 @@ public class RegisteredCommand {
private RegisteredCommand parent;
private String description;
private String[] permissions;
+ private String[] altPermissions;
private boolean onlyPlayers;
private Method method;
private Object methodInstance;
@@ -65,11 +66,23 @@ void addSuffixCommand(String suffix, RegisteredCommand command) {
boolean doesSuffixCommandExist(String suffix) {
return suffixesByName.get(suffix) != null;
}
+
+ public String getCompleteLabel() {
+ return (parent == null ? "" : parent.getCompleteLabel() + " " ) +
+ (label == null ? "-noCommandLabelDefined-" : label) ;
+ }
void execute(CommandSender sender, String[] args) {
if (!testPermission(sender)) {
Prison.get().getLocaleManager().getLocalizable("noPermission")
.sendTo(sender, Localizable.Level.ERROR);
+
+ Output.get().logInfo( "&cLack of Permission Error: &7Player &3%s &7lacks permission to " +
+ "run the command &3%s&7. Permissions needed: [&3%s&7]. Alt Permissions: [&3%s&7]",
+ sender.getName(), getCompleteLabel(),
+ (permissions == null ? "-none-" : String.join( ", ", permissions )),
+ (altPermissions == null ? "-none-" : String.join( ", ", altPermissions ))
+ );
return;
}
@@ -183,6 +196,10 @@ public String[] getPermissions() {
return permissions;
}
+ public String[] getAltPermissions() {
+ return altPermissions;
+ }
+
public RegisteredCommand getSuffixCommand(String suffix) {
return suffixesByName.get(suffix);
}
@@ -223,6 +240,7 @@ void set(Object methodInstance, Method method) {
Flags flagsAnnotation = method.getAnnotation(Flags.class);
this.description = command.description();
this.permissions = command.permissions();
+ this.altPermissions = command.altPermissions();
this.onlyPlayers = command.onlyPlayers();
Class[] methodParameters = method.getParameterTypes();
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/RootCommand.java b/prison-core/src/main/java/tech/mcprison/prison/commands/RootCommand.java
index 38d8e970b..c6aedbb3e 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/RootCommand.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/RootCommand.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/TransformError.java b/prison-core/src/main/java/tech/mcprison/prison/commands/TransformError.java
index 8d5aaa8c0..3d31d3704 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/TransformError.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/TransformError.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/VerifierNotRegistered.java b/prison-core/src/main/java/tech/mcprison/prison/commands/VerifierNotRegistered.java
index e54f394ee..55339404e 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/VerifierNotRegistered.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/VerifierNotRegistered.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/VerifyError.java b/prison-core/src/main/java/tech/mcprison/prison/commands/VerifyError.java
index ea2725aff..4e399b1e1 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/VerifyError.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/VerifyError.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/Wildcard.java b/prison-core/src/main/java/tech/mcprison/prison/commands/Wildcard.java
index fa5efe9c9..5043aa39f 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/Wildcard.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/Wildcard.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/WildcardArgument.java b/prison-core/src/main/java/tech/mcprison/prison/commands/WildcardArgument.java
index 7825b395e..83ccba2fa 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/WildcardArgument.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/WildcardArgument.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/BlockArgumentHandler.java b/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/BlockArgumentHandler.java
index 97bc5efee..f2c3e3838 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/BlockArgumentHandler.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/BlockArgumentHandler.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/DoubleArgumentHandler.java b/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/DoubleArgumentHandler.java
index fc9bdc815..1af2272cd 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/DoubleArgumentHandler.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/DoubleArgumentHandler.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/IntegerArgumentHandler.java b/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/IntegerArgumentHandler.java
index 3c9d76fd6..bbae89071 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/IntegerArgumentHandler.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/IntegerArgumentHandler.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/NumberArgumentHandler.java b/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/NumberArgumentHandler.java
index 4a460d4d2..3c8e2fa58 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/NumberArgumentHandler.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/NumberArgumentHandler.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/PlayerArgumentHandler.java b/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/PlayerArgumentHandler.java
index 700701855..c1de8faa6 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/PlayerArgumentHandler.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/PlayerArgumentHandler.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/StringArgumentHandler.java b/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/StringArgumentHandler.java
index e0470d5d2..b636a0219 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/StringArgumentHandler.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/StringArgumentHandler.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/WorldArgumentHandler.java b/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/WorldArgumentHandler.java
index f1f773767..ac3cec1b3 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/WorldArgumentHandler.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/handlers/WorldArgumentHandler.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/commands/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/commands/package-info.java
index 9817fe5a6..d619b8496 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/commands/package-info.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/commands/package-info.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/file/YamlFileIO.java b/prison-core/src/main/java/tech/mcprison/prison/file/YamlFileIO.java
new file mode 100644
index 000000000..67bec94af
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/file/YamlFileIO.java
@@ -0,0 +1,202 @@
+package tech.mcprison.prison.file;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.TreeMap;
+
+import tech.mcprison.prison.autofeatures.AutoFeaturesFileConfig.AutoFeatures;
+import tech.mcprison.prison.autofeatures.BooleanNode;
+import tech.mcprison.prison.autofeatures.DoubleNode;
+import tech.mcprison.prison.autofeatures.IntegerNode;
+import tech.mcprison.prison.autofeatures.LongNode;
+import tech.mcprison.prison.autofeatures.TextNode;
+import tech.mcprison.prison.autofeatures.ValueNode;
+import tech.mcprison.prison.output.Output;
+
+public abstract class YamlFileIO {
+
+ private File yamlFile;
+
+ public YamlFileIO( File yamlFile ) {
+ super();
+
+ this.yamlFile = yamlFile;
+ }
+
+ public boolean saveYamlAutoFeatures( Map config ) {
+
+ // clears out the pre-existing data that is stored:
+ clear();
+
+
+ // Create the sections first:
+ // This controls the order in which the sections will appear in the file:
+ for ( AutoFeatures autoFeat : AutoFeatures.values() ) {
+ if ( autoFeat.isSection() ) {
+ createSection( autoFeat.getKey() );
+ }
+ }
+
+
+ Set keys = config.keySet();
+ for ( String key : keys ) {
+ ValueNode value = config.get( key );
+
+ if ( value.isNullNode() ) {
+ // skip nulls
+ set( key, null );
+ }
+ else if ( value.isBooleanNode() ) {
+ set( key, ((BooleanNode) value).getValue() );
+ }
+ else if ( value.isTextNode() ) {
+ set( key, ((TextNode) value).getValue() );
+ }
+ else if ( value.isDoubleNode() ) {
+ set( key, ((DoubleNode) value).getValue() );
+ }
+ else if ( value.isLongNode() ) {
+ set( key, ((LongNode) value).getValue() );
+ }
+ else if ( value.isIntegerNode() ) {
+ set( key, ((IntegerNode) value).getValue() );
+ }
+ else {
+ // invalid type... not supported.
+// set( key, value );
+ }
+ }
+
+ return saveYaml();
+ }
+
+ /**
+ * This function loads a yaml file based upon the AutoFeatures enumeration.
+ * It loads the proper ValueNode based upon the defined value within the
+ * enum. If there is a property that does not exist within the yaml file,
+ * it will add it to the config object with the default value, plus it will
+ * return a list of all features that do not exist (dne). If any new settings
+ * are added to the configuration uploading (ie. new features), then it will
+ * trigger a save to update the file so the new features will exist in there.
+ *
+ *
+ * This way, if the dne List is not empty, then it needs to be saved to
+ * update what is saved on the file system. Only the new items, with the
+ * default values, will be added; the original values will not be altered.
+ *
+ *
+ * @param config
+ * @return List of AutoFeatures that were just added to the config file.
+ */
+ public List loadYamlAutoFeatures( Map config ) {
+ List dne = new ArrayList<>();
+
+ // Load from the actual yaml file:
+ loadYaml();
+
+ Map yaml = new TreeMap<>();
+ Set keys = getKeys();
+ for ( String key : keys ) {
+ Object value = getValues().get( key );
+ yaml.put( key, value );
+ }
+
+ for ( AutoFeatures autoFeat : AutoFeatures.values() ) {
+ ValueNode value = null;
+ String key = autoFeat.getKey();
+
+ if ( autoFeat.isSection() ) {
+ createSection( key );
+ }
+ else if ( autoFeat.isBoolean() ) {
+ boolean boolVal = !yaml.containsKey( key ) ? autoFeat.getValue().booleanValue() :
+ Boolean.parseBoolean( yaml.get( key ).toString() );
+ value = BooleanNode.valueOf( boolVal );
+ }
+ else if ( autoFeat.isMessage() ) {
+ String text = !yaml.containsKey( key ) ? autoFeat.getMessage() :
+ yaml.get( key ).toString();
+ value = TextNode.valueOf( text );
+ }
+ else if ( autoFeat.isInteger() ) {
+ int intVal = !yaml.containsKey( key ) ? autoFeat.getIntValue().intValue() :
+ (int) yaml.get( key );
+ value = IntegerNode.valueOf( intVal);
+ }
+ else if ( autoFeat.isLong() ) {
+ long longVal = !yaml.containsKey( key ) ? autoFeat.getLongValue().longValue() :
+ (long) yaml.get( key );
+ value = LongNode.valueOf( longVal );
+ }
+ else if ( autoFeat.isDouble() ) {
+ double doubVal = !yaml.containsKey( key ) ? autoFeat.getDoubleValue().doubleValue() :
+ (double) yaml.get( key );
+ value = DoubleNode.valueOf( doubVal );
+ }
+
+
+ if ( !keys.contains( autoFeat.getKey() )) {
+ // AutoFeature does not exist in save file:
+ dne.add( autoFeat );
+ }
+
+ if ( value != null ) {
+ config.put( autoFeat.getKey(), value );
+ }
+ }
+
+ if ( dne.size() > 0 ) {
+ // New configs were found. Saving the configs.
+ saveYamlAutoFeatures( config );
+ Output.get().logWarn(
+ String.format( "&cNotice: &7AutoManager config file was just updated with &c%s&7 new entries. " +
+ "May need to be configured. &cFile: &7%s",
+ Integer.toString( dne.size() ),
+ getYamlFile().getName()) );
+ }
+
+ if ( keys.size() == 0 ) {
+ Output.get().logWarn(
+ String.format( "Notice: AutoManager config file was just created. " +
+ "You must configure it to use it. &cFile: &7%s",
+ getYamlFile().getName()) );
+ }
+
+ return dne;
+ }
+
+
+ public File getYamlFile() {
+ return yamlFile;
+ }
+
+
+ abstract protected boolean loadYaml();
+ abstract protected boolean saveYaml();
+
+ abstract public Set getKeys();
+ abstract public Map getValues();
+
+ abstract protected void clear();
+ abstract protected void set( String key, Object value );
+ abstract protected void createSection( String key );
+
+ abstract protected boolean getBoolean( String key );
+ abstract protected boolean getBoolean( String key, boolean defaultValue );
+
+ abstract protected String getString( String key );
+ abstract protected String getString( String key, String defaultValue );
+
+ abstract protected double getDouble( String key );
+ abstract protected double getDouble( String key, double defaultValue );
+
+ abstract protected int getInteger( String key );
+ abstract protected int getInteger( String key, int intValue );
+
+ abstract protected long getLong( String key );
+ abstract protected long getLong( String key, long defaultValue );
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/gui/Action.java b/prison-core/src/main/java/tech/mcprison/prison/gui/Action.java
index d6f2739bc..d691cd45c 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/gui/Action.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/gui/Action.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/gui/Button.java b/prison-core/src/main/java/tech/mcprison/prison/gui/Button.java
index d05b08816..3c7e4ecff 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/gui/Button.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/gui/Button.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/gui/ClickedButton.java b/prison-core/src/main/java/tech/mcprison/prison/gui/ClickedButton.java
index 2ec80e604..48a2daab2 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/gui/ClickedButton.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/gui/ClickedButton.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/gui/GUI.java b/prison-core/src/main/java/tech/mcprison/prison/gui/GUI.java
index cb7d0459b..af6a59170 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/gui/GUI.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/gui/GUI.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/gui/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/gui/package-info.java
index 800b6b846..f2893f7ea 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/gui/package-info.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/gui/package-info.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/integration/EconomyCurrencyIntegration.java b/prison-core/src/main/java/tech/mcprison/prison/integration/EconomyCurrencyIntegration.java
new file mode 100644
index 000000000..56d693763
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/integration/EconomyCurrencyIntegration.java
@@ -0,0 +1,48 @@
+package tech.mcprison.prison.integration;
+
+import java.util.TreeMap;
+
+import tech.mcprison.prison.internal.Player;
+
+public abstract class EconomyCurrencyIntegration
+ extends EconomyIntegration
+{
+ private TreeMap supportedCurrencies;
+
+ public EconomyCurrencyIntegration( String keyName, String providerName ) {
+ super( keyName, providerName );
+
+ this.supportedCurrencies = new TreeMap<>();
+ }
+
+ public boolean hasCurrency( String currency ) {
+
+ if ( !getSupportedCurrencies().containsKey( currency ) ) {
+ boolean valid = supportedCurrency( currency );
+ getSupportedCurrencies().put( currency, Boolean.valueOf( valid ) );
+ }
+
+ return getSupportedCurrencies().get( currency ).booleanValue();
+ }
+
+ public abstract boolean supportedCurrency( String currency );
+
+ public abstract double getBalance( Player player, String currency );
+
+ public abstract void setBalance( Player player, double amount, String currency );
+
+ public abstract void addBalance( Player player, double amount, String currency );
+
+ public abstract void removeBalance( Player player, double amount, String currency );
+
+ public abstract boolean canAfford( Player player, double amount, String currency );
+
+
+ public TreeMap getSupportedCurrencies() {
+ return supportedCurrencies;
+ }
+ public void setSupportedCurrencies( TreeMap supportedCurrencies ) {
+ this.supportedCurrencies = supportedCurrencies;
+ }
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/integration/EconomyIntegration.java b/prison-core/src/main/java/tech/mcprison/prison/integration/EconomyIntegration.java
index 3adf95402..acfa60304 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/integration/EconomyIntegration.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/integration/EconomyIntegration.java
@@ -8,15 +8,21 @@
* @author Faizaan A. Datoo
* @since API 1.0
*/
-public interface EconomyIntegration extends Integration {
-
+public abstract class EconomyIntegration
+ extends IntegrationCore {
+
+ public EconomyIntegration( String keyName, String providerName ) {
+ super( keyName, providerName, IntegrationType.ECONOMY );
+
+ }
+
/**
* Returns the player's current balance.
*
* @param player The {@link Player}.
* @return a double.
*/
- double getBalance(Player player);
+ public abstract double getBalance(Player player);
/**
* Sets the player's balance.
@@ -25,7 +31,7 @@ public interface EconomyIntegration extends Integration {
* @param player The {@link Player}.
* @param amount The amount.
*/
- void setBalance(Player player, double amount);
+ public abstract void setBalance(Player player, double amount);
/**
* Adds to the player's current balance.
@@ -33,7 +39,7 @@ public interface EconomyIntegration extends Integration {
* @param player The {@link Player}.
* @param amount The amount.
*/
- void addBalance(Player player, double amount);
+ public abstract void addBalance(Player player, double amount);
/**
* Removes from the player's current balance.
@@ -41,7 +47,7 @@ public interface EconomyIntegration extends Integration {
* @param player The {@link Player}.
* @param amount The amount.
*/
- void removeBalance(Player player, double amount);
+ public abstract void removeBalance(Player player, double amount);
/**
* Returns whether or not the player can afford a transaction.
@@ -50,10 +56,6 @@ public interface EconomyIntegration extends Integration {
* @param amount The amount.
* @return true if the player can afford it, false otherwise.
*/
- boolean canAfford(Player player, double amount);
-
- @Override default IntegrationType getType() {
- return IntegrationType.ECONOMY;
- }
+ public abstract boolean canAfford(Player player, double amount);
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/integration/Integration.java b/prison-core/src/main/java/tech/mcprison/prison/integration/Integration.java
index 430453362..0cc4ac337 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/integration/Integration.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/integration/Integration.java
@@ -10,26 +10,118 @@
*/
public interface Integration {
- /**
+
+ /**
+ * If there is an initialization process that is dependent upon the modules being loaded,
+ * then place it within this function. The integrations are initialized prior to the
+ * modules, but this is a way to defer initializing something until after they are loaded.
+ */
+ public void deferredInitialization();
+
+
+ /**
+ * This is used to identify if an integration has been registered with the server engine,
+ * such as with Bukkit.getPluginManager().isPluginEnabled(). If the
+ * the given integration has not been registered, then it could be dangerous tying to
+ * access the class files associated with that plugin since it could result in
+ * class not found exceptions, or similar. Some plugins may have the same identifier,
+ * but yet different internal classes depending upon their versions, such as LuckPerms,
+ * so additional code must be used to verify what is actually loaded. Of course there
+ * are always exceptions to the rules too.
+ *
+ * @return true if the requested plugin has been registered with the server engine
+ */
+ public boolean isRegistered();
+
+ /**
+ * Used to identify if the integration (plugin) has been registered with the server
+ * engine.
+ *
+ * @param registered
+ */
+ public void setRegistered( boolean registered );
+
+ /**
* Returns the type of integration that this class provides.
*
* @return The {@link IntegrationType}.
*/
- IntegrationType getType();
+ public IntegrationType getType();
/**
- * Returns the name of the third-party plugin that this class is integrating with.
+ * Returns true if this class has integrated with the provider successfully, or false
+ * otherwise. This should also return false if the third-party plugin which this
+ * integration is built for is not present. This is not the same as isRegistered,
+ * since a few integrations may have different class files backing it (such as LuckPerms).
*
- * @return The name of the provider.
+ * @return true if this class has integrated successfully, false otherwise.
+ */
+ public boolean hasIntegrated();
+
+
+ /**
+ * The function that is called to perform the integration. Generally the check is done
+ * prior to calling this function, but may vary. The attempt at integration used to be
+ * performed in the constructor, but but that prevents storing the failed integrations
+ * which can then be used to inform the admins what's available. If the integration
+ * was successful, then hasIntegrated() will return a value of true.
+ */
+ public void integrate();
+
+ /**
+ * Returns the name of the internal representation that should be used for this integrator.
+ * It may not always be the same as providerName, but in most circumstances it will be.
+ * It's important that this keyName should be unique from any other integration keyName.
+ * For example, since there are two major kinds of LuckPerms that are supported,
+ * these should reflect which one is which. This field is used internally within
+ * collections and for display purposes when listing integrations so it should be
+ * more descriptive than the providerName.
*/
- String getProviderName();
+ public String getKeyName();
/**
- * Returns true if this class has integrated with the provider successfully, or false otherwise.
- * This should also return false if the third-party plugin which this integration is built for is not present.
+ * Returns the name of the third-party plugin that this class is integrating with. This
+ * must be exactly what is provided in the plugin's plugin.yml file that
+ * is within the given jar files for the field called name:.
*
- * @return true if this class has integrated successfully, false otherwise.
+ * @return The name of the provider.
*/
- boolean hasIntegrated();
-
+ public String getProviderName();
+
+ /**
+ * The displayName is the value that is actually used when listing all the integrations.
+ * In general it is the combination of both the providerName and the keyName, but
+ * different integrations could customize it to better suite their unique requirements,
+ * such as with Vault.
+ *
+ * @return
+ */
+ public String getDisplayName();
+
+ /**
+ * This is a way for an integration to provide additional information when the
+ * integration is displayed through the /prison version command. This may vary
+ * from integration to integration, or by type. It is perfectly valid for it
+ * to return a null value, which indicates there is nothing available, so ignore
+ * this.
+ *
+ *
+ * @return null means nothing is available so ignore
+ */
+ public String getAlternativeInformation();
+
+ /**
+ * To help admins setup integrations, this is the URL that is generally associated
+ * with the integration. It should usually refer to the spigotmc.org website for
+ * that resource.
+ *
+ *
+ * @return null means nothing is available so this value should be ignored
+ */
+ public String getPluginSourceURL();
+
+
+ public String getDebugInfo();
+ public void setDebugInfo( String debugInfo );
+ public void addDebugInfo( String debugInfo );
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationCore.java b/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationCore.java
new file mode 100644
index 000000000..236385f82
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationCore.java
@@ -0,0 +1,121 @@
+package tech.mcprison.prison.integration;
+
+import java.lang.reflect.InvocationTargetException;
+
+/**
+ * This class provides for most of the default implementations for the
+ * Integration interface, and sets up some of the expected core behaviors.
+ *
+ *
+ */
+public class IntegrationCore
+ implements Integration
+{
+
+ private final String keyName;
+ private final String providerName;
+ private final IntegrationType type;
+ private boolean registered = false;
+
+ private String debugInfo;
+
+ public IntegrationCore( String keyName, String providerName, IntegrationType type ) {
+ super();
+
+ this.keyName = keyName;
+ this.providerName = providerName;
+ this.type = type;
+ }
+
+ public void deferredInitialization() {
+ }
+
+ public boolean isRegistered() {
+ return registered;
+ }
+ public void setRegistered( boolean registered )
+ {
+ this.registered = registered;
+ }
+
+ /**
+ * This may not work since the actual class loader for the plugins
+ * might not be the System class loader.
+ *
+ * @param klass
+ * @return
+ */
+ public boolean isClassLoaded( Class klass ) {
+ Object results = null;
+
+ if ( klass != null ) {
+ try {
+ java.lang.reflect.Method m =
+ ClassLoader.class.getDeclaredMethod("findLoadedClass", new Class[] { String.class});
+ m.setAccessible(true);
+ ClassLoader cl = ClassLoader.getSystemClassLoader();
+ results = m.invoke( cl, klass.getName() );
+ }
+ catch ( NoSuchMethodException | SecurityException | IllegalAccessException | IllegalArgumentException |
+ InvocationTargetException e ) {
+ // Ignore: the class is not loaded.
+ e.getStackTrace();
+ }
+ }
+
+ return results != null;
+ }
+
+ public IntegrationType getType() {
+ return type;
+ }
+
+ public boolean hasIntegrated() {
+ return false;
+ }
+
+
+ public void integrate() {
+
+ }
+
+
+ public String getKeyName() {
+ return keyName;
+ }
+
+ public String getProviderName() {
+ return providerName;
+ }
+
+ public String getDisplayName() {
+ return getProviderName() +
+ ( getProviderName().equals( getKeyName() ) ? "" :
+ " (" + getKeyName() + ")" );
+ }
+
+
+ public String getAlternativeInformation() {
+ return null;
+ }
+
+ public String getPluginSourceURL() {
+ return null;
+ }
+
+
+ @Override
+ public String getDebugInfo() {
+ return debugInfo;
+ }
+ @Override
+ public void setDebugInfo( String debugInfo ) {
+ this.debugInfo = debugInfo;
+ }
+ @Override
+ public void addDebugInfo( String debugInfo ) {
+ this.debugInfo = (this.debugInfo == null ? "" : this.debugInfo) +
+ "(" + debugInfo + ")";
+ }
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationManager.java b/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationManager.java
index 7b9fa4842..ece757386 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationManager.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationManager.java
@@ -1,6 +1,19 @@
package tech.mcprison.prison.integration;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
+
+import tech.mcprison.prison.Prison;
+import tech.mcprison.prison.chat.FancyMessage;
+import tech.mcprison.prison.output.DisplayComponent;
+import tech.mcprison.prison.output.FancyMessageComponent;
+import tech.mcprison.prison.output.Output;
+import tech.mcprison.prison.output.TextComponent;
/**
* The IntegrationManager stores instances of each {@link Integration} and allows
@@ -12,12 +25,478 @@
public class IntegrationManager {
private Map> integrations;
+
+ private List deferredIntegrations;
public IntegrationManager() {
this.integrations = new HashMap<>();
+ this.deferredIntegrations = new ArrayList<>();
}
+ public static final String PRISON_PLACEHOLDER_PREFIX = "prison";
+ public static final String PRISON_PLACEHOLDER_PREFIX_EXTENDED = PRISON_PLACEHOLDER_PREFIX + "_";
+
+ public static final String PRISON_PLACEHOLDER_MINENAME_SUFFIX = "_minename";
+ public static final String PRISON_PLACEHOLDER_LADDERNAME_SUFFIX = "_laddername";
+
+ private PlaceholderProgressBarConfig progressBarConfig;
+
+ public enum PlaceHolderFlags {
+
+ PLAYER,
+ LADDERS,
+ MINES,
+ PLAYERMINES,
+
+ SUPRESS,
+ ALIAS
+ ;
+ }
+
/**
+ * The given place holders should have both the prison prefix and without,
+ * with the without having the suppress value set. The suppressable items
+ * will not always be displayed since it would be implied that the prefix
+ * would have been provided.
+ *
+ *
+ * Update: The placeholders without the prison prefix have been eliminated
+ * since the prefix is now prepended when it is missing prior to matching to a
+ * valid placeholder enum. This cuts the number of generated placeholders in half.
+ * This is significant since with the addition of the aliases there would be about
+ * 744 placeholders generated if the prison had 30 mines setup! Now a 30 mine prison
+ * would have about 372.
+ *
+ *
+ * Note: In order to use these placeholders with something like holographic display
+ * you need to also include the placeholderAPI,
+ * plugin holographic extension and protocolib.
+ *
+ *
+ * In order to get the holographics extension to work it is critical you read
+ * their spigot page since you have to specify a refresh speed.
+ *
+ *
+ * /hd addline temp2 Mine Size: {slowest}{prison_mines_blocks_size_temp2}
+ * or
+ * /hd addline temp2 Mine Size: {slowest}{prison_mines_blocks_size_temp2}
+ * /hd addline temp2 Mine Size: {slowest}%prison_mines_blocks_size_temp2%
+ *
+ *
+ * https://dev.bukkit.org/projects/holographic-displays
+ * https://www.spigotmc.org/resources/placeholderapi.6245/
+ * https://www.spigotmc.org/resources/protocollib.1997/
+ * https://www.spigotmc.org/resources/holographicextension.18461/
+ */
+ public enum PrisonPlaceHolders {
+
+ no_match__(PlaceHolderFlags.SUPRESS),
+
+ // Rank aliases:
+ prison_r(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+ prison_rt(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+ prison_rc(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+ prison_rcp(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+ prison_rcb(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+ prison_rcr(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+ prison_rr(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+ prison_rrt(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+
+
+ prison_rank(prison_r, PlaceHolderFlags.PLAYER),
+ prison_rank_tag(prison_rt, PlaceHolderFlags.PLAYER),
+ prison_rankup_cost(prison_rc, PlaceHolderFlags.PLAYER),
+ prison_rankup_cost_percent(prison_rcp, PlaceHolderFlags.PLAYER),
+ prison_rankup_cost_bar(prison_rcb, PlaceHolderFlags.PLAYER),
+ prison_rankup_cost_remaining(prison_rcr, PlaceHolderFlags.PLAYER),
+ prison_rankup_rank(prison_rr, PlaceHolderFlags.PLAYER),
+ prison_rankup_rank_tag(prison_rrt, PlaceHolderFlags.PLAYER),
+
+
+ // Ladder aliases:
+ prison_r_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+ prison_rt_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+ prison_rc_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+ prison_rcp_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+ prison_rcb_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+ prison_rcr_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+ prison_rr_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+ prison_rrt_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+
+
+ prison_rank_laddername(prison_r_laddername, PlaceHolderFlags.LADDERS),
+ prison_rank_tag_laddername(prison_rt_laddername, PlaceHolderFlags.LADDERS),
+ prison_rankup_cost_laddername(prison_rc_laddername, PlaceHolderFlags.LADDERS),
+ prison_rankup_cost_percent_laddername(prison_rcp_laddername, PlaceHolderFlags.LADDERS),
+ prison_rankup_cost_bar_laddername(prison_rcb_laddername, PlaceHolderFlags.LADDERS),
+ prison_rankup_cost_remaining_laddername(prison_rcr_laddername, PlaceHolderFlags.LADDERS),
+ prison_rankup_rank_laddername(prison_rr_laddername, PlaceHolderFlags.LADDERS),
+ prison_rankup_rank_tag_laddername(prison_rrt_laddername, PlaceHolderFlags.LADDERS),
+
+
+ // Mine aliases:
+ prison_mi_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mif_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mtl_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mtlb_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mtlf_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_ms_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mr_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mrb_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mp_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mpc_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mbm_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mrc_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+
+
+ // reset_interval, reset_timeleft, blocks_size, blocks_remaining, blocks_percent
+ // player_count
+ // NOTE: Remove PrisonPlaceHolderFlags.SUPRESS when ready to be used:
+ prison_mines_interval_minename(prison_mi_minename, PlaceHolderFlags.MINES),
+ prison_mines_interval_formatted_minename(prison_mif_minename, PlaceHolderFlags.MINES),
+ prison_mines_timeleft_minename(prison_mtl_minename, PlaceHolderFlags.MINES),
+ prison_mines_timeleft_bar_minename(prison_mtlb_minename, PlaceHolderFlags.MINES),
+ prison_mines_timeleft_formatted_minename(prison_mtlf_minename, PlaceHolderFlags.MINES),
+ prison_mines_size_minename(prison_ms_minename, PlaceHolderFlags.MINES),
+ prison_mines_remaining_minename(prison_mr_minename, PlaceHolderFlags.MINES),
+ prison_mines_remaining_bar_minename(prison_mrb_minename, PlaceHolderFlags.MINES),
+ prison_mines_percent_minename(prison_mp_minename, PlaceHolderFlags.MINES),
+ prison_mines_player_count_minename(prison_mpc_minename, PlaceHolderFlags.MINES),
+ prison_mines_blocks_mined_minename(prison_mbm_minename, PlaceHolderFlags.MINES),
+ prison_mines_reset_count_minename(prison_mrc_minename, PlaceHolderFlags.MINES),
+
+
+
+ // PlayerMine aliases:
+ prison_mi_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mif_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mtl_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mtlb_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mtlf_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_ms_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mr_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mrb_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mp_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mpc_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mbm_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mrc_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+
+
+ prison_mines_interval_playermines(prison_mi_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_interval_formatted_playermines(prison_mif_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_timeleft_playermines(prison_mtl_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_timeleft_bar_playermines(prison_mtlb_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_timeleft_formatted_playermines(prison_mtlf_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_size_playermines(prison_ms_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_remaining_playermines(prison_mr_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_remaining_bar_playermines(prison_mrb_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_percent_playermines(prison_mp_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_player_count_playermines(prison_mpc_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_blocks_mined_playermines(prison_mbm_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_reset_count_playermines(prison_mrc_pm, PlaceHolderFlags.PLAYERMINES),
+
+
+
+ ;
+
+
+ private final PrisonPlaceHolders alias;
+ private final List flags;
+ private PrisonPlaceHolders() {
+ this.flags = new ArrayList<>();
+ this.alias = null;
+ }
+ private PrisonPlaceHolders(PlaceHolderFlags... flags) {
+ this.alias = null;
+ this.flags = getFlags(flags);
+ }
+ private PrisonPlaceHolders(PrisonPlaceHolders alias, PlaceHolderFlags... flags) {
+ this.alias = alias;
+ this.flags = getFlags(flags);
+ }
+
+ private List getFlags( PlaceHolderFlags[] flags ) {
+ List flagz = new ArrayList<>();
+ if ( flags != null ) {
+ for ( PlaceHolderFlags flag : flags ) {
+ flagz.add( flag );
+ }
+ }
+ return flagz;
+ }
+
+ public PrisonPlaceHolders getAlias()
+ {
+ return alias;
+ }
+
+ public boolean hasAlias() {
+ return alias != null;
+ }
+ public boolean isAlias() {
+ return flags.contains( PlaceHolderFlags.ALIAS );
+ }
+ public boolean isSuppressed() {
+ return flags.contains( PlaceHolderFlags.SUPRESS );
+ }
+ public boolean hasFlag( PlaceHolderFlags flag ) {
+ return flags.contains( flag );
+ }
+ public List getFlags() {
+ return flags;
+ }
+
+ public static PrisonPlaceHolders fromString( String placeHolder ) {
+ PrisonPlaceHolders result = no_match__;
+
+ if ( placeHolder != null && placeHolder.trim().length() > 0 ) {
+ placeHolder = placeHolder.trim();
+
+ // This allows us to get rid of suppressed placeholders that were used for
+ // internal matching when placeholder APIs strip off the prefix:
+ if ( !placeHolder.toLowerCase().startsWith( PRISON_PLACEHOLDER_PREFIX ) ) {
+ placeHolder = PRISON_PLACEHOLDER_PREFIX + "_" + placeHolder;
+ }
+
+ for ( PrisonPlaceHolders ph : values() ) {
+ if ( ph.name().equalsIgnoreCase( placeHolder ) ) {
+ result = ph;
+ break;
+ }
+ }
+ }
+
+ return result;
+ }
+
+ public static List getTypes(PlaceHolderFlags flag) {
+ List results = new ArrayList<>();
+
+ if ( flag != null ) {
+ for ( PrisonPlaceHolders ph : values() ) {
+ if ( ph.getFlags().contains( flag )) {
+ results.add( ph );
+ }
+ }
+ }
+
+ return results;
+ }
+
+ public static List excludeTypes(
+ List list, PlaceHolderFlags flag) {
+ List results = new ArrayList<>();
+
+ if ( flag != null ) {
+ for ( PrisonPlaceHolders ph : list ) {
+ if ( !ph.getFlags().contains( flag )) {
+ results.add( ph );
+ }
+ }
+ }
+
+ return results;
+ }
+
+ public String getChatText() {
+ return "&a" + name() +
+ (hasAlias() ? "&7(&b" + getAlias().name() + "&7)" : "") +
+ (isSuppressed() ? "&4*&a ": " ");
+ }
+
+ public static String getAllChatTexts() {
+ return getAllChatTexts(false);
+ }
+
+ public static String getAllChatTextsOmitSuppressable() {
+ return getAllChatTexts(true);
+ }
+
+ private static List getAllChatList( boolean omitSuppressable) {
+ List results = new ArrayList<>();
+
+ boolean hasDeprecated = false;
+
+ for ( PrisonPlaceHolders ph : values() )
+ {
+ if ( !omitSuppressable || omitSuppressable && !ph.isSuppressed() && !ph.isAlias() ) {
+ if ( !hasDeprecated && ph.isSuppressed() ) {
+ hasDeprecated = true;
+ }
+
+ results.add( ph.getChatText() );
+ }
+ }
+
+ if ( hasDeprecated ) {
+ results.add( " &2(&4*&2=&4suppressed&2)" );
+ }
+
+ return results;
+ }
+
+ private static String getAllChatTexts( boolean omitSuppressable) {
+ StringBuilder sb = new StringBuilder();
+
+ List placeholders = getAllChatList(omitSuppressable);
+
+ for ( String placeholder : placeholders ) {
+ sb.append( placeholder );
+ }
+
+ return sb.toString();
+ }
+
+ }
+
+
+ public void reloadPlaceholderBarConfig() {
+ setProgressBarConfig( loadPlaceholderBarConfig() );
+ }
+
+ public PlaceholderProgressBarConfig loadPlaceholderBarConfig() {
+ PlaceholderProgressBarConfig config = null;
+
+ String barSegmentsStr = Prison.get().getPlatform().getConfigString(
+ "placeholder.bar-segments" );
+ String barPositiveColor = Prison.get().getPlatform().getConfigString(
+ "placeholder.bar-positive-color" );
+ String barPositiveSegment = Prison.get().getPlatform().getConfigString(
+ "placeholder.bar-positive-segment" );
+ String barNegativeColor = Prison.get().getPlatform().getConfigString(
+ "placeholder.bar-negative-color" );
+ String barNegativeSegment = Prison.get().getPlatform().getConfigString(
+ "placeholder.bar-negative-segment" );
+
+
+ // All 5 must not be null:
+ if ( barSegmentsStr != null && barPositiveColor != null && barPositiveSegment != null &&
+ barNegativeColor != null && barNegativeSegment != null ) {
+
+ int barSegments = 20;
+
+ try {
+ barSegments = Integer.parseInt( barSegmentsStr );
+ }
+ catch ( NumberFormatException e ) {
+ Output.get().logWarn(
+ "IntegrationManager.loadPlaceholderBarConfigs(): Failure to convert the" +
+ "/plugins/Prison/config.yml prison-placeholder-configs.progress-bar.bar-segments " +
+ "to a valid integer. Defaulting to a value of 20 " +
+ "[" + barSegmentsStr + "] " + e.getMessage() );
+
+ }
+
+ config = new PlaceholderProgressBarConfig( barSegments,
+ barPositiveColor, barPositiveSegment,
+ barNegativeColor, barNegativeSegment );
+ }
+
+ if ( config == null ) {
+ // go with default values because the config.yml is not up to date with
+ // the default values
+
+ config = new PlaceholderProgressBarConfig(
+ 20, "&2", "#", "&4", "="
+// 20, "&2", "▊", "&4", "▒"
+ );
+
+ Output.get().logInfo( "The /plugins/Prison/config.yml does not contain the " +
+ "default values for the Placeholder Progress Bar." );
+ Output.get().logInfo( "Default values are " +
+ "being used. To customize the bar, rename the config.yml and it will be " +
+ "regenerated and then edit to restore prior values.");
+
+ }
+
+ return config;
+ }
+
+ public PlaceholderProgressBarConfig getProgressBarConfig() {
+ if ( progressBarConfig == null ) {
+ progressBarConfig = loadPlaceholderBarConfig();
+ }
+ return progressBarConfig;
+ }
+ public void setProgressBarConfig( PlaceholderProgressBarConfig progressBarConfig ) {
+ this.progressBarConfig = progressBarConfig;
+ }
+
+ /**
+ * This function uses the settings within the config.yml to construct a progress
+ * bar. It takes two numeric values and constructs it upon those parameters.
+ * The parameter
value
is the value that changes, and is the value that
+ * sets where the bar changes. The parameter valueTotal
is the max value
+ * of where the value
is increasing to.
+ *
+ *
+ * The lowest range is always zero and
value
will be set to zero if
+ * it is negative. If value
is greater than valueTotal
+ * then it will be set to that value. The valid range for this function is only 0 percent
+ * to 100 percent.
+ *
+ *
+ * If the progress bar is moving in the wrong direction, then set the parameter
+ *
reverse
to true and then the value
will be inverted by subtracting
+ * its value from valueTotal
.
+ *
+ *
+ * @param value A value that is changing. Will be set to zero if negative. Will be
+ * set to valueTotal if greater than that amount.
+ * @param valueTotal The target value that is non-changing.
+ * @param reverse Changes the growth direction of the progress bar.
+ * @return
+ */
+ public String getProgressBar( double value, double valueTotal, boolean reverse ) {
+ StringBuilder sb = new StringBuilder();
+
+ // value cannot be greater than valueTotal:
+ if ( value > valueTotal ) {
+ value = valueTotal;
+ }
+ else if ( value < 0 ) {
+ value = 0;
+ }
+
+ // If reverse, then the new value is subtracted from valueTotal:
+ if ( reverse ) {
+ value = valueTotal - value;
+ }
+
+ double percent = value / valueTotal * 100.0;
+
+ PlaceholderProgressBarConfig barConfig =
+ Prison.get().getIntegrationManager().getProgressBarConfig();
+
+ String lastColorCode = null;
+ for ( int i = 0; i < barConfig.getSegments(); i++ ) {
+ double pct = i / ((double)barConfig.getSegments()) * 100.0;
+
+ if ( pct < percent ) {
+ if ( lastColorCode == null ||
+ !barConfig.getPositiveColor().equalsIgnoreCase( lastColorCode )) {
+ sb.append( barConfig.getPositiveColor() );
+ lastColorCode = barConfig.getPositiveColor();
+ }
+ sb.append( barConfig.getPositiveSegment() );
+ }
+ else {
+ if ( lastColorCode == null ||
+ !barConfig.getNegativeColor().equalsIgnoreCase( lastColorCode )) {
+ sb.append( barConfig.getNegativeColor() );
+ lastColorCode = barConfig.getNegativeColor();
+ }
+ sb.append( barConfig.getNegativeSegment() );
+
+ }
+ }
+
+
+ return sb.toString();
+ }
+
+
+ /**
* Returns a list of all of the {@link Integration}s that are registered under a certain {@link IntegrationType}, if any.
* This includes integrations that have not successfully integrated.
* If there are none, an empty list will be returned.
@@ -58,9 +537,181 @@ public boolean hasForType(IntegrationType type) {
* @param i The {@link Integration}.
*/
public void register(Integration i) {
- List integrationList = integrations.getOrDefault(i.getType(), new ArrayList<>());
- integrationList.add(i);
- integrations.put(i.getType(), integrationList);
+ IntegrationType iType = i.getType();
+ if ( !integrations.containsKey( iType ) ) {
+ integrations.put(iType, new ArrayList<>());
+ }
+ integrations.get(iType).add(i);
+ }
+
+ public EconomyCurrencyIntegration getEconomyForCurrency(String currency) {
+ EconomyCurrencyIntegration results = null;
+
+ if(integrations.containsKey(IntegrationType.ECONOMY)) {
+
+ List econs = getAllForType(IntegrationType.ECONOMY);
+
+ for ( Integration econ : econs ) {
+ if ( econ.hasIntegrated() && econ instanceof EconomyCurrencyIntegration ) {
+
+ EconomyCurrencyIntegration currencyEcon = (EconomyCurrencyIntegration) econ;
+
+ if ( currencyEcon.hasCurrency( currency )) {
+ results = currencyEcon;
+ break;
+ }
+ }
+ }
+
+ }
+ return results;
+ }
+
+ public String getIntegrationDetails( IntegrationType intType ) {
+ StringBuilder sb = new StringBuilder();
+ Set keys = integrations.keySet();
+
+ for ( IntegrationType key : keys ) {
+ if ( key == intType ) {
+ sb.append( key.name() );
+ sb.append( ": [" );
+
+ StringBuilder sb2 = new StringBuilder();
+ List integrates = integrations.get( key );
+ for ( Integration i : integrates ) {
+ if ( sb2.length() > 0 ) {
+ sb2.append( ", " );
+ }
+ sb2.append( i.getDisplayName() );
+ sb2.append( " (registered=" );
+ sb2.append( i.isRegistered() );
+ sb2.append( ", integrated=" );
+ sb2.append( i.hasIntegrated() );
+ sb2.append( ")" );
+ if ( i.getDebugInfo() != null && i.getDebugInfo().trim().length() > 0 ) {
+ sb2.append( " Debug: {" );
+ sb2.append( i.getDebugInfo() );
+ sb2.append( "}" );
+ }
+ }
+
+ sb.append( sb2 );
+ sb.append( "] " );
+ }
+ }
+ return sb.toString();
+ }
+
+ /**
+ * This function formats all the Integrations, both active and inactive, to be displayed
+ * to a user, or sent to the server logs. This function returns a List to provide a
+ * degree of flexibility in where it is being used, without this container
+ * (The integration manager) having to know where the data will be used. This function
+ * keeps the business logic of relationship of integrations to Integration Types
+ * internal so as to no leak that knowledge out of this function.
+ *
+ *
+ * @return
+ */
+ public List getIntegrationComponents() {
+ List results = new ArrayList<>();
+
+ for ( IntegrationType integType : IntegrationType.values() )
+ {
+ results.add( new TextComponent( String.format( "&7Integration Type: &3%s", integType.name() ) ));
+
+ // Generates the placeholder list for the /prison version command, printing
+ // two placeholders per line.
+ if ( integType == IntegrationType.PLACEHOLDER ) {
+ getPlaceholderTemplateList( results );
+ }
+
+ List plugins = getAllForType( integType );
+
+ if ( plugins == null || plugins.size() == 0 ) {
+ results.add( new TextComponent( " &e&onone" ));
+ } else {
+ for ( Integration plugin : plugins ) {
+ String pluginUrl = plugin.getPluginSourceURL();
+ String msg = String.format( " &a%s &7<%s&7> %s", plugin.getDisplayName(),
+ ( plugin.hasIntegrated() ? "&aActive" : "&cInactive"),
+ ( pluginUrl == null ? "" : "&7[&eURL&7]"));
+ FancyMessage fancy = new FancyMessage( msg );
+ if ( pluginUrl != null ) {
+ fancy.command( pluginUrl ).tooltip( "Click to open URL for this plugin.", pluginUrl );
+ }
+ results.add( new FancyMessageComponent(fancy) );
+
+ String altInfo = plugin.getAlternativeInformation();
+ if ( altInfo != null ) {
+ results.add( new TextComponent( " " + altInfo ));
+ }
+
+ if ( integType == IntegrationType.ECONOMY &&
+ plugin instanceof EconomyCurrencyIntegration ) {
+ EconomyCurrencyIntegration econ = (EconomyCurrencyIntegration) plugin;
+
+ StringBuilder sb = new StringBuilder();
+
+ for ( String currency : econ.getSupportedCurrencies().keySet() ) {
+ Boolean supported = econ.getSupportedCurrencies().get( currency );
+ if ( supported.booleanValue() ) {
+ if ( sb.length() > 0 ) {
+ sb.append( " " );
+ }
+ sb.append( currency );
+ }
+ }
+
+ if ( sb.length() > 0 ) {
+ results.add( new TextComponent( " &3Currencies: &7" + sb.toString() ));
+ }
+ }
+ }
+ }
+ }
+
+ return results;
}
+ public void getPlaceholderTemplateList( List results )
+ {
+ results.add( new TextComponent( " &7Available PlaceHolders: " ));
+
+ List placeholders = PrisonPlaceHolders.getAllChatList(true);
+ StringBuilder sb = new StringBuilder();
+ for ( String placeholder : placeholders ) {
+ if ( sb.length() == 0) {
+ sb.append( " " );
+ sb.append( placeholder );
+ }
+ else if ( (sb.length() + placeholder.length()) > 90) {
+ // will be too long combined so write existing sb then start over:
+ results.add( new TextComponent( sb.toString() ));
+ sb.setLength( 0 );
+
+ sb.append( " " );
+ sb.append( placeholder );
+ } else {
+ sb.append( placeholder );
+ results.add( new TextComponent( sb.toString() ));
+ sb.setLength( 0 );
+ }
+ }
+ if ( sb.length() > 0 ) {
+ results.add( new TextComponent( sb.toString() ));
+ }
+ }
+
+ public List getDeferredIntegrations() {
+ return deferredIntegrations;
+ }
+ public void setDeferredIntegrations( List deferredIntegrations ) {
+ this.deferredIntegrations = deferredIntegrations;
+ }
+
+ public void addDeferredInitialization( Integration defferedIntegration ) {
+ getDeferredIntegrations().add( defferedIntegration );
+ }
+
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationType.java b/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationType.java
index 811ff1f29..8a8f27001 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationType.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/integration/IntegrationType.java
@@ -5,6 +5,6 @@
*/
public enum IntegrationType {
- ECONOMY, PERMISSION, PLACEHOLDER
+ ECONOMY, PERMISSION, PLACEHOLDER, WORLDGUARD
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/integration/ManagerPlaceholders.java b/prison-core/src/main/java/tech/mcprison/prison/integration/ManagerPlaceholders.java
new file mode 100644
index 000000000..9af2b340d
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/integration/ManagerPlaceholders.java
@@ -0,0 +1,10 @@
+package tech.mcprison.prison.integration;
+
+import java.util.List;
+
+public interface ManagerPlaceholders {
+
+ public List getTranslatedPlaceHolderKeys();
+
+ public void reloadPlaceholders();
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/integration/PermissionIntegration.java b/prison-core/src/main/java/tech/mcprison/prison/integration/PermissionIntegration.java
index 161efb2ac..f62740e1e 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/integration/PermissionIntegration.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/integration/PermissionIntegration.java
@@ -1,7 +1,6 @@
package tech.mcprison.prison.integration;
import tech.mcprison.prison.internal.Player;
-import tech.mcprison.prison.internal.platform.Platform;
/**
* An {@link Integration} for a permissions plugin.
@@ -9,15 +8,21 @@
* @author Faizaan A. Datoo
* @since API 1.0
*/
-public interface PermissionIntegration extends Integration {
+public abstract class PermissionIntegration
+ extends IntegrationCore {
+ public PermissionIntegration( String keyName, String providerName ) {
+ super( keyName, providerName, IntegrationType.PERMISSION );
+
+ }
+
/**
* Adds a permission to this player.
*
* @param holder The player that will receive this permission.
* @param permission The permission to add.
*/
- void addPermission(Player holder, String permission);
+ public abstract void addPermission(Player holder, String permission);
/**
* Removes a permission from this player.
@@ -25,10 +30,6 @@ public interface PermissionIntegration extends Integration {
* @param holder The player that will have this permission revoked.
* @param permission The permission to remove.
*/
- void removePermission(Player holder, String permission);
-
- @Override default IntegrationType getType() {
- return IntegrationType.PERMISSION;
- }
+ public abstract void removePermission(Player holder, String permission);
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/integration/PlaceHolderKey.java b/prison-core/src/main/java/tech/mcprison/prison/integration/PlaceHolderKey.java
new file mode 100644
index 000000000..d7f509358
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/integration/PlaceHolderKey.java
@@ -0,0 +1,64 @@
+package tech.mcprison.prison.integration;
+
+import tech.mcprison.prison.integration.IntegrationManager.PrisonPlaceHolders;
+
+public class PlaceHolderKey {
+
+ private String key;
+ private PrisonPlaceHolders placeholder;
+ private String data;
+ private boolean primary = true;
+ private String aliasName;
+
+ public PlaceHolderKey( String key, PrisonPlaceHolders placeholder ) {
+ this(key, placeholder, true);
+ }
+ public PlaceHolderKey( String key, PrisonPlaceHolders placeholder, boolean primary ) {
+ this.key = key;
+ this.placeholder = placeholder;
+ this.primary = primary;
+ }
+ public PlaceHolderKey( String key, PrisonPlaceHolders placeholder, String data ) {
+ this(key, placeholder);
+ this.data = data;
+ }
+ public PlaceHolderKey( String key, PrisonPlaceHolders placeholder, String data, boolean primary ) {
+ this(key, placeholder, primary);
+ this.data = data;
+ }
+
+ public String getKey() {
+ return key;
+ }
+ public void setKey( String key ) {
+ this.key = key;
+ }
+
+ public PrisonPlaceHolders getPlaceholder() {
+ return placeholder;
+ }
+ public void setPlaceholder( PrisonPlaceHolders placeholder ) {
+ this.placeholder = placeholder;
+ }
+
+ public String getData() {
+ return data;
+ }
+ public void setData( String data ) {
+ this.data = data;
+ }
+
+ public boolean isPrimary() {
+ return primary;
+ }
+ public void setPrimary( boolean primary ) {
+ this.primary = primary;
+ }
+
+ public String getAliasName() {
+ return aliasName;
+ }
+ public void setAliasName( String aliasName ) {
+ this.aliasName = aliasName;
+ }
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/integration/PlaceholderIntegration.java b/prison-core/src/main/java/tech/mcprison/prison/integration/PlaceholderIntegration.java
index 83644765d..e36cfa22b 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/integration/PlaceholderIntegration.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/integration/PlaceholderIntegration.java
@@ -1,19 +1,20 @@
package tech.mcprison.prison.integration;
-import tech.mcprison.prison.internal.Player;
-
import java.util.function.Function;
+import tech.mcprison.prison.internal.Player;
+
/**
* An integration into a placeholder plugin.
*/
-public interface PlaceholderIntegration extends Integration {
-
- void registerPlaceholder(String placeholder, Function action);
+public abstract class PlaceholderIntegration
+ extends IntegrationCore {
- @Override
- default IntegrationType getType() {
- return IntegrationType.PLACEHOLDER;
- }
+ public PlaceholderIntegration( String keyName, String providerName ) {
+ super( keyName, providerName, IntegrationType.PLACEHOLDER );
+
+ }
+
+ public abstract void registerPlaceholder(String placeholder, Function action);
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/integration/PlaceholderProgressBarConfig.java b/prison-core/src/main/java/tech/mcprison/prison/integration/PlaceholderProgressBarConfig.java
new file mode 100644
index 000000000..b6d12bc0d
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/integration/PlaceholderProgressBarConfig.java
@@ -0,0 +1,70 @@
+package tech.mcprison.prison.integration;
+
+public class PlaceholderProgressBarConfig {
+
+ private int segments = 20;
+
+ private String positiveColor;
+ private String positiveSegment;
+
+ private String negativeColor;
+ private String negativeSegment;
+
+ public PlaceholderProgressBarConfig() {
+ super();
+
+
+ }
+
+ public PlaceholderProgressBarConfig( int segments,
+ String positiveColor, String positiveSegment,
+ String negativeColor, String negativeSegment ) {
+ super();
+
+ this.segments = segments;
+
+ this.positiveColor = positiveColor;
+ this.positiveSegment = positiveSegment;
+
+ this.negativeColor = negativeColor;
+ this.negativeSegment = negativeSegment;
+ }
+
+ public int getSegments(){
+ return segments;
+ }
+ public void setSegments( int segments ) {
+ this.segments = segments;
+ }
+
+ public String getPositiveColor() {
+ return positiveColor;
+ }
+ public void setPositiveColor( String positiveColor ) {
+ this.positiveColor = positiveColor;
+ }
+
+ public String getPositiveSegment() {
+ return positiveSegment;
+ }
+ public void setPositiveSegment( String positiveSegment ) {
+ this.positiveSegment = positiveSegment;
+ }
+
+ public String getNegativeColor() {
+ return negativeColor;
+ }
+ public void setNegativeColor( String negativeColor ) {
+ this.negativeColor = negativeColor;
+ }
+
+ public String getNegativeSegment() {
+ return negativeSegment;
+ }
+ public void setNegativeSegment( String negativeSegment ) {
+ this.negativeSegment = negativeSegment;
+ }
+
+
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/integration/Placeholders.java b/prison-core/src/main/java/tech/mcprison/prison/integration/Placeholders.java
new file mode 100644
index 000000000..6a417ebb5
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/integration/Placeholders.java
@@ -0,0 +1,37 @@
+package tech.mcprison.prison.integration;
+
+import java.util.List;
+import java.util.Map;
+import java.util.UUID;
+
+import tech.mcprison.prison.integration.IntegrationManager.PlaceHolderFlags;
+
+public interface Placeholders {
+
+ public Map getPlaceholderDetailCounts();
+
+
+ public int getPlaceholderCount();
+
+
+ public int getPlaceholderRegistrationCount();
+
+
+ public String placeholderTranslate(UUID playerUuid, String playerName, String identifier);
+
+
+ public String placeholderTranslateText( String text);
+
+
+ public String placeholderTranslateText( UUID playerUuid, String playerName, String text);
+
+
+ public List placeholderSearch( UUID playerUuid, String playerName, String[] patterns );
+
+
+ public void reloadPlaceholders();
+
+
+ public void printPlaceholderStats();
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/integration/WorldGuardIntegration.java b/prison-core/src/main/java/tech/mcprison/prison/integration/WorldGuardIntegration.java
new file mode 100644
index 000000000..a04e74787
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/integration/WorldGuardIntegration.java
@@ -0,0 +1,48 @@
+package tech.mcprison.prison.integration;
+
+/**
+ * WorldGuard Integration is needed because there are two major versions of
+ * WorldGuard and WorldEdit that needs to be supported. This is required due
+ * to the wide range of spigot versions that are supported.
+ *
+ *
+ * The two different versions WorldGuard, and WorldEdit, may have different
+ * command sets and parameters, not to mention different class names and
+ * possibly different package names too. So these integrations are to
+ * provide a common interface in to any platform, and any version. Hopefully! lol
+ *
+ *
+ * Version 6.x is for minecraft versions 1.12.2 and below.
+ *
+ * Version 7.x is for minecraft versions 1.13.0 and up.
+ *
+ *
+ * It is stated that minecraft implementations for spigot have significant
+ * changes from one version to the next, so one version of WorldEdit and
+ * WorldGuard may not support any of the older versions. Due to these restrictions
+ * and warnings, carefully make sure you download the version of WorldGuard and
+ * WorldEdit that matches the server you are running. All v6.x are not the same, nor
+ * are all v7.x the same. The best we can do is to make sure you are using the
+ * correct major version for the version of minecraft that you are running on
+ * your server; the correct minor version is on you to get correct.
+ *
+ *
+ */
+public class WorldGuardIntegration
+ extends IntegrationCore {
+
+ private boolean integrated = false;
+
+ public WorldGuardIntegration( String keyName, String providerName ) {
+ super( keyName, providerName, IntegrationType.WORLDGUARD );
+ }
+
+ public boolean isIntegrated() {
+ return integrated;
+ }
+ public void setIntegrated( boolean integrated ) {
+ this.integrated = integrated;
+ }
+
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/CommandSender.java b/prison-core/src/main/java/tech/mcprison/prison/internal/CommandSender.java
index 8e88a7142..4f4b3af36 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/CommandSender.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/CommandSender.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -73,5 +73,8 @@ public interface CommandSender {
* @param json The JSON message. Must be in proper format.
*/
void sendRaw(String json);
+
+
+ public boolean isOp();
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/ItemStack.java b/prison-core/src/main/java/tech/mcprison/prison/internal/ItemStack.java
index 22e33680c..a4c5d9ee5 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/ItemStack.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/ItemStack.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/OfflineMcPlayer.java b/prison-core/src/main/java/tech/mcprison/prison/internal/OfflineMcPlayer.java
new file mode 100644
index 000000000..6f99e3da0
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/OfflineMcPlayer.java
@@ -0,0 +1,29 @@
+package tech.mcprison.prison.internal;
+
+import java.util.UUID;
+
+public interface OfflineMcPlayer
+ extends Player {
+ /**
+ * Returns the unique identifier for this player.
+ */
+ UUID getUUID();
+
+ /**
+ * Returns the player's display name (nickname), which may include colors.
+ */
+ String getDisplayName();
+
+ /**
+ * Sets the player's display name (nickname).
+ *
+ * @param newDisplayName The new display name. May include colors, amp-prefixed.
+ */
+ void setDisplayName(String newDisplayName);
+
+ /**
+ * @return Returns true if the player is online, false otherwise.
+ */
+ boolean isOnline();
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/Player.java b/prison-core/src/main/java/tech/mcprison/prison/internal/Player.java
index c359145be..75a3afcf6 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/Player.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/Player.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/Scheduler.java b/prison-core/src/main/java/tech/mcprison/prison/internal/Scheduler.java
index 5bffb46fe..7eea4e1c3 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/Scheduler.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/Scheduler.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/World.java b/prison-core/src/main/java/tech/mcprison/prison/internal/World.java
index 74ab75a12..9921126e7 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/World.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/World.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -18,11 +18,11 @@
package tech.mcprison.prison.internal;
+import java.util.List;
+
import tech.mcprison.prison.internal.block.Block;
import tech.mcprison.prison.util.Location;
-import java.util.List;
-
/**
* Represents a world on the Minecraft server.
*
@@ -36,7 +36,7 @@ public interface World {
*/
String getName();
- /**
+ /**O
* Returns a list of all the players in this world.
*/
List getPlayers();
@@ -46,6 +46,6 @@ public interface World {
*
* @param location The {@link Location} of the block.
*/
- Block getBlockAt(Location location);
+ public Block getBlockAt(Location location);
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/block/Block.java b/prison-core/src/main/java/tech/mcprison/prison/internal/block/Block.java
index 143fb9390..92c3793a4 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/block/Block.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/block/Block.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -53,6 +53,10 @@ public interface Block {
* @return The {@link BlockType}.
*/
BlockType getType();
+
+
+ public PrisonBlock getPrisonBlock();
+
/**
* Sets the block to a different type.
@@ -60,7 +64,11 @@ public interface Block {
* @param type The new {@link BlockType}.
*/
void setType(BlockType type);
+
+
+ public void setPrisonBlock( PrisonBlock prisonBlock );
+
/**
* Returns a snapshot of the state of this block, which you can edit to your liking.
*
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/block/BlockFace.java b/prison-core/src/main/java/tech/mcprison/prison/internal/block/BlockFace.java
index cc3123d8d..d3d38f4a6 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/block/BlockFace.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/block/BlockFace.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/block/BlockState.java b/prison-core/src/main/java/tech/mcprison/prison/internal/block/BlockState.java
index 1cb97310c..01d8c788b 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/block/BlockState.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/block/BlockState.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/block/BrewingStand.java b/prison-core/src/main/java/tech/mcprison/prison/internal/block/BrewingStand.java
index 67d9d8300..c7283a78c 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/block/BrewingStand.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/block/BrewingStand.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/block/Door.java b/prison-core/src/main/java/tech/mcprison/prison/internal/block/Door.java
index 275aad40a..d7f1a681d 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/block/Door.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/block/Door.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/block/DoubleChest.java b/prison-core/src/main/java/tech/mcprison/prison/internal/block/DoubleChest.java
index 212534fe4..6e1f1b387 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/block/DoubleChest.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/block/DoubleChest.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/block/Lever.java b/prison-core/src/main/java/tech/mcprison/prison/internal/block/Lever.java
index 408e915ed..76ee39d67 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/block/Lever.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/block/Lever.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/block/PrisonBlock.java b/prison-core/src/main/java/tech/mcprison/prison/internal/block/PrisonBlock.java
new file mode 100644
index 000000000..c3e6cda54
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/block/PrisonBlock.java
@@ -0,0 +1,83 @@
+package tech.mcprison.prison.internal.block;
+
+/**
+ * This class embodies the nature of the block and different behaviors, if
+ * they exist.
+ *
+ *
+ */
+public class PrisonBlock {
+ private String blockName;
+
+ private double chance;
+
+ private boolean valid = true;
+ private boolean mineable = true;
+
+ private boolean legacyBlock = false;
+
+ public PrisonBlock( String blockName ) {
+ this( blockName, 0);
+ }
+
+ public PrisonBlock( String blockName, double chance ) {
+ super();
+
+ this.blockName = blockName;
+ this.chance = chance;
+ }
+
+ public String getBlockName() {
+ return blockName;
+ }
+ public void setBlockName( String blockName ) {
+ this.blockName = blockName;
+ }
+
+ public double getChance() {
+ return chance;
+ }
+ public void setChance( double chance ) {
+ this.chance = chance;
+ }
+
+ public boolean isValid() {
+ return valid;
+ }
+ public void setValid( boolean valid ) {
+ this.valid = valid;
+ }
+
+ public boolean isMineable() {
+ return mineable;
+ }
+ public void setMineable( boolean mineable ){
+ this.mineable = mineable;
+ }
+
+ /**
+ * This value isLegacyBlock indicates that there was not a direct match
+ * with the stored (saved) name of the block, and list of valid block types
+ * for the server. In order to find a successful match, had to use the
+ * obsolete BlockType to make a connection to the valid block types.
+ *
+ *
+ * If this value is set to true, it only has a purpose during the loading
+ * of the mine when the server is starting up. If it is set to true, then it
+ * indicates that the block name that was saved to disk is not directly translatable
+ * to a valid block type, and therefore once the mine is loaded, if any of the
+ * blocks have this set, then the mine must be saved to store the
+ * correct block name. The next time it is loaded, it will not have to
+ * fall back to the legacy BlockType for a conversion.
+ *
+ *
+ * @return
+ */
+ public boolean isLegacyBlock() {
+ return legacyBlock;
+ }
+ public void setLegacyBlock( boolean legacyBlock ) {
+ this.legacyBlock = legacyBlock;
+ }
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/block/PrisonBlockTypes.java b/prison-core/src/main/java/tech/mcprison/prison/internal/block/PrisonBlockTypes.java
new file mode 100644
index 000000000..3bcf90bbf
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/block/PrisonBlockTypes.java
@@ -0,0 +1,56 @@
+package tech.mcprison.prison.internal.block;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import tech.mcprison.prison.Prison;
+
+/**
+ * This class is a new way of dealing with blocks within prison.
+ * All blocks will be stored and used as string values.
+ *
+ *
+ */
+public class PrisonBlockTypes {
+
+ private List blockTypes;
+
+ public enum InternalBlockTypes {
+ IGNORE,
+ NULL_BLOCK
+ }
+
+ public PrisonBlockTypes() {
+ super();
+
+ this.blockTypes = new ArrayList<>();
+
+
+ }
+
+ public void loadServerBlockTypes() {
+
+ // First clear the blockTypes:
+ getBlockTypes().clear();
+
+ // Add in the internal block types and mark them as not mineable.
+ for ( InternalBlockTypes iBlockType : InternalBlockTypes.values() ) {
+ PrisonBlock block = new PrisonBlock( iBlockType.name() );
+ block.setMineable( false );
+
+ getBlockTypes().add( block );
+ }
+
+ // Next using the server's platform, load all of the available blockTypes.
+ Prison.get().getPlatform().getAllPlatformBlockTypes( getBlockTypes() );
+
+ }
+
+ public List getBlockTypes() {
+ return blockTypes;
+ }
+ public void setBlockTypes( List blockTypes ) {
+ this.blockTypes = blockTypes;
+ }
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/Cancelable.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/Cancelable.java
index f3f164c18..3de1605e4 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/Cancelable.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/Cancelable.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/block/BlockBreakEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/block/BlockBreakEvent.java
index 58f7d4e13..149c4bcaa 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/block/BlockBreakEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/block/BlockBreakEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/block/BlockPlaceEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/block/BlockPlaceEvent.java
index 64908271e..488454272 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/block/BlockPlaceEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/block/BlockPlaceEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/BrewEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/BrewEvent.java
index 221366150..7aab8134f 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/BrewEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/BrewEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/CraftItemEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/CraftItemEvent.java
index 4a226bdd1..b0b2a3504 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/CraftItemEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/CraftItemEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/FurnaceBurnEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/FurnaceBurnEvent.java
index 976b2afce..6b33c8231 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/FurnaceBurnEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/FurnaceBurnEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/FurnaceExtractEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/FurnaceExtractEvent.java
index eda9f3bba..fd5a7effd 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/FurnaceExtractEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/FurnaceExtractEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/FurnaceSmeltEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/FurnaceSmeltEvent.java
index 6cbbaf639..999875c01 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/FurnaceSmeltEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/FurnaceSmeltEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryClickEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryClickEvent.java
index b126b4692..066e05fc7 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryClickEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryClickEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryCloseEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryCloseEvent.java
index 3bebc8667..23dfc5ba2 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryCloseEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryCloseEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryCreativeEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryCreativeEvent.java
index 2992e624d..ec2873ab7 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryCreativeEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryCreativeEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryDragEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryDragEvent.java
index 997ead5d8..d18902205 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryDragEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryDragEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryEvent.java
index 294de8aa3..8f1b685c5 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryInteractEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryInteractEvent.java
index aa561a945..fbabf137b 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryInteractEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryInteractEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryMoveItemEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryMoveItemEvent.java
index 166e4d66f..3682e7f13 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryMoveItemEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryMoveItemEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryOpenEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryOpenEvent.java
index 205d50305..bcedbd3b6 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryOpenEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/InventoryOpenEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/PrepareAnvilEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/PrepareAnvilEvent.java
index daa97a7a7..055cfa904 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/PrepareAnvilEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/PrepareAnvilEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/PrepareItemCraftEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/PrepareItemCraftEvent.java
index 315a825e1..008830e64 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/PrepareItemCraftEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/inventory/PrepareItemCraftEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerChatEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerChatEvent.java
index e864150a9..571559337 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerChatEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerChatEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerDropItemEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerDropItemEvent.java
index 76f468fc7..92146fef0 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerDropItemEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerDropItemEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerInteractEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerInteractEvent.java
index 42bc9daf4..0f34ec64f 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerInteractEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerInteractEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerJoinEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerJoinEvent.java
index 0c5a10d17..b3df23d64 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerJoinEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerJoinEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerKickEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerKickEvent.java
index 5e28acced..a41183f0d 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerKickEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerKickEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerPickUpItemEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerPickUpItemEvent.java
index c33059107..3d54073d6 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerPickUpItemEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerPickUpItemEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerQuitEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerQuitEvent.java
index 30227151c..13d12d74d 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerQuitEvent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/player/PlayerQuitEvent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/events/world/PrisonWorldLoadEvent.java b/prison-core/src/main/java/tech/mcprison/prison/internal/events/world/PrisonWorldLoadEvent.java
new file mode 100644
index 000000000..99c01bd09
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/events/world/PrisonWorldLoadEvent.java
@@ -0,0 +1,33 @@
+package tech.mcprison.prison.internal.events.world;
+
+/**
+ * This event monitors the loading of worlds. During the loading of mines, not
+ * all worlds may be loaded yet, so we need to monitor when they come online
+ * so we can hook them up to the mines.
+ *
+ *
+ * At this point in time, all we need to know is the world name when it loads.
+ * All other uses of the world can go through the standard procedures since
+ * it will then be fully loaded. The key is knowing when the world is avialble
+ * for use.
+ *
+ *
+ */
+public class PrisonWorldLoadEvent {
+
+ private String worldName;
+
+ public PrisonWorldLoadEvent(String worldName) {
+ super();
+
+ this.worldName = worldName;
+ }
+
+ public String getWorldName() {
+ return worldName;
+ }
+ public void setWorldName( String worldName ) {
+ this.worldName = worldName;
+ }
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/AnvilInventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/AnvilInventory.java
index 297491411..8610602c5 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/AnvilInventory.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/AnvilInventory.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BeaconInventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BeaconInventory.java
index 07e86ed21..5367e2be2 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BeaconInventory.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BeaconInventory.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BrewerInventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BrewerInventory.java
index 1ad58b063..9d601a0d4 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BrewerInventory.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BrewerInventory.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/CraftingInventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/CraftingInventory.java
index 9012f4ebb..3cb8b8cc2 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/CraftingInventory.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/CraftingInventory.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/DoubleChestInventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/DoubleChestInventory.java
index 51ebfaa8b..33478166d 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/DoubleChestInventory.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/DoubleChestInventory.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/EnchantingInventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/EnchantingInventory.java
index 0d69cd9ec..8cc72e4eb 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/EnchantingInventory.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/EnchantingInventory.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/FurnaceRecipe.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/FurnaceRecipe.java
index 5402875d5..d38fd8adb 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/FurnaceRecipe.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/FurnaceRecipe.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Inventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Inventory.java
index 9d9003806..1aa117814 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Inventory.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Inventory.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryHolder.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryHolder.java
index 41b3f572b..16e40a61a 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryHolder.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryHolder.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryType.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryType.java
index 48dcbb6c1..d1bc54828 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryType.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryType.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/PlayerInventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/PlayerInventory.java
index ec97c31a1..723b4b11d 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/PlayerInventory.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/PlayerInventory.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Recipe.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Recipe.java
index e894aeab5..734c550ce 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Recipe.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Recipe.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapedRecipe.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapedRecipe.java
index 045471a71..73cee8c90 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapedRecipe.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapedRecipe.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapelessRecipe.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapelessRecipe.java
index 147daf2af..883aed4f2 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapelessRecipe.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapelessRecipe.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Viewable.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Viewable.java
index 958df5498..759268132 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Viewable.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Viewable.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/internal/package-info.java
index bcddaa1a7..479705078 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/package-info.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/package-info.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Capability.java b/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Capability.java
index bd8c6013e..bbf871610 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Capability.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Capability.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/platform/IncapableException.java b/prison-core/src/main/java/tech/mcprison/prison/internal/platform/IncapableException.java
index e7d04b9df..c29b09285 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/platform/IncapableException.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/platform/IncapableException.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -25,8 +25,9 @@
* @since API 1.0
*/
public class IncapableException extends RuntimeException {
-
- private Capability capability;
+ private static final long serialVersionUID = 1L;
+
+ private Capability capability;
public IncapableException(Capability capability) {
this.capability = capability;
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Platform.java b/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Platform.java
index f4a60b486..4a4b8f4b7 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Platform.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Platform.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -18,21 +18,26 @@
package tech.mcprison.prison.internal.platform;
+import java.io.File;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.UUID;
+
import tech.mcprison.prison.commands.PluginCommand;
+import tech.mcprison.prison.file.YamlFileIO;
import tech.mcprison.prison.gui.GUI;
+import tech.mcprison.prison.integration.Placeholders;
+import tech.mcprison.prison.internal.CommandSender;
import tech.mcprison.prison.internal.Player;
import tech.mcprison.prison.internal.Scheduler;
import tech.mcprison.prison.internal.World;
+import tech.mcprison.prison.internal.block.PrisonBlock;
import tech.mcprison.prison.internal.scoreboard.ScoreboardManager;
+import tech.mcprison.prison.output.ChatDisplay;
import tech.mcprison.prison.store.Storage;
import tech.mcprison.prison.util.Location;
-import java.io.File;
-import java.util.List;
-import java.util.Map;
-import java.util.Optional;
-import java.util.UUID;
-
/**
* Represents an internal platform that Prison has been implemented for.
* The internal platform is responsible for connecting Prison's APIs to the underlying server API.
@@ -48,6 +53,18 @@ public interface Platform {
*/
Optional getWorld(String name);
+
+ /**
+ * This function allows the PrisonCommand to get a list of any possible world
+ * load failures.
+ *
+ *
+ * @param display
+ * @return
+ */
+ public void getWorldLoadErrors( ChatDisplay display );
+
+
/**
* Returns the player with the specified name.
*/
@@ -63,6 +80,12 @@ public interface Platform {
*/
List getOnlinePlayers();
+// NOTE: Disabling for now. There is an internal failure within the Prison code base when trying
+// to use this, so will revisit in the future.
+ public Optional getOfflinePlayer(String name);
+
+ public Optional getOfflinePlayer(UUID uuid);
+
/**
* Returns the plugin's version.
*/
@@ -101,6 +124,14 @@ public interface Platform {
*/
void dispatchCommand(String cmd);
+ /**
+ * Runs a command as the sender and with only the sender's privileges.
+ *
+ * @param sender
+ * @param cmd
+ */
+ public void dispatchCommand(CommandSender sender, String cmd);
+
/**
* Returns the {@link Scheduler}, which can be used to schedule tasks.
*/
@@ -203,4 +234,37 @@ default Optional getCommand(String label) {
* This is a configuration option.kkjksdf;erljnkx.jcsmka.f.fdlwe;s.x. frrer5
*/
boolean shouldShowAlerts();
+
+
+
+ public void identifyRegisteredPlugins();
+
+
+
+ public Placeholders getPlaceholders();
+
+
+
+ public YamlFileIO getYamlFileIO( File yamlFile );
+
+
+ public void reloadConfig();
+
+
+ public String getConfigString( String key );
+
+
+ public boolean getConfigBooleanFalse( String key );
+
+
+ public boolean getConfigBooleanTrue( String key );
+
+
+ public void getAllPlatformBlockTypes( List blockTypes );
+
+
+ public PrisonBlock getPrisonBlock( String blockName );
+
+
+
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/DisplaySlot.java b/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/DisplaySlot.java
index bde846e94..c6b1ce3c8 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/DisplaySlot.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/DisplaySlot.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Objective.java b/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Objective.java
index 8092d0150..6fc79ae18 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Objective.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Objective.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Score.java b/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Score.java
index d430921c5..7475ce682 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Score.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Score.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Scoreboard.java b/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Scoreboard.java
index 1b7dba3c7..cb9198089 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Scoreboard.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Scoreboard.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/ScoreboardManager.java b/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/ScoreboardManager.java
index 9b9d300b7..5a3210fa9 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/ScoreboardManager.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/ScoreboardManager.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Team.java b/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Team.java
index a302a4d3e..c5ba82189 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Team.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/Team.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/package-info.java
index 0b42ed367..c2013c71d 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/package-info.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/internal/scoreboard/package-info.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/jackson/JacksonYaml.java b/prison-core/src/main/java/tech/mcprison/prison/jackson/JacksonYaml.java
new file mode 100644
index 000000000..45feaa17e
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/jackson/JacksonYaml.java
@@ -0,0 +1,204 @@
+package tech.mcprison.prison.jackson;
+
+/**
+ * This class uses Jackson's YAML databind tools to
+ * read and write to yaml configuration files.
+ *
+ *
+ * What makes this different, is that the yaml is built
+ * upon a hierarchy, but when loaded, it must be flattened
+ * using dot notation to represent the levels within the
+ * key.
+ *
+ *
+ * Since values of the various properties can have
+ * different types, internally the Jackson's ValueNode object
+ * is used since it is extended to contain various kinds of
+ * values. See list:
+ *
+ *
+ * Possible ValueNodes values:
+ *
+ *
+ * - com.fasterxml.jackson.databind.node.ValueNode
+ * - com.fasterxml.jackson.databind.node.BooleanNode
+ * - com.fasterxml.jackson.databind.node.TextNode
+ * - com.fasterxml.jackson.databind.node.IntNode
+ * - com.fasterxml.jackson.databind.node.DoubleNode
+ *
+ *
+ * Collections based nodes that extend from ValueNode:
+ *
+ *
+ * - com.fasterxml.jackson.databind.node.ArrayNode
+ * - com.fasterxml.jackson.databind.node.ObjectNode (a Map)
+ *
+ *
+ */
+public class JacksonYaml {
+
+ public JacksonYaml() {
+ super();
+
+ }
+
+// /**
+// * This function will read a yaml file, which loads as a hierarchical
+// * map. Then it will flatten the hierarchical map and return it.
+// *
+// *
+// *
+// * @param file
+// */
+// public Map loadYamlConfigFile( File file ) {
+// Map map = null;
+//
+// ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
+//
+// // If using something like a custom date formatter, etc:
+// mapper.findAndRegisterModules();
+//
+//
+// try {
+// JsonNode tree = mapper.readTree( file );
+//
+// map = flattenJson( tree );
+//
+//// for (Map.Entry kv : map.entrySet()) {
+//// System.out.println(kv.getKey() + ": " +
+//// kv.getValue().asText() + " [" +
+//// kv.getValue().getClass() + "]");
+//// }
+// }
+// catch ( IOException e ) {
+// Output.get().logError( String.format( "JacksonYaml.loadYamlConfigFile: " +
+// "Failure: file= %s :: %s ", file.getAbsoluteFile(), e.getMessage() ));
+// }
+//
+// return map;
+// }
+//
+//
+//
+// private Map flattenJson(JsonNode input) {
+// Map map = new LinkedHashMap<>();
+// flattenJson(input, null, map);
+// return map;
+// }
+//
+// private void flattenJson(JsonNode node, String parent, Map map) {
+// if (node instanceof ValueNode) {
+// map.put(parent, (ValueNode)node);
+// }
+// else {
+// String prefix = parent == null ? "" : parent + ".";
+// if (node instanceof ArrayNode) {
+// ArrayNode arrayNode = (ArrayNode)node;
+// for(int i = 0; i < arrayNode.size(); i++) {
+// flattenJson(arrayNode.get(i), prefix + i, map);
+// }
+// }
+// else if (node instanceof ObjectNode) {
+// ObjectNode objectNode = (ObjectNode) node;
+// for (Iterator> it = objectNode.fields(); it.hasNext(); ) {
+// Map.Entry field = it.next();
+// flattenJson(field.getValue(), prefix + field.getKey(), map);
+// }
+// }
+// else {
+// Output.get().logWarn( String.format( "JacksonYaml.flattenJson: " +
+// "Warning: Unknown node type. node= %s ", node.getClass()));
+//
+// }
+// }
+// }
+//
+//
+//
+// /**
+// * This function will write a flat map to a yaml file after it
+// * expands it to an hierarchical map, expanding the key values on
+// * their periods.
+// *
+// *
+// * @param file Target file to save to
+// * @param map A flat map of all the configs
+// */
+// public void writeYamlConfigFile( File file, Map map ) {
+//
+// String filenameTemp = file.getName() + ".tmp.yml";
+// File fileTemp = new File( file.getParentFile(), filenameTemp );
+//
+// ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
+//
+// // If using something like a custom date formatter, etc:
+// mapper.findAndRegisterModules();
+//
+// try {
+// Map mapExpanded = expandMap( map );
+//
+// // Write to the temp file:
+// mapper.writeValue( fileTemp, mapExpanded );
+//
+// // Delete the original file if it exists:
+// if ( file.exists() ) {
+// file.delete();
+// }
+//
+// // Rename the temp file to the actual file:
+// fileTemp.renameTo( file );
+// }
+// catch ( IOException e ) {
+// Output.get().logError( String.format( "JacksonYaml.writeYamlConfigFile: " +
+// "Failure: file= %s :: %s ", file.getAbsoluteFile(), e.getMessage() ));
+// }
+// }
+//
+// /**
+// * This takes a flat map and expands the keys, breaking on the periods,
+// * and builds a multi-level hierarchy.
+// *
+// *
+// * @param map Flat map
+// * @return Hierarchical map
+// */
+// private Map expandMap( Map map ) {
+// Map m = new LinkedHashMap<>();
+//
+// for ( Entry node : map.entrySet() ) {
+//
+// String key = node.getKey();
+//
+// if ( key != null ) {
+//
+// ValueNode value = node.getValue();
+//
+// String[] keyz = key.split( "\\." );
+//
+// // There are multiple depths and we must place the value at the
+// // leaf nodes. getChildExpandedMap traverses all the children
+// // to get to the leaf node, making the nodes if needed.
+// Map child = getChildExpandedMap(m, keyz, 0);
+//
+// child.put( keyz[keyz.length-1], value );
+// }
+// }
+//
+// return m;
+// }
+//
+// @SuppressWarnings( "unchecked" )
+// private Map getChildExpandedMap( Map map, String[] keyz, int pos ) {
+// if ( pos < keyz.length - 1 ) {
+// String key = keyz[pos];
+// if ( !map.containsKey( key ) ) {
+// map.put( key, new LinkedHashMap<>() );
+// }
+// return getChildExpandedMap( (Map) map.get( key ), keyz, pos + 1);
+// }
+//
+// return map;
+// }
+
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/localization/LocaleManager.java b/prison-core/src/main/java/tech/mcprison/prison/localization/LocaleManager.java
index 1a79fa795..22d7a99b6 100755
--- a/prison-core/src/main/java/tech/mcprison/prison/localization/LocaleManager.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/localization/LocaleManager.java
@@ -29,11 +29,15 @@
package tech.mcprison.prison.localization;
+import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
+import java.io.OutputStream;
import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.StandardOpenOption;
import java.security.CodeSource;
import java.util.Arrays;
import java.util.HashMap;
@@ -43,7 +47,11 @@
import java.util.logging.Logger;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
+
+import tech.mcprison.prison.Prison;
import tech.mcprison.prison.internal.Player;
+import tech.mcprison.prison.modules.Module;
+import tech.mcprison.prison.modules.ModuleManager;
import tech.mcprison.prison.modules.PluginEntity;
/**
@@ -106,7 +114,11 @@ public class LocaleManager {
public LocaleManager(PluginEntity module, String internalPath) {
this.module = module;
this.internalPath = internalPath;
+
+ // Load the shipped locales first first from the prison jar file:
loadShippedLocales();
+
+ // Then any custom locales will overried and replace the internal locales:
loadCustomLocales(); // custom locales will override
}
@@ -116,6 +128,9 @@ public LocaleManager(PluginEntity module) {
private void loadCustomLocales() {
File dataFolder = getOwningPlugin().getDataFolder();
+
+ dataFolder = fixPrisonCoreLanguagePath( dataFolder );
+
if (dataFolder.isDirectory()) {
File localeFolder = new File(dataFolder, LOCALE_FOLDER);
if (localeFolder.exists()) {
@@ -150,9 +165,97 @@ private void loadCustomLocales() {
+ " is not a directory - not loading custom locales");
}
}
+ else {
+ // The local custom lang directory doesn't exist so create it:
+ localeFolder.mkdirs();
+
+ // Now copy all of the default language files that are in the prison jar to this new directory.
+ // This will make it a lot easier for admins to modify the language files.
+ extractShippedLocales( localeFolder );
+
+ }
}
}
+ /**
+ * The Prison core is not truly a Prison module, so the targetPath that is passed to this function
+ * is not correctly setup to place the core/lang directory in the correct place. It will try
+ * to put it in /plugins/Prison/lang which is wrong. This function detects this error and
+ * will regenerate the targetPath to be /plugins/Prison/module_conf/core/lang.
+ *
+ *
+ * Note: There is a unit test that is ran by the gradle build process that hits this
+ * function. At the time, the value of PrisonAPI.getModuleManager() is null due to the unit test,
+ * therefore the following function is using static functions to ensure there is not a
+ * null pointer exception thrown. The unit test does not do anything with the content of
+ * these directories, but it still hits these functions, so allowing it to proceed, even if the
+ * paths are incorrect, will have no impact on anything.
+ *
+ *
+ * @param targetPath
+ * @return The corrected targetPath for the core plugin
+ */
+ private File fixPrisonCoreLanguagePath( File targetPath ) {
+ if ( !targetPath.getAbsolutePath().startsWith(
+ ModuleManager.getModuleRootDefault().getAbsolutePath() ) ) {
+ targetPath = Module.setupDataFolder( Prison.PSEDUO_MODLE_NAME );
+ }
+ return targetPath;
+ }
+
+ private void extractShippedLocales( File targetPath ) {
+
+ targetPath = fixPrisonCoreLanguagePath( targetPath );
+
+ CodeSource cs = getOwningPlugin().getClass().getProtectionDomain().getCodeSource();
+ if (cs != null) {
+ try {
+ URL jar = cs.getLocation();
+ ZipInputStream zip = new ZipInputStream(jar.openStream());
+ ZipEntry entry;
+ while ((entry = zip.getNextEntry()) != null) {
+ String entryName = entry.getName();
+
+ if (entryName.startsWith(internalPath) && entryName.endsWith(".properties")) {
+
+ String[] arr = entryName.split("/");
+ String localeName = arr[arr.length - 1];
+
+ File newLocal = new File( targetPath, localeName );
+
+ BufferedInputStream inStream = new BufferedInputStream( zip );
+ try (
+ OutputStream outStream = Files.newOutputStream( newLocal.toPath(),
+ StandardOpenOption.CREATE_NEW, StandardOpenOption.WRITE );
+ ) {
+ copyStreams( inStream, outStream) ;
+ }
+ }
+
+ }
+ } catch (IOException ex) {
+ throw new RuntimeException(
+ "Failed to initialize LocaleManager for plugin " + getOwningPlugin()
+ + " - Prison cannot continue to load.", ex);
+ }
+ } else {
+ throw new RuntimeException("LocalManager.extractShippedLocales(): " +
+ "Failed to load code source for plugin " + getOwningPlugin()
+ + " - Prison cannot continue to load.");
+ }
+
+ }
+
+ private void copyStreams(InputStream inStream, OutputStream outStream)
+ throws IOException {
+ byte[] buf = new byte[8192];
+ int length;
+ while ((length = inStream.read(buf)) > 0) {
+ outStream.write(buf, 0, length);
+ }
+ }
+
+
private void loadShippedLocales() {
CodeSource cs = getOwningPlugin().getClass().getProtectionDomain().getCodeSource();
if (cs != null) {
@@ -181,6 +284,7 @@ private void loadShippedLocales() {
}
private void loadLocale(String name, InputStream is, boolean printStackTrace) {
+
try {
Properties temp = new Properties();
temp.load(is);
diff --git a/prison-core/src/main/java/tech/mcprison/prison/localization/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/localization/package-info.java
index f23816076..0eb959ae4 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/localization/package-info.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/localization/package-info.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/modules/Module.java b/prison-core/src/main/java/tech/mcprison/prison/modules/Module.java
index 6b9b08d3b..131683eeb 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/modules/Module.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/modules/Module.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -18,12 +18,11 @@
package tech.mcprison.prison.modules;
+import java.io.File;
+
import tech.mcprison.prison.Prison;
-import tech.mcprison.prison.PrisonAPI;
import tech.mcprison.prison.error.ErrorManager;
-import java.io.File;
-
/**
* Represents a module, which is a part of Prison that can be enabled and
* disabled independently from the rest of the modules.
@@ -57,16 +56,42 @@ public abstract class Module implements PluginEntity {
public Module(String name, String version, int target) {
this.name = name;
this.version = version;
- this.dataFolder = new File(PrisonAPI.getModuleManager().getModuleRoot(),
- name.toLowerCase().replace(" ", "_"));
this.apiTarget = target;
+
+ this.dataFolder = setupDataFolder( name );
+
this.status = new ModuleStatus();
- if (!this.dataFolder.exists()) {
- this.dataFolder.mkdir();
- }
this.errorManager = new ErrorManager(this);
}
+
+ public static File setupDataFolder( String name ) {
+ File dataFolder = new File(ModuleManager.getModuleRootDefault(),
+ name.toLowerCase().replace(" ", "_"));
+ if (!dataFolder.exists()) {
+ dataFolder.mkdir();
+ }
+ return dataFolder;
+ }
+
+ /**
+ * The getBaseCommands() should return all of the base commands that
+ * would apply to the module. It should include the / as in /mines or
+ * the /ranks command. It should be viewed as being ran from in game
+ * to be consistent.
+ *
+ *
+ * An example of what this would return would be:
+ *
+ *
+ *
+ * - Mines plugin: "&2/mines"
+ * - Ranks plugin: "&2/ranks &2/rankup"
+ *
+ *
+ * @return
+ */
+ abstract public String getBaseCommands();
/*
* Methods, to be overridden
*/
diff --git a/prison-core/src/main/java/tech/mcprison/prison/modules/ModuleManager.java b/prison-core/src/main/java/tech/mcprison/prison/modules/ModuleManager.java
index 6d4c91b08..d88a57f7e 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/modules/ModuleManager.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/modules/ModuleManager.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -35,17 +35,28 @@
*/
public class ModuleManager {
+ public static final String MODULE_MANAGER_DIRECTORY = "module_conf";
+
private List modules;
+ private List disabledModules;
private File moduleRoot;
public ModuleManager() {
modules = new ArrayList<>();
- moduleRoot = new File(PrisonAPI.getPluginDirectory(), "module_conf");
- if (!moduleRoot.exists()) {
- moduleRoot.mkdir();
- }
+ disabledModules = new ArrayList<>();
+
+ moduleRoot = getModuleRootDefault();
}
+ public static File getModuleRootDefault() {
+ File moduleRoot = new File(PrisonAPI.getPluginDirectory(), MODULE_MANAGER_DIRECTORY);
+ if (!moduleRoot.exists()) {
+ moduleRoot.mkdir();
+ }
+
+ return moduleRoot;
+ }
+
/**
* Register a new module.
*/
@@ -77,7 +88,7 @@ private void validateVersion(Module module) {
*/
public boolean enableModule(Module module) {
long startTime = System.currentTimeMillis();
- Output.get().logInfo("%s enable start...", module.getName());
+ Output.get().logInfo("%s Module enablement starting...", module.getName());
module.setEnabled(true);
module.enable();
@@ -85,12 +96,13 @@ public boolean enableModule(Module module) {
if (module.getStatus().getStatus() != ModuleStatus.Status.ENABLED) {
// Anything else and we assume that the enable failed.
- Output.get().logInfo("%s enable &cfailed&f, in %d milliseconds.", module.getName(),
- (System.currentTimeMillis() - startTime));
+
+ Output.get().logInfo("%s Module enablement &cfailed&f in %d milliseconds. &d[%s&d]", module.getName(),
+ (System.currentTimeMillis() - startTime), module.getStatus().getMessage() );
return false;
}
- Output.get().logInfo("%s enable succeeded, in %d milliseconds.", module.getName(),
+ Output.get().logInfo("%s Module enabled successfully in %d milliseconds.", module.getName(),
(System.currentTimeMillis() - startTime));
return true;
}
@@ -124,6 +136,8 @@ public void disableModule(Module module) {
public void unregisterAll() {
modules.forEach(this::disableModule);
modules.clear();
+
+ disabledModules.clear();
}
/**
@@ -149,7 +163,11 @@ public List getModules() {
return modules;
}
- public File getModuleRoot() {
+ public List getDisabledModules() {
+ return disabledModules;
+ }
+
+ public File getModuleRoot() {
return moduleRoot;
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/modules/ModuleStatus.java b/prison-core/src/main/java/tech/mcprison/prison/modules/ModuleStatus.java
index 002426f7c..d7f7a4de8 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/modules/ModuleStatus.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/modules/ModuleStatus.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -74,6 +74,21 @@ public Status getStatus() {
return status;
}
+ /**
+ * Displays the associated test based upon the three combinations
+ * of status codes.
+ *
+ *
+ * @return
+ */
+ public String getStatusText() {
+ return (getStatus() == ModuleStatus.Status.ENABLED ?
+ "&2Enabled" :
+ (getStatus() == ModuleStatus.Status.FAILED ?
+ "&cFailed" : "&9&m-Disabled-" ));
+ }
+
+
/*
* Getters & Setters
*/
@@ -89,6 +104,14 @@ public String getMessage() {
public void setMessage(String message) {
this.message = message;
}
+
+ public void addMessage(String message) {
+ if ( this.message == null ) {
+ setMessage(message);
+ } else {
+ setMessage( getMessage() + ". " + message);
+ }
+ }
public enum Status {
ENABLED, DISABLED, FAILED
diff --git a/prison-core/src/main/java/tech/mcprison/prison/modules/PluginEntity.java b/prison-core/src/main/java/tech/mcprison/prison/modules/PluginEntity.java
index c27cc7602..03b3da3f6 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/modules/PluginEntity.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/modules/PluginEntity.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/modules/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/modules/package-info.java
index 86de0ce4a..7f8fdba95 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/modules/package-info.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/modules/package-info.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/BulletedListComponent.java b/prison-core/src/main/java/tech/mcprison/prison/output/BulletedListComponent.java
index 9f3b62aab..82941c26d 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/output/BulletedListComponent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/output/BulletedListComponent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/ChatDisplay.java b/prison-core/src/main/java/tech/mcprison/prison/output/ChatDisplay.java
index 462e6b481..8d3bc8e72 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/output/ChatDisplay.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/output/ChatDisplay.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -74,5 +74,12 @@ public void send(CommandSender sender) {
component.send(sender);
}
}
+
+ public void toLog(LogLevel logLevel) {
+ Output.get().log( title, logLevel );
+ for (DisplayComponent component : displayComponents) {
+ Output.get().log( component.text(), logLevel );
+ }
+ }
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/DisplayComponent.java b/prison-core/src/main/java/tech/mcprison/prison/output/DisplayComponent.java
index c239a48e4..1e790027b 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/output/DisplayComponent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/output/DisplayComponent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/FancyMessageComponent.java b/prison-core/src/main/java/tech/mcprison/prison/output/FancyMessageComponent.java
index c90c7eb5c..c8769183b 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/output/FancyMessageComponent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/output/FancyMessageComponent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/LogLevel.java b/prison-core/src/main/java/tech/mcprison/prison/output/LogLevel.java
index de4785521..6b8c6fc68 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/output/LogLevel.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/output/LogLevel.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/Output.java b/prison-core/src/main/java/tech/mcprison/prison/output/Output.java
index f57e6b0cb..690cb0040 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/output/Output.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/output/Output.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -18,11 +18,11 @@
package tech.mcprison.prison.output;
+import java.util.Arrays;
+
import tech.mcprison.prison.Prison;
import tech.mcprison.prison.internal.CommandSender;
-import java.util.Arrays;
-
/**
* Standardized output to the console and to players.
*
@@ -64,9 +64,13 @@ public String format(String message, LogLevel level, Object... args) {
* Log a message with a specified {@link LogLevel}
*/
public void log(String message, LogLevel level, Object... args) {
- Prison.get().getPlatform().log(gen("&3Prison") + " " + (level == LogLevel.INFO ?
- "&f" :
- level == LogLevel.WARNING ? "&6" : "&c") + String.format(message, args));
+ if ( Prison.get() == null || Prison.get().getPlatform() == null ) {
+ System.err.println("Prison: Output.log Logger failure: " + message );
+ } else {
+ Prison.get().getPlatform().log(gen("&3Prison") + " " + (level == LogLevel.INFO ?
+ "&f" :
+ level == LogLevel.WARNING ? "&6" : "&c") + String.format(message, args));
+ }
}
/**
diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/TextComponent.java b/prison-core/src/main/java/tech/mcprison/prison/output/TextComponent.java
index 19f1bcfec..7336b483b 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/output/TextComponent.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/output/TextComponent.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/output/package-info.java
index fbfbf44e3..0954a2a44 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/output/package-info.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/output/package-info.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/selection/Selection.java b/prison-core/src/main/java/tech/mcprison/prison/selection/Selection.java
index 943260cd3..d05003fef 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/selection/Selection.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/selection/Selection.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionListener.java b/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionListener.java
index b884f7d0c..4c63844d7 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionListener.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionListener.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionManager.java b/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionManager.java
index 0484097ac..048e435b3 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionManager.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionManager.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -56,7 +56,14 @@ public Selection getSelection(Player player) {
}
return selectionMap.get(player.getName());
}
+
+ public void clearSelection(Player player) {
+ if (!selectionMap.containsKey(player.getName())) {
+ selectionMap.remove(player.getName());
+ }
+ }
+
public void setSelection(Player player, Selection selection) {
selectionMap.put(player.getName(), selection);
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/selection/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/selection/package-info.java
index 4ba71405b..38b692d05 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/selection/package-info.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/selection/package-info.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/sorting/PrisonSortable.java b/prison-core/src/main/java/tech/mcprison/prison/sorting/PrisonSortable.java
new file mode 100644
index 000000000..f1dea1c2e
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/sorting/PrisonSortable.java
@@ -0,0 +1,5 @@
+package tech.mcprison.prison.sorting;
+
+public interface PrisonSortable {
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/sorting/PrisonSorter.java b/prison-core/src/main/java/tech/mcprison/prison/sorting/PrisonSorter.java
new file mode 100644
index 000000000..5ff76a53f
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/sorting/PrisonSorter.java
@@ -0,0 +1,10 @@
+package tech.mcprison.prison.sorting;
+
+import java.util.Set;
+
+public abstract class PrisonSorter {
+
+
+ public abstract Set getSortedSet();
+
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/BlockType.java b/prison-core/src/main/java/tech/mcprison/prison/util/BlockType.java
index 2623dec61..f5538f0f1 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/util/BlockType.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/BlockType.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -18,7 +18,9 @@
package tech.mcprison.prison.util;
+import java.util.ArrayList;
import java.util.Collection;
+import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
@@ -27,7 +29,19 @@
/**
- * All of the blocks in the game.
+ * All of the blocks in the game.
+ *
+ *
+ * The new field altNames contains a list of String values that will help
+ * XMaterial map these types to valid Material types. These are spigot version
+ * Dependent, so some blocks may have different altNames for different spigot
+ * versions.
+ *
+ *
+ * XMaterial support for spigot 1.8.8:
+ * MOSS_STONE = mossy_cobblestone, LAPIS_LAZULI_ORE = "lapis_ore",
+ * LAPIS_LAZULI_BLOCK = "lapis_block", PILLAR_QUARTZ_BLOCK = "quartz_pillar"
+ *
*
* @author Faizaan A. Datoo
* @author Camouflage100
@@ -44,8 +58,43 @@ public enum BlockType {
* of the Material.
*/
+ IGNORE( -1, "prison:ignore", -1, MaterialType.BLOCK ),
+ NULL_BLOCK( -2, "prison:null_block", -1, MaterialType.INVALID ),
+
+
// This was auto-generated from WorldEdit's blocks.json
// @formatter:off
+
+
+ // NOTE: Double slabs are ones that players cannot naturally place, and they are
+ // similar to the main block type. It appears like they have been replaced,
+ // but not sure with what. I suspect no one will use them anyway, and if they
+ // do, then mapping them to their counter part block. There are a few doubles
+ // that have been mapped to "smooth" in the later versions, so they are used when
+ // possible.
+
+
+ DOUBLE_STONE_SLAB( 43, "minecraft:double_stone_slab", 0, MaterialType.BLOCK, "smooth_stone" ),
+ DOUBLE_SANDSTONE_SLAB( 43, "minecraft:double_stone_slab", 1, MaterialType.BLOCK, "smooth_sandstone_slab" ),
+ DOUBLE_WOODEN_SLAB( 43, "minecraft:double_stone_slab", 2, MaterialType.BLOCK, "OAK_PLANKS" ),
+ DOUBLE_COBBLESTONE_SLAB( 43, "minecraft:double_stone_slab", 3, MaterialType.BLOCK, "COBBLESTONE" ),
+ DOUBLE_BRICK_SLAB( 43, "minecraft:double_stone_slab", 4, MaterialType.BLOCK, "BRICKS" ),
+ DOUBLE_STONE_BRICK_SLAB( 43, "minecraft:double_stone_slab", 5, MaterialType.BLOCK, "STONE_BRICKS" ),
+ DOUBLE_NETHER_BRICK_SLAB( 43, "minecraft:double_stone_slab", 6, MaterialType.BLOCK, "NETHER_BRICKS" ),
+ DOUBLE_QUARTZ_SLAB( 43, "minecraft:double_stone_slab", 7, MaterialType.BLOCK, "SMOOTH_QUARTZ" ),
+
+ DOUBLE_OAK_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 0, MaterialType.BLOCK, "OAK_PLANKS" ),
+ DOUBLE_SPRUCE_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 1, MaterialType.BLOCK, "SPRUCE_PLANKS" ),
+ DOUBLE_BIRCH_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 2, MaterialType.BLOCK, "BIRCH_PLANKS" ),
+ DOUBLE_JUNGLE_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 3, MaterialType.BLOCK, "JUNGLE_PLANKS" ),
+ DOUBLE_ACACIA_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 4, MaterialType.BLOCK, "ACACIA_PLANKS" ),
+ DOUBLE_DARK_OAK_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 5, MaterialType.BLOCK, "DARK_OAK_PLANKS" ),
+
+ DOUBLE_RED_SANDSTONE_SLAB( 181, "minecraft:double_stone_slab2", 0, MaterialType.BLOCK, "RED_SANDSTONE" ),
+ PURPUR_DOUBLE_SLAB( 204, "minecraft:purpur_double_slab", 0, MaterialType.BLOCK, "PURPUR_BLOCK" ),
+
+
+
AIR( 0, "minecraft:air", 0, MaterialType.BLOCK ),
STONE( 1, "minecraft:stone", 0, MaterialType.BLOCK ),
GRANITE( 1, "minecraft:stone", 1, MaterialType.BLOCK ),
@@ -59,44 +108,52 @@ public enum BlockType {
COARSE_DIRT( 3, "minecraft:dirt", 1, MaterialType.BLOCK ),
PODZOL( 3, "minecraft:dirt", 2, MaterialType.BLOCK ),
COBBLESTONE( 4, "minecraft:cobblestone", 0, MaterialType.BLOCK ),
- OAK_WOOD_PLANK( 5, "minecraft:planks", 0, MaterialType.BLOCK ),
- SPRUCE_WOOD_PLANK( 5, "minecraft:planks", 1, MaterialType.BLOCK ),
- BIRCH_WOOD_PLANK( 5, "minecraft:planks", 2, MaterialType.BLOCK ),
- JUNGLE_WOOD_PLANK( 5, "minecraft:planks", 3, MaterialType.BLOCK ),
- ACACIA_WOOD_PLANK( 5, "minecraft:planks", 4, MaterialType.BLOCK ),
- DARK_OAK_WOOD_PLANK( 5, "minecraft:planks", 5, MaterialType.BLOCK ),
+
+ OAK_WOOD_PLANK( 5, "minecraft:planks", 0, MaterialType.BLOCK, "OAK_PLANKS" ),
+ SPRUCE_WOOD_PLANK( 5, "minecraft:planks", 1, MaterialType.BLOCK, "SPRUCE_PLANKS" ),
+ BIRCH_WOOD_PLANK( 5, "minecraft:planks", 2, MaterialType.BLOCK, "BIRCH_PLANKS" ),
+ JUNGLE_WOOD_PLANK( 5, "minecraft:planks", 3, MaterialType.BLOCK, "JUNGLE_PLANKS" ),
+ ACACIA_WOOD_PLANK( 5, "minecraft:planks", 4, MaterialType.BLOCK, "ACACIA_PLANKS" ),
+ DARK_OAK_WOOD_PLANK( 5, "minecraft:planks", 5, MaterialType.BLOCK, "DARK_OAK_PLANKS" ),
+
OAK_SAPLING( 6, "minecraft:sapling", 0, MaterialType.BLOCK ),
SPRUCE_SAPLING( 6, "minecraft:sapling", 1, MaterialType.BLOCK ),
BIRCH_SAPLING( 6, "minecraft:sapling", 2, MaterialType.BLOCK ),
JUNGLE_SAPLING( 6, "minecraft:sapling", 3, MaterialType.BLOCK ),
ACACIA_SAPLING( 6, "minecraft:sapling", 4, MaterialType.BLOCK ),
DARK_OAK_SAPLING( 6, "minecraft:sapling", 5, MaterialType.BLOCK ),
- BEDROCK( 7, "minecraft:bedrock", 0, MaterialType.BLOCK ),
- FLOWING_WATER( 8, "minecraft:flowing_water", 0, MaterialType.BLOCK ),
+ BEDROCK( 7, "minecraft:bedrock", 0, MaterialType.BLOCK ),
+
+ FLOWING_WATER( 8, "minecraft:flowing_water", 0, MaterialType.BLOCK, "WATER" ),
+
STILL_WATER( 9, "minecraft:water", 0, MaterialType.BLOCK ),
- FLOWING_LAVA( 10, "minecraft:flowing_lava", 0, MaterialType.BLOCK ),
+ FLOWING_LAVA( 10, "minecraft:flowing_lava", 0, MaterialType.BLOCK, "LAVA" ),
STILL_LAVA( 11, "minecraft:lava", 0, MaterialType.BLOCK ),
+
SAND( 12, "minecraft:sand", 0, MaterialType.BLOCK ),
RED_SAND( 12, "minecraft:sand", 1, MaterialType.BLOCK ),
GRAVEL( 13, "minecraft:gravel", 0, MaterialType.BLOCK ),
- GOLD_ORE( 14, "minecraft:gold_ore", 0, MaterialType.BLOCK ),
- IRON_ORE( 15, "minecraft:iron_ore", 0, MaterialType.BLOCK ),
- COAL_ORE( 16, "minecraft:coal_ore", 0, MaterialType.BLOCK ),
+ GOLD_ORE( 14, "minecraft:gold_ore", 0, MaterialType.BLOCK ),
+ IRON_ORE( 15, "minecraft:iron_ore", 0, MaterialType.BLOCK ),
+ COAL_ORE( 16, "minecraft:coal_ore", 0, MaterialType.BLOCK ),
+
OAK_WOOD( 17, "minecraft:log", 0, MaterialType.BLOCK ),
SPRUCE_WOOD( 17, "minecraft:log", 1, MaterialType.BLOCK ),
BIRCH_WOOD( 17, "minecraft:log", 2, MaterialType.BLOCK ),
JUNGLE_WOOD( 17, "minecraft:log", 3, MaterialType.BLOCK ),
+
OAK_LEAVES( 18, "minecraft:leaves", 0, MaterialType.BLOCK ),
SPRUCE_LEAVES( 18, "minecraft:leaves", 1, MaterialType.BLOCK ),
BIRCH_LEAVES( 18, "minecraft:leaves", 2, MaterialType.BLOCK ),
- UNGL_LEAVES( 18, "minecraft:leaves", 3, MaterialType.BLOCK ), /// ??? Should this be JUNGLE_LEAVES ???
JUNGLE_LEAVES( 18, "minecraft:leaves", 3, MaterialType.BLOCK ),
SPONGE( 19, "minecraft:sponge", 0, MaterialType.BLOCK ),
WET_SPONGE( 19, "minecraft:sponge", 1, MaterialType.BLOCK ),
GLASS( 20, "minecraft:glass", 0, MaterialType.BLOCK ),
+
LAPIS_LAZULI_ORE( 21, "minecraft:lapis_ore", 0, MaterialType.BLOCK ),
LAPIS_LAZULI_BLOCK( 22, "minecraft:lapis_block", 0, MaterialType.BLOCK ),
+
DISPENSER( 23, "minecraft:dispenser", 0, MaterialType.BLOCK ),
SANDSTONE( 24, "minecraft:sandstone", 0, MaterialType.BLOCK ),
CHISELED_SANDSTONE( 24, "minecraft:sandstone", 1, MaterialType.BLOCK ),
@@ -107,10 +164,10 @@ public enum BlockType {
DETECTOR_RAIL( 28, "minecraft:detector_rail", 0, MaterialType.BLOCK ),
STICKY_PISTON( 29, "minecraft:sticky_piston", 0, MaterialType.BLOCK ),
COBWEB( 30, "minecraft:web", 0, MaterialType.BLOCK ),
- DEAD_SHRUB( 31, "minecraft:tallgrass", 0, MaterialType.BLOCK ),
+ DEAD_SHRUB( 31, "minecraft:tallgrass", 0, MaterialType.BLOCK, "DEAD_BUSH" ),
TALL_GRASS( 31, "minecraft:tallgrass", 1, MaterialType.BLOCK ),
FERN( 31, "minecraft:tallgrass", 2, MaterialType.BLOCK ),
- DEAD_BUSH( 32, "minecraft:deadbush", 0, MaterialType.BLOCK ),
+ DEAD_BUSH( 32, "minecraft:deadbush", 0, MaterialType.BLOCK, "DEAD_BUSH" ),
PISTON( 33, "minecraft:piston", 0, MaterialType.BLOCK ),
PISTON_HEAD( 34, "minecraft:piston_head", 0, MaterialType.BLOCK ),
WHITE_WOOL( 35, "minecraft:wool", 0, MaterialType.BLOCK ),
@@ -129,11 +186,12 @@ public enum BlockType {
GREEN_WOOL( 35, "minecraft:wool", 13, MaterialType.BLOCK ),
RED_WOOL( 35, "minecraft:wool", 14, MaterialType.BLOCK ),
BLACK_WOOL( 35, "minecraft:wool", 15, MaterialType.BLOCK ),
+
DANDELION( 37, "minecraft:yellow_flower", 0, MaterialType.BLOCK ),
- POPPY( 38, "minecraft:red_flower", 0, MaterialType.BLOCK ),
+ POPPY( 38, "minecraft:red_flower", 0, MaterialType.BLOCK, "RED_ROSE" ),
BLUE_ORCHID( 38, "minecraft:red_flower", 1, MaterialType.BLOCK ),
ALLIUM( 38, "minecraft:red_flower", 2, MaterialType.BLOCK ),
- AZURE_BLUET( 38, "minecraft:red_flower", 3, MaterialType.BLOCK ),
+ AZURE_BLUET( 38, "minecraft:red_flower", 3, MaterialType.BLOCK, "AZURE_BLUET" ),
RED_TULIP( 38, "minecraft:red_flower", 4, MaterialType.BLOCK ),
ORANGE_TULIP( 38, "minecraft:red_flower", 5, MaterialType.BLOCK ),
WHITE_TULIP( 38, "minecraft:red_flower", 6, MaterialType.BLOCK ),
@@ -143,26 +201,21 @@ public enum BlockType {
RED_MUSHROOM( 40, "minecraft:red_mushroom", 0, MaterialType.BLOCK ),
GOLD_BLOCK( 41, "minecraft:gold_block", 0, MaterialType.BLOCK ),
IRON_BLOCK( 42, "minecraft:iron_block", 0, MaterialType.BLOCK ),
- DOUBLE_STONE_SLAB( 43, "minecraft:double_stone_slab", 0, MaterialType.BLOCK ),
- DOUBLE_SANDSTONE_SLAB( 43, "minecraft:double_stone_slab", 1, MaterialType.BLOCK ),
- DOUBLE_WOODEN_SLAB( 43, "minecraft:double_stone_slab", 2, MaterialType.BLOCK ),
- DOUBLE_COBBLESTONE_SLAB( 43, "minecraft:double_stone_slab", 3, MaterialType.BLOCK ),
- DOUBLE_BRICK_SLAB( 43, "minecraft:double_stone_slab", 4, MaterialType.BLOCK ),
- DOUBLE_STONE_BRICK_SLAB( 43, "minecraft:double_stone_slab", 5, MaterialType.BLOCK ),
- DOUBLE_NETHER_BRICK_SLAB( 43, "minecraft:double_stone_slab", 6, MaterialType.BLOCK ),
- DOUBLE_QUARTZ_SLAB( 43, "minecraft:double_stone_slab", 7, MaterialType.BLOCK ),
+
+
STONE_SLAB( 44, "minecraft:stone_slab", 0, MaterialType.BLOCK ),
SANDSTONE_SLAB( 44, "minecraft:stone_slab", 1, MaterialType.BLOCK ),
WOODEN_SLAB( 44, "minecraft:stone_slab", 2, MaterialType.BLOCK ),
COBBLESTONE_SLAB( 44, "minecraft:stone_slab", 3, MaterialType.BLOCK ),
- BRICK_SLAB( 44, "minecraft:stone_slab", 4, MaterialType.BLOCK ),
+ BRICK_SLAB( 44, "minecraft:stone_slab", 4, MaterialType.BLOCK, "STONE_BRICK_SLAB" ),
STONE_BRICK_SLAB( 44, "minecraft:stone_slab", 5, MaterialType.BLOCK ),
NETHER_BRICK_SLAB( 44, "minecraft:stone_slab", 6, MaterialType.BLOCK ),
QUARTZ_SLAB( 44, "minecraft:stone_slab", 7, MaterialType.BLOCK ),
BRICKS( 45, "minecraft:brick_block", 0, MaterialType.BLOCK ),
TNT( 46, "minecraft:tnt", 0, MaterialType.BLOCK ),
BOOKSHELF( 47, "minecraft:bookshelf", 0, MaterialType.BLOCK ),
- MOSS_STONE( 48, "minecraft:mossy_cobblestone", 0, MaterialType.BLOCK ),
+ MOSS_STONE( 48, "minecraft:mossy_cobblestone", 0, MaterialType.BLOCK, "MOSSY_COBBLESTONE" ),
+
OBSIDIAN( 49, "minecraft:obsidian", 0, MaterialType.BLOCK ),
TORCH( 50, "minecraft:torch", 0, MaterialType.BLOCK ),
FIRE( 51, "minecraft:fire", 0, MaterialType.BLOCK ),
@@ -177,7 +230,7 @@ public enum BlockType {
FARMLAND( 60, "minecraft:farmland", 0, MaterialType.BLOCK ),
FURNACE( 61, "minecraft:furnace", 0, MaterialType.BLOCK ),
BURNING_FURNACE( 62, "minecraft:lit_furnace", 0, MaterialType.BLOCK ),
- STANDING_SIGN_BLOCK( 63, "minecraft:standing_sign", 0, MaterialType.BLOCK ),
+ STANDING_SIGN_BLOCK( 63, "minecraft:standing_sign", 0, MaterialType.BLOCK, "OAK_SIGN" ),
OAK_DOOR_BLOCK( 64, "minecraft:wooden_door", 0, MaterialType.BLOCK ),
LADDER( 65, "minecraft:ladder", 0, MaterialType.BLOCK ),
RAIL( 66, "minecraft:rail", 0, MaterialType.BLOCK ),
@@ -186,7 +239,9 @@ public enum BlockType {
LEVER( 69, "minecraft:lever", 0, MaterialType.BLOCK ),
STONE_PRESSURE_PLATE( 70, "minecraft:stone_pressure_plate", 0, MaterialType.BLOCK ),
IRON_DOOR_BLOCK( 71, "minecraft:iron_door", 0, MaterialType.BLOCK ),
- WOODEN_PRESSURE_PLATE( 72, "minecraft:wooden_pressure_plate", 0, MaterialType.BLOCK ),
+
+ WOODEN_PRESSURE_PLATE( 72, "minecraft:wooden_pressure_plate", 0, MaterialType.BLOCK,
+ "OAK_PRESSURE_PLATE", "WOOD_PLATE" ),
REDSTONE_ORE( 73, "minecraft:redstone_ore", 0, MaterialType.BLOCK ),
GLOWING_REDSTONE_ORE( 74, "minecraft:lit_redstone_ore", 0, MaterialType.BLOCK ),
@@ -201,7 +256,7 @@ public enum BlockType {
CACTUS( 81, "minecraft:cactus", 0, MaterialType.BLOCK ),
CLAY( 82, "minecraft:clay", 0, MaterialType.BLOCK ),
- SUGAR_CANES( 83, "minecraft:reeds", 0, MaterialType.BLOCK ),
+ SUGAR_CANES( 83, "minecraft:reeds", 0, MaterialType.BLOCK, "SUGAR_CANE" ),
JUKEBOX( 84, "minecraft:jukebox", 0, MaterialType.BLOCK ),
OAK_FENCE( 85, "minecraft:fence", 0, MaterialType.BLOCK ),
PUMPKIN( 86, "minecraft:pumpkin", 0, MaterialType.BLOCK ),
@@ -210,10 +265,14 @@ public enum BlockType {
SOUL_SAND( 88, "minecraft:soul_sand", 0, MaterialType.BLOCK ),
GLOWSTONE( 89, "minecraft:glowstone", 0, MaterialType.BLOCK ),
NETHER_PORTAL( 90, "minecraft:portal", 0, MaterialType.BLOCK ),
- JACK_OLANTERN( 91, "minecraft:lit_pumpkin", 0, MaterialType.BLOCK ),
+
+ JACK_OLANTERN( 91, "minecraft:lit_pumpkin", 0, MaterialType.BLOCK, "jack_o_lantern" ),
+
CAKE_BLOCK( 92, "minecraft:cake", 0, MaterialType.BLOCK ),
- REDSTONE_REPEATER_BLOCK_OFF( 93, "minecraft:unpowered_repeater", 0, MaterialType.BLOCK ),
- REDSTONE_REPEATER_BLOCK_ON( 94, "minecraft:powered_repeater", 0, MaterialType.BLOCK ),
+
+ REDSTONE_REPEATER_BLOCK_OFF( 93, "minecraft:unpowered_repeater", 0, MaterialType.BLOCK, "REPEATER" ),
+ REDSTONE_REPEATER_BLOCK_ON( 94, "minecraft:powered_repeater", 0, MaterialType.BLOCK, "REPEATER" ),
+
WHITE_STAINED_GLASS( 95, "minecraft:stained_glass", 0, MaterialType.BLOCK ),
ORANGE_STAINED_GLASS( 95, "minecraft:stained_glass", 1, MaterialType.BLOCK ),
MAGENTA_STAINED_GLASS( 95, "minecraft:stained_glass", 2, MaterialType.BLOCK ),
@@ -230,19 +289,25 @@ public enum BlockType {
GREEN_STAINED_GLASS( 95, "minecraft:stained_glass", 13, MaterialType.BLOCK ),
RED_STAINED_GLASS( 95, "minecraft:stained_glass", 14, MaterialType.BLOCK ),
BLACK_STAINED_GLASS( 95, "minecraft:stained_glass", 15, MaterialType.BLOCK ),
- WOODEN_TRAPDOOR( 96, "minecraft:trapdoor", 0, MaterialType.BLOCK ),
- STONE_MONSTER_EGG( 97, "minecraft:monster_egg", 0, MaterialType.BLOCK ),
- COBBLESTONE_MONSTER_EGG( 97, "minecraft:monster_egg", 1, MaterialType.BLOCK ),
- STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 2, MaterialType.BLOCK ),
- MOSSY_STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 3, MaterialType.BLOCK ),
- CRACKED_STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 4, MaterialType.BLOCK ),
- CHISELED_STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 5, MaterialType.BLOCK ),
- STONE_BRICKS( 98, "minecraft:stonebrick", 0, MaterialType.BLOCK ),
- MOSSY_STONE_BRICKS( 98, "minecraft:stonebrick", 1, MaterialType.BLOCK ),
- CRACKED_STONE_BRICKS( 98, "minecraft:stonebrick", 2, MaterialType.BLOCK ),
- CHISELED_STONE_BRICKS( 98, "minecraft:stonebrick", 3, MaterialType.BLOCK ),
+ WOODEN_TRAPDOOR( 96, "minecraft:trapdoor", 0, MaterialType.BLOCK, "oak_trapdoor" ),
+
+ STONE_MONSTER_EGG( 97, "minecraft:monster_egg", 0, MaterialType.BLOCK, "INFESTED_STONE" ),
+ COBBLESTONE_MONSTER_EGG( 97, "minecraft:monster_egg", 1, MaterialType.BLOCK, "INFESTED_COBBLESTONE" ),
+ STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 2, MaterialType.BLOCK, "INFESTED_STONE_BRICKS" ),
+ MOSSY_STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 3, MaterialType.BLOCK, "INFESTED_MOSSY_STONE_BRICKS" ),
+ CRACKED_STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 4, MaterialType.BLOCK, "INFESTED_CRACKED_STONE_BRICKS" ),
+ CHISELED_STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 5, MaterialType.BLOCK, "INFESTED_CHISELED_STONE_BRICKS" ),
+
+ STONE_BRICKS( 98, "minecraft:stonebrick", 0, MaterialType.BLOCK, "STONE_BRICKS" ),
+ MOSSY_STONE_BRICKS( 98, "minecraft:stonebrick", 1, MaterialType.BLOCK, "MOSSY_STONE_BRICKS" ),
+ CRACKED_STONE_BRICKS( 98, "minecraft:stonebrick", 2, MaterialType.BLOCK, "CRACKED_STONE_BRICKS" ),
+ CHISELED_STONE_BRICKS( 98, "minecraft:stonebrick", 3, MaterialType.BLOCK, "CHISELED_STONE_BRICKS" ),
+
BROWN_MUSHROOM_BLOCK( 99, "minecraft:brown_mushroom_block", 0, MaterialType.BLOCK ),
+ HUGE_MUSHROOM_1( 99, "minecraft:brown_mushroom_block", 14, MaterialType.BLOCK ),
RED_MUSHROOM_BLOCK( 100, "minecraft:red_mushroom_block", 0, MaterialType.BLOCK ),
+ HUGE_MUSHROOM_2( 100, "minecraft:red_mushroom_block", 14, MaterialType.BLOCK ),
+
IRON_BARS( 101, "minecraft:iron_bars", 0, MaterialType.BLOCK ),
GLASS_PANE( 102, "minecraft:glass_pane", 0, MaterialType.BLOCK ),
MELON_BLOCK( 103, "minecraft:melon_block", 0, MaterialType.BLOCK ),
@@ -254,6 +319,7 @@ public enum BlockType {
STONE_BRICK_STAIRS( 109, "minecraft:stone_brick_stairs", 0, MaterialType.BLOCK ),
MYCELIUM( 110, "minecraft:mycelium", 0, MaterialType.BLOCK ),
LILY_PAD( 111, "minecraft:waterlily", 0, MaterialType.BLOCK ),
+
NETHER_BRICK( 112, "minecraft:nether_brick", 0, MaterialType.BLOCK ),
NETHER_BRICK_FENCE( 113, "minecraft:nether_brick_fence", 0, MaterialType.BLOCK ),
NETHER_BRICK_STAIRS( 114, "minecraft:nether_brick_stairs", 0, MaterialType.BLOCK ),
@@ -265,14 +331,11 @@ public enum BlockType {
END_PORTAL_FRAME( 120, "minecraft:end_portal_frame", 0, MaterialType.BLOCK ),
END_STONE( 121, "minecraft:end_stone", 0, MaterialType.BLOCK ),
DRAGON_EGG( 122, "minecraft:dragon_egg", 0, MaterialType.BLOCK ),
- REDSTONE_LAMP_INACTIVE( 123, "minecraft:redstone_lamp", 0, MaterialType.BLOCK ),
- REDSTONE_LAMP_ACTIVE( 124, "minecraft:lit_redstone_lamp", 0, MaterialType.BLOCK ),
- DOUBLE_OAK_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 0, MaterialType.BLOCK ),
- DOUBLE_SPRUCE_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 1, MaterialType.BLOCK ),
- DOUBLE_BIRCH_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 2, MaterialType.BLOCK ),
- DOUBLE_JUNGLE_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 3, MaterialType.BLOCK ),
- DOUBLE_ACACIA_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 4, MaterialType.BLOCK ),
- DOUBLE_DARK_OAK_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 5, MaterialType.BLOCK ),
+
+ REDSTONE_LAMP_INACTIVE( 123, "minecraft:redstone_lamp", 0, MaterialType.BLOCK, "REDSTONE_LAMP_OFF" ),
+ REDSTONE_LAMP_ACTIVE( 124, "minecraft:lit_redstone_lamp", 0, MaterialType.BLOCK, "REDSTONE_LAMP", "REDSTONE_LAMP_ON" ),
+
+
OAK_WOOD_SLAB( 126, "minecraft:wooden_slab", 0, MaterialType.BLOCK ),
SPRUCE_WOOD_SLAB( 126, "minecraft:wooden_slab", 1, MaterialType.BLOCK ),
BIRCH_WOOD_SLAB( 126, "minecraft:wooden_slab", 2, MaterialType.BLOCK ),
@@ -296,40 +359,46 @@ public enum BlockType {
FLOWER_POT( 140, "minecraft:flower_pot", 0, MaterialType.BLOCK ),
CARROTS( 141, "minecraft:carrots", 0, MaterialType.BLOCK ),
POTATOES( 142, "minecraft:potatoes", 0, MaterialType.BLOCK ),
- WOODEN_BUTTON( 143, "minecraft:wooden_button", 0, MaterialType.BLOCK ),
+ WOODEN_BUTTON( 143, "minecraft:wooden_button", 0, MaterialType.BLOCK, "OAK_BUTTON", "wood_button" ),
MOB_HEAD( 144, "minecraft:skull", 0, MaterialType.BLOCK ),
ANVIL( 145, "minecraft:anvil", 0, MaterialType.BLOCK ),
TRAPPED_CHEST( 146, "minecraft:trapped_chest", 0, MaterialType.BLOCK ),
WEIGHTED_PRESSURE_PLATE_LIGHT( 147, "minecraft:light_weighted_pressure_plate", 0, MaterialType.BLOCK ),
WEIGHTED_PRESSURE_PLATE_HEAVY( 148, "minecraft:heavy_weighted_pressure_plate", 0, MaterialType.BLOCK ),
- REDSTONE_COMPARATOR_INACTIVE( 149, "minecraft:unpowered_comparator", 0, MaterialType.BLOCK ),
- REDSTONE_COMPARATOR_ACTIVE( 150, "minecraft:powered_comparator", 0, MaterialType.BLOCK ),
+
+ REDSTONE_COMPARATOR_INACTIVE( 149, "minecraft:unpowered_comparator", 0, MaterialType.BLOCK, "COMPARATOR" ),
+ REDSTONE_COMPARATOR_ACTIVE( 150, "minecraft:powered_comparator", 0, MaterialType.BLOCK, "COMPARATOR" ),
+
DAYLIGHT_SENSOR( 151, "minecraft:daylight_detector", 0, MaterialType.BLOCK ),
REDSTONE_BLOCK( 152, "minecraft:redstone_block", 0, MaterialType.BLOCK ),
NETHER_QUARTZ_ORE( 153, "minecraft:quartz_ore", 0, MaterialType.BLOCK ),
HOPPER( 154, "minecraft:hopper", 0, MaterialType.BLOCK ),
QUARTZ_BLOCK( 155, "minecraft:quartz_block", 0, MaterialType.BLOCK ),
CHISELED_QUARTZ_BLOCK( 155, "minecraft:quartz_block", 1, MaterialType.BLOCK ),
- PILLAR_QUARTZ_BLOCK( 155, "minecraft:quartz_block", 2, MaterialType.BLOCK ),
+
+ PILLAR_QUARTZ_BLOCK( 155, "minecraft:quartz_block", 2, MaterialType.BLOCK, "QUARTZ_PILLAR" ),
+
QUARTZ_STAIRS( 156, "minecraft:quartz_stairs", 0, MaterialType.BLOCK ),
ACTIVATOR_RAIL( 157, "minecraft:activator_rail", 0, MaterialType.BLOCK ),
DROPPER( 158, "minecraft:dropper", 0, MaterialType.BLOCK ),
- WHITE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 0, MaterialType.BLOCK ),
- ORANGE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 1, MaterialType.BLOCK ),
- MAGENTA_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 2, MaterialType.BLOCK ),
- LIGHT_BLUE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 3, MaterialType.BLOCK ),
- YELLOW_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 4, MaterialType.BLOCK ),
- LIME_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 5, MaterialType.BLOCK ),
- PINK_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 6, MaterialType.BLOCK ),
- GRAY_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 7, MaterialType.BLOCK ),
- LIGHT_GRAY_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 8, MaterialType.BLOCK ),
- CYAN_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 9, MaterialType.BLOCK ),
- PURPLE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 10, MaterialType.BLOCK ),
- BLUE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 11, MaterialType.BLOCK ),
- BROWN_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 12, MaterialType.BLOCK ),
- GREEN_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 13, MaterialType.BLOCK ),
- RED_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 14, MaterialType.BLOCK ),
- BLACK_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 15, MaterialType.BLOCK ),
+
+ WHITE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 0, MaterialType.BLOCK, "WHITE_TERRACOTTA" ),
+ ORANGE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 1, MaterialType.BLOCK, "ORANGE_TERRACOTTA" ),
+ MAGENTA_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 2, MaterialType.BLOCK, "MAGENTA_TERRACOTTA" ),
+ LIGHT_BLUE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 3, MaterialType.BLOCK, "LIGHT_BLUE_TERRACOTTA" ),
+ YELLOW_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 4, MaterialType.BLOCK, "YELLOW_TERRACOTTA" ),
+ LIME_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 5, MaterialType.BLOCK, "LIME_TERRACOTTA" ),
+ PINK_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 6, MaterialType.BLOCK, "PINK_TERRACOTTA" ),
+ GRAY_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 7, MaterialType.BLOCK, "GRAY_TERRACOTTA" ),
+ LIGHT_GRAY_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 8, MaterialType.BLOCK, "LIGHT_GRAY_TERRACOTTA" ),
+ CYAN_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 9, MaterialType.BLOCK, "CYAN_TERRACOTTA" ),
+ PURPLE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 10, MaterialType.BLOCK, "PURPLE_TERRACOTTA" ),
+ BLUE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 11, MaterialType.BLOCK, "BLUE_TERRACOTTA" ),
+ BROWN_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 12, MaterialType.BLOCK, "BROWN_TERRACOTTA" ),
+ GREEN_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 13, MaterialType.BLOCK, "GREEN_TERRACOTTA" ),
+ RED_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 14, MaterialType.BLOCK, "RED_TERRACOTTA" ),
+ BLACK_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 15, MaterialType.BLOCK, "BLACK_TERRACOTTA" ),
+
WHITE_STAINED_GLASS_PANE( 160, "minecraft:stained_glass_pane", 0, MaterialType.BLOCK ),
ORANGE_STAINED_GLASS_PANE( 160, "minecraft:stained_glass_pane", 1, MaterialType.BLOCK ),
MAGENTA_STAINED_GLASS_PANE( 160, "minecraft:stained_glass_pane", 2, MaterialType.BLOCK ),
@@ -346,7 +415,8 @@ public enum BlockType {
GREEN_STAINED_GLASS_PANE( 160, "minecraft:stained_glass_pane", 13, MaterialType.BLOCK ),
RED_STAINED_GLASS_PANE( 160, "minecraft:stained_glass_pane", 14, MaterialType.BLOCK ),
BLACK_STAINED_GLASS_PANE( 160, "minecraft:stained_glass_pane", 15, MaterialType.BLOCK ),
- ACACIA_LEAVES( 161, "minecraft:leaves2", 0, MaterialType.BLOCK ),
+
+ ACACIA_LEAVES( 161, "minecraft:leaves2", 0, MaterialType.BLOCK, "ACACIA_LEAVES" ),
DARK_OAK_LEAVES( 161, "minecraft:leaves2", 1, MaterialType.BLOCK ),
ACACIA_WOOD( 162, "minecraft:log2", 0, MaterialType.BLOCK ),
DARK_OAK_WOOD( 162, "minecraft:log2", 1, MaterialType.BLOCK ),
@@ -376,7 +446,7 @@ public enum BlockType {
GREEN_CARPET( 171, "minecraft:carpet", 13, MaterialType.BLOCK ),
RED_CARPET( 171, "minecraft:carpet", 14, MaterialType.BLOCK ),
BLACK_CARPET( 171, "minecraft:carpet", 15, MaterialType.BLOCK ),
- HARDENED_CLAY( 172, "minecraft:hardened_clay", 0, MaterialType.BLOCK ),
+ HARDENED_CLAY( 172, "minecraft:hardened_clay", 0, MaterialType.BLOCK, "TERRACOTTA", "HARD_CLAY" ),
BLOCK_OF_COAL( 173, "minecraft:coal_block", 0, MaterialType.BLOCK ),
PACKED_ICE( 174, "minecraft:packed_ice", 0, MaterialType.BLOCK ),
SUNFLOWER( 175, "minecraft:double_plant", 0, MaterialType.BLOCK ),
@@ -392,8 +462,9 @@ public enum BlockType {
CHISELED_RED_SANDSTONE( 179, "minecraft:red_sandstone", 1, MaterialType.BLOCK ),
SMOOTH_RED_SANDSTONE( 179, "minecraft:red_sandstone", 2, MaterialType.BLOCK ),
RED_SANDSTONE_STAIRS( 180, "minecraft:red_sandstone_stairs", 0, MaterialType.BLOCK ),
- DOUBLE_RED_SANDSTONE_SLAB( 181, "minecraft:double_stone_slab2", 0, MaterialType.BLOCK ),
+
RED_SANDSTONE_SLAB( 182, "minecraft:stone_slab2", 0, MaterialType.BLOCK ),
+
SPRUCE_FENCE_GATE( 183, "minecraft:spruce_fence_gate", 0, MaterialType.BLOCK ),
BIRCH_FENCE_GATE( 184, "minecraft:birch_fence_gate", 0, MaterialType.BLOCK ),
JUNGLE_FENCE_GATE( 185, "minecraft:jungle_fence_gate", 0, MaterialType.BLOCK ),
@@ -415,7 +486,7 @@ public enum BlockType {
PURPUR_BLOCK( 201, "minecraft:purpur_block", 0, MaterialType.BLOCK ),
PURPUR_PILLAR( 202, "minecraft:purpur_pillar", 0, MaterialType.BLOCK ),
PURPUR_STAIRS( 203, "minecraft:purpur_stairs", 0, MaterialType.BLOCK ),
- PURPUR_DOUBLE_SLAB( 204, "minecraft:purpur_double_slab", 0, MaterialType.BLOCK ),
+
PURPUR_SLAB( 205, "minecraft:purpur_slab", 0, MaterialType.BLOCK ),
END_STONE_BRICKS( 206, "minecraft:end_bricks", 0, MaterialType.BLOCK ),
BEETROOT_BLOCK( 207, "minecraft:beetroots", 0, MaterialType.BLOCK ),
@@ -509,7 +580,7 @@ public enum BlockType {
MILK_BUCKET( 335, "minecraft:milk_bucket", 0 ),
BRICK( 336, "minecraft:brick", 0, MaterialType.BLOCK ),
CLAY_BALL( 337, "minecraft:clay_ball", 0 ),
- SUGAR_CANES_ITEM( 338, "minecraft:reeds", 0, MaterialType.BLOCK ),
+ SUGAR_CANES_ITEM( 338, "minecraft:reeds", 0, MaterialType.BLOCK, "SUGAR_CANE" ),
PAPER( 339, "minecraft:paper", 0 ),
BOOK( 340, "minecraft:book", 0 ),
SLIMEBALL( 341, "minecraft:slime_ball", 0 ),
@@ -526,11 +597,15 @@ public enum BlockType {
PUFFERFISH( 349, "minecraft:fish", 3 ),
COOKED_FISH( 350, "minecraft:cooked_fish", 0 ),
COOKED_SALMON( 350, "minecraft:cooked_fish", 1 ),
+
INK_SACK( 351, "minecraft:dye", 0 ),
ROSE_RED( 351, "minecraft:dye", 1 ),
CACTUS_GREEN( 351, "minecraft:dye", 2 ),
COCO_BEANS( 351, "minecraft:dye", 3 ),
+
+ // NOTE: May actually be minecraft:ink_sack which is what XMaterial uses?
LAPIS_LAZULI( 351, "minecraft:dye", 4 ),
+
PURPLE_DYE( 351, "minecraft:dye", 5 ),
CYAN_DYE( 351, "minecraft:dye", 6 ),
LIGHT_GRAY_DYE( 351, "minecraft:dye", 7 ),
@@ -542,6 +617,8 @@ public enum BlockType {
MAGENTA_DYE( 351, "minecraft:dye", 13 ),
ORANGE_DYE( 351, "minecraft:dye", 14 ),
BONE_MEAL( 351, "minecraft:dye", 15 ),
+
+
BONE( 352, "minecraft:bone", 0 ),
SUGAR( 353, "minecraft:sugar", 0 ),
CAKE( 354, "minecraft:cake", 0 ),
@@ -628,7 +705,7 @@ public enum BlockType {
ENCHANTED_BOOK( 403, "minecraft:enchanted_book", 0 ),
REDSTONE_COMPARATOR( 404, "minecraft:comparator", 0, MaterialType.BLOCK ),
NETHER_BRICK_ITEM( 405, "minecraft:netherbrick", 0, MaterialType.BLOCK ),
- NETHER_QUARTZ( 406, "minecraft:quartz", 0, MaterialType.BLOCK ),
+ NETHER_QUARTZ( 406, "minecraft:quartz", 0 ),
MINECART_WITH_TNT( 407, "minecraft:tnt_minecart", 0 ),
MINECART_WITH_HOPPER( 408, "minecraft:hopper_minecart", 0 ),
PRISMARINE_SHARD( 409, "minecraft:prismarine_shard", 0 ),
@@ -683,6 +760,32 @@ public enum BlockType {
DISC_11( 2266, "minecraft:record_11", 0 ),
WAIT_DISC( 2267, "minecraft:record_wait", 0 ),
+
+// Testing to see if we can inject 1.13 block types: :( nope... does not work.
+// Commenting out for now, will revisit later.
+//
+// AIR_113( "air", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+//
+// QUARTZ_113( "quartz", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+// NETHER_QUARTZ_ORE_113( "nether_quartz_ore", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+// QUARTZ_BLOCK_113( "quartz_block", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+// CHISELED_QUARTZ_BLOCK_113( "chiseled_quartz_block", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+// QUARTZ_PILLAR_113( "quartz_pillar", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+// QUARTZ_SLAB_113( "quartz_slab", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+// SMOOTH_QUARTZ_113( "smooth_quartz", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+//
+// OAK_LOG_113( "oak_log", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+// SPRUCE_LOG_113( "spruce_log", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+// BIRCH_LOG_113( "birch_log", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+// JUNGLE_LOG_113( "jungle_log", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+//
+// OAK_WOOD_113( "oak_wood", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+// SPRUCE_WOOD_113( "spruce_wood", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+// BIRCH_WOOD_113( "birch_wood", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+// JUNGLE_WOOD_113( "jungle_wood", MaterialType.BLOCK, MaterialVersion.v1_13 ),
+//
+
+
;
// @formatter:on
@@ -690,13 +793,41 @@ public enum BlockType {
private final String id;
private final short data;
private final MaterialType materialType;
+ private final MaterialVersion materialVersion;
+
+ private final List altNames;
BlockType(int legacyId, String id, int data, MaterialType materialType) {
this.legacyId = legacyId;
this.id = (id != null ? id : "minecraft:" + this.name().toLowerCase());
this.data = (short) data;
this.materialType = materialType;
+ this.materialVersion = MaterialVersion.v1_8;
+
+ this.altNames = new ArrayList<>();
+ }
+
+
+ BlockType(int legacyId, String id, int data, MaterialType materialType, String... altNames) {
+ this( legacyId, id, data, materialType );
+
+ for ( String altName : altNames ) {
+ this.altNames.add( altName );
+ }
}
+
+
+
+ BlockType(String id, MaterialType materialType, MaterialVersion materialVersion ) {
+ this.legacyId = -1;
+ this.id = (id != null ? id : "minecraft:" + this.name().toLowerCase());
+ this.data = 0;
+ this.materialType = materialType;
+ this.materialVersion = materialVersion;
+
+ this.altNames = new ArrayList<>();
+ }
+
BlockType(MaterialType materialType) {
this(0, null, 0, materialType);
}
@@ -709,6 +840,41 @@ public enum BlockType {
this(legacyId, id, data, MaterialType.NOT_SET);
}
+ /**
+ * This function is for legacy versions of spigot that
+ * uses the data value. This function will returns a
+ * string value of a material name that
+ * XMaterial will be able to use to look up the correct
+ * bukkit material type.
+ *
+ *
+ * The way it needs to be constructed, is by taking the id,
+ * dropping the "minecraft:" prefix, then if data is non-zero,
+ * add a colon and the value of data.
+ *
+ *
+ *
+ * @return
+ */
+ public String getXMaterialNameLegacy() {
+ String xMatName = getId().replace( "minecraft:", "" ) +
+ ( getData() > 0 ? ":" + getData() : "" );
+ return xMatName;
+ }
+
+ /**
+ * This function will return the lower case name of the BlockType.
+ * This should match
+ * @return
+ */
+ public String getXMaterialName() {
+ return name().toLowerCase();
+ }
+
+ public List getXMaterialAltNames() {
+ return getAltNames();
+ }
+
public static BlockType getBlock(int legacyId) {
return getBlock(legacyId, (short) 0);
}
@@ -737,6 +903,9 @@ public static BlockType getBlock(String key) {
if ( blockType == null ) {
blockType = getBlockById( key );
}
+ if ( blockType == null ) {
+ blockType = getBlockByXMaterialName(key);
+ }
return blockType;
}
@@ -763,7 +932,7 @@ private static BlockType getBlockById(String id) {
Short.parseShort(id.split(":")[1]));
}
Prison prison = Prison.get();
- if ( prison != null && prison.getIntegrationManager() != null ) {
+ if ( prison != null && prison.getItemManager() != null ) {
Set>> entrySet = prison.getItemManager().getItems().entrySet();
for (Map.Entry> entry : entrySet) {
if (entry.getValue().contains(id.toLowerCase())) {
@@ -784,6 +953,21 @@ private static BlockType getBlockByName(String name) {
}
return null;
}
+
+ private static BlockType getBlockByXMaterialName(String name) {
+ for (BlockType block : values()) {
+ if (block.getXMaterialAltNames().size() > 0 ) {
+ for ( String altName : block.getXMaterialAltNames() ) {
+
+ if ( altName.equalsIgnoreCase(name)) {
+ return block;
+ }
+ }
+ }
+
+ }
+ return null;
+ }
public static BlockType getBlockWithData(int id, short data) {
for (BlockType block : values()) {
@@ -820,11 +1004,18 @@ public boolean isItem() {
return materialType == MaterialType.ITEM;
}
- public MaterialType getMaterialType()
- {
+ public MaterialType getMaterialType() {
return materialType;
}
+ public MaterialVersion getMaterialVersion() {
+ return materialVersion;
+ }
+
+ public List getAltNames() {
+ return altNames;
+ }
+
@Override public String toString() {
return id + ":" + data;
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/Bounds.java b/prison-core/src/main/java/tech/mcprison/prison/util/Bounds.java
index 56b363cd4..65128dbda 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/util/Bounds.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/Bounds.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -18,6 +18,8 @@
package tech.mcprison.prison.util;
+import tech.mcprison.prison.internal.World;
+
/**
* Represents the area between two {@link Location}s.
*
@@ -68,6 +70,21 @@ public Bounds(Location min, Location max) {
(getzBlockMax() - getzBlockMin() + 1);
}
+ public void setWorld( World world ) {
+ if ( world != null ) {
+
+ if ( getMin().getWorld() == null ) {
+ getMin().setWorld( world );
+ }
+ if ( getMax().getWorld() == null ) {
+ getMax().setWorld( world );
+ }
+ if ( getCenter().getWorld() == null ) {
+ getCenter().setWorld( world );
+ }
+ }
+ }
+
/**
* Returns the width of the area.
* This will always be positive.
@@ -109,6 +126,14 @@ public double getArea() {
+ getHeight() * getWidth());
}
+ public boolean within(Location location) {
+ return within( location, false );
+ }
+
+ public boolean withinIncludeTopOfMine(Location location) {
+ return within( location, true );
+ }
+
/**
* Returns whether or not a single point is within these boundaries. Ensure the same worlds
* are being compared too.
@@ -120,30 +145,90 @@ public double getArea() {
* @param location The {@link Location} to check.
* @return true if the location is within the bounds, false otherwise.
*/
- public boolean within(Location location) {
+ private boolean within(Location location, boolean includeTopOfMine ) {
boolean results = false;
- // TODO fix Bounds.within() get working with junit tests (currently it won't run) until then cannot test changes:
- // If the worlds don't match, then don't waste time calculating if the passed
- // location is within the Bounds. Some unit tests pass in nulls.
-// if ( min.getWorld() == null && max.getWorld() == null && location.getWorld() == null ||
-// min.getWorld() != null && max.getWorld() != null && location.getWorld() != null &&
-// min.getWorld().getName().equalsIgnoreCase( max.getWorld().getName()) &&
-// min.getWorld().getName().equalsIgnoreCase( location.getWorld().getName() )) {
-
+ if ( withinSameWorld( location )) {
double ourX = Math.floor(location.getX());
double ourY = Math.floor(location.getY());
double ourZ = Math.floor(location.getZ());
results = ourX >= getxMin() && ourX <= getxMax() // Within X
- && ourY >= (getyMin() - 1) && ourY <= getyMax() // Within Y
+ && ourY >= (getyMin() - 1) && ourY <= (getyMax() + (includeTopOfMine ? 1 : 0)) // Within Y
&& ourZ >= getzMin() && ourZ <= getzMax(); // Within Z
-// }
+ }
return results;
}
+
+ public boolean withinSameWorld(Location location) {
+ return getCenter().getWorld() != null && location.getWorld() != null &&
+ getCenter().getWorld().getName().equalsIgnoreCase(
+ location.getWorld().getName() );
+ }
+
+ /**
+ * This function will determine if the given location is within a radius of the Bounds'
+ * center. This will return a true or false value.
+ *
+ *
+ * To keep the calculations simple, if the worlds are the same, then it will create a new
+ * Bounds object and then utilize the computed values for width and length by feeding it in
+ * to a Pythagorean theorem to compute the hypotenuse (distance) between these two points.
+ * There maybe other unused values calculated, but going for the simplicity of reusing existing code.
+ *
+ *
+ * @param location
+ * @param radius
+ * @return
+ */
+ public boolean within(Location location, long radius) {
+ boolean results = false;
+
+ if ( withinSameWorld( location ) ) {
+
+ // Ignore y since this is radius from the center axis of the mine:
+ double distance = getDistance(location);
+
+ results = distance <= radius;
+ }
+
+ return results;
+ }
+ /**
+ * Ignore Y since this is the radius from the center axis of the mine.
+ *
+ * @return
+ */
+ public double getDistance() {
+ double deltaX = getMin().getX() - getMax().getX();
+ double deltaZ = getMin().getZ() - getMax().getZ();
+ double distance = Math.sqrt( (deltaX * deltaX) + (deltaZ * deltaZ) );
+ return Math.round( distance );
+ }
+
+ public double getDistance(Location location) {
+ double deltaX = getCenter().getX() - location.getX();
+ double deltaZ = getCenter().getZ() - location.getZ();
+ double distance = Math.sqrt( (deltaX * deltaX) + (deltaZ * deltaZ) );
+ return Math.round( distance );
+ }
+
+ public double getDistance3d(Location location) {
+ double deltaX = getCenter().getX() - location.getX();
+ double deltaY = getCenter().getY() - location.getY();
+ double deltaZ = getCenter().getZ() - location.getZ();
+ double distance = Math.sqrt( (deltaX * deltaX) + (deltaY * deltaY) + (deltaZ * deltaZ) );
+ return distance;
+ }
+
+ public String getDimensions() {
+ return "&7" + Math.round(getWidth()) + "&8x&7" +
+ Math.round(getHeight()) + "&8x&7" + Math.round(getLength());
+ }
+
public Location getMin() {
return min;
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/ChatColor.java b/prison-core/src/main/java/tech/mcprison/prison/util/ChatColor.java
index bf8cbcb0b..cba2bd4c1 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/util/ChatColor.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/ChatColor.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/ClassUtil.java b/prison-core/src/main/java/tech/mcprison/prison/util/ClassUtil.java
index f838555c2..1e48a49b9 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/util/ClassUtil.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/ClassUtil.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/CollectionUtil.java b/prison-core/src/main/java/tech/mcprison/prison/util/CollectionUtil.java
index 722776293..bc66ecbec 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/util/CollectionUtil.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/CollectionUtil.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/EventExceptionHandler.java b/prison-core/src/main/java/tech/mcprison/prison/util/EventExceptionHandler.java
index 5b0e8a91a..d98a1082f 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/util/EventExceptionHandler.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/EventExceptionHandler.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/Gamemode.java b/prison-core/src/main/java/tech/mcprison/prison/util/Gamemode.java
index 84c1ffd46..3160500af 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/util/Gamemode.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/Gamemode.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/ItemManager.java b/prison-core/src/main/java/tech/mcprison/prison/util/ItemManager.java
index 4758ffa73..ddd9b60fb 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/util/ItemManager.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/ItemManager.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -43,25 +43,39 @@ public ItemManager() throws Exception {
items = ArrayListMultimap.create();
if (!file.exists()) {
- InputStream inputStream = getClass().getResourceAsStream("/items.csv");
- Files.copy(inputStream, Paths.get(file.getPath()));
- }
- BufferedReader in = new BufferedReader(new FileReader(file));
- String inputLine;
-
- while ((inputLine = in.readLine()) != null) {
- try {
- if (!inputLine.startsWith("#")) {
- String[] array = inputLine.split(",");
- String itemName = array[0];
- int id = Integer.parseInt(array[1]);
- short data = Short.parseShort(array[2]);
- items.put(BlockType.getBlockWithData(id, data), itemName.toLowerCase());
- }
- } catch (Exception e) {
- throw new IOException("Error while reading items.csv -- it's probably invalid", e);
+ try (
+ // make sure the InputStream is properly closed. May not be 100% needed here:
+ InputStream inputStream = getClass().getResourceAsStream("/items.csv");
+ )
+ {
+ Files.copy(inputStream, Paths.get(file.getPath()));
+ }
+ catch (Exception e) {
+ throw new IOException("Error while copying items.csv from the jar resource to a " +
+ "file within the plugins directory:", e);
}
}
+ try (
+ // Was a memory leak... always must be closed, so the try with resource ensures that it is:
+ BufferedReader in = new BufferedReader(new FileReader(file));
+ )
+ {
+ String inputLine;
+
+ while ((inputLine = in.readLine()) != null) {
+ if (!inputLine.startsWith("#")) {
+ String[] array = inputLine.split(",");
+ String itemName = array[0];
+ int id = Integer.parseInt(array[1]);
+ short data = Short.parseShort(array[2]);
+ items.put(BlockType.getBlockWithData(id, data), itemName.toLowerCase());
+ }
+ }
+
+ }
+ catch (Exception e) {
+ throw new IOException("Error while reading items.csv -- it's probably invalid", e);
+ }
}
public Map> getItems() {
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/Location.java b/prison-core/src/main/java/tech/mcprison/prison/util/Location.java
index 1953209a4..7e106f77f 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/util/Location.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/Location.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/MaterialType.java b/prison-core/src/main/java/tech/mcprison/prison/util/MaterialType.java
index 32088a362..7776831f4 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/util/MaterialType.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/MaterialType.java
@@ -5,5 +5,8 @@ public enum MaterialType
BLOCK,
ITEM,
- NOT_SET;
+ NOT_SET,
+
+ INVALID;
+
}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/MaterialVersion.java b/prison-core/src/main/java/tech/mcprison/prison/util/MaterialVersion.java
new file mode 100644
index 000000000..3c2dc4600
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/MaterialVersion.java
@@ -0,0 +1,9 @@
+package tech.mcprison.prison.util;
+
+public enum MaterialVersion
+{
+ v1_8,
+
+ v1_13
+ ;
+}
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/Scoreboard.java b/prison-core/src/main/java/tech/mcprison/prison/util/Scoreboard.java
index de45b73cc..079fe3da1 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/util/Scoreboard.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/Scoreboard.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/Text.java b/prison-core/src/main/java/tech/mcprison/prison/util/Text.java
index 08fc10d65..1c91a43f5 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/util/Text.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/Text.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/Vector.java b/prison-core/src/main/java/tech/mcprison/prison/util/Vector.java
index 6e4531b26..6c404219c 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/util/Vector.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/Vector.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/util/package-info.java
index c46e52677..4dc47e8f2 100644
--- a/prison-core/src/main/java/tech/mcprison/prison/util/package-info.java
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/package-info.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/main/resources/lang/mines/de_DE.properties b/prison-core/src/main/resources/lang/mines/de_DE.properties
index 37a67732a..0a537d40c 100644
--- a/prison-core/src/main/resources/lang/mines/de_DE.properties
+++ b/prison-core/src/main/resources/lang/mines/de_DE.properties
@@ -1,5 +1,5 @@
-reset_warning=&7Alle Minen wurden zurückgesetzt in &3%1&7.
-reset_message=&7Alle Minen wurden zurückgesetzt.
+reset_warning=&7Alle Minen %1 wurden zurückgesetzt in &3%2&7.
+reset_message=&7Alle Minen %1 wurden zurückgesetzt.
not_allowed=&7Hier darfst du nicht verminen.
autosmelt_enable=&bAutosmelt &7wurde aktiviert.
autosmelt_disable=&bAutosmelt &7wurde deaktiviert.
diff --git a/prison-core/src/main/resources/lang/mines/en_US.properties b/prison-core/src/main/resources/lang/mines/en_US.properties
index 5d598f11e..14ccbcc4c 100644
--- a/prison-core/src/main/resources/lang/mines/en_US.properties
+++ b/prison-core/src/main/resources/lang/mines/en_US.properties
@@ -1,5 +1,5 @@
-reset_warning=&7All mines are going to reset in &3%1&7.
-reset_message=&7All mines have been reset.
+reset_warning=&7Mine %1 will reset in &3%2&7.
+reset_message=&7The mine %1 has been reset.
not_allowed=&7You are not allowed to mine here.
autosmelt_enable=&bAutosmelt &7has been &aenabled&7.
autosmelt_disable=&bAutosmelt &7has been &cdisabled&7.
diff --git a/prison-core/src/main/resources/lang/mines/es_ES.properties b/prison-core/src/main/resources/lang/mines/es_ES.properties
index debb27447..2dc813912 100644
--- a/prison-core/src/main/resources/lang/mines/es_ES.properties
+++ b/prison-core/src/main/resources/lang/mines/es_ES.properties
@@ -1,5 +1,5 @@
-reset_warning=&7Todas las minas se reiniciarán en &3%1&7.
-reset_message=&7Todas las minas han sido reiniciadas.
+reset_warning=&7Todas las minas %1 se reiniciarán en &3%2&7.
+reset_message=&7Todas las minas %1 han sido reiniciadas.
not_allowed=&7No tienes permitido minar aquí.
autosmelt_enable=&7La &bFundición Automática &7ha sido &aactivada&7.
autosmelt_disable=&7La &bFundición Automática &7ha sido &cdesactivada&7.
diff --git a/prison-core/src/main/resources/lang/mines/hu_HU.properties b/prison-core/src/main/resources/lang/mines/hu_HU.properties
index dd31c9e56..ea5eb56f2 100644
--- a/prison-core/src/main/resources/lang/mines/hu_HU.properties
+++ b/prison-core/src/main/resources/lang/mines/hu_HU.properties
@@ -1,5 +1,5 @@
-reset_warning=&7Minden bánya újratöltve &3%1&7.
-reset_message=&7Az összes bánya vissza lett állítva.
+reset_warning=&7Minden %1 bánya újratöltve &3%2&7.
+reset_message=&7Az összes %1 bánya vissza lett állítva.
not_allowed=&7A bányászás nem megengedett.
autosmelt_enable=&bAz auto. égetés &7engedélyezve.
autosmelt_disable=&bAz auto. égetés &7letiltva.
diff --git a/prison-core/src/main/resources/lang/mines/it_IT.properties b/prison-core/src/main/resources/lang/mines/it_IT.properties
index 787ef0df3..a5c964e2d 100644
--- a/prison-core/src/main/resources/lang/mines/it_IT.properties
+++ b/prison-core/src/main/resources/lang/mines/it_IT.properties
@@ -1,5 +1,5 @@
-reset_warning=&7Tutte le miniere stanno per essere resettate tra &3%1&7.
-reset_message=&7Tutte le miniere sono state resettate.
+reset_warning=&7Tutte le miniere %1 stanno per essere resettate tra &3%2&7.
+reset_message=&7Tutte le miniere %1 sono state resettate.
not_allowed=&7Non sei ammesso a scvare qua.
autosmelt_enable=&bAutoFusione &7è stata &aabilitata&7.
autosmelt_disable=&bAutoFusione &7è stata &cdisabilitata&7.
diff --git a/prison-core/src/main/resources/lang/mines/nl_BE.properties b/prison-core/src/main/resources/lang/mines/nl_BE.properties
index 0d04c4245..c165f1e2e 100644
--- a/prison-core/src/main/resources/lang/mines/nl_BE.properties
+++ b/prison-core/src/main/resources/lang/mines/nl_BE.properties
@@ -1,5 +1,5 @@
-reset_warning=&Alle mijnen worden hersteld in &3%1&7.
-reset_message=&7Alle mijnen zijn hersteld.
+reset_warning=&Alle mijnen %1 worden hersteld in &3%2&7.
+reset_message=&7Alle mijnen %1 zijn hersteld.
not_allowed=&7Je mag hier niet mijnen.
autosmelt_enable=&bAutosmelt &7is aangezet.
autosmelt_disable=&bAutosmelt &7is afgezet.
diff --git a/prison-core/src/main/resources/lang/mines/nl_NL.properties b/prison-core/src/main/resources/lang/mines/nl_NL.properties
index 0d04c4245..c165f1e2e 100644
--- a/prison-core/src/main/resources/lang/mines/nl_NL.properties
+++ b/prison-core/src/main/resources/lang/mines/nl_NL.properties
@@ -1,5 +1,5 @@
-reset_warning=&Alle mijnen worden hersteld in &3%1&7.
-reset_message=&7Alle mijnen zijn hersteld.
+reset_warning=&Alle mijnen %1 worden hersteld in &3%2&7.
+reset_message=&7Alle mijnen %1 zijn hersteld.
not_allowed=&7Je mag hier niet mijnen.
autosmelt_enable=&bAutosmelt &7is aangezet.
autosmelt_disable=&bAutosmelt &7is afgezet.
diff --git a/prison-core/src/test/java/tech/mcprison/prison/TestPlatform.java b/prison-core/src/test/java/tech/mcprison/prison/TestPlatform.java
index 7b615fb74..29ad335dd 100644
--- a/prison-core/src/test/java/tech/mcprison/prison/TestPlatform.java
+++ b/prison-core/src/test/java/tech/mcprison/prison/TestPlatform.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -18,22 +18,35 @@
package tech.mcprison.prison;
+import java.io.File;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.TreeMap;
+import java.util.UUID;
+
+import tech.mcprison.prison.PrisonCommand.RegisteredPluginsData;
import tech.mcprison.prison.commands.PluginCommand;
import tech.mcprison.prison.file.FileStorage;
+import tech.mcprison.prison.file.YamlFileIO;
import tech.mcprison.prison.gui.GUI;
+import tech.mcprison.prison.integration.IntegrationManager.PlaceHolderFlags;
+import tech.mcprison.prison.integration.Placeholders;
+import tech.mcprison.prison.internal.CommandSender;
import tech.mcprison.prison.internal.Player;
import tech.mcprison.prison.internal.Scheduler;
import tech.mcprison.prison.internal.World;
+import tech.mcprison.prison.internal.block.PrisonBlock;
import tech.mcprison.prison.internal.platform.Capability;
import tech.mcprison.prison.internal.platform.Platform;
import tech.mcprison.prison.internal.scoreboard.ScoreboardManager;
+import tech.mcprison.prison.output.ChatDisplay;
import tech.mcprison.prison.store.Storage;
import tech.mcprison.prison.util.ChatColor;
import tech.mcprison.prison.util.Location;
-import java.io.File;
-import java.util.*;
-
/**
* @author Faizaan A. Datoo
*/
@@ -51,6 +64,11 @@ public TestPlatform(File pluginDirectory, boolean suppressOutput) {
return Optional.of(new TestWorld(name));
}
+ @Override
+ public void getWorldLoadErrors( ChatDisplay display ) {
+
+ }
+
@Override public Optional getPlayer(String name) {
return null;
}
@@ -63,7 +81,17 @@ public TestPlatform(File pluginDirectory, boolean suppressOutput) {
return new ArrayList<>();
}
- @Override public String getPluginVersion() {
+ @Override
+ public Optional getOfflinePlayer( String name ) {
+ return null;
+ }
+
+ @Override
+ public Optional getOfflinePlayer( UUID uuid ) {
+ return null;
+ }
+
+ @Override public String getPluginVersion() {
return "Tests";
}
@@ -91,7 +119,11 @@ public boolean shouldShowAlerts() {
@Override public void dispatchCommand(String cmd) {
}
- @Override public Scheduler getScheduler() {
+ @Override
+ public void dispatchCommand( CommandSender sender, String cmd ) {
+ }
+
+ @Override public Scheduler getScheduler() {
return new TestScheduler();
}
@@ -134,4 +166,77 @@ public boolean shouldShowAlerts() {
return new FileStorage(getPluginDirectory());
}
+ @Override
+ public void identifyRegisteredPlugins() {
+ PrisonCommand cmdVersion = Prison.get().getPrisonCommands();
+
+ // reset so it will reload cleanly:
+ cmdVersion.getRegisteredPluginData().clear();
+
+ RegisteredPluginsData rpd1 = cmdVersion.addRegisteredPlugin( "TestPlugin", "3.2.1-alpha.13" );
+ RegisteredPluginsData rpd2 = cmdVersion.addRegisteredPlugin( "AnotherPlugin", "0.1.1" );
+
+ cmdVersion.addPluginDetails( rpd1.getPluginName(), rpd1.getPluginVersion(), "lol", new ArrayList<>() );
+ cmdVersion.addPluginDetails( rpd2.getPluginName(), rpd2.getPluginVersion(), "crime", new ArrayList<>() );
+ cmdVersion.addPluginDetails( rpd2.getPluginName(), rpd2.getPluginVersion(), "justice", new ArrayList<>() );
+ }
+
+
+
+ public Map getPlaceholderDetailCounts() {
+ Map placeholderDetails = new TreeMap<>();
+
+ return placeholderDetails;
+ }
+
+ public int getPlaceholderCount() {
+ return 0;
+ }
+
+
+ public int getPlaceholderRegistrationCount() {
+ return 0;
+ }
+
+
+ @Override
+ public Placeholders getPlaceholders() {
+ return null;
+ }
+
+
+ @Override
+ public YamlFileIO getYamlFileIO( File yamlFile ) {
+ return null;
+ }
+
+ @Override
+ public void reloadConfig() {
+ }
+
+ @Override
+ public String getConfigString( String key ) {
+ return null;
+ }
+
+ @Override
+ public boolean getConfigBooleanFalse( String key ) {
+ return false;
+ }
+
+ @Override
+ public boolean getConfigBooleanTrue( String key ) {
+ return false;
+ }
+
+ @Override
+ public void getAllPlatformBlockTypes( List blockTypes ) {
+
+ }
+
+
+ @Override
+ public PrisonBlock getPrisonBlock( String blockName ) {
+ return null;
+ }
}
diff --git a/prison-core/src/test/java/tech/mcprison/prison/TestPlayer.java b/prison-core/src/test/java/tech/mcprison/prison/TestPlayer.java
index 5bc994942..c005e6419 100644
--- a/prison-core/src/test/java/tech/mcprison/prison/TestPlayer.java
+++ b/prison-core/src/test/java/tech/mcprison/prison/TestPlayer.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/test/java/tech/mcprison/prison/TestWorld.java b/prison-core/src/test/java/tech/mcprison/prison/TestWorld.java
index 05ea3709d..bf17f16c7 100644
--- a/prison-core/src/test/java/tech/mcprison/prison/TestWorld.java
+++ b/prison-core/src/test/java/tech/mcprison/prison/TestWorld.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/test/java/tech/mcprison/prison/autofeatures/ValueNodeFactoryTest.java b/prison-core/src/test/java/tech/mcprison/prison/autofeatures/ValueNodeFactoryTest.java
new file mode 100644
index 000000000..0d509ec6e
--- /dev/null
+++ b/prison-core/src/test/java/tech/mcprison/prison/autofeatures/ValueNodeFactoryTest.java
@@ -0,0 +1,261 @@
+package tech.mcprison.prison.autofeatures;
+
+import static org.junit.Assert.*;
+
+import org.junit.Test;
+
+public class ValueNodeFactoryTest
+ extends
+ ValueNodeFactory
+{
+
+ @Test
+ public void testNormalValues()
+ {
+ {
+ ValueNode vn = getValueNode( null );
+ assertNotNull( vn );
+ assertTrue( vn.isNullNode() );
+ assertTrue( vn instanceof NullNode );
+ assertTrue( ((NullNode) vn).isNull() );
+ }
+
+ {
+ ValueNode vn = getValueNode( "true" );
+ assertNotNull( vn );
+ assertTrue( vn.isBooleanNode() );
+ assertTrue( vn instanceof BooleanNode );
+ assertTrue( ((BooleanNode) vn).getValue() );
+ }
+
+ {
+ ValueNode vn = getValueNode( "false" );
+ assertNotNull( vn );
+ assertTrue( vn.isBooleanNode() );
+ assertTrue( vn instanceof BooleanNode );
+ assertFalse( ((BooleanNode) vn).getValue() );
+ }
+
+ {
+ ValueNode vn = getValueNode( "1" );
+ assertNotNull( vn );
+ assertTrue( vn.isLongNode() );
+ assertTrue( vn instanceof LongNode );
+ assertEquals( 1L, ((LongNode) vn).getValue() );
+ }
+
+ {
+ ValueNode vn = getValueNode( "123456789" );
+ assertNotNull( vn );
+ assertTrue( vn.isLongNode() );
+ assertTrue( vn instanceof LongNode );
+ assertEquals( 123456789L, ((LongNode) vn).getValue() );
+ }
+
+ {
+ ValueNode vn = getValueNode( "-123456789" );
+ assertNotNull( vn );
+ assertTrue( vn.isLongNode() );
+ assertTrue( vn instanceof LongNode );
+ assertEquals( -123456789L, ((LongNode) vn).getValue() );
+ }
+
+ {
+ ValueNode vn = getValueNode( "0.0" );
+ assertNotNull( vn );
+ assertTrue( vn.isDoubleNode() );
+ assertTrue( vn instanceof DoubleNode );
+ assertEquals( 0d, ((DoubleNode) vn).getValue(), 0.01 );
+ }
+
+ {
+ ValueNode vn = getValueNode( "0.001" );
+ assertNotNull( vn );
+ assertTrue( vn.isDoubleNode() );
+ assertTrue( vn instanceof DoubleNode );
+ assertEquals( 0.001d, ((DoubleNode) vn).getValue(), 0.0001 );
+ }
+
+ {
+ ValueNode vn = getValueNode( "1234567.8901" );
+ assertNotNull( vn );
+ assertTrue( vn.isDoubleNode() );
+ assertTrue( vn instanceof DoubleNode );
+ assertEquals( 1234567.8901d, ((DoubleNode) vn).getValue(), 0.001 );
+ }
+
+ {
+ ValueNode vn = getValueNode( "-1234567.8901" );
+ assertNotNull( vn );
+ assertTrue( vn.isDoubleNode() );
+ assertTrue( vn instanceof DoubleNode );
+ assertEquals( -1234567.8901d, ((DoubleNode) vn).getValue(), 0.001 );
+ }
+
+ {
+ // NOTE: Cannot parse scientific notation:
+ ValueNode vn = getValueNode( "123.45E2" );
+ assertNotNull( vn );
+ assertFalse( vn.isDoubleNode() );
+ assertTrue( vn.isTextNode() );
+ assertTrue( vn instanceof TextNode );
+// assertEquals( 12345.0d, ((DoubleNode) vn).getValue(), 0.01 );
+ }
+
+
+ {
+ ValueNode vn = getValueNode( "" );
+ assertNotNull( vn );
+ assertTrue( vn.isTextNode() );
+ assertTrue( vn instanceof TextNode );
+ assertEquals( "", ((TextNode) vn).getValue() );
+ }
+
+ {
+ // Note: Leading and trailing spaces are removed.
+ ValueNode vn = getValueNode( " test " );
+ assertNotNull( vn );
+ assertTrue( vn.isTextNode() );
+ assertTrue( vn instanceof TextNode );
+ assertEquals( "test", ((TextNode) vn).getValue() );
+ }
+
+ {
+ ValueNode vn = getValueNode( "test 123" );
+ assertNotNull( vn );
+ assertTrue( vn.isTextNode() );
+ assertTrue( vn instanceof TextNode );
+ assertEquals( "test 123", ((TextNode) vn).getValue() );
+ }
+
+
+
+
+ }
+
+ /**
+ * The purpose of these tests are to try to test the edge cases of what may not
+ * be normally encountered.
+ */
+ @Test
+ public void testStrangeValues()
+ {
+ // null is null, so nothing else to test with NullNode.
+
+ {
+ ValueNode vn = getValueNode( " true" );
+ assertNotNull( vn );
+ assertTrue( vn.isBooleanNode() );
+ assertTrue( vn instanceof BooleanNode );
+ assertTrue( ((BooleanNode) vn).getValue() );
+ }
+
+ {
+ ValueNode vn = getValueNode( " false " );
+ assertNotNull( vn );
+ assertTrue( vn.isBooleanNode() );
+ assertTrue( vn instanceof BooleanNode );
+ assertFalse( ((BooleanNode) vn).getValue() );
+ }
+
+ {
+ ValueNode vn = getValueNode( " 1 " );
+ assertNotNull( vn );
+ assertTrue( vn.isLongNode() );
+ assertTrue( vn instanceof LongNode );
+ assertEquals( 1L, ((LongNode) vn).getValue() );
+ }
+
+ {
+ // Expected fail: No space between number and sign
+ ValueNode vn = getValueNode( " - 123456789 " );
+ assertNotNull( vn );
+ assertFalse( vn.isLongNode() );
+ assertTrue( vn.isTextNode() );
+// assertTrue( vn instanceof LongNode );
+// assertEquals( 123456789L, ((LongNode) vn).getValue() );
+ }
+
+ {
+ // Expected fail: No double signs
+ ValueNode vn = getValueNode( "-123456789-" );
+ assertNotNull( vn );
+ assertFalse( vn.isLongNode() );
+ assertTrue( vn.isTextNode() );
+// assertTrue( vn instanceof LongNode );
+// assertEquals( -123456789L, ((LongNode) vn).getValue() );
+ }
+
+ {
+ ValueNode vn = getValueNode( "0.0" );
+ assertNotNull( vn );
+ assertTrue( vn.isDoubleNode() );
+ assertTrue( vn instanceof DoubleNode );
+ assertEquals( 0d, ((DoubleNode) vn).getValue(), 0.01 );
+ }
+
+ {
+ ValueNode vn = getValueNode( "0.001" );
+ assertNotNull( vn );
+ assertTrue( vn.isDoubleNode() );
+ assertTrue( vn instanceof DoubleNode );
+ assertEquals( 0.001d, ((DoubleNode) vn).getValue(), 0.0001 );
+ }
+
+ {
+ ValueNode vn = getValueNode( "1234567.8901" );
+ assertNotNull( vn );
+ assertTrue( vn.isDoubleNode() );
+ assertTrue( vn instanceof DoubleNode );
+ assertEquals( 1234567.8901d, ((DoubleNode) vn).getValue(), 0.001 );
+ }
+
+ {
+ ValueNode vn = getValueNode( "-1234567.8901" );
+ assertNotNull( vn );
+ assertTrue( vn.isDoubleNode() );
+ assertTrue( vn instanceof DoubleNode );
+ assertEquals( -1234567.8901d, ((DoubleNode) vn).getValue(), 0.001 );
+ }
+
+ {
+ // NOTE: Cannot parse scientific notation:
+ ValueNode vn = getValueNode( "123.45E2" );
+ assertNotNull( vn );
+ assertFalse( vn.isDoubleNode() );
+ assertTrue( vn.isTextNode() );
+ assertTrue( vn instanceof TextNode );
+// assertEquals( 12345.0d, ((DoubleNode) vn).getValue(), 0.01 );
+ }
+
+
+ {
+ ValueNode vn = getValueNode( "" );
+ assertNotNull( vn );
+ assertTrue( vn.isTextNode() );
+ assertTrue( vn instanceof TextNode );
+ assertEquals( "", ((TextNode) vn).getValue() );
+ }
+
+ {
+ ValueNode vn = getValueNode( " test\n " );
+ assertNotNull( vn );
+ assertTrue( vn.isTextNode() );
+ assertTrue( vn instanceof TextNode );
+ assertEquals( "test", ((TextNode) vn).getValue() );
+ }
+
+ {
+ ValueNode vn = getValueNode( "test 123 " );
+ assertNotNull( vn );
+ assertTrue( vn.isTextNode() );
+ assertTrue( vn instanceof TextNode );
+ assertEquals( "test 123", ((TextNode) vn).getValue() );
+ }
+
+
+
+
+ }
+
+}
diff --git a/prison-core/src/test/java/tech/mcprison/prison/chat/ChatTest.java b/prison-core/src/test/java/tech/mcprison/prison/chat/ChatTest.java
index 4cdae7e92..34befeafe 100644
--- a/prison-core/src/test/java/tech/mcprison/prison/chat/ChatTest.java
+++ b/prison-core/src/test/java/tech/mcprison/prison/chat/ChatTest.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
diff --git a/prison-core/src/test/java/tech/mcprison/prison/selection/SelectionTest.java b/prison-core/src/test/java/tech/mcprison/prison/selection/SelectionTest.java
index c3ef286cf..b1d2a8bfa 100644
--- a/prison-core/src/test/java/tech/mcprison/prison/selection/SelectionTest.java
+++ b/prison-core/src/test/java/tech/mcprison/prison/selection/SelectionTest.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -44,7 +44,9 @@ public class SelectionTest {
@Rule public TemporaryFolder temporaryFolder = new TemporaryFolder();
@Before public void setUp() throws Exception {
- Prison.get().init(new TestPlatform(temporaryFolder.newFolder("test"), false));
+ TestPlatform testPlatform = new TestPlatform(temporaryFolder.newFolder("test"), false);
+ Prison.get()
+ .init(testPlatform, "1.12.X-test.1");
}
@Test public void testSelection() throws Exception {
diff --git a/prison-core/src/test/java/tech/mcprison/prison/util/BoundsTest.java b/prison-core/src/test/java/tech/mcprison/prison/util/BoundsTest.java
index 9dc9263f5..d7dc0a26c 100644
--- a/prison-core/src/test/java/tech/mcprison/prison/util/BoundsTest.java
+++ b/prison-core/src/test/java/tech/mcprison/prison/util/BoundsTest.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -44,11 +44,11 @@ public class BoundsTest {
}
@Test public void within() throws Exception {
-// TestWorld world1 = new TestWorld("test1");
+ TestWorld world1 = new TestWorld("test1");
// TestWorld world2 = new TestWorld("test2");
- Location loc1 = new Location(null, 0.0, 4.0, 0.0);
- Location loc2 = new Location(null, 10.0, 10.0, 10.0);
- Location loc3 = new Location(null, 5.0, 5.0, 5.0);
+ Location loc1 = new Location(world1, 0.0, 4.0, 0.0);
+ Location loc2 = new Location(world1, 10.0, 10.0, 10.0);
+ Location loc3 = new Location(world1, 5.0, 5.0, 5.0);
Bounds bounds = new Bounds(loc1, loc2);
Location toCheck = loc3;
diff --git a/prison-mines/build.gradle b/prison-mines/build.gradle
index bd2f8aace..6d560c986 100644
--- a/prison-mines/build.gradle
+++ b/prison-mines/build.gradle
@@ -9,6 +9,6 @@ repositories {
}
dependencies {
- compile project(':prison-core')
+ implementation project(':prison-core')
testCompile group: 'junit', name: 'junit', version: '4.12'
}
diff --git a/prison-mines/src/main/java/tech/mcprison/prison/mines/MineException.java b/prison-mines/src/main/java/tech/mcprison/prison/mines/MineException.java
index d29dc45cf..5ae4efee2 100644
--- a/prison-mines/src/main/java/tech/mcprison/prison/mines/MineException.java
+++ b/prison-mines/src/main/java/tech/mcprison/prison/mines/MineException.java
@@ -2,7 +2,9 @@
public class MineException extends Exception {
- public MineException(String msg) {
+ private static final long serialVersionUID = 1L;
+
+ public MineException(String msg) {
super(msg);
}
}
diff --git a/prison-mines/src/main/java/tech/mcprison/prison/mines/MinesChatHandler.java b/prison-mines/src/main/java/tech/mcprison/prison/mines/MinesChatHandler.java
new file mode 100644
index 000000000..7d11051b7
--- /dev/null
+++ b/prison-mines/src/main/java/tech/mcprison/prison/mines/MinesChatHandler.java
@@ -0,0 +1,39 @@
+package tech.mcprison.prison.mines;
+
+import com.google.common.eventbus.Subscribe;
+
+import tech.mcprison.prison.Prison;
+import tech.mcprison.prison.internal.events.player.PlayerChatEvent;
+
+public class MinesChatHandler {
+
+ public MinesChatHandler() {
+ Prison.get().getEventBus().register(this);
+ }
+
+
+ @Subscribe
+ public void onPlayerChat(PlayerChatEvent e) {
+ String newFormat = e.getFormat();
+
+ // Now translates
+ String translated = Prison.get().getPlatform().getPlaceholders()
+ .placeholderTranslateText( newFormat );
+
+ e.setFormat( translated );
+
+// MineManager mm = PrisonMines.getInstance().getMineManager();
+//
+// List placeholderKeys = mm.getTranslatedPlaceHolderKeys();
+//
+// for ( PlaceHolderKey placeHolderKey : placeholderKeys ) {
+// String key = "{" + placeHolderKey.getKey() + "}";
+// if ( newFormat.contains( key )) {
+// newFormat = newFormat.replace(key, Text.translateAmpColorCodes(
+// mm.getTranslateMinesPlaceHolder( placeHolderKey ) ));
+// }
+// }
+//
+// e.setFormat(newFormat);
+ }
+}
diff --git a/prison-mines/src/main/java/tech/mcprison/prison/mines/MinesListener.java b/prison-mines/src/main/java/tech/mcprison/prison/mines/MinesListener.java
index 1ba516383..4e0aa7b52 100644
--- a/prison-mines/src/main/java/tech/mcprison/prison/mines/MinesListener.java
+++ b/prison-mines/src/main/java/tech/mcprison/prison/mines/MinesListener.java
@@ -1,15 +1,9 @@
package tech.mcprison.prison.mines;
import com.google.common.eventbus.Subscribe;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-import tech.mcprison.prison.internal.ItemStack;
-import tech.mcprison.prison.internal.Player;
-import tech.mcprison.prison.internal.events.block.BlockBreakEvent;
-import tech.mcprison.prison.internal.inventory.PlayerInventory;
+
+import tech.mcprison.prison.internal.events.world.PrisonWorldLoadEvent;
import tech.mcprison.prison.selection.SelectionCompletedEvent;
-import tech.mcprison.prison.util.BlockType;
import tech.mcprison.prison.util.Bounds;
/**
@@ -25,89 +19,99 @@ public void onSelectionComplete(SelectionCompletedEvent e) {
+ "&7 blocks. Type /mines create to create it.");
}
- /**
- * Powertool helper
- */
+
@Subscribe
- public void onBlockBreak(BlockBreakEvent e) {
- if (PrisonMines.getInstance().getPlayerManager().hasAutosmelt(e.getPlayer())) {
- smelt(e.getBlockLocation().getBlockAt()
- .getDrops(((PlayerInventory) e.getPlayer().getInventory()).getItemInRightHand()));
- }
- if (PrisonMines.getInstance().getPlayerManager().hasAutopickup(e.getPlayer())) {
- e.getPlayer().getInventory()
- .addItem(e.getBlockLocation().getBlockAt().getDrops().toArray(new ItemStack[]{}));
- e.getBlockLocation().getBlockAt().setType(BlockType.AIR);
- e.setCanceled(true);
- }
- if (PrisonMines.getInstance().getPlayerManager().hasAutoblock(e.getPlayer())) {
- block(e.getPlayer());
- }
+ public void onWorldLoadListener( PrisonWorldLoadEvent e ) {
+
+ String worldName = e.getWorldName();
+ PrisonMines.getInstance().getMineManager().assignAvailableWorld( worldName );
+
}
+
+
+// /**
+// * Powertool helper
+// */
+// @Subscribe
+// public void onBlockBreak(BlockBreakEvent e) {
+// if (PrisonMines.getInstance().getPlayerManager().hasAutosmelt(e.getPlayer())) {
+// smelt(e.getBlockLocation().getBlockAt()
+// .getDrops(((PlayerInventory) e.getPlayer().getInventory()).getItemInRightHand()));
+// }
+// if (PrisonMines.getInstance().getPlayerManager().hasAutopickup(e.getPlayer())) {
+// e.getPlayer().getInventory()
+// .addItem(e.getBlockLocation().getBlockAt().getDrops().toArray(new ItemStack[]{}));
+// e.getBlockLocation().getBlockAt().setType(BlockType.AIR);
+// e.setCanceled(true);
+// }
+// if (PrisonMines.getInstance().getPlayerManager().hasAutoblock(e.getPlayer())) {
+// block(e.getPlayer());
+// }
+// }
- private void smelt(List drops) {
- drops.replaceAll(x -> {
- if (x.getMaterial() == BlockType.GOLD_ORE) {
- return new ItemStack(x.getAmount(), BlockType.GOLD_INGOT);
- } else if (x.getMaterial() == BlockType.IRON_ORE) {
- return new ItemStack(x.getAmount(), BlockType.IRON_INGOT);
- } else {
- return x;
- }
- });
- }
+// private void smelt(List drops) {
+// drops.replaceAll(x -> {
+// if (x.getMaterial() == BlockType.GOLD_ORE) {
+// return new ItemStack(x.getAmount(), BlockType.GOLD_INGOT);
+// } else if (x.getMaterial() == BlockType.IRON_ORE) {
+// return new ItemStack(x.getAmount(), BlockType.IRON_INGOT);
+// } else {
+// return x;
+// }
+// });
+// }
- private void block(Player player) {
- List itemList = Arrays.asList(player.getInventory().getItems());
- List giveBack = new ArrayList<>();
- itemList.replaceAll(x -> {
- if (x != null) {
- if (x.getMaterial() == BlockType.DIAMOND) {
- if (x.getAmount() % 9 > 0) {
- giveBack.add(new ItemStack(x.getAmount() % 9, x.getMaterial()));
- }
- return new ItemStack(x.getAmount() / 9, BlockType.DIAMOND_BLOCK);
- } else if (x.getMaterial() == BlockType.EMERALD) {
- if (x.getAmount() % 9 > 0) {
- giveBack.add(new ItemStack(x.getAmount() % 9, x.getMaterial()));
- }
- return new ItemStack(x.getAmount() / 9, BlockType.EMERALD_BLOCK);
- } else if (x.getMaterial() == BlockType.IRON_INGOT) {
- if (x.getAmount() % 9 > 0) {
- giveBack.add(new ItemStack(x.getAmount() % 9, x.getMaterial()));
- }
- return new ItemStack(x.getAmount() / 9, BlockType.IRON_BLOCK);
- } else if (x.getMaterial() == BlockType.GLOWSTONE_DUST) {
- if (x.getAmount() % 4 > 0) {
- giveBack.add(new ItemStack(x.getAmount() % 9, x.getMaterial()));
- }
- return new ItemStack(x.getAmount() / 4, BlockType.GLOWSTONE);
- } else if (x.getMaterial() == BlockType.GOLD_INGOT) {
- if (x.getAmount() % 9 > 0) {
- giveBack.add(new ItemStack(x.getAmount() % 9, x.getMaterial()));
- }
- return new ItemStack(x.getAmount() / 9, BlockType.GOLD_BLOCK);
- } else if (x.getMaterial() == BlockType.COAL) {
- if (x.getAmount() % 9 > 0) {
- giveBack.add(new ItemStack(x.getAmount() % 9, x.getMaterial()));
- }
- return new ItemStack(x.getAmount() / 9, BlockType.BLOCK_OF_COAL);
- } else if (x.getMaterial() == BlockType.REDSTONE) {
- if (x.getAmount() % 9 > 0) {
- giveBack.add(new ItemStack(x.getAmount() % 9, x.getMaterial()));
- }
- return new ItemStack(x.getAmount() / 9, BlockType.REDSTONE_BLOCK);
- } else if (x.getMaterial() == BlockType.LAPIS_LAZULI) {
- return new ItemStack(x.getAmount() / 9, BlockType.LAPIS_LAZULI_BLOCK);
- } else {
- return x;
- }
- } else {
- return x;
- }
- });
- player.getInventory().setItems(itemList);
- player.getInventory().addItem((ItemStack[]) giveBack.toArray());
- }
+// private void block(Player player) {
+// List itemList = Arrays.asList(player.getInventory().getItems());
+// List giveBack = new ArrayList<>();
+// itemList.replaceAll(x -> {
+// if (x != null) {
+// if (x.getMaterial() == BlockType.DIAMOND) {
+// if (x.getAmount() % 9 > 0) {
+// giveBack.add(new ItemStack(x.getAmount() % 9, x.getMaterial()));
+// }
+// return new ItemStack(x.getAmount() / 9, BlockType.DIAMOND_BLOCK);
+// } else if (x.getMaterial() == BlockType.EMERALD) {
+// if (x.getAmount() % 9 > 0) {
+// giveBack.add(new ItemStack(x.getAmount() % 9, x.getMaterial()));
+// }
+// return new ItemStack(x.getAmount() / 9, BlockType.EMERALD_BLOCK);
+// } else if (x.getMaterial() == BlockType.IRON_INGOT) {
+// if (x.getAmount() % 9 > 0) {
+// giveBack.add(new ItemStack(x.getAmount() % 9, x.getMaterial()));
+// }
+// return new ItemStack(x.getAmount() / 9, BlockType.IRON_BLOCK);
+// } else if (x.getMaterial() == BlockType.GLOWSTONE_DUST) {
+// if (x.getAmount() % 4 > 0) {
+// giveBack.add(new ItemStack(x.getAmount() % 9, x.getMaterial()));
+// }
+// return new ItemStack(x.getAmount() / 4, BlockType.GLOWSTONE);
+// } else if (x.getMaterial() == BlockType.GOLD_INGOT) {
+// if (x.getAmount() % 9 > 0) {
+// giveBack.add(new ItemStack(x.getAmount() % 9, x.getMaterial()));
+// }
+// return new ItemStack(x.getAmount() / 9, BlockType.GOLD_BLOCK);
+// } else if (x.getMaterial() == BlockType.COAL) {
+// if (x.getAmount() % 9 > 0) {
+// giveBack.add(new ItemStack(x.getAmount() % 9, x.getMaterial()));
+// }
+// return new ItemStack(x.getAmount() / 9, BlockType.BLOCK_OF_COAL);
+// } else if (x.getMaterial() == BlockType.REDSTONE) {
+// if (x.getAmount() % 9 > 0) {
+// giveBack.add(new ItemStack(x.getAmount() % 9, x.getMaterial()));
+// }
+// return new ItemStack(x.getAmount() / 9, BlockType.REDSTONE_BLOCK);
+// } else if (x.getMaterial() == BlockType.LAPIS_LAZULI) {
+// return new ItemStack(x.getAmount() / 9, BlockType.LAPIS_LAZULI_BLOCK);
+// } else {
+// return x;
+// }
+// } else {
+// return x;
+// }
+// });
+// player.getInventory().setItems(itemList);
+// player.getInventory().addItem((ItemStack[]) giveBack.toArray());
+// }
}
diff --git a/prison-mines/src/main/java/tech/mcprison/prison/mines/PrisonMines.java b/prison-mines/src/main/java/tech/mcprison/prison/mines/PrisonMines.java
index 85486119d..d0b3f8b9b 100644
--- a/prison-mines/src/main/java/tech/mcprison/prison/mines/PrisonMines.java
+++ b/prison-mines/src/main/java/tech/mcprison/prison/mines/PrisonMines.java
@@ -19,16 +19,16 @@
package tech.mcprison.prison.mines;
import java.io.File;
-import java.util.ArrayList;
import java.util.List;
-import java.util.ListIterator;
import java.util.Optional;
+import java.util.TreeMap;
import tech.mcprison.prison.Prison;
import tech.mcprison.prison.PrisonAPI;
import tech.mcprison.prison.convert.ConversionManager;
import tech.mcprison.prison.error.ErrorManager;
import tech.mcprison.prison.file.JsonFileIO;
+import tech.mcprison.prison.internal.Player;
import tech.mcprison.prison.localization.LocaleManager;
import tech.mcprison.prison.mines.commands.MinesCommands;
import tech.mcprison.prison.mines.data.Mine;
@@ -38,6 +38,7 @@
import tech.mcprison.prison.modules.Module;
import tech.mcprison.prison.output.Output;
import tech.mcprison.prison.store.Database;
+import tech.mcprison.prison.util.Location;
/**
* The Prison 3 Mines Module
@@ -45,43 +46,67 @@
* @author The MC-Prison Team
*/
public class PrisonMines extends Module {
-
- /*
- * Fields & Constants
- */
+ public static final String MODULE_NAME = "Mines";
private static PrisonMines i = null;
private MinesConfig config;
- private List worlds;
+// private List worlds;
private LocaleManager localeManager;
private Database db;
private ErrorManager errorManager;
private JsonFileIO jsonFileIO;
- private MineManager mines;
+ private MineManager mineManager;
private PlayerManager player;
+
+ /**
+ * playerCache tries to provide a faster way to identify which mine a player is
+ * in. The theory is that there is a very high chance it will be the last mine
+ * they were in. So this records the last mine they were in, and if that is not
+ * where they are, then, and only then, do we check all mines to see if it may
+ * be something else.
+ *
+ *
+ */
+ private final TreeMap playerCache;
+
+
+
public PrisonMines(String version) {
- super("Mines", version, 3);
+ super(MODULE_NAME, version, 3);
+
+ this.playerCache = new TreeMap<>();
}
public static PrisonMines getInstance() {
return i;
}
+ @Override
+ public String getBaseCommands() {
+ return "&7/&2mines";
+ }
+
public void enable() {
i = this;
- errorManager = new ErrorManager(this);
+ this.errorManager = new ErrorManager(this);
this.jsonFileIO = new JsonFileIO( errorManager, getStatus() );
initDb();
initConfig();
- localeManager = new LocaleManager(this, "lang/mines");
+ this.localeManager = new LocaleManager(this, "lang/mines");
- initWorlds();
- initMines();
+// initWorlds();
+
+ this.mineManager = new MineManager();
+ getMineManager().loadFromDbCollection(this);
+
+ player = new PlayerManager();
+
+// initMines();
PrisonAPI.getEventBus().register(new MinesListener());
Prison.get().getCommandHandler().registerCommands(new MinesCommands());
@@ -90,9 +115,6 @@ public void enable() {
ConversionManager.getInstance().registerConversionAgent(new MinesConversionAgent());
}
-// private void initGson() {
-// gson = new GsonBuilder().disableHtmlEscaping().setPrettyPrinting().create();
-// }
private void initDb() {
Optional dbOptional =
@@ -124,42 +146,61 @@ private void initConfig() {
config = (MinesConfig) getJsonFileIO().readJsonFile( configFile, config );
}
-//
-// if (!configFile.exists()) {
-// try {
-// configFile.createNewFile();
-// String json = gson.toJson(config);
-// Files.write(configFile.toPath(), json.getBytes());
-// } catch (IOException e) {
-// errorManager.throwError(
-// new Error("Failed to create config").appendStackTrace("while creating", e));
-// getStatus().toFailed("Failed to create config");
-// }
-// } else {
-// try {
-// String json = new String(Files.readAllBytes(configFile.toPath()));
-// config = gson.fromJson(json, MinesConfig.class);
-// } catch (IOException e) {
-// errorManager.throwError(
-// new Error("Failed to load config").appendStackTrace("while loading", e));
-// getStatus().toFailed("Failed to load config");
-// }
-// }
}
- private void initWorlds() {
- ListIterator iterator = config.worlds.listIterator();
- worlds = new ArrayList<>();
- while (iterator.hasNext()) {
- worlds.add(iterator.next().toLowerCase());
- }
- }
+
+
+
+ /**
+ * Search all mines to find if the given block is located within any
+ * of the mines. If not, then return a null.
+ *
+ *
+ * @param block
+ * @return
+ */
+ public Mine findMineLocation( Location locationToCheck ) {
+ Mine mine = null;
+ for ( Mine m : getMines() ) {
+ if ( m.isInMine( locationToCheck ) ) {
+ mine = m;
+ break;
+ }
+ }
+ return mine;
+ }
- private void initMines() {
- mines = MineManager.fromDb();
- player = new PlayerManager();
- Prison.get().getPlatform().getScheduler().runTaskTimer(mines.getTimerTask(), 20, 20);
- }
+ public TreeMap getPlayerCache() {
+ return playerCache;
+ }
+
+ public Mine findMineLocation( Player player ) {
+ Mine result = null;
+
+ Long playerUUIDLSB = Long.valueOf( player.getUUID().getLeastSignificantBits() );
+
+ // Get the cached mine, if it exists:
+ Mine mine = getPlayerCache().get( playerUUIDLSB );
+
+ if ( mine == null || !mine.isInMine( player.getLocation() ) ) {
+ // Look for the correct mine to use.
+ // Set mine to null so if cannot find the right one it will return a null:
+ mine = findMineLocation( player.getLocation() );
+
+ // Store the mine in the player cache if not null:
+ if ( mine != null ) {
+ getPlayerCache().put( playerUUIDLSB, mine );
+ }
+ }
+
+ return result;
+ }
+
+// private void initMines() {
+//// mines = MineManager.fromDb();
+//// player = new PlayerManager();
+//// Prison.get().getPlatform().getScheduler().runTaskTimer(mines.getTimerTask(), 20, 20);
+// }
public JsonFileIO getJsonFileIO()
{
@@ -173,8 +214,7 @@ public JsonFileIO getJsonFileIO()
*
*/
public void disable() {
-
-// mines.saveMines();
+ // Nothing to do...
}
public MinesConfig getConfig() {
@@ -186,20 +226,24 @@ public Database getDb() {
}
public MineManager getMineManager() {
- return mines;
+ return mineManager;
}
public List getMines() {
- return mines.getMines();
+ return getMineManager().getMines();
}
+ public Mine getMine(String mineName) {
+ return getMineManager().getMine(mineName);
+ }
+
public LocaleManager getMinesMessages() {
return localeManager;
}
- public List getWorlds() {
- return worlds;
- }
+// public List getWorlds() {
+// return worlds;
+// }
public PlayerManager getPlayerManager() {
return player;
diff --git a/prison-mines/src/main/java/tech/mcprison/prison/mines/commands/MinesCommands.java b/prison-mines/src/main/java/tech/mcprison/prison/mines/commands/MinesCommands.java
index e9f2735bb..8ef929c41 100644
--- a/prison-mines/src/main/java/tech/mcprison/prison/mines/commands/MinesCommands.java
+++ b/prison-mines/src/main/java/tech/mcprison/prison/mines/commands/MinesCommands.java
@@ -1,6 +1,6 @@
/*
* Prison is a Minecraft plugin for the prison game mode.
- * Copyright (C) 2017 The Prison Team
+ * Copyright (C) 2017-2020 The Prison Team
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -22,6 +22,9 @@
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
+import java.util.Optional;
+import java.util.Set;
+import java.util.TreeMap;
import org.apache.commons.lang3.StringUtils;
@@ -29,16 +32,21 @@
import tech.mcprison.prison.chat.FancyMessage;
import tech.mcprison.prison.commands.Arg;
import tech.mcprison.prison.commands.Command;
+import tech.mcprison.prison.commands.CommandPagedData;
+import tech.mcprison.prison.commands.Wildcard;
import tech.mcprison.prison.internal.CommandSender;
import tech.mcprison.prison.internal.Player;
+import tech.mcprison.prison.internal.block.PrisonBlock;
import tech.mcprison.prison.localization.Localizable;
import tech.mcprison.prison.mines.PrisonMines;
import tech.mcprison.prison.mines.data.Block;
import tech.mcprison.prison.mines.data.Mine;
+import tech.mcprison.prison.mines.data.MineData;
+import tech.mcprison.prison.mines.data.MineData.MineNotificationMode;
+import tech.mcprison.prison.mines.managers.MineManager;
import tech.mcprison.prison.output.BulletedListComponent;
-import tech.mcprison.prison.output.ButtonComponent;
-import tech.mcprison.prison.output.ButtonComponent.Style;
import tech.mcprison.prison.output.ChatDisplay;
+import tech.mcprison.prison.output.FancyMessageComponent;
import tech.mcprison.prison.output.Output;
import tech.mcprison.prison.output.RowComponent;
import tech.mcprison.prison.selection.Selection;
@@ -55,10 +63,11 @@ public class MinesCommands {
private String lastMineReferenced;
private Long lastMineReferencedTimestamp;
+
- private boolean performCheckMineExists(CommandSender sender, String name) {
- name = Text.stripColor( name );
- if (!PrisonMines.getInstance().getMineManager().getMine(name).isPresent()) {
+ private boolean performCheckMineExists(CommandSender sender, String mineName) {
+ mineName = Text.stripColor( mineName );
+ if (PrisonMines.getInstance().getMine(mineName) == null) {
PrisonMines.getInstance().getMinesMessages().getLocalizable("mine_does_not_exist")
.sendTo(sender);
return false;
@@ -66,12 +75,27 @@ private boolean performCheckMineExists(CommandSender sender, String name) {
return true;
}
- @Command(identifier = "mines create", description = "Creates a new mine.", permissions = "mines.create")
+ @Command(identifier = "mines create", description = "Creates a new mine.",
+ onlyPlayers = false, permissions = "mines.create")
public void createCommand(CommandSender sender,
- @Arg(name = "mineName", description = "The name of the new mine.") String name) {
+ @Wildcard(join=true)
+ @Arg(name = "mineName", description = "The name of the new mine.", def = " ") String mineName) {
+
+ if ( mineName == null || mineName.contains( " " ) || mineName.trim().length() == 0 ) {
+ sender.sendMessage( "&3Names cannot contain spaces or be empty. &b[&d" + mineName + "&b]" );
+ return;
+ }
+ mineName = mineName.trim();
+
+ Player player = getPlayer( sender );
+
+ if (player == null || !player.isOnline()) {
+ sender.sendMessage( "&3You must be a player in the game to run this command." );
+ return;
+ }
PrisonMines pMines = PrisonMines.getInstance();
- Selection selection = Prison.get().getSelectionManager().getSelection((Player) sender);
+ Selection selection = Prison.get().getSelectionManager().getSelection(player);
if (!selection.isComplete()) {
pMines.getMinesMessages().getLocalizable("select_bounds")
.sendTo(sender, Localizable.Level.ERROR);
@@ -85,31 +109,48 @@ public void createCommand(CommandSender sender,
return;
}
- if (PrisonMines.getInstance().getMines().stream()
- .anyMatch(mine -> mine.getName().equalsIgnoreCase(name))) {
+ if (PrisonMines.getInstance().getMine(mineName) != null) {
pMines.getMinesMessages().getLocalizable("mine_exists")
.sendTo(sender, Localizable.Level.ERROR);
return;
}
- setLastMineReferenced(name);
+ setLastMineReferenced(mineName);
- Mine mine = new Mine().setBounds(selection.asBounds()).setName(name);
+ Mine mine = new Mine(mineName, selection);
pMines.getMineManager().add(mine);
pMines.getMinesMessages().getLocalizable("mine_created").sendTo(sender);
+
+ // Delete the selection:
+ Prison.get().getSelectionManager().clearSelection((Player) sender);
+
}
- @Command(identifier = "mines set spawn", description = "Set the mine's spawn to where you're standing.", permissions = "mines.set")
+ @Command(identifier = "mines set spawn", description = "Set the mine's spawn to where you're standing.",
+ onlyPlayers = false, permissions = "mines.set")
public void spawnpointCommand(CommandSender sender,
- @Arg(name = "mineName", description = "The name of the mine to edit.") String name) {
+ @Arg(name = "mineName", description = "The name of the mine to edit.") String mineName) {
- if (!performCheckMineExists(sender, name)) {
+ Player player = getPlayer( sender );
+
+ if (player == null || !player.isOnline()) {
+ sender.sendMessage( "&3You must be a player in the game to run this command." );
+ return;
+ }
+
+ if (!performCheckMineExists(sender, mineName)) {
return;
}
PrisonMines pMines = PrisonMines.getInstance();
- if (!PrisonMines.getInstance().getMineManager().getMine(name).get().getWorld()
- .isPresent()) {
+ Mine mine = pMines.getMine(mineName);
+
+ if ( !mine.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
+
+ if (!mine.getWorld().isPresent()) {
pMines.getMinesMessages().getLocalizable("missing_world")
.sendTo(sender);
return;
@@ -117,159 +158,285 @@ public void spawnpointCommand(CommandSender sender,
if (!((Player) sender).getLocation().getWorld().getName()
.equalsIgnoreCase(
- pMines.getMineManager().getMine(name).get().getWorld().get()
- .getName())) {
+ mine.getWorldName())) {
pMines.getMinesMessages().getLocalizable("spawnpoint_same_world")
.sendTo(sender);
return;
}
- setLastMineReferenced(name);
+ setLastMineReferenced(mineName);
- Mine mine = pMines.getMineManager().getMine(name).get();
mine.setSpawn(((Player) sender).getLocation());
pMines.getMineManager().saveMine(mine);
pMines.getMinesMessages().getLocalizable("spawn_set").sendTo(sender);
}
- @Command(identifier = "mines block add", permissions = "mines.block", onlyPlayers = false, description = "Adds a block to a mine.")
+ @Command(identifier = "mines block add", permissions = "mines.block", onlyPlayers = false,
+ description = "Adds a block to a mine.")
public void addBlockCommand(CommandSender sender,
@Arg(name = "mineName", description = "The name of the mine to add the block to.")
- String mine,
+ String mineName,
@Arg(name = "block", description = "The block's name or ID.")
String block,
@Arg(name = "chance", description = "The percent chance (out of 100) that this block will occur.")
double chance) {
- if (!performCheckMineExists(sender, mine)) {
+ if (!performCheckMineExists(sender, mineName)) {
return;
}
PrisonMines pMines = PrisonMines.getInstance();
- setLastMineReferenced(mine);
+ setLastMineReferenced(mineName);
- Mine m = pMines.getMineManager().getMine(mine).get();
-
- BlockType blockType = BlockType.getBlock(block);
- if (blockType == null || blockType.getMaterialType() != MaterialType.BLOCK ) {
- pMines.getMinesMessages().getLocalizable("not_a_block")
- .withReplacements(block).sendTo(sender);
- return;
- }
-
- if (m.isInMine(blockType)) {
- pMines.getMinesMessages().getLocalizable("block_already_added")
- .sendTo(sender);
- return;
- }
-
- if ( chance <= 0 ) {
- sender.sendMessage( "The percent chance must have a value greater than zero." );
+ Mine m = pMines.getMine(mineName);
+
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
return;
}
- final double[] totalComp = {chance};
- m.getBlocks().forEach(block1 -> totalComp[0] += block1.getChance());
- if (totalComp[0] > 100.0d) {
- pMines.getMinesMessages().getLocalizable("mine_full")
- .sendTo(sender, Localizable.Level.ERROR);
- return;
+ if ( Prison.get().getPlatform().getConfigBooleanFalse( "use-new-prison-block-model" ) ) {
+
+ PrisonBlock prisonBlock = Prison.get().getPlatform().getPrisonBlock( block );
+ if ( prisonBlock != null ) {
+ pMines.getMinesMessages().getLocalizable("not_a_block").
+ withReplacements(block).sendTo(sender);
+ return;
+ }
+
+
+ if (m.isInMine(prisonBlock)) {
+ pMines.getMinesMessages().getLocalizable("block_already_added").
+ sendTo(sender);
+ return;
+ }
+
+ if ( chance <= 0 ) {
+ sender.sendMessage( "The percent chance must have a value greater than zero." );
+ return;
+ }
+
+ final double[] totalComp = {chance};
+
+ m.getPrisonBlocks().forEach(block1 -> totalComp[0] += block1.getChance());
+ if (totalComp[0] > 100.0d) {
+ pMines.getMinesMessages().getLocalizable("mine_full").
+ sendTo(sender, Localizable.Level.ERROR);
+ return;
+ }
+
+ prisonBlock.setChance( chance );
+ m.getPrisonBlocks().add( prisonBlock );
+ }
+ else {
+
+ BlockType blockType = BlockType.getBlock(block);
+ if (blockType == null || blockType.getMaterialType() != MaterialType.BLOCK ) {
+ pMines.getMinesMessages().getLocalizable("not_a_block")
+ .withReplacements(block).sendTo(sender);
+ return;
+ }
+
+ if (m.isInMine(blockType)) {
+ pMines.getMinesMessages().getLocalizable("block_already_added")
+ .sendTo(sender);
+ return;
+ }
+
+ if ( chance <= 0 ) {
+ sender.sendMessage( "The percent chance must have a value greater than zero." );
+ return;
+ }
+
+ final double[] totalComp = {chance};
+
+ m.getBlocks().forEach(block1 -> totalComp[0] += block1.getChance());
+ if (totalComp[0] > 100.0d) {
+ pMines.getMinesMessages().getLocalizable("mine_full")
+ .sendTo(sender, Localizable.Level.ERROR);
+ return;
+ }
+
+ m.getBlocks().add(new Block(blockType, chance));
}
- m.getBlocks().add(new Block(blockType, chance));
pMines.getMineManager().saveMine( m );
pMines.getMinesMessages().getLocalizable("block_added")
- .withReplacements(block, mine).sendTo(sender);
- getBlocksList(m).send(sender);
+ .withReplacements(block, mineName).sendTo(sender);
+ getBlocksList(m, null).send(sender);
- pMines.getMineManager().clearCache();
+ //pMines.getMineManager().clearCache();
}
@Command(identifier = "mines block set", permissions = "mines.block", onlyPlayers = false,
description = "Changes the percentage of a block in a mine.")
public void setBlockCommand(CommandSender sender,
@Arg(name = "mineName", description = "The name of the mine to edit.")
- String mine,
+ String mineName,
@Arg(name = "block", description = "The block's name or ID.")
String block,
@Arg(name = "chance", description = "The percent chance (out of 100) that this block will occur.")
double chance) {
- if (!performCheckMineExists(sender, mine)) {
+ if (!performCheckMineExists(sender, mineName)) {
return;
}
- setLastMineReferenced(mine);
+ setLastMineReferenced(mineName);
PrisonMines pMines = PrisonMines.getInstance();
- Mine m = pMines.getMineManager().getMine(mine).get();
+ Mine m = pMines.getMine(mineName);
- BlockType blockType = BlockType.getBlock(block);
- if (blockType == null) {
- pMines.getMinesMessages().getLocalizable("not_a_block")
- .withReplacements(block).sendTo(sender);
- return;
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
}
-
- // Change behavior: If trying to change a block that is not in the mine, then instead add it:
- if (!m.isInMine(blockType)) {
- addBlockCommand( sender, mine, block, chance );
+
+ if ( Prison.get().getPlatform().getConfigBooleanFalse( "use-new-prison-block-model" ) ) {
+
+
+ PrisonBlock prisonBlock = Prison.get().getPlatform().getPrisonBlock( block );
+ if ( prisonBlock == null ) {
+ pMines.getMinesMessages().getLocalizable("not_a_block").
+ withReplacements(block).sendTo(sender);
+ return;
+ }
+
+
+ // Change behavior: If trying to change a block that is not in the mine, then instead add it:
+ if (!m.isInMine(prisonBlock)) {
+ addBlockCommand( sender, mineName, block, chance );
// pMines.getMinesMessages().getLocalizable("block_not_removed")
// .sendTo(sender);
- return;
- }
-
- // If it's 0, just delete it!
- if (chance <= 0.0d) {
- deleteBlock( sender, pMines, m, blockType );
+ return;
+ }
+
+ // If it's 0, just delete it!
+ if (chance <= 0.0d) {
+ deleteBlock( sender, pMines, m, prisonBlock );
// delBlockCommand(sender, mine, block);
- return;
- }
-
- final double[] totalComp = {chance};
- m.getBlocks().forEach(block1 -> {
- if (block1.getType() == blockType) {
- totalComp[0] -= block1.getChance();
- } else {
- totalComp[0] += block1.getChance();
- }
- });
- if (totalComp[0] > 100.0d) {
- pMines.getMinesMessages().getLocalizable("mine_full")
- .sendTo(sender, Localizable.Level.ERROR);
- return;
+ return;
+ }
+
+
+ double totalChance = chance;
+ PrisonBlock blockToUpdate = null;
+ for ( PrisonBlock blk : m.getPrisonBlocks() ) {
+ if ( blk.getBlockName().equalsIgnoreCase( prisonBlock.getBlockName() ) ) {
+ totalChance -= blk.getChance();
+ blockToUpdate = blk;
+ }
+ else {
+ totalChance += blk.getChance();
+ }
+ }
+
+ if (totalChance > 100.0d) {
+ pMines.getMinesMessages().getLocalizable("mine_full").
+ sendTo(sender, Localizable.Level.ERROR);
+ return;
+ }
+
+ blockToUpdate.setChance( chance );
+
+// // total chance is not being calculated correctly...
+//
+// final double[] totalComp = {chance};
+// m.getPrisonBlocks().forEach(block1 -> {
+// totalComp[0] -= block1.getChance();
+// });
+//
+// if (totalComp[0] > 100.0d) {
+// pMines.getMinesMessages().getLocalizable("mine_full")
+// .sendTo(sender, Localizable.Level.ERROR);
+// return;
+// }
+//
+// for (PrisonBlock blockObject : m.getPrisonBlocks()) {
+// if (blockObject.getBlockName().equalsIgnoreCase( prisonBlock.getBlockName() )) {
+// blockObject.setChance(chance);
+// }
+// }
+
}
-
- for (Block blockObject : m.getBlocks()) {
- if (blockObject.getType() == blockType) {
- blockObject.setChance(chance);
- }
+ else {
+
+ BlockType blockType = BlockType.getBlock(block);
+ if (blockType == null) {
+ pMines.getMinesMessages().getLocalizable("not_a_block").
+ withReplacements(block).sendTo(sender);
+ return;
+ }
+
+ // Change behavior: If trying to change a block that is not in the mine, then instead add it:
+ if (!m.isInMine(blockType)) {
+ addBlockCommand( sender, mineName, block, chance );
+// pMines.getMinesMessages().getLocalizable("block_not_removed")
+// .sendTo(sender);
+ return;
+ }
+
+ // If it's 0, just delete it!
+ if (chance <= 0.0d) {
+ deleteBlock( sender, pMines, m, blockType );
+// delBlockCommand(sender, mine, block);
+ return;
+ }
+
+
+ double totalChance = chance;
+ Block blockToUpdate = null;
+ for ( Block blk : m.getBlocks() ) {
+ if ( blk.getType() == blockType ) {
+ totalChance -= blk.getChance();
+ blockToUpdate = blk;
+ }
+ else {
+ totalChance += blk.getChance();
+ }
+ }
+
+ if (totalChance > 100.0d) {
+ pMines.getMinesMessages().getLocalizable("mine_full").
+ sendTo(sender, Localizable.Level.ERROR);
+ return;
+ }
+
+ blockToUpdate.setChance( chance );
+
}
+
+
pMines.getMineManager().saveMine( m );
pMines.getMinesMessages().getLocalizable("block_set")
- .withReplacements(block, mine).sendTo(sender);
- getBlocksList(m).send(sender);
+ .withReplacements(block, mineName).sendTo(sender);
+ getBlocksList(m, null).send(sender);
- pMines.getMineManager().clearCache();
+ //pMines.getMineManager().clearCache();
}
@Command(identifier = "mines block remove", permissions = "mines.block", onlyPlayers = false, description = "Deletes a block from a mine.")
public void delBlockCommand(CommandSender sender,
- @Arg(name = "mineName", description = "The name of the mine to edit.") String mine,
+ @Arg(name = "mineName", description = "The name of the mine to edit.") String mineName,
@Arg(name = "block", def = "AIR", description = "The block's name or ID.") String block) {
- if (!performCheckMineExists(sender, mine)) {
+ if (!performCheckMineExists(sender, mineName)) {
return;
}
- setLastMineReferenced(mine);
+ setLastMineReferenced(mineName);
PrisonMines pMines = PrisonMines.getInstance();
- Mine m = pMines.getMineManager().getMine(mine).get();
+ Mine m = pMines.getMine(mineName);
+
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
BlockType blockType = BlockType.getBlock(block);
if (blockType == null) {
@@ -278,7 +445,7 @@ public void delBlockCommand(CommandSender sender,
return;
}
- if (m.isInMine(blockType)) {
+ if (!m.isInMine(blockType)) {
pMines.getMinesMessages().getLocalizable("block_not_removed")
.sendTo(sender);
return;
@@ -287,19 +454,59 @@ public void delBlockCommand(CommandSender sender,
deleteBlock( sender, pMines, m, blockType );
}
+ /**
+ * Delete only the first occurrence of a block with the given BlockType.
+ *
+ * @param sender
+ * @param pMines
+ * @param m
+ * @param prisonBlock
+ */
+ private void deleteBlock( CommandSender sender, PrisonMines pMines, Mine m, PrisonBlock prisonBlock )
+ {
+ PrisonBlock rBlock = null;
+ for ( PrisonBlock block : m.getPrisonBlocks() ) {
+ if (block.getBlockName().equalsIgnoreCase( prisonBlock.getBlockName() )) {
+ rBlock = block;
+ break;
+ }
+ }
+ if ( m.getPrisonBlocks().remove( rBlock )) {
+ pMines.getMineManager().saveMine( m );
+
+ pMines.getMinesMessages().getLocalizable("block_deleted").
+ withReplacements(prisonBlock.getBlockName(), m.getName()).sendTo(sender);
+ getBlocksList(m, null).send(sender);
+ }
+ }
+ /**
+ * Delete only the first occurrence of a block with the given BlockType.
+ *
+ * @param sender
+ * @param pMines
+ * @param m
+ * @param blockType
+ */
private void deleteBlock( CommandSender sender, PrisonMines pMines, Mine m, BlockType blockType )
{
- m.getBlocks().removeIf(x -> x.getType() == blockType);
- pMines.getMineManager().saveMine( m );
-
- pMines.getMinesMessages().getLocalizable("block_deleted")
- .withReplacements(blockType.name(), m.getName()).sendTo(sender);
- getBlocksList(m).send(sender);
-
- pMines.getMineManager().clearCache();
+ Block rBlock = null;
+ for ( Block block : m.getBlocks() ) {
+ if ( block.getType() == blockType ) {
+ rBlock = block;
+ break;
+ }
+ }
+ if ( m.getBlocks().remove( rBlock )) {
+ pMines.getMineManager().saveMine( m );
+
+ pMines.getMinesMessages().getLocalizable("block_deleted")
+ .withReplacements(blockType.name(), m.getName()).sendTo(sender);
+ getBlocksList(m, null).send(sender);
+ }
}
- @Command(identifier = "mines block search", permissions = "mines.block", description = "Searches for a block to add to a mine.")
+ @Command(identifier = "mines block search", permissions = "mines.block",
+ description = "Searches for a block to add to a mine.")
public void searchBlockCommand(CommandSender sender,
@Arg(name = "search", def = " ", description = "Any part of the block's name or ID.") String search,
@Arg(name = "page", def = "1", description = "Page of search results (optional)") String page ) {
@@ -314,7 +521,7 @@ public void searchBlockCommand(CommandSender sender,
display.send(sender);
- pMines.getMineManager().clearCache();
+ //pMines.getMineManager().clearCache();
}
private ChatDisplay blockSearchBuilder(String search, String page)
@@ -330,20 +537,26 @@ private ChatDisplay blockSearchBuilder(String search, String page)
}
}
- int curPage = 1;
- int pageSize = 10;
- int pages = (blocks.size() / pageSize) + 1;
- try
- {
- curPage = Integer.parseInt(page);
- }
- catch ( NumberFormatException e )
- {
- // Ignore: Not an integer, will use the default value.
- }
- curPage = ( curPage < 1 ? 1 : (curPage > pages ? pages : curPage ));
- int pageStart = (curPage - 1) * pageSize;
- int pageEnd = ((pageStart + pageSize) > blocks.size() ? blocks.size() : pageStart + pageSize);
+
+ CommandPagedData cmdPageData = new CommandPagedData(
+ "/mines block search " + search, blocks.size(),
+ 0, page );
+
+ // Same page logic as in mines info
+// int curPage = 1;
+// int pageSize = 10;
+// int pages = (blocks.size() / pageSize) + 1;
+// try
+// {
+// curPage = Integer.parseInt(page);
+// }
+// catch ( NumberFormatException e )
+// {
+// // Ignore: Not an integer, will use the default value.
+// }
+// curPage = ( curPage < 1 ? 1 : (curPage > pages ? pages : curPage ));
+// int pageStart = (curPage - 1) * pageSize;
+// int pageEnd = ((pageStart + pageSize) > blocks.size() ? blocks.size() : pageStart + pageSize);
ChatDisplay display = new ChatDisplay("Block Search (" + blocks.size() + ")");
@@ -351,7 +564,7 @@ private ChatDisplay blockSearchBuilder(String search, String page)
BulletedListComponent.BulletedListBuilder builder =
new BulletedListComponent.BulletedListBuilder();
- for ( int i = pageStart; i < pageEnd; i++ )
+ for ( int i = cmdPageData.getPageStart(); i < cmdPageData.getPageEnd(); i++ )
{
BlockType block = blocks.get(i);
FancyMessage msg =
@@ -364,27 +577,10 @@ private ChatDisplay blockSearchBuilder(String search, String page)
}
display.addComponent(builder.build());
- // Need to construct a dynamic row of buttons. It may have no buttons, both, or
- // a combination of previous page or next page. But it will always have a page
- // count between the two.
- RowComponent row = new RowComponent();
- if ( curPage > 1 )
- {
- row.addFancy(
- new ButtonComponent( "&e<-- Prev Page", '-', Style.NEGATIVE)
- .runCommand("/mines block search " + search + " " + (curPage - 1),
- "View the prior page of search results").getFancyMessage() );
- }
- row.addFancy(
- new FancyMessage(" &9< &3Page " + curPage + " of " + pages + " &9> ") );
- if ( curPage < pages )
- {
- row.addFancy(
- new ButtonComponent( "&eNext Page -->", '+', Style.POSITIVE)
- .runCommand("/mines block search " + search + " " + (curPage + 1),
- "View the prior page of search results").getFancyMessage() );
- }
- display.addComponent( row );
+ // This command plus parameters used:
+// String pageCmd = "/mines block search " + search;
+
+ cmdPageData.generatePagedCommandFooter( display );
return display;
}
@@ -392,13 +588,13 @@ private ChatDisplay blockSearchBuilder(String search, String page)
@Command(identifier = "mines delete", permissions = "mines.delete", onlyPlayers = false, description = "Deletes a mine.")
public void deleteCommand(CommandSender sender,
- @Arg(name = "mineName", description = "The name of the mine to delete.") String name,
+ @Arg(name = "mineName", description = "The name of the mine to delete.") String mineName,
@Arg(name = "confirm", def = "", description = "Confirm that the mine should be deleted") String confirm) {
- if (!performCheckMineExists(sender, name)) {
+ if (!performCheckMineExists(sender, mineName)) {
return;
}
- setLastMineReferenced(name);
+ setLastMineReferenced(mineName);
// They have 1 minute to confirm.
long now = System.currentTimeMillis();
@@ -407,25 +603,44 @@ public void deleteCommand(CommandSender sender,
setConfirmTimestamp( null );
PrisonMines pMines = PrisonMines.getInstance();
- pMines.getMineManager().removeMine(pMines.getMineManager().getMine(name).get());
+
+ Mine mine = pMines.getMine(mineName);
+
+ if ( !mine.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
+
+ // Remove from the manager:
+ pMines.getMineManager().removeMine(mine);
+
+ // Terminate the running task for mine resets. Will allow it to be garbage collected.
+ mine.terminateJob();
+
+ setLastMineReferenced(null);
+
pMines.getMinesMessages().getLocalizable("mine_deleted").sendTo(sender);
} else if ( getConfirmTimestamp() == null || ((now - getConfirmTimestamp()) >= 1000 * 60 ) ) {
setConfirmTimestamp( now );
- ChatDisplay chatDisplay = new ChatDisplay("&cDelete " + name);
+ ChatDisplay chatDisplay = new ChatDisplay("&cDelete " + mineName);
BulletedListComponent.BulletedListBuilder builder = new BulletedListComponent.BulletedListBuilder();
builder.add( new FancyMessage(
"&3Confirm the deletion of this mine" )
- .suggest("/mines delete " + name + " cancel"));
+ .suggest("/mines delete " + mineName + " cancel"));
builder.add( new FancyMessage(
"&3Click &eHERE&3 to display the command" )
- .suggest("/mines delete " + name + " cancel"));
+ .suggest("/mines delete " + mineName + " cancel"));
+
+ builder.add( new FancyMessage(
+ "&3Enter: &7/mines delete " + mineName + " confirm" )
+ .suggest("/mines delete " + mineName + " cancel"));
builder.add( new FancyMessage(
"&3Then change &ecancel&3 to &econfirm&3." )
- .suggest("/mines delete " + name + " cancel"));
+ .suggest("/mines delete " + mineName + " cancel"));
builder.add( new FancyMessage("You have 1 minute to respond."));
@@ -435,13 +650,13 @@ public void deleteCommand(CommandSender sender,
} else if (confirm != null && "cancel".equalsIgnoreCase( confirm )) {
setConfirmTimestamp( null );
- ChatDisplay display = new ChatDisplay("&cDelete " + name);
+ ChatDisplay display = new ChatDisplay("&cDelete " + mineName);
display.text("&8Delete canceled.");
display.send( sender );
} else {
- ChatDisplay display = new ChatDisplay("&cDelete " + name);
+ ChatDisplay display = new ChatDisplay("&cDelete " + mineName);
display.text("&8Delete confirmation failed. Try again.");
display.send( sender );
@@ -449,66 +664,330 @@ public void deleteCommand(CommandSender sender,
}
- @Command(identifier = "mines info", permissions = "mines.info", onlyPlayers = false, description = "Lists information about a mine.")
+ @Command(identifier = "mines info", permissions = "mines.info", onlyPlayers = false,
+ description = "Lists information about a mine.")
public void infoCommand(CommandSender sender,
- @Arg(name = "mineName", description = "The name of the mine to view.") String name) {
- if (!performCheckMineExists(sender, name)) {
+ @Arg(name = "mineName", description = "The name of the mine to view.") String mineName,
+ @Arg(name = "page", def = "1",
+ description = "Page of search results (optional) [1-n, ALL]") String page
+ ) {
+ if (!performCheckMineExists(sender, mineName)) {
return;
}
- setLastMineReferenced(name);
+
+ setLastMineReferenced(mineName);
PrisonMines pMines = PrisonMines.getInstance();
- Mine m = pMines.getMineManager().getMine(name).get();
-
- ChatDisplay chatDisplay = new ChatDisplay(m.getName());
+ MineManager mMan = pMines.getMineManager();
+ Mine m = pMines.getMine(mineName);
+
+
+ CommandPagedData cmdPageData = null;
+
+
+ if ( Prison.get().getPlatform().getConfigBooleanFalse( "use-new-prison-block-model" ) ) {
+
+ cmdPageData = new CommandPagedData(
+ "/mines info " + m.getName(), m.getPrisonBlocks().size(),
+ 1, page );
+ }
+ else {
+
+ cmdPageData = new CommandPagedData(
+ "/mines info " + m.getName(), m.getBlocks().size(),
+ 1, page );
+ }
+
+// // Same page logic as in mines block search:
+// int curPage = 1;
+// int pageSize = 10;
+// int pages = (m.getBlocks().size() / pageSize) + 1;
+// try
+// {
+// curPage = Integer.parseInt(page);
+// }
+// catch ( NumberFormatException e )
+// {
+// // Ignore: Not an integer, will use the default value.
+// }
+// curPage = ( curPage < 1 ? 1 : (curPage > pages ? pages : curPage ));
+// int pageStart = (curPage - 1) * pageSize;
+// int pageEnd = ((pageStart + pageSize) > m.getBlocks().size() ? m.getBlocks().size() : pageStart + pageSize);
- String worldName = m.getWorld().isPresent() ? m.getWorld().get().getName() : "&cmissing";
- chatDisplay.text("&3World: &7%s", worldName);
+
- String minCoords = m.getBounds().getMin().toBlockCoordinates();
- String maxCoords = m.getBounds().getMax().toBlockCoordinates();
- chatDisplay.text("&3Bounds: &7%s &8to &7%s", minCoords, maxCoords);
+ DecimalFormat dFmt = new DecimalFormat("#,##0");
+ DecimalFormat fFmt = new DecimalFormat("#,##0.00");
+
+ ChatDisplay chatDisplay = new ChatDisplay("&bMine: &3" + m.getName());
+ // Display Mine Info only:
+ if ( cmdPageData.getCurPage() == 1 ) {
+
+ if ( !m.isEnabled() ) {
+ chatDisplay.text("&cWarning!! This mine is &lDISABLED&r&c!!" );
+ }
+
+
+ String worldName = m.getWorld().isPresent() ? m.getWorld().get().getName() : "&cmissing";
+ chatDisplay.text("&3World: &7%s", worldName);
+
+ String minCoords = m.getBounds().getMin().toBlockCoordinates();
+ String maxCoords = m.getBounds().getMax().toBlockCoordinates();
+ chatDisplay.text("&3Bounds: &7%s &8to &7%s", minCoords, maxCoords);
+ Player player = getPlayer( sender );
+
+ chatDisplay.text("&3Center: &7%s &3%s &7%s",
+ m.getBounds().getCenter().toBlockCoordinates(),
+ (player == null ? "" : "Distance:"),
+ (player == null ? "" : fFmt.format( m.getBounds().getDistance3d( player.getLocation() ) ))
+ );
+ if ( mMan.isMineStats() ) {
+ }
+
+
+ String spawnPoint = m.getSpawn() != null ? m.getSpawn().toBlockCoordinates() : "&cnot set";
+ chatDisplay.text("&3Spawnpoint: &7%s", spawnPoint);
+
+ if ( mMan.isMineStats() ) {
+ RowComponent rowStats = new RowComponent();
+ rowStats.addTextComponent( " -- &7 Stats :: " );
+ rowStats.addTextComponent( m.statsMessage() );
+
+ chatDisplay.addComponent(rowStats);
+ }
+
+
+ {
+ RowComponent row = new RowComponent();
+ double rtMinutes = m.getResetTime() / 60.0D;
+ row.addTextComponent( "&3Reset time: &7%s &3Secs (&7%.2f &3Mins)",
+ Integer.toString(m.getResetTime()), rtMinutes );
+ chatDisplay.addComponent( row );
+ }
+
+ {
+ RowComponent row = new RowComponent();
+ row.addTextComponent( "&3Mine Reset Count: &7%s ",
+ dFmt.format(m.getResetCount()) );
+
+ if ( m.isUsePagingOnReset() ) {
+ row.addTextComponent( " &7-= &5Reset Paging Enabled &7=-" );
+ }
+ else {
+ row.addTextComponent( " &7-= &3Reset Paging Disabled &7=-" );
+ }
+
+ chatDisplay.addComponent( row );
+ }
+
+ {
+ RowComponent row = new RowComponent();
+
+ long targetResetTime = m.getTargetResetTime();
+ double remaining = ( targetResetTime <= 0 ? 0d :
+ (targetResetTime - System.currentTimeMillis()) / 1000d);
+ double rtMinutes = remaining / 60.0D;
+
+ row.addTextComponent( "&3Time Remaining Until Reset: &7%s &3Secs (&7%.2f &3Mins)",
+ dFmt.format( remaining ), rtMinutes );
+ chatDisplay.addComponent( row );
+ }
+
+ {
+ RowComponent row = new RowComponent();
+ row.addTextComponent( "&3Notification Mode: &7%s &7%s",
+ m.getNotificationMode().name(),
+ ( m.getNotificationMode() == MineNotificationMode.radius ?
+ dFmt.format( m.getNotificationRadius() ) + " blocks" : "" ) );
+ chatDisplay.addComponent( row );
+ }
+
+ {
+ RowComponent row = new RowComponent();
+ row.addTextComponent( "&3Notifications Filtered by Permissions: %s",
+ ( m.isUseNotificationPermission() ? "&2Enabled" : "&dDisabled" ) );
+ chatDisplay.addComponent( row );
+ }
+
+ {
+ RowComponent row = new RowComponent();
+ row.addTextComponent( "&3Notification Permission: &7%s",
+ m.getMineNotificationPermissionName() );
+ chatDisplay.addComponent( row );
+ }
+
+
+
+
// chatDisplay.text("&3Size: &7%d&8x&7%d&8x&7%d", Math.round(m.getBounds().getWidth()),
// Math.round(m.getBounds().getHeight()), Math.round(m.getBounds().getLength()));
+
+ {
+ RowComponent row = new RowComponent();
+ row.addTextComponent( "&3Size: &7%d&8x&7%d&8x&7%d", Math.round(m.getBounds().getWidth()),
+ Math.round(m.getBounds().getHeight()), Math.round(m.getBounds().getLength()) );
+
+ row.addTextComponent( " &3Volume: &7%s &3Blocks",
+ dFmt.format( Math.round(m.getBounds().getTotalBlockCount())) );
+ chatDisplay.addComponent( row );
+ }
+
+
+ {
+ RowComponent row = new RowComponent();
+ row.addTextComponent( "&3Blocks Remaining: &7%s %s%% ",
+ dFmt.format( m.getRemainingBlockCount() ),
+ fFmt.format( m.getPercentRemainingBlockCount() ) );
+
+ chatDisplay.addComponent( row );
+ }
+
+ {
+ RowComponent row = new RowComponent();
+ if ( m.isZeroBlockResetDisabled() ) {
+ row.addTextComponent( "&3Zero Blocks Reset Delay: &cDISABLED");
+ } else {
+ if ( m.getResetThresholdPercent() == 0 ) {
+ row.addTextComponent( "&3Zero Blocks Reset Delay: &7%s &3Seconds",
+ fFmt.format( m.getZeroBlockResetDelaySec() ));
+ }
+ else {
+ row.addTextComponent( "&7Threshold &3Reset Delay: &7%s &3Seconds",
+ fFmt.format( m.getZeroBlockResetDelaySec() ));
+ }
+ }
+
+ chatDisplay.addComponent( row );
+ }
+
+
+ {
+ RowComponent row = new RowComponent();
+ if ( m.getResetThresholdPercent() == 0 ) {
+ row.addTextComponent( "&3Reset Threshold: &cDISABLED");
+ } else {
+
+ double blocks = m.getBounds().getTotalBlockCount() *
+ m.getResetThresholdPercent() / 100.0d;
+ row.addTextComponent( "&3Reset Threshold: &7%s &3Percent (&7%s &3blocks)",
+ fFmt.format( m.getResetThresholdPercent() ),
+ dFmt.format( blocks ) );
+ }
+
+ chatDisplay.addComponent( row );
+ }
+
+
+ if ( m.isSkipResetEnabled() ) {
+ RowComponent row = new RowComponent();
+ row.addTextComponent( "&3Skip Reset &2Enabled&3: &3Threshold: &7%s &3Skip Limit: &7%s",
+ fFmt.format( m.getSkipResetPercent() ), dFmt.format( m.getSkipResetBypassLimit() ));
+ chatDisplay.addComponent( row );
+
+ if ( m.getSkipResetBypassCount() > 0 ) {
+ RowComponent row2 = new RowComponent();
+ row2.addTextComponent( " &3Skipping Enabled: Skip Count: &7%s",
+ dFmt.format( m.getSkipResetBypassCount() ));
+ chatDisplay.addComponent( row2 );
+ }
+ } else {
+ RowComponent row = new RowComponent();
+ row.addTextComponent( "&3Skip Mine Reset if no Activity: &cnot set");
+ chatDisplay.addComponent( row );
+ }
+
+
+ if ( m.getResetCommands() != null && m.getResetCommands().size() > 0 ) {
+// RowComponent row = new RowComponent();
+// row.addTextComponent( "&3Reset Commands: &7%s ",
+// dFmt.format( m.getResetCommands().size() ) );
+
+ BulletedListComponent.BulletedListBuilder builder = new BulletedListComponent.BulletedListBuilder();
+
+ FancyMessage msg = new FancyMessage(String.format("&3Reset Commands: &7%s",
+ dFmt.format( m.getResetCommands().size() )))
+ .suggest("/mines command list " + m.getName())
+ .tooltip("&7Click to list to view the reset commands.");
+
+ builder.add(msg);
+
+ chatDisplay.addComponent( builder.build() );
+ }
- RowComponent row = new RowComponent();
- row.addTextComponent( "&3Size: &7%d&8x&7%d&8x&7%d", Math.round(m.getBounds().getWidth()),
- Math.round(m.getBounds().getHeight()), Math.round(m.getBounds().getLength()) );
+
+ }
- row.addTextComponent( " &3Volume: &7%d &3Blocks", Math.round(m.getBounds().getTotalBlockCount()) );
- chatDisplay.addComponent( row );
+ if ( cmdPageData.isShowAll() || cmdPageData.getCurPage() > 1 ) {
+ chatDisplay.text("&3Blocks:");
+ chatDisplay.text("&8Click on a block's name to edit its chances of appearing.");
+ BulletedListComponent list = getBlocksList(m, cmdPageData);
+
+ chatDisplay.addComponent(list);
+ }
+ int blockSize = 0;
- String spawnPoint = m.getSpawn() != null ? m.getSpawn().toBlockCoordinates() : "&cnot set";
- chatDisplay.text("&3Spawnpoint: &7%s", spawnPoint);
-
- chatDisplay.text("&3Blocks:");
- chatDisplay.text("&8Click on a block's name to edit its chances of appearing.");
- BulletedListComponent list = getBlocksList(m);
- chatDisplay.addComponent(list);
+ if ( Prison.get().getPlatform().getConfigBooleanFalse( "use-new-prison-block-model" ) ) {
+ blockSize = m.getPrisonBlocks().size();
+ }
+ else {
+ blockSize = m.getBlocks().size();
+ }
+
+ String message = blockSize != 0 ? null : " &cNo Blocks Defined";
+ cmdPageData.generatePagedCommandFooter( chatDisplay, message );
chatDisplay.send(sender);
}
- private BulletedListComponent getBlocksList(Mine m) {
+ private BulletedListComponent getBlocksList(Mine m, CommandPagedData cmdPageData) {
BulletedListComponent.BulletedListBuilder builder = new BulletedListComponent.BulletedListBuilder();
DecimalFormat dFmt = new DecimalFormat("##0.00");
double totalChance = 0.0d;
- for (Block block : m.getBlocks()) {
- double chance = Math.round(block.getChance() * 100.0d) / 100.0d;
- totalChance += chance;
-
- String blockName =
- StringUtils.capitalize(block.getType().name().replaceAll("_", " ").toLowerCase());
- String percent = dFmt.format(chance) + "%";
- FancyMessage msg = new FancyMessage(String.format("&7%s - %s (%s)",
- percent, block.getType().name(), blockName))
- .suggest("/mines block set " + m.getName() + " " + block.getType().name() + " %")
- .tooltip("&7Click to edit the block's chance.");
- builder.add(msg);
+ int count = 0;
+
+ if ( Prison.get().getPlatform().getConfigBooleanFalse( "use-new-prison-block-model" ) ) {
+
+ for (PrisonBlock block : m.getPrisonBlocks()) {
+ double chance = Math.round(block.getChance() * 100.0d) / 100.0d;
+ totalChance += chance;
+
+ if ( cmdPageData == null ||
+ count++ >= cmdPageData.getPageStart() && count <= cmdPageData.getPageEnd() ) {
+ String blockName =
+ StringUtils.capitalize(block.getBlockName().replaceAll("_", " ").toLowerCase());
+ String percent = dFmt.format(chance) + "%";
+ FancyMessage msg = new FancyMessage(String.format("&7%s - %s (%s)",
+ percent, block.getBlockName(), blockName))
+ .suggest("/mines block set " + m.getName() + " " + block.getBlockName() + " %")
+ .tooltip("&7Click to edit the block's chance.");
+ builder.add(msg);
+
+ }
+ }
+ }
+ else {
+
+ for (Block block : m.getBlocks()) {
+ double chance = Math.round(block.getChance() * 100.0d) / 100.0d;
+ totalChance += chance;
+
+ if ( cmdPageData == null ||
+ count++ >= cmdPageData.getPageStart() && count <= cmdPageData.getPageEnd() ) {
+ String blockName =
+ StringUtils.capitalize(block.getType().name().replaceAll("_", " ").toLowerCase());
+ String percent = dFmt.format(chance) + "%";
+ FancyMessage msg = new FancyMessage(String.format("&7%s - %s (%s)",
+ percent, block.getType().name(), blockName))
+ .suggest("/mines block set " + m.getName() + " " + block.getType().name() + " %")
+ .tooltip("&7Click to edit the block's chance.");
+ builder.add(msg);
+
+ }
+ }
}
if (totalChance < 100.0d) {
@@ -520,21 +999,29 @@ private BulletedListComponent getBlocksList(Mine m) {
@Command(identifier = "mines reset", permissions = "mines.reset", description = "Resets a mine.")
public void resetCommand(CommandSender sender,
- @Arg(name = "mineName", description = "The name of the mine to reset.") String name) {
+ @Arg(name = "mineName", description = "The name of the mine to reset.") String mineName) {
- if (!performCheckMineExists(sender, name)) {
+ if (!performCheckMineExists(sender, mineName)) {
return;
}
- setLastMineReferenced(name);
+ setLastMineReferenced(mineName);
PrisonMines pMines = PrisonMines.getInstance();
+
+ Mine m = pMines.getMine(mineName);
+
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
+
try {
- pMines.getMineManager().getMine(name).get().reset();
+ m.manualReset();
} catch (Exception e) {
pMines.getMinesMessages().getLocalizable("mine_reset_fail")
.sendTo(sender);
- Output.get().logError("Couldn't reset mine " + name, e);
+ Output.get().logError("Couldn't reset mine " + mineName, e);
}
pMines.getMinesMessages().getLocalizable("mine_reset").sendTo(sender);
@@ -542,53 +1029,675 @@ public void resetCommand(CommandSender sender,
@Command(identifier = "mines list", permissions = "mines.list", onlyPlayers = false)
- public void listCommand(CommandSender sender) {
+ public void listCommand(CommandSender sender,
+ @Arg(name = "sort", def = "alpha",
+ description = "Sort the list by either alpha or active [alpha, active]. " +
+ " Most active mines are based upon blocks mined since server restart.")
+ String sort,
+ @Arg(name = "page", def = "1",
+ description = "Page of search results (optional) [1-n, ALL]") String page
+ ) {
ChatDisplay display = new ChatDisplay("Mines");
display.text("&8Click a mine's name to see more information.");
- BulletedListComponent.BulletedListBuilder builder =
- new BulletedListComponent.BulletedListBuilder();
-
+ Player player = getPlayer( sender );
+
+ if ( sort != null && !sort.equalsIgnoreCase( "alpha" ) &&
+ !sort.equalsIgnoreCase( "active" )) {
+ if ( "ALL".equalsIgnoreCase( sort )) {
+ // The user did not specify a sort order, but instead this is the page number
+ // so fix it for them:
+ sort = "alpha";
+ page = "ALL";
+ }
+ else {
+ try {
+ int test = Integer.parseInt( sort );
+
+ // This is actually the page number so default to alpha sort:
+ sort = "alpha";
+ page = Integer.toString( test );
+ }
+ catch ( NumberFormatException e ) {
+ // Oof... this isn't a page number, so report an error.
+ sender.sendMessage( "Invalid sort order. Use either alpha, " +
+ "active, or a page number such as [1-n, ALL]" );
+ }
+ }
+ }
+
PrisonMines pMines = PrisonMines.getInstance();
- for (Mine m : pMines.getMines()) {
+ MineManager mMan = pMines.getMineManager();
+
+
+ // Sort mines by: total blocks mined, name
+ List mineList = pMines.getMines();
+
+ // Sort first by name, then blocks mined so final sort order will be:
+ // Most blocks mined, then alphabetical
+ mineList.sort( (a, b) -> a.getName().compareToIgnoreCase( b.getName()) );
+
+ // for now hold off on sorting by total blocks mined.
+ if ( "active".equalsIgnoreCase( sort )) {
+ mineList.sort( (a, b) -> Long.compare(b.getTotalBlocksMined(), a.getTotalBlocksMined()) );
+ }
+
+
+ CommandPagedData cmdPageData = new CommandPagedData(
+ "/mines list " + sort, pMines.getMines().size(),
+ 0, page, 7 );
+
+ BulletedListComponent list =
+ getMinesLineItemList(pMines.getMines(), player, cmdPageData, mMan.isMineStats());
+
+ display.addComponent(list);
+
+
+ cmdPageData.generatePagedCommandFooter( display );
+
+ display.send(sender);
+ }
+
+
+ private BulletedListComponent getMinesLineItemList( List mines, Player player,
+ CommandPagedData cmdPageData, boolean isMineStatsEnabled )
+ {
+ BulletedListComponent.BulletedListBuilder builder =
+ new BulletedListComponent.BulletedListBuilder();
+
+ DecimalFormat dFmt = new DecimalFormat("#,##0");
+ DecimalFormat fFmt = new DecimalFormat("#,##0.00");
+
+ int count = 0;
+
+ for (Mine m : mines) {
- RowComponent row = new RowComponent();
-
- row.addTextComponent( m.getWorldName() + " - " );
+ if ( cmdPageData == null ||
+ count++ >= cmdPageData.getPageStart() && count <= cmdPageData.getPageEnd() ) {
+
+ RowComponent row = new RowComponent();
+
+ //row.addTextComponent( m.getWorldName() + " " );
+
+ row.addFancy(
+ new FancyMessage( String.format("&3Mine: &7%s ", m.getName()) )
+ .command("/mines info " + m.getName())
+ .tooltip("&7Click to view info."));
+
+ boolean hasCmds = m.getResetCommands().size() > 0;
+ if ( hasCmds ) {
+ row.addFancy(
+ new FancyMessage( String.format(" &cCmds: &7%s ",
+ Integer.toString( m.getResetCommands().size() )) )
+ .command("/mines commands list " + m.getName())
+ .tooltip("&7Click to view commands."));
+ }
+
+
+
+ if ( !m.isEnabled() ) {
+ row.addFancy(
+ new FancyMessage( "&cDISABLED!! " )
+ .command("/mines info " + m.getName())
+ .tooltip("&7Click to view possible reason why the mine is " +
+ "disabled. World may not exist? "));
+ }
+
+ row.addFancy(
+ new FancyMessage("&eTP ").command("/mines tp " + m.getName())
+ .tooltip("&7Click to TP to the mine"));
+
+
+ if ( m.isUsePagingOnReset() ) {
+ row.addFancy(
+ new FancyMessage("&5Pgd ")
+ .tooltip("&7Paging Used during Mine Reset"));
+ }
+
+
+ row.addTextComponent( " &3Reset: &7" );
+
+ row.addFancy(
+ new FancyMessage(dFmt.format(m.getRemainingTimeSec()))
+ .tooltip( "Estimated time in seconds before the mine resets" ) );
+ row.addTextComponent( " sec &3(&b" );
+ row.addFancy(
+ new FancyMessage(dFmt.format(m.getResetTime()))
+ .tooltip( "Reset time in seconds" ) );
+ row.addTextComponent( " sec&3)&b" );
+
+ if ( player != null && m.getBounds().withinSameWorld( player.getLocation() ) ) {
+
+ row.addTextComponent( " &3Dist: &7");
+ row.addFancy(
+ new FancyMessage( fFmt.format(m.getBounds().getDistance3d(player.getLocation()))).
+ tooltip("Distance to the Mine") );
+
+ }
+
+ builder.add(row.getFancy());
+
+
+
+ RowComponent row2 = new RowComponent();
+// row2.addTextComponent( " &3Rem: " );
+
+ // Right justify the total blocks mined, with 1000's separators:
+ String blocksMined = " " + dFmt.format( m.getTotalBlocksMined() );
+ blocksMined = blocksMined.substring( blocksMined.length() - 10);
+
+ row2.addFancy(
+ new FancyMessage( String.format(" %s &3Rem: ", blocksMined)).
+ tooltip( "Blocks mined" ) );
+
+ row2.addFancy(
+ new FancyMessage(fFmt.format(m.getPercentRemainingBlockCount())).
+ tooltip( "Percent Blocks Remaining" ) );
+
+ row2.addTextComponent( "%% &3RCnt: &7" );
+
+ row2.addFancy(
+ new FancyMessage(dFmt.format(m.getResetCount())).
+ tooltip( "Times the mine was reset." ) );
+
+
+ row2.addTextComponent( " &3 Vol: &7" );
+ row2.addFancy(
+ new FancyMessage(dFmt.format(m.getBounds().getTotalBlockCount())).
+ tooltip( "Volume in Blocks" ) );
+
+
+// String noteMode = m.getNotificationMode().name() +
+// ( m.getNotificationMode() == MineNotificationMode.radius ?
+// " " + dFmt.format( m.getNotificationRadius() ) : "" );
+// row.addFancy(
+// new FancyMessage(noteMode).tooltip( "Notification Mode" ) );
+//
+// row.addTextComponent( "&7 - &b" );
+//
+// row.addFancy(
+// new FancyMessage(m.getBounds().getDimensions()).tooltip( "Size of Mine" ) );
+//
+// row.addTextComponent( "&7 - &b");
+
+ builder.add(row2.getFancy());
+
+
+ if ( isMineStatsEnabled ) {
+ RowComponent rowStats = new RowComponent();
+
+ rowStats.addTextComponent( " -- &7 Stats :: " );
+
+ rowStats.addTextComponent( m.statsMessage() );
+
+ builder.add(rowStats.getFancy());
+ }
+
+ }
+ }
+
+// display.addComponent(builder.build());
- row.addFancy(
- new FancyMessage("&7" + m.getName()).command("/mines info " + m.getName())
- .tooltip("&7Click to view info."));
+ return builder.build();
+ }
- row.addTextComponent( "&r - " );
-
- row.addFancy(
- new FancyMessage("&eTP").command("/mines tp " + m.getName())
- .tooltip("&7Click to TP to the mine"));
-
- row.addTextComponent( "&r - " );
+ /**
+ * The following command will change the mine's time between resets. But it will
+ * not be applied until after the next reset.
+ *
+ *
+ * @param sender
+ * @param mineName
+ * @param time
+ */
+ @Command(identifier = "mines set skipReset", permissions = "mines.skipreset",
+ description = "Set a mine to skip the reset if not enough blocks have been mined.")
+ public void skipResetCommand(CommandSender sender,
+ @Arg(name = "mineName", description = "The name of the mine to edit.") String mineName,
+ @Arg(name = "enabled", description = "Enable the skip reset processing: 'Enabled' or 'Disable'",
+ def = "disabled") String enabled,
+ @Arg(name = "percent", description = "Percent threshold before resetting.", def = "80" ) String percent,
+ @Arg(name = "bypassLimit", description = "Limit number of skips before bypassing and performing a reset",
+ def = "50") String bypassLimit
+ ) {
+
+ if (performCheckMineExists(sender, mineName)) {
+ setLastMineReferenced(mineName);
+
+ if ( enabled == null || !"enabled".equalsIgnoreCase( enabled ) && !"disabled".equalsIgnoreCase( enabled )) {
+ Output.get().sendWarn( sender,"&7Invalid &benabled&7 value. Must be either &benabled&7 or " +
+ "&bdisabled&7. Was &b%s&7.", (enabled == null ? "&c-blank-" : enabled) );
+ return;
+ }
+
+ PrisonMines pMines = PrisonMines.getInstance();
+ Mine m = pMines.getMine(mineName);
+
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
+
+ boolean skipEnabled = "enabled".equalsIgnoreCase( enabled );
+ double skipPercent = 80.0d;
+ int skipBypassLimit = 50;
+
+ try {
+ skipPercent = Double.parseDouble( percent );
+ if ( skipPercent < 0.0d ) {
+ skipPercent = 0.0d;
+ } else if ( skipPercent > 100.0d ) {
+ skipPercent = 100.0d;
+ }
+ }
+ catch ( NumberFormatException e1 ) {
+ Output.get().sendWarn( sender,"&7Invalid percentage. Not a number. " +
+ "Was &b%s&7.", (enabled == null ? "&c-blank-" : enabled) );
+ return;
+ }
+
+ try {
+ skipBypassLimit = Integer.parseInt( bypassLimit );
+ if ( skipBypassLimit < 1 ) {
+ skipBypassLimit = 1;
+ }
+ }
+ catch ( NumberFormatException e1 ) {
+ Output.get().sendWarn( sender,"&7Invalid bypass limit. Not number. " +
+ "Was &b%s&7.", (bypassLimit == null ? "-blank-" : bypassLimit) );
+ }
+
+ m.setSkipResetEnabled( skipEnabled );
+ m.setSkipResetPercent( skipPercent );
+ m.setSkipResetBypassLimit( skipBypassLimit );
+
+ pMines.getMineManager().saveMine( m );
+
+ // User's message:
+ String message = String.format( "&7mines skipreset for &b%s&7: &b%s&7 " +
+ "threshold: &b%.2f&7 percent bypassLimit: &b%d",
+ m.getName(), (skipEnabled ? "enabled" : "disabled"),
+ skipPercent, skipBypassLimit );
+ Output.get().sendInfo( sender, message );
+
+ // Server Log message:
+ Player player = getPlayer( sender );
+ Output.get().logInfo( "%s :: Changed by: %s", message,
+ (player == null ? "console" : player.getDisplayName()) );
+ }
+ }
- row.addTextComponent( "&3Size: &7%d&8x&7%d&8x&7%d", Math.round(m.getBounds().getWidth()),
- Math.round(m.getBounds().getHeight()), Math.round(m.getBounds().getLength()) );
- row.addTextComponent( "&r - &3Volume: &7%d &3blocks", m.getBounds().getTotalBlockCount() );
+
+ /**
+ * The following command will change the mine's time between resets. But it will
+ * not be applied until after the next reset.
+ *
+ *
+ * @param sender
+ * @param mineName
+ * @param time
+ */
+ @Command(identifier = "mines set resetTime", permissions = "mines.resettime",
+ description = "Set a mine's time to reset.")
+ public void resetTimeCommand(CommandSender sender,
+ @Arg(name = "mineName", description = "The name of the mine to edit.") String mineName,
+ @Arg(name = "time", description = "Time in seconds for the mine to auto reset." ) String time
+
+ ) {
+
+ if (performCheckMineExists(sender, mineName)) {
+ setLastMineReferenced(mineName);
+
+ try {
+ int resetTime = MineData.MINE_RESET__TIME_SEC__DEFAULT;
+
+ if ( time != null && time.trim().length() > 0 ) {
+ resetTime = Integer.parseInt( time );
+ }
+
+ if ( resetTime < MineData.MINE_RESET__TIME_SEC__MINIMUM ) {
+ Output.get().sendWarn( sender,
+ "&7Invalid resetTime value for &b%s&7. Must be an integer value of &b%d&7 or greater. [&b%d&7]",
+ mineName, MineData.MINE_RESET__TIME_SEC__MINIMUM, resetTime );
+ } else {
+ PrisonMines pMines = PrisonMines.getInstance();
+ Mine m = pMines.getMine(mineName);
+
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
+
+ m.setResetTime( resetTime );
+
+ pMines.getMineManager().saveMine( m );
+
+ // User's message:
+ Output.get().sendInfo( sender, "&7mines set resettime: &b%s &7resetTime set to &b%d", m.getName(), resetTime );
+
+ // Server Log message:
+ Player player = getPlayer( sender );
+ Output.get().logInfo( "&bmines set resettime&7: &b%s &7set &b%s &7resetTime to &b%d",
+ (player == null ? "console" : player.getDisplayName()), m.getName(), resetTime );
+ }
+ }
+ catch ( NumberFormatException e ) {
+ Output.get().sendWarn( sender,
+ "&7Invalid resetTime value for &b%s&7. Must be an integer value of &b%d &7or greater. [&b%s&7]",
+ mineName, MineData.MINE_RESET__TIME_SEC__MINIMUM, time );
+ }
+ }
+ }
+
+
+
+ /**
+ * When a mine reaches zero blocks, a manual reset will be issued to run. By default
+ * it will have a 0 second delay before running, but this command controls how long of
+ * a delay to use.
+ *
+ *
+ * Although the delay is in seconds, it should be known that the value will be multiplied
+ * by 20 to convert it to ticks. So any value less than 0.05 will be treated as zero and
+ * effectively will be in 0.05 increments. Give or take a tick should not matter, but
+ * beware if a player, or owner, complains that 0.17 is the same as 0.15.
+ *
+ *
+ * @param sender
+ * @param mineName
+ * @param time
+ */
+ @Command(identifier = "mines set zeroBlockResetDelay", permissions = "mines.zeroblockresetdelay",
+ description = "Set a mine's delay before reset when it reaches zero blocks.")
+ public void zeroBlockResetDelayCommand(CommandSender sender,
+ @Arg(name = "mineName", description = "The name of the mine to edit.") String mineName,
+ @Arg(name = "time/DISABLE", description = "Delay in seconds before resetting when the mine reaches " +
+ "zero blocks, or DISABLE." ) String time
+
+ ) {
+
+ if (performCheckMineExists(sender, mineName)) {
+ setLastMineReferenced(mineName);
+
+ try {
+ double resetTime =
+ time != null && "disable".equalsIgnoreCase( time ) ? -1.0d :
+ 0.0d;
+
+ if ( resetTime != -1.0d && time != null && time.trim().length() > 0 ) {
+ resetTime = Double.parseDouble( time );
+
+ // Only displaying two decimal positions, since 0.01 is 10 ms.
+ // Anything less than 0.01 is set to ZERO so it does not mess with anything unseen.
+ // Also any value less than 0.05 is basically zero since this value has to be
+ // converted to ticks.
+ if ( resetTime < 0.01d ) {
+ resetTime = 0.0d;
+ }
+ }
+
+ PrisonMines pMines = PrisonMines.getInstance();
+ Mine m = pMines.getMine(mineName);
+
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
+
+ m.setZeroBlockResetDelaySec( resetTime );
+
+ pMines.getMineManager().saveMine( m );
+
+ DecimalFormat dFmt = new DecimalFormat("#,##0.00");
+ // User's message:
+ if ( m.isZeroBlockResetDisabled() ) {
+ Output.get().sendInfo( sender, "&7Mine &b%s Zero Block Reset Delay: &cDISABLED",
+ m.getName(), dFmt.format( resetTime ) );
+
+ } else {
+ Output.get().sendInfo( sender, "&7Mine &b%s Zero Block Reset Delay: &b%s &7sec",
+ m.getName(), dFmt.format( resetTime ) );
+
+ }
+
+ // Server Log message:
+ Player player = getPlayer( sender );
+ Output.get().logInfo( "&7Mine &b%s Zero Block Reset Delay: &b%s &7set it to &b%s &7sec",
+ (player == null ? "console" : player.getDisplayName()),
+ m.getName(), dFmt.format( resetTime ) );
+ }
+ catch ( NumberFormatException e ) {
+ Output.get().sendWarn( sender,
+ "&7Invalid zeroBlockResetDelay value for &b%s&7. Must be an double value of &b0.00 &7or " +
+ "greater. [&b%s&7]",
+ mineName, time );
+ }
+ }
+ }
+
+
+
+ /**
+ * The following command will change the mine's time between resets. But it will
+ * not be applied until after the next reset.
+ *
+ *
+ * @param sender
+ * @param mineName
+ * @param time
+ */
+ @Command(identifier = "mines set resetThreshold", permissions = "mines.resetThreshold",
+ description = "Triggers a mine reset once this threshold is crossed and the remaining " +
+ "block percentage is less than or equal to this value")
+ public void resetThresholdPercentCommand(CommandSender sender,
+ @Arg(name = "mineName", description = "The name of the mine to edit.") String mineName,
+ @Arg(name = "percent", description = "Threshold percent to trigger a reset.(0 is disabled)",
+ def = "0" ) String percent
+ ) {
+
+ if (performCheckMineExists(sender, mineName)) {
+ setLastMineReferenced(mineName);
- builder.add(row.getFancy());
- }
- display.addComponent(builder.build());
- display.send(sender);
+ PrisonMines pMines = PrisonMines.getInstance();
+ Mine m = pMines.getMine(mineName);
+
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
+
+ double thresholdPercent = 0.0d;
+
+ try {
+ thresholdPercent = Double.parseDouble( percent );
+ if ( thresholdPercent < 0.0d ) {
+ thresholdPercent = 0.0d;
+ } else if ( thresholdPercent > 100.0d ) {
+ thresholdPercent = 100.0d;
+ }
+ }
+ catch ( NumberFormatException e1 ) {
+ Output.get().sendWarn( sender,"&7Invalid percentage. Not a number. " +
+ "Was &b%s&7.", (percent == null ? "&c-blank-" : percent) );
+ return;
+ }
+
+
+ if ( thresholdPercent == m.getResetThresholdPercent() ) {
+ String msg = "The Reset Threshold Percent was not changed.";
+ Output.get().sendInfo( sender, msg );
+ return;
+ }
+
+ m.setResetThresholdPercent( thresholdPercent );
+
+ pMines.getMineManager().saveMine( m );
+
+ double blocks = m.getBounds().getTotalBlockCount() *
+ m.getResetThresholdPercent() / 100.0d;
+
+ DecimalFormat dFmt = new DecimalFormat("#,##0");
+ DecimalFormat fFmt = new DecimalFormat("#,##0.00");
+
+ // User's message:
+ String message = String.format( "&7The Reset Threshold Percent for mine &b%s&7 was set to &b%s&7, " +
+ "which is about &b%s &7blocks.",
+ m.getName(),
+ fFmt.format( m.getResetThresholdPercent() ),
+ dFmt.format( blocks ) );
+ Output.get().sendInfo( sender, message );
+
+ // Server Log message:
+ Player player = getPlayer( sender );
+ Output.get().logInfo( "%s :: Changed by: %s", message,
+ (player == null ? "console" : player.getDisplayName()) );
+ }
+ }
+
+
+
+ @Command(identifier = "mines set notification", permissions = "mines.notification",
+ description = "Set a mine's notification mode.")
+ public void setNotificationCommand(CommandSender sender,
+ @Arg(name = "mineName", description = "The name of the mine to edit.") String mineName,
+ @Arg(name = "mode", def="displayOptions", description = "The notification mode to use: disabled, within, radius")
+ String mode,
+ @Arg(name = "radius", def="0", description = "The distance from the center of the mine to notify players of a reset." )
+ String radius
+
+ ) {
+
+ if (performCheckMineExists(sender, mineName)) {
+ setLastMineReferenced(mineName);
+
+ PrisonMines pMines = PrisonMines.getInstance();
+ Mine m = pMines.getMine(mineName);
+
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
+
+ MineNotificationMode noteMode = MineNotificationMode.fromString( mode, MineNotificationMode.displayOptions );
+
+ if ( noteMode == MineNotificationMode.displayOptions ) {
+ sender.sendMessage( "&7Select a Mode: &bdisabled&7, &bwithin &7the mine, &bradius " +
+ "&7from center of mine." );
+ } else {
+ long noteRadius = 0L;
+ if ( noteMode == MineNotificationMode.radius ) {
+ if ( radius == null || radius.trim().length() == 0 ) {
+ noteRadius = MineData.MINE_RESET__BROADCAST_RADIUS_BLOCKS;
+ } else {
+ try {
+ noteRadius = Long.parseLong( radius );
+
+ if ( noteRadius < 1 ) {
+ noteRadius = MineData.MINE_RESET__BROADCAST_RADIUS_BLOCKS;
+ DecimalFormat dFmt = new DecimalFormat("#,##0");
+ Output.get().sendWarn( sender, "&7Invalid radius value for &b%s&7. " +
+ "Must be an positive non-zero integer. Using the default value: &b%s &7[&b%s&7]",
+ mineName, dFmt.format(MineData.MINE_RESET__BROADCAST_RADIUS_BLOCKS), radius );
+ }
+ }
+ catch ( NumberFormatException e ) {
+ e.printStackTrace();
+ Output.get().sendWarn( sender, "&7Invalid notification radius for &b%s&7. " +
+ "Must be an positive non-zero integer. [&b%s&7]",
+ mineName, radius );
+ }
+ }
+ }
+
+ if ( m.getNotificationMode() != noteMode || m.getNotificationRadius() != noteRadius ) {
+ m.setNotificationMode( noteMode );
+ m.setNotificationRadius( noteRadius );
+
+ pMines.getMineManager().saveMine( m );
+
+ DecimalFormat dFmt = new DecimalFormat("#,##0");
+ // message: notification mode changed
+ Output.get().sendInfo( sender, "&7Notification mode was changed for &b%s&7: &b%s %s",
+ mineName, m.getNotificationMode().name(),
+ (m.getNotificationMode() == MineNotificationMode.radius ?
+ dFmt.format( m.getNotificationRadius() ) : "" ));
+
+ } else {
+ // message: notification mode did not change
+ Output.get().sendInfo( sender, "&7Notification mode was not changed for mine &b%s&7.", mineName );
+ }
+ }
+ }
}
- @Command(identifier = "mines set area", permissions = "mines.set", description = "Set the area of a mine to your current selection.")
+ @Command(identifier = "mines set notificationPerm", permissions = "mines.notification",
+ description = "Enable or disable a mine's notification permission. If enabled, then players " +
+ "must have the mine's permission to get messages for reset. This filter " +
+ "can be combined with the other notification settings.")
+ public void setNotificationPermissionCommand(CommandSender sender,
+ @Arg(name = "mineName", description = "The name of the mine to edit.") String mineName,
+ @Arg(name = "action", def="enable", description = "Enable or disable the permission filtering: [enable, disable]")
+ String action
+
+ ) {
+
+ if (performCheckMineExists(sender, mineName)) {
+ setLastMineReferenced(mineName);
+
+ PrisonMines pMines = PrisonMines.getInstance();
+ Mine m = pMines.getMine(mineName);
+
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
+
+ if ( !action.equalsIgnoreCase( "enable" ) && !action.equalsIgnoreCase( "disable" )) {
+ sender.sendMessage( "&7Invalid value for action: [enable, disable]" );
+ return;
+ }
+
+ if ( action.equalsIgnoreCase( "enable" ) && !m.isUseNotificationPermission() ) {
+ sender.sendMessage( "&7Notification Permission filter has been enabled." );
+ m.setUseNotificationPermission( true );
+ pMines.getMineManager().saveMine( m );
+ }
+ else if ( action.equalsIgnoreCase( "disable" ) && m.isUseNotificationPermission() ) {
+ sender.sendMessage( "&7Notification Permission filter has been disabled." );
+ m.setUseNotificationPermission( false );
+ pMines.getMineManager().saveMine( m );
+ }
+ else {
+
+ sender.sendMessage( "&7Notification Permission filter was not changed. Canceling." );
+ }
+
+
+ }
+ }
+
+
+
+ @Command(identifier = "mines set area", permissions = "mines.set",
+ description = "Set the area of a mine to your current selection.")
public void redefineCommand(CommandSender sender,
- @Arg(name = "mineName", description = "The name of the mine to edit.") String name) {
+ @Arg(name = "mineName", description = "The name of the mine to edit.") String mineName) {
- if (!performCheckMineExists(sender, name)) {
+ if (!performCheckMineExists(sender, mineName)) {
return;
}
- Selection selection = Prison.get().getSelectionManager().getSelection((Player) sender);
PrisonMines pMines = PrisonMines.getInstance();
+ Mine m = pMines.getMine(mineName);
+
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
+
+ Selection selection = Prison.get().getSelectionManager().getSelection((Player) sender);
+
if (!selection.isComplete()) {
pMines.getMinesMessages().getLocalizable("select_bounds")
.sendTo(sender);
@@ -604,32 +1713,122 @@ public void redefineCommand(CommandSender sender,
// TODO check to see if they are the same boundaries, if not, don't change...
- setLastMineReferenced(name);
+ setLastMineReferenced(mineName);
- Mine m = pMines.getMineManager().getMine(name).get();
m.setBounds(selection.asBounds());
pMines.getMineManager().saveMine( m );
pMines.getMinesMessages().getLocalizable("mine_redefined")
.sendTo(sender);
- pMines.getMineManager().clearCache();
+
+ // Delete the selection:
+ Prison.get().getSelectionManager().clearSelection((Player) sender);
+ //pMines.getMineManager().clearCache();
+ }
+
+
+ @Command(identifier = "mines set resetpaging", permissions = "mines.resetpaging",
+ description = "Enable paging during a mine reset.")
+ public void setMineResetPagingCommand(CommandSender sender,
+ @Arg(name = "mineName", description = "The name of the mine to edit.") String mineName,
+ @Arg(name = "paging", def="disabled",
+ description = "Enable or disable paging [disable, enable]")
+ String paging
+ ) {
+
+ if (performCheckMineExists(sender, mineName)) {
+ setLastMineReferenced(mineName);
+
+ PrisonMines pMines = PrisonMines.getInstance();
+ Mine m = pMines.getMine(mineName);
+
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
+
+ if ( paging == null || !"disable".equalsIgnoreCase( paging ) && !"enable".equalsIgnoreCase( paging ) ) {
+ sender.sendMessage( "&cInvalid paging option&7. Use &adisable&7 or &aenable&7" );
+ return;
+ }
+
+ if ( "disable".equalsIgnoreCase( paging ) && m.isUsePagingOnReset() ) {
+ m.setUsePagingOnReset( false );
+ pMines.getMineManager().saveMine( m );
+ sender.sendMessage( String.format( "&7Mine Reset Paging has been disabled for mine %s.", m.getName()) );
+ }
+ else if ( "enable".equalsIgnoreCase( paging ) && !m.isUsePagingOnReset() ) {
+ m.setUsePagingOnReset( true );
+ pMines.getMineManager().saveMine( m );
+ sender.sendMessage( String.format( "&7Mine Reset Paging has been enabled for mine %s.", m.getName()) );
+ }
+
+ }
}
- @Command(identifier = "mines tp", permissions = "mines.tp", description = "TP to the mine.")
+ @Command(identifier = "mines tp", description = "TP to the mine.",
+ altPermissions = {"mines.tp", "mines.tp.[mineName]"})
public void mineTp(CommandSender sender,
- @Arg(name = "mineName", description = "The name of the mine to teleport to.") String name) {
+ @Arg(name = "mineName", description = "The name of the mine to teleport to.") String mineName,
+
+ @Arg(name = "player", def = "", description = "Player name to TP - " +
+ "Only console or rank command can include this parameter") String playerName
+
+ ) {
- if (!performCheckMineExists(sender, name)) {
- return;
+ Player player = getPlayer( sender );
+
+ Player playerAlt = getOnlinePlayer( playerName );
+
+ if (player == null || !player.isOnline()) {
+
+ if ( playerName != null && playerName.trim().length() > 0 && playerAlt == null) {
+ sender.sendMessage( "&3Specified player is not in the game so they cannot be teleported." );
+ }
+
+ // If the sender is console or its being ran as a rank command, and the playerName is
+ // a valid online player, then use that player as the active player issuing the command:
+ if ( playerAlt != null && playerAlt.isOnline() ) {
+ player = playerAlt;
+ }
+ else {
+ sender.sendMessage( "&3You must be a player in the game to run this command." );
+ return;
+ }
+
+ }
+ else if ( playerAlt != null ) {
+ sender.sendMessage( "&3You cannot teleport other players to a mine. Ignoring parameter." );
}
- setLastMineReferenced(name);
+ // Load mine information first to confirm the mine exists and the parameter is correct:
+ if (!performCheckMineExists(sender, mineName)) {
+ return;
+ }
+ setLastMineReferenced(mineName);
+
PrisonMines pMines = PrisonMines.getInstance();
- Mine m = pMines.getMineManager().getMine(name).get();
+ Mine m = pMines.getMine(mineName);
+
+ String minePermission = "mines.tp." + m.getName().toLowerCase();
+ if ( !sender.isOp() &&
+ !sender.hasPermission("mines.tp") &&
+ !sender.hasPermission( minePermission ) ) {
+ Output.get()
+ .sendError(sender, "You need the permission '%s' or '%s' to tp to this mine.",
+ "mines.tp", minePermission );
+ return;
+ }
+
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
+
if ( sender instanceof Player ) {
m.teleportPlayerOut( (Player) sender );
} else {
@@ -639,13 +1838,269 @@ public void mineTp(CommandSender sender,
}
+
+ @Command(identifier = "mines stats", permissions = "mines.stats", description = "Toggle stats on all mines.")
+ public void mineStats(CommandSender sender) {
+
+ PrisonMines pMines = PrisonMines.getInstance();
+ MineManager mMan = pMines.getMineManager();
+
+ // toggle the stats:
+ mMan.setMineStats( !mMan.isMineStats() );
+
+ if ( mMan.isMineStats() ) {
+ sender.sendMessage(
+ "&3Mine Stats are now enabled. Use &7/mines list&3 to view stats on last mine reset. ");
+ } else {
+ sender.sendMessage( "&3Mine stats are now disabled." );
+ }
+ }
+
+
+
+ @Command(identifier = "mines whereami", permissions = "mines.whereami",
+ description = "Identifies what mines you are in, or are the closest to." )
+ public void mineWhereAmI(CommandSender sender) {
+
+ Player player = getPlayer( sender );
+
+ if (player == null || !player.isOnline()) {
+ sender.sendMessage( "&3You must be a player in the game to run this command." );
+ return;
+ }
+
+ player.sendMessage( "&3Your coordinates are: &7" + player.getLocation().toBlockCoordinates() );
+
+ PrisonMines pMines = PrisonMines.getInstance();
+
+ List inMine = new ArrayList<>();
+ TreeMap nearMine = new TreeMap<>();
+ for ( Mine mine : pMines.getMineManager().getMines() ) {
+ if ( mine.getBounds().within( player.getLocation() ) ) {
+ inMine.add( mine );
+ }
+
+ // This is checking for within a certain distance from any mine, so we just need to use
+ // some arbitrary distance as a max radius. We do not want to use the individual values
+ // that have been set for each mine.
+ else if ( mine.getBounds().within( player.getLocation(), MineData.MINE_RESET__BROADCAST_RADIUS_BLOCKS) ) {
+ Double distance = mine.getBounds().getDistance3d( player.getLocation() );
+// Double distance = new Bounds( mine.getBounds().getCenter(), player.getLocation()).getDistance();
+ nearMine.put( distance.intValue(), mine );
+ }
+ }
+
+ if ( inMine.size() > 0 ) {
+ // You are in the mines:
+ for ( Mine m : inMine ) {
+ sender.sendMessage( "&3You are in mine &7" + m.getName() );
+ }
+ }
+ if ( nearMine.size() > 0 ) {
+ // You are near the mines:
+ int cnt = 0;
+ Set distances = nearMine.keySet();
+ for ( Integer dist : distances ) {
+ Mine m = nearMine.get( dist );
+ sender.sendMessage( "&3You are &7" + dist + " &7blocks away from the center of mine &3" + m.getName() );
+ if ( ++cnt >= 5 ) {
+ break;
+ }
+ }
+
+ } else {
+ // you are not near any mines:
+ sender.sendMessage( "&3Sorry, you are not within " + MineData.MINE_RESET__BROADCAST_RADIUS_BLOCKS +
+ " blocks from any mine." );
+ }
+
+ }
+
+ private Player getPlayer( CommandSender sender ) {
+ Optional player = Prison.get().getPlatform().getPlayer( sender.getName() );
+ return player.isPresent() ? player.get() : null;
+ }
+
+ private Player getOnlinePlayer( String playerName ) {
+ Player player = null;
+ if ( playerName != null ) {
+ Optional oPlayer = Prison.get().getPlatform().getPlayer( playerName );
+ player = oPlayer.isPresent() ? oPlayer.get() : null;
+ }
+ return player;
+ }
+
+
+
@Command(identifier = "mines wand", permissions = "mines.wand", description = "Receive a wand to select a mine area.")
public void wandCommand(Player sender) {
+
+ Player player = getPlayer( sender );
+
+ if (player == null || !player.isOnline()) {
+ sender.sendMessage( "&3You must be a player in the game to run this command." );
+ return;
+ }
+
Prison.get().getSelectionManager().bestowSelectionTool(sender);
sender.sendMessage(
"&3Here you go! &7Left click to select the first corner, and right click to select the other.");
}
+
+
+ @Command(identifier = "mines command list", description = "Lists the commands for a mine.",
+ onlyPlayers = false, permissions = "mines.command")
+ public void commandList(CommandSender sender,
+ @Arg(name = "mineName") String mineName) {
+
+// if ( 1 < 2 ) {
+// sender.sendMessage( "&cThis command is disabled&7. It will be enabled in the near future." );
+// return;
+// }
+
+ if (!performCheckMineExists(sender, mineName)) {
+ return;
+ }
+
+
+ setLastMineReferenced(mineName);
+
+ PrisonMines pMines = PrisonMines.getInstance();
+// MineManager mMan = pMines.getMineManager();
+ Mine m = pMines.getMine(mineName);
+
+ if (m.getResetCommands() == null || m.getResetCommands().size() == 0) {
+ Output.get().sendInfo(sender, "The mine '%s' contains no commands.", m.getName());
+ return;
+ }
+
+
+ ChatDisplay display = new ChatDisplay("ResetCommand for " + m.getName());
+ display.text("&8Click a command to remove it.");
+ BulletedListComponent.BulletedListBuilder builder =
+ new BulletedListComponent.BulletedListBuilder();
+
+ for (String command : m.getResetCommands()) {
+ FancyMessage msg = new FancyMessage( "&a'&7" + command + "&a'" )
+ .command("/mines command remove " + mineName + " " + command)
+ .tooltip("Click to remove.");
+ builder.add(msg);
+ }
+
+ display.addComponent(builder.build());
+ display.addComponent(new FancyMessageComponent(
+ new FancyMessage("&7[&a+&7] Add").suggest("/mines command add " + mineName + " /")
+ .tooltip("&7Add a new command.")));
+ display.send(sender);
+ }
+
+
+ @Command(identifier = "mines command remove", description = "Removes a command from a mine.",
+ onlyPlayers = false, permissions = "mines.command")
+ public void commandRemove(CommandSender sender,
+ @Arg(name = "mineName") String mineName,
+ @Arg(name = "command",
+ description = "Exact command to remove including the 'before: ' and 'after: ' states.")
+ @Wildcard String command) {
+
+// if ( 1 < 2 ) {
+// sender.sendMessage( "&cThis command is disabled&7. It will be enabled in the near future." );
+// return;
+// }
+
+ if (command.startsWith("/")) {
+ command = command.replaceFirst("/", "");
+ }
+
+ if (!performCheckMineExists(sender, mineName)) {
+ return;
+ }
+
+ setLastMineReferenced(mineName);
+
+ PrisonMines pMines = PrisonMines.getInstance();
+// MineManager mMan = pMines.getMineManager();
+ Mine m = pMines.getMine(mineName);
+
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
+
+ if (m.getResetCommands() == null || m.getResetCommands().size() == 0) {
+ Output.get().sendInfo(sender, "The mine '%s' contains no commands.", m.getName());
+ return;
+ }
+
+ if ( m.getResetCommands().remove(command) ) {
+
+ pMines.getMineManager().saveMine( m );
+
+ Output.get().sendInfo(sender, "Removed command '%s' from the mine '%s'.",
+ command, m.getName());
+ } else {
+ Output.get().sendWarn(sender,
+ String.format("The mine %s doesn't contain that command. Nothing was changed.",
+ m.getName()));
+ }
+ }
+
+ @Command(identifier = "mines command add", description = "Adds a command to a mine with NO placeholders.",
+ onlyPlayers = false, permissions = "mines.command")
+ public void commandAdd(CommandSender sender,
+ @Arg(name = "mineName") String mineName,
+ @Arg(name = "state", def = "before", description = "State can be either before or after.") String state,
+ @Arg(name = "command") @Wildcard String command) {
+
+// if ( 1 < 2 ) {
+// sender.sendMessage( "&cThis command is disabled&7. It will be enabled in the near future." );
+// return;
+// }
+
+ if (command.startsWith("/")) {
+ command = command.replaceFirst("/", "");
+ }
+
+ if (!performCheckMineExists(sender, mineName)) {
+ return;
+ }
+
+ if ( state == null || !state.equalsIgnoreCase( "before" ) && !state.equalsIgnoreCase( "after" )) {
+ sender.sendMessage(
+ String.format("&7Please provide a valid state: b&before&7 or &bafter&7. Was state=[&b%s&7]",
+ state ));
+ return;
+ }
+
+ setLastMineReferenced(mineName);
+
+ PrisonMines pMines = PrisonMines.getInstance();
+// MineManager mMan = pMines.getMineManager();
+ Mine m = pMines.getMine(mineName);
+
+ if ( !m.isEnabled() ) {
+ sender.sendMessage( "&cMine is disabled&7. Use &a/mines info &7for possible cause." );
+ return;
+ }
+
+ if ( command == null || command.trim().length() == 0 ) {
+ sender.sendMessage(
+ String.format( "&7Please provide a valid command: command=[%s]", command) );
+ return;
+
+ }
+
+ String newComand = state + ": " + command;
+ m.getResetCommands().add(newComand);
+
+ pMines.getMineManager().saveMine( m );
+
+ Output.get().sendInfo(sender, "&7Added command '&b%s&7' to the mine '&b%s&7'.",
+ newComand, m.getName());
+
+ }
+
public Long getConfirmTimestamp()
{
return confirmTimestamp;
@@ -666,7 +2121,8 @@ public void setConfirmTimestamp( Long confirmTimestamp )
*/
public String getLastMineReferenced()
{
- if ( System.currentTimeMillis() - getLastMineReferencedTimestamp() > (30 * 60 * 1000))
+ if ( getLastMineReferencedTimestamp() != null &&
+ System.currentTimeMillis() - getLastMineReferencedTimestamp() > (30 * 60 * 1000))
{
setLastMineReferenced( null );
}
@@ -687,4 +2143,5 @@ public void lastMineReferenced( Long lastMineReferencedTimestamp )
this.lastMineReferencedTimestamp = lastMineReferencedTimestamp;
}
+
}
diff --git a/prison-mines/src/main/java/tech/mcprison/prison/mines/data/Mine.java b/prison-mines/src/main/java/tech/mcprison/prison/mines/data/Mine.java
index 0d3280073..cace801bf 100644
--- a/prison-mines/src/main/java/tech/mcprison/prison/mines/data/Mine.java
+++ b/prison-mines/src/main/java/tech/mcprison/prison/mines/data/Mine.java
@@ -19,19 +19,20 @@
package tech.mcprison.prison.mines.data;
import java.util.ArrayList;
-import java.util.HashMap;
+import java.util.HashSet;
import java.util.List;
-import java.util.Map;
import java.util.Optional;
+import java.util.Set;
import tech.mcprison.prison.Prison;
-import tech.mcprison.prison.internal.Player;
import tech.mcprison.prison.internal.World;
+import tech.mcprison.prison.internal.block.PrisonBlock;
import tech.mcprison.prison.mines.MineException;
import tech.mcprison.prison.mines.PrisonMines;
-import tech.mcprison.prison.mines.events.MineResetEvent;
import tech.mcprison.prison.mines.managers.MineManager;
import tech.mcprison.prison.output.Output;
+import tech.mcprison.prison.selection.Selection;
+import tech.mcprison.prison.sorting.PrisonSortable;
import tech.mcprison.prison.store.Document;
import tech.mcprison.prison.util.BlockType;
import tech.mcprison.prison.util.Bounds;
@@ -40,47 +41,166 @@
/**
* @author Dylan M. Perks
*/
-public class Mine {
-
- private Bounds bounds;
-
- private Location spawn;
- private String worldName, name;
- private boolean hasSpawn = false;
-
- private List blocks;
-
+public class Mine
+ extends MineScheduler
+ implements PrisonSortable {
/**
* Creates a new, empty mine instance
*/
public Mine() {
- blocks = new ArrayList<>();
+ super();
+
+ // Kick off the initialize:
+ initialize();
}
- private Location getLocation(Document doc, World world, String x, String y, String z) {
- return new Location(world, (double) doc.get(x), (double) doc.get(y), (double) doc.get(z));
- }
- private Location getLocation(Document doc, World world, String x, String y, String z, String pitch, String yaw) {
- Location loc = getLocation(doc, world, x, y, z);
- loc.setPitch( ((Double) doc.get(pitch)).floatValue() );
- loc.setYaw( ((Double) doc.get(yaw)).floatValue() );
- return loc;
+ /**
+ * This is called when a mine is first created.
+ *
+ *
+ * @param name
+ * @param selection
+ */
+ public Mine(String name, Selection selection) {
+ super();
+
+ setName(name);
+ setBounds(selection.asBounds());
+
+ setWorldName( getBounds().getMin().getWorld().getName());
+
+ setEnabled( true );
+
+ // Kick off the initialize:
+ initialize();
}
+
/**
- * Loads a mine from a document.
+ * Loads a mine from a document.
+ *
+ *
+ * Note that the location where the loadFromDocument() occurs in the whole
+ * "create the objects" is in the "middle". All classes that are extended
+ * from are instantiated first due to the super() function call. So when Mine
+ * tries to be instantiated, it first drills all the way down to MineData and
+ * then runs all the initialization code within MineData and then works back
+ * through all of the classes, instantiating everything, one layer at a time.
+ *
+ *
+ * Then when it gets back up to this class, Mine, all parents have been fully
+ * instantiated so all collections will have been assigned non-null values
+ * as an example. Then this class loads the data from the document object.
+ * This is important, since all parents have been initialized, now the document
+ * loader is making it a "mine".
+ *
+ *
+ * Then at that point, after the mine data is loaded, it once again drills all the
+ * way down to the MineData ancestor class, using the initialize() functions, where
+ * it then starts to initialize all classes from MineData, back up to Mine.
+ * What this enables and allows, is when a class is initialized, it will have access
+ * to the fully loaded mine data. This is a perfect example of being able to start
+ * submitting the mine reset jobs since all data has been loaded, and all lower
+ * functions have been ran.
+ *
+ *
+ * So the over all design of the Mine objects is that all ancestors instantiate
+ * first, from MineData to Mine. Then the mine is loaded from the file system.
+ * Then all ancestors are initialized from MineData to Mine. This gives a high
+ * degree of control over when actions can be ran over a mine, and have confidence the
+ * data and conditions will be there.
+ *
*
* @param document The document to load from.
* @throws MineException If the mine couldn't be loaded from the document.
*/
public Mine(Document document) throws MineException {
+ super();
- Optional worldOptional = Prison.get().getPlatform().getWorld((String) document.get("world"));
+ loadFromDocument( document );
+
+ // Kick off the initialize:
+ // This is critically vital to ensure the workflow is generated with the contents
+ // from the document and not the defaults as set by the super().
+ initialize();
+ }
+
+
+ /**
+ * This initialize function gets called after the classes are
+ * instantiated, and is initiated from Mine class and propagates
+ * to the MineData class. Good for kicking off the scheduler.
+ *
+ */
+ @Override
+ protected void initialize() {
+ super.initialize();
+
+ }
+
+ /**
+ * The loading of a mine checks to ensure if the world exists. If not, then
+ * traditionally, it would not load the mine. The problem with this model is
+ * the world may not exist yet, if running Multiverse-core (or another similar
+ * plugin) and as such, may falsely cause mine failures. This is the situation if
+ * the mine exists within a world that must be loaded by Multiverse-core. If it was
+ * a standard world, then it would be fine.
+ *
+ *
+ * Soft dependencies do not provide a solution. One bad solution for this
+ * situation, is to manually add a hard dependency to Multiverse-core. This
+ * should not be used.
+ *
+ *
+ * As a better solution to this problem, mines will be loaded as normal, but
+ * if the world does not exist, then their initialization, or enablement, will be
+ * delayed until the world is available.
+ *
+ *
+ * @param document
+ * @throws MineException
+ */
+ @SuppressWarnings( "unchecked" )
+ private void loadFromDocument( Document document )
+ throws MineException {
+
+ boolean dirty = false;
+ boolean inconsistancy = false;
+
+ String worldName = (String) document.get("world");
+ setWorldName( worldName );
+ setName((String) document.get("name")); // Mine name:
+
+ World world = null;
+
+ if ( worldName == null ) {
+ Output.get().logInfo( "Mines.loadFromDocument: Failure: World does not exist in Mine file. mine= %s " +
+ "Contact support on how to fix.",
+ getName());
+ }
+
+ Optional worldOptional = Prison.get().getPlatform().getWorld(worldName);
if (!worldOptional.isPresent()) {
- throw new MineException("world doesn't exist");
+ MineManager mineMan = PrisonMines.getInstance().getMineManager();
+
+ // Store this mine and the world in MineManager's unavailableWorld for later
+ // processing and hooking up to the world object. Print an error message upon
+ // the first mine's world not existing.
+ mineMan.addUnavailableWorld( worldName, this );
+
+ setEnabled( false );
+ }
+ else {
+ world = worldOptional.get();
+ setEnabled( true );
}
- World world = worldOptional.get();
+
+// World world = worldOptional.get();
+
+
+ Double resetTimeDouble = (Double) document.get("resetTime");
+ setResetTime( resetTimeDouble != null ? resetTimeDouble.intValue() : PrisonMines.getInstance().getConfig().resetTime );
setBounds( new Bounds(
getLocation(document, world, "minX", "minY", "minZ"),
@@ -91,358 +211,236 @@ public Mine(Document document) throws MineException {
setSpawn(getLocation(document, world, "spawnX", "spawnY", "spawnZ", "spawnPitch", "spawnYaw"));
}
- setWorldName(world.getName());
- setName((String) document.get("name"));
+
+ setNotificationMode( MineNotificationMode.fromString( (String) document.get("notificationMode")) );
+ Double noteRadius = (Double) document.get("notificationRadius");
+ setNotificationRadius( noteRadius == null ? MINE_RESET__BROADCAST_RADIUS_BLOCKS : noteRadius.longValue() );
- this.blocks = new ArrayList<>();
+ Double zeroBlockResetDelaySec = (Double) document.get("zeroBlockResetDelaySec");
+ setZeroBlockResetDelaySec( zeroBlockResetDelaySec == null ? 0.0d : zeroBlockResetDelaySec.doubleValue() );
+
+ Boolean skipResetEnabled = (Boolean) document.get( "skipResetEnabled" );
+ setSkipResetEnabled( skipResetEnabled == null ? false : skipResetEnabled.booleanValue() );
+ Double skipResetPercent = (Double) document.get( "skipResetPercent" );
+ setSkipResetPercent( skipResetPercent == null ? 80.0D : skipResetPercent.doubleValue() );
+ Double skipResetBypassLimit = (Double) document.get( "skipResetBypassLimit" );
+ setSkipResetBypassLimit( skipResetBypassLimit == null ? 50 : skipResetBypassLimit.intValue() );
+
+ Double resetThresholdPercent = (Double) document.get( "resetThresholdPercent" );
+ setResetThresholdPercent( resetThresholdPercent == null ? 0 : resetThresholdPercent.doubleValue() );
+
+ // When loading, skipResetBypassCount must be set to zero:
+ setSkipResetBypassCount( 0 );
- @SuppressWarnings( "unchecked" )
- List docBlocks = (List) document.get("blocks");
- for (String docBlock : docBlocks) {
+ // This is a validation set to ensure only one block type is loaded file system.
+ // Must keep the first one loaded.
+ Set validateBlockNames = new HashSet<>();
+ getBlocks().clear();
+
+ List docBlocks = (List) document.get("blocks");
+ for (String docBlock : docBlocks) {
String[] split = docBlock.split("-");
- String id = split[0];
+ String blockTypeName = split[0];
double chance = Double.parseDouble(split[1]);
- Block block = new Block(BlockType.getBlock(id), chance);
- blocks.add(block);
+ if ( blockTypeName != null && !validateBlockNames.contains( blockTypeName )) {
+ // Use the BlockType.name() load the block type:
+ BlockType blockType = BlockType.getBlock(blockTypeName);
+ if ( blockType != null ) {
+ Block block = new Block(blockType, chance);
+ getBlocks().add(block);
+ }
+ else {
+ String message = String.format( "Failure in loading block type from %s mine's " +
+ "save file. Block type %s has no mapping.", getName(),
+ blockTypeName );
+ Output.get().logError( message );
+ }
+
+ validateBlockNames.add( blockTypeName );
+ }
+ else if (validateBlockNames.contains( blockTypeName ) ) {
+ // Detected and fixed a duplication so mark as dirty so fixed block list is saved:
+ dirty = true;
+ inconsistancy = true;
+ }
}
- }
+
+
+ // Reset validation checks:
+ validateBlockNames.clear();
+ getPrisonBlocks().clear();
+
+ List docPrisonBlocks = (List) document.get("prisonBlocks");
+ if ( docPrisonBlocks != null ) {
+
+ for (String docBlock : docPrisonBlocks) {
+ String[] split = docBlock.split("-");
+ String blockTypeName = split[0];
+ double chance = Double.parseDouble(split[1]);
+
+ if ( blockTypeName != null ) {
+ // The new way to get the PrisonBlocks:
+ PrisonBlock prisonBlock = Prison.get().getPlatform().getPrisonBlock( blockTypeName );
+
+ if ( prisonBlock != null && !validateBlockNames.contains( blockTypeName )) {
+ prisonBlock.setChance( chance );
+ if ( prisonBlock.isLegacyBlock() ) {
+ dirty = true;
+ }
+ getPrisonBlocks().add( prisonBlock );
+
+ validateBlockNames.add( blockTypeName );
+ }
+ else if (validateBlockNames.contains( blockTypeName ) ) {
+ // Detected and fixed a duplication so mark as dirty so fixed block list is saved:
+ dirty = true;
+ inconsistancy = true;
+ }
+
+ }
+ }
+ }
+
+
+ if ( Prison.get().getPlatform().getConfigBooleanFalse( "use-new-prison-block-model" ) &&
+ getPrisonBlocks().size() == 0 && getBlocks().size() > 0 ) {
+ // Need to perform the initial conversion:
+
+ for ( Block block : getBlocks() ) {
+ PrisonBlock prisonBlock = Prison.get().getPlatform().getPrisonBlock( block.getType().name() );
+ if ( prisonBlock != null ) {
+
+ prisonBlock.setChance( block.getChance() );
+ getPrisonBlocks().add( prisonBlock );
+
+ dirty = true;
+ }
+
+ }
+ Output.get().logInfo( "Notice: Mine: " + getName() + ": Existing prison block model has " +
+ "been converted to the new block model and will be saved." );
+ }
+
+
+ List commands = (List) document.get("commands");
+ setResetCommands( commands == null ? new ArrayList<>() : commands );
+
+
+ Boolean usePagingOnReset = (Boolean) document.get( "usePagingOnReset" );
+ setUsePagingOnReset( usePagingOnReset == null ? false : usePagingOnReset.booleanValue() );
+
+ if ( dirty ) {
+
+ // Resave the mine data since an update to the mine format was detected and
+ // needs to be saved. Otherwise the bad data will always need to be converted
+ // every time the mine is loaded which may lead to other issues.
+
+ // This is enabled since the original is not modified.
+
+ PrisonMines.getInstance().getMineManager().saveMine( this );
+
+ if ( inconsistancy ) {
+
+ Output.get().logInfo( "Notice: Mine: " + getName() + ": During the loading of this mine an " +
+ "inconsistancy was detected and was fixed then saved." );
+ }
+ else {
+ Output.get().logInfo( "Notice: Mine: " + getName() + ": Updated mine data was successfully saved." );
+
+ }
+ }
+ }
public Document toDocument() {
Document ret = new Document();
- ret.put("world", worldName);
- ret.put("name", name);
+ ret.put("world", getWorldName());
+ ret.put("name", getName());
ret.put("minX", getBounds().getMin().getX());
ret.put("minY", getBounds().getMin().getY());
ret.put("minZ", getBounds().getMin().getZ());
ret.put("maxX", getBounds().getMax().getX());
ret.put("maxY", getBounds().getMax().getY());
ret.put("maxZ", getBounds().getMax().getZ());
- ret.put("hasSpawn", hasSpawn);
+ ret.put("hasSpawn", isHasSpawn());
+
+ ret.put("resetTime", getResetTime() );
+ ret.put("notificationMode", getNotificationMode().name() );
+ ret.put("notificationRadius", Long.valueOf( getNotificationRadius() ));
- if (hasSpawn) {
- ret.put("spawnX", spawn.getX());
- ret.put("spawnY", spawn.getY());
- ret.put("spawnZ", spawn.getZ());
- ret.put("spawnPitch", spawn.getPitch());
- ret.put("spawnYaw", spawn.getYaw());
+ ret.put( "zeroBlockResetDelaySec", Double.valueOf( getZeroBlockResetDelaySec() ) );
+
+ ret.put( "skipResetEnabled", isSkipResetEnabled() );
+ ret.put( "skipResetPercent", getSkipResetPercent() );
+ ret.put( "skipResetBypassLimit", getSkipResetBypassLimit() );
+
+ ret.put( "resetThresholdPercent", getResetThresholdPercent() );
+
+ if (isHasSpawn()) {
+ ret.put("spawnX", getSpawn().getX());
+ ret.put("spawnY", getSpawn().getY());
+ ret.put("spawnZ", getSpawn().getZ());
+ ret.put("spawnPitch", getSpawn().getPitch());
+ ret.put("spawnYaw", getSpawn().getYaw());
}
+ // This is a validation set to ensure only one block is written to file system:
+ Set validateBlockNames = new HashSet<>();
+
List blockStrings = new ArrayList<>();
- for (Block block : blocks) {
- blockStrings.add(block.getType().getId() + "-" + block.getChance());
+ for (Block block : getBlocks()) {
+ if ( !validateBlockNames.contains( block.getType().name() )) {
+ // Use the BlockType.name() to save the block type to the file:
+ blockStrings.add(block.getType().name() + "-" + block.getChance());
+// blockStrings.add(block.getType().getId() + "-" + block.getChance());
+ validateBlockNames.add( block.getType().name() );
+ }
}
+
ret.put("blocks", blockStrings);
- return ret;
- }
-
- /**
- * NOTE: Have no idea WHY this always returns a value of true; why not void then?
- *
- * @return
- */
- public boolean reset() {
- // The all-important event
- MineResetEvent event = new MineResetEvent(this);
- Prison.get().getEventBus().post(event);
- if (event.isCanceled()) {
- return true;
+ // reset validation for next block list:
+ validateBlockNames.clear();
+
+ List prisonBlockStrings = new ArrayList<>();
+ for (PrisonBlock pBlock : getPrisonBlocks() ) {
+ if ( !validateBlockNames.contains( pBlock.getBlockName()) ) {
+ prisonBlockStrings.add(pBlock.getBlockName() + "-" + pBlock.getChance());
+ validateBlockNames.add( pBlock.getBlockName() );
+ }
}
+
+ ret.put("prisonBlocks", prisonBlockStrings);
- try {
- Optional worldOptional = getWorld();
- if (!worldOptional.isPresent()) {
- Output.get().logError("Could not reset mine " + name
- + " because the world it was created in does not exist.");
- return false;
- }
- World world = worldOptional.get();
-
- MineManager manager = PrisonMines.getInstance().getMineManager();
- // Generate new set of randomized blocks each time:
- manager.generateBlockList(this);
- List blockTypes = manager.getRandomizedBlocks().get(name);
-
- teleportAllPlayersOut( world, getBounds().getyBlockMax() );
-
- int i = 0;
- boolean isFillMode = PrisonMines.getInstance().getConfig().fillMode;
- for (int y = getBounds().getyBlockMin(); y <= getBounds().getyBlockMax(); y++) {
- for (int x = getBounds().getxBlockMin(); x <= getBounds().getxBlockMax(); x++) {
- for (int z = getBounds().getzBlockMin(); z <= getBounds().getzBlockMax(); z++) {
- Location targetBlock = new Location(world, x, y, z);
-
- if (!isFillMode || isFillMode && targetBlock.getBlockAt().isEmpty()) {
- targetBlock.getBlockAt().setType(blockTypes.get(i++));
- }
- }
- }
- }
-
- // NOTE: This is not making sense, since block list was generated about 20 lines ago?
- // Why generate blocks after resetting the mine, of which they will NOT be used since the
- // list will be generated above when the mines reset again? This could be adding to
- // lag and sluggishness on mine reset events, which could cause players to fall back in to
- // the mine and suffocate?
- // I'm about to remove this code, but I'm thinking it is left over from a refactoring
- // and was not removed? Comment out for now.
-// if (PrisonMines.getInstance().getConfig().asyncReset) {
-// asyncGen();
-// }
-
- // free up memory:
- manager.clearCache();
-
- // If a player falls back in to the mine before it is fully done being reset,
- // such as could happen if there is lag or a lot going on within the server,
- // this will TP anyone out who would otherwise suffocate. I hope! lol
- teleportAllPlayersOut( world, getBounds().getyBlockMax() );
-
- return true;
- } catch (Exception e) {
- Output.get().logError("&cFailed to reset mine " + name, e);
- return false;
- }
+ ret.put("commands", getResetCommands());
+
+
+ ret.put( "usePagingOnReset", isUsePagingOnReset() );
+
+ return ret;
}
- /**
- * This function teleports players out of existing mines if they are within
- * their boundaries within the world where the Mine exists.
- *
- * Using only players within the existing world of the current mine, each
- * player is checked to see if they are within the mine, and if they are they
- * are teleported either to the mine's spawn location, or straight up from the
- * center of the mine, to the top of the mine (assumes air space will exist there).
- *
- * This function eliminates possible bug of players being teleported from other
- * worlds, and also eliminates the possibility that the destination could
- * ever be null.
- *
- * @param world - world
- * @param targetY
- */
- private void teleportAllPlayersOut(World world, int targetY) {
- List players = (world.getPlayers() != null ? world.getPlayers() :
- Prison.get().getPlatform().getOnlinePlayers());
- for (Player player : players) {
- if ( isSameWorld(world, getBounds().getMin().getWorld()) &&
- getBounds().within(player.getLocation())) {
-
- teleportPlayerOut(player);
-
-// Location destination = null;
-// if (this.hasSpawn && getWorld().isPresent()) {
-// destination = this.spawn;
-// } else {
-// destination = player.getLocation();
-// destination.setY( targetY + 1 );
-// }
-//
-// player.teleport( destination );
-// PrisonMines.getInstance().getMinesMessages().getLocalizable("teleported")
-// .withReplacements(this.name).sendTo(player);
- }
- }
+ private Location getLocation(Document doc, World world, String x, String y, String z) {
+ return new Location(world, (double) doc.get(x), (double) doc.get(y), (double) doc.get(z));
}
- /**
- * This function will teleport the player out of a given mine, or to the given
- * mine. It will not confirm if the player is within the mine before trying to
- * teleport.
- *
- *
- * This function will teleport the player to the defined spawn location, or it
- * will teleport the player to the center of the mine, but on top of the
- * mine's surface.
- *
- * If the player target location has an empty block under its feet, it will
- * then spawn in a single glass block so the player will not take fall damage.
- * If that block is within the mine, it will be reset at a later time when the
- * mine resets and resets that block. If it is part of spawn for the mine, then
- * the glass block will become part of the landscape.
- *
- *
- * @param player
- */
- public void teleportPlayerOut(Player player) {
-
- Location altTp = new Location( getBounds().getCenter() );
- altTp.setY( getBounds().getyBlockMax() + 1 );
- Location target = isHasSpawn() ? getSpawn() : altTp;
-
- // Player needs to stand on something. If block below feet is air, change it to a
- // glass block:
- Location targetGround = new Location( target );
- targetGround.setY( target.getBlockY() - 1 );
- if ( targetGround.getBlockAt().isEmpty() ) {
- targetGround.getBlockAt().setType( BlockType.GLASS );
- }
-
- player.teleport( target );
- PrisonMines.getInstance().getMinesMessages().getLocalizable("teleported")
- .withReplacements(this.name).sendTo(player);
+ private Location getLocation(Document doc, World world, String x, String y, String z, String pitch, String yaw) {
+ Location loc = getLocation(doc, world, x, y, z);
+ loc.setPitch( ((Double) doc.get(pitch)).floatValue() );
+ loc.setYaw( ((Double) doc.get(yaw)).floatValue() );
+ return loc;
}
- /**
- *
This is a temporary fix until the Bounds.within() checks for the
- * same world. For now, it is assumed that Bounds.min and Bounds.max are
- * the same world, but that may not always be the case.
- *
- * @param w1 First world to compare to
- * @param w2 Second world to compare to
- * @return true if they are the same world
- */
- private boolean isSameWorld(World w1, World w2) {
- // TODO Need to fix Bounds.within() to test for same worlds:
- return w1 == null && w2 == null ||
- w1 != null && w2 != null &&
- w1.getName().equalsIgnoreCase(w2.getName());
- }
-
-// private void asyncGen() {
-// try {
-// Prison.get().getPlatform().getScheduler()
-// .runTaskLaterAsync(
-// () -> PrisonMines.getInstance().getMineManager().generateBlockList(this), 0L);
-// } catch (Exception e) {
-// Output.get().logWarn("Couldn't generate blocks for mine " + name
-// + " asynchronously. The blocks will be generated synchronously later.", e);
-// }
-// }
-
-
- /**
- * Gets the spawn for this mine
- *
- * @return the location of the spawn. {@link Optional#empty()} if no spawn is present OR the
- * world can't be found
- */
- public Location getSpawn() {
- return spawn;
- }
-
- /**
- * Sets the spawn for this mine.
- *
- * @param location the new spawn
- * @return this instance for chaining
- */
- public Mine setSpawn(Location location) {
- hasSpawn = (location != null);
- spawn = location;
- return this;
- }
-
- /**
- * Gets the name of this mine
- *
- * @return the name of this mine
- */
- public String getName() {
- return name;
- }
-
- /**
- * Sets the name of this mine
- *
- * @param name the new name
- * @return this instance for chaining
- */
- public Mine setName(String name) {
- this.name = name;
- return this;
- }
-
- /**
- * Gets the world
- */
- public Optional getWorld() {
- return Prison.get().getPlatform().getWorld(worldName);
- }
-
- public Bounds getBounds() {
- return bounds;
- }
-
- /**
- * (Re)defines the boundaries for this mine
- *
- * @param bounds the new boundaries
- * @return this instance for chaining
- */
- public Mine setBounds(Bounds bounds) {
- this.bounds = bounds;
- this.worldName = bounds.getMin().getWorld().getName();
- return this;
- }
-
- public List getBlocks() {
- return blocks;
- }
-
- /**
- * Sets the blocks for this mine
- *
- * @param blockMap the new blockmap with the {@link BlockType} as the key, and the chance of the
- * block appearing as the value.
- * @return this instance for chaining
- */
- public Mine setBlocks(HashMap blockMap) {
- blocks = new ArrayList<>();
- for (Map.Entry entry : blockMap.entrySet()) {
- blocks.add(new Block(entry.getKey(), entry.getValue()));
- }
- return this;
- }
-
- public boolean isInMine(Location location) {
- return getBounds().within(location);
- }
-
- public boolean isInMine(BlockType blockType) {
- for (Block block : getBlocks()) {
- if (blockType == block.getType()) {
- return true;
- }
- }
- return false;
- }
-
- public double area() {
- return getBounds().getArea();
- }
-
@Override
public boolean equals(Object obj) {
- return (obj instanceof Mine) && (((Mine) obj).name).equals(name);
+ return (obj instanceof Mine) && (((Mine) obj).getName()).equals(getName());
}
@Override
public int hashCode() {
- return name.hashCode();
+ return getName().hashCode();
}
-
-
- public String getWorldName()
- {
- return worldName;
- }
- public void setWorldName( String worldName )
- {
- this.worldName = worldName;
- }
-
- public boolean isHasSpawn()
- {
- return hasSpawn;
- }
- public void setHasSpawn( boolean hasSpawn )
- {
- this.hasSpawn = hasSpawn;
- }
-
}
diff --git a/prison-mines/src/main/java/tech/mcprison/prison/mines/data/MineCountAirBlocksAsyncTask.java b/prison-mines/src/main/java/tech/mcprison/prison/mines/data/MineCountAirBlocksAsyncTask.java
new file mode 100644
index 000000000..a66cf57f9
--- /dev/null
+++ b/prison-mines/src/main/java/tech/mcprison/prison/mines/data/MineCountAirBlocksAsyncTask.java
@@ -0,0 +1,23 @@
+package tech.mcprison.prison.mines.data;
+
+public class MineCountAirBlocksAsyncTask
+ implements PrisonRunnable {
+
+ private MineReset mine;
+ private PrisonRunnable callbackAsync;
+
+ public MineCountAirBlocksAsyncTask(MineReset mine, PrisonRunnable callbackAsync) {
+ this.mine = mine;
+ this.callbackAsync = callbackAsync;
+ }
+
+ @Override
+ public void run() {
+ this.mine.refreshAirCountAsyncTask();
+
+ if ( this.callbackAsync != null ) {
+ this.mine.submitAsyncTask( callbackAsync );
+ }
+ }
+
+}
diff --git a/prison-mines/src/main/java/tech/mcprison/prison/mines/data/MineData.java b/prison-mines/src/main/java/tech/mcprison/prison/mines/data/MineData.java
new file mode 100644
index 000000000..8460de481
--- /dev/null
+++ b/prison-mines/src/main/java/tech/mcprison/prison/mines/data/MineData.java
@@ -0,0 +1,475 @@
+package tech.mcprison.prison.mines.data;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+
+import tech.mcprison.prison.Prison;
+import tech.mcprison.prison.internal.World;
+import tech.mcprison.prison.internal.block.PrisonBlock;
+import tech.mcprison.prison.util.BlockType;
+import tech.mcprison.prison.util.Bounds;
+import tech.mcprison.prison.util.Location;
+
+public abstract class MineData {
+
+ public static final int MINE_RESET__TIME_SEC__DEFAULT = 15 * 60; // 15 minutes
+ public static final int MINE_RESET__TIME_SEC__MINIMUM = 30; // 30 seconds
+ public static final long MINE_RESET__BROADCAST_RADIUS_BLOCKS = 150;
+
+ public static final String MINE_NOTIFICATION_PERMISSION_PREFIX = "mines.notification.";
+
+ private String name;
+ private boolean enabled = false;
+
+ private Bounds bounds;
+
+ private Location spawn;
+ private String worldName;
+ private boolean hasSpawn = false;
+
+ private int resetTime;
+ private MineNotificationMode notificationMode;
+ private long notificationRadius;
+ private boolean useNotificationPermission = false;
+
+ private long targetResetTime;
+ private int resetCount = 0;
+
+ private List
+
+
+
+**End of the guide**
+
+
+diff --git a/docs/prison_docs_0xx_setting_up_PlaceholderAPI.md b/docs/prison_docs_0xx_setting_up_PlaceholderAPI.md new file mode 100644 index 000000000..40222f51d --- /dev/null +++ b/docs/prison_docs_0xx_setting_up_PlaceholderAPI.md @@ -0,0 +1,84 @@ + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## Setting up PlaceholderAPI + +This document provides a quick overview on how to install PlaceholderAPI. + +Additional documentation on placeholders: + +* [Guide: Prison Placeholders](prison_docs_310_guide_placeholders.md) + How to use placeholders. Includes HolographicDisplays. + +* [Setting up Mines](prison_docs_101_setting_up_mines.md) + This has a placeholder example using a One-block mine example with HolographicDisplays. + + +
+ + + +# Optional Dependencies + +* If you want to use placeholders with plugins without placeholderAPI support you should also install the right version of [Protocollib](https://www.spigotmc.org/resources/protocollib.1997/) for you server and the [PlaceholderAPI ChatInjector](https://www.spigotmc.org/resources/chatinjector.38327/) + + +
+ + + +# Setting up PlaceholderAPI + +Setting up PlaceholderAPI just need couple of steps: + +* Download PlaceholderAPI + - Go to the SpigotMC.org PlaceholderAPI download page + - [PlaceholderAPI Download page](https://www.spigotmc.org/resources/placeholderapi.6245/) + +* Copy to your server's plugin directory + +* Restart your server. Do not use **/reload** or you'll break Prison Placeholders. Prison registers all of the placeholders upon server startup so the registrations will be lost. + +
+ + + +# Placeholders Commands + +Use the command **/prison placeholders** for a listing the placeholder commands. These include: + +* **/prison placeholders list** +* **/prison placeholders search
+ + +# Troubleshooting Possible Compatibility Issues + +There are no known issues with Prison and PlaceholderAPI, but out of the interest to help get your servers up and running, here are a couple of tips that could help with your environment. + + +
Issue with PlaceholderAPI not working with Economy and Scoreboard
+ +There was an issue with an economy placeholder not working with the QuickBoard placeholder. + +The solution was to download from PlaceholderAPI, their modified version of Vault and Essentials. Followed by a server restart, or use `/papi reload`. + +``` +/papi ecloud download Vault +/papi ecloud download Essentials +/papi reload +``` + +As a note, I'm not sure how well Prison behaves with the use of `/papi reload`. It may be good to test with, but safer to just restart the server, once everything appears to be working and looks good. The point is that any plugin reload is good to test with, but if you're going to let your server run for months, its probably best to do a clean restart. + +With this example of installing the PlaceholderAPI and downloading their version of Vault and Essentials, the player reported that once the economy placeholder was working, another placeholder stopped working. Their solution was to reinstall all of the papi (PlaceholderAPI) plugins (not sure if that includes reinstalling papi's version of Vault and Essentials) and then restarted the server. The point here, is a clean start is probably helpful. + + +diff --git a/docs/prison_docs_101_setting_up_mines.md b/docs/prison_docs_101_setting_up_mines.md new file mode 100644 index 000000000..acd380626 --- /dev/null +++ b/docs/prison_docs_101_setting_up_mines.md @@ -0,0 +1,476 @@ + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## Prison - Setting Up Mines + +This document provides some highlights to how to setup mines. It is a work in progress so check back for more information. Initially it will cover the basics, but hopefully will expand to more advanced topics. + +
+ +# Overview + +This document should be able to provide the basic information to get your mines configured. There are many options available within Prison, and also through the use of other plugins, and these advanced topics are beyond the scope of this document. + + +Items to add to this document: +* Use of **/mines set area** to change the mine size without deleting it. +* Use of **/mines delete** how it works and how to recover a deleted mine. +* Use of **/mines list** +* Use of **/mines reset** provide a little information about how it works in relationship to the other settings and commands. There are some internal things that happen and this will help clarify how the other settings are impacted. + +
+ + +# Getting Started + +Please review the Prison's [Table of Contents](prison_docs_000_toc.md) for information on how to configure your server, and which plugins are required, or at least suggested. + +It is also strongly suggested that you review the documentation on [Configuring and Using WorldGuard with LuckPerms to Protect Mines](prison_docs_626_configuring_worldguard_regions.md) since that explains a lot on how to setup the basics with your world, which will not be covered here. There will be references to this document, but this will be the only link provided. + +These instructions assume you are OP'd since that is part of the above document pertaining to WorldGuard. If not, go ahead and OP yourself. + +To follow along with this documentation, you may want to crate your first mine as a test, with intentions of deleting it later. It may be easier to remove it, than to convert it over to a final product. The instructions here are informational, not focused on perfection. So after you figure out how to create your mines, you may want to provide more attention to the details to ensure they are perfect. But for now, the focus is on the commands. + +Please note that all command provide in this document will be written as if they were entered within the game. If you use some of them from the console, then do not include the slash prefix. I always include the slash prefix in the documentation so the commands stand out as being commands. + +It should also be strongly noted that you should never modify the save files for the mines, ranks, or ladders, since that could easily lead to corruption and undefined failures and problems. We cannot support misuse of the files. + +
+ + +# Create Your First Mine + +Being OP'd, find a good location for your mines. + +Also the following commands may help setup the environment. Optional of course. Having some block in your inventory can be useful for use as scaffolding or selecting. I personally like to use sealanterns because they are not a common block and they stand out well in low light conditions and are easier to see in screen prints. Giving yourself `/fly` and `/god` may not be necessary, but it could help if you need to find a good location, or if there are mobs in the area when you drop out of creative mode and back in to survival. + +``` +/op
The wand
+ +Now give yourself a Prison wand. + +``` +/mines wand +``` + + +Laying Out the New Mine
+ +For the sake of this document, and to keep things simple, the mines we are creating will be very small and will not be deep within the ground. + + +First mark out the dimensions of your mine. As you can see here, I've marked my first mine out with sealanterns to show you how big it will be. You really only need to mark opposing corners since that defines a cuboidal region. I've cleared away some of the dirt so you can see the lower blocks. This mine will be 5 x 5 x 5 in size. + +
+
+
+
+Define the New Mine
+ +Then holding the Prison's wand (blaze rod), left-click in one corner, and then right-click in the opposite corner. In this example, I've left-clicked the lowest sealantern block, then right-clicked the highest sealantern block. You should see a message indicating that you have successfully selected a region. + +
+
+
+Then create the mine with:
+```
+/mines create test1
+```
+
+It will default to 100% air. So then follow up creating the new mine with a reset to confirm everything is replaced with air.
+
+
+
+Reset the New Mine to Test it Exists
+ +Go ahead and reset the mine. All of the sealanterns that were used to mark the mine are now gone, and so are the two layers of dirt. That confirms success with our first mine since the only default block that exists in the mines when created is air. + +``` +/mines reset test1 +``` + +
+
+
+
++ + + +# Mine Commands Overview + +Now that we've created a mine, let's take a moment and review some of the available commands. There are a lot of options available, and many of those options have numerous features, so this will just be an overview so you have a better idea of what you could possibly do with your new mines. This listing is generated within the console so it's easier to see. This includes the main grouping of commands, which is displayed with `/mines`. Remember, when using commands within the console drop the leading slash. Then two sub-groups: `/mines block` and also `/mines set`. + + +For the following commands, we can use the console, which is also easier to see for this documentation. But these commands can just as easily be ran within game. + + + +
+
+
+Some of the highlights of these commands are as follows:
+* `/mines create` : Create the mine based upon the wand selection.
+* `/mines command` : **Now active!** **Take your mines to the next level!** See the document on [Mine Commands](prison_docs_111_mine_commands.md) for more information. Every time a mine resets, you can now control what commands run right before a reset, and what runs right after a reset. These commands are similar to the Rank Commands, since they can be any command that you can run from the console. The idea is that you can have unique mines that have not been possible before, such as randomly spawned forests or specific builds.
+* `/mines delete` : Deletes a mine. You can always undelete a mine by going in to the server file system and rename the deleted mine, then restart the server.
+* `/mines info` : Very useful in viewing all information related to the mine.
+* `/mines list` : Displays all mines on your server.
+* `/mines reset` : Resets the mine. Forces a regeneration of all the blocks, even if the mine is in skip reset mode.
+* `/mines stats` : Toggles the display of stats that pertain to how long it takes to reset the mines. View /mines info or /mines list to see the stats. Use this command again to turn it off.
+* `/mines tp` : tp to a mine's spawn point, or the center of the mine if no spawn has been set. If players are given the permissions, they too can use this command. Use `/mines tp help` for a list of the perms.
+* `/mines whereami` : Shows you what mine you are in, or how far away you are from other mines in the area. If you have a lot of mines, it's easy to lose track of where you are, and this may help get your bearings.
+
+
+* `/mines block add` : Add a new block type to a mine. It's easier to start off with block search and have it fill in the commands for you.
+* `/mines block remove` : Remove a block type from a mine.
+* `/mines block search` : Search for a block type based up on a search string.
+* `/mines block set` : Edit the block's percentage within the mine. A percent of zero will remove. If the block does not already exist, it will be added. (Can replace add and remove).
+
+
+* `/mines set area` : Redefine the area of the mine. Careful, this can wipe out builds if set incorrectly.
+* `/mines set notification` : Can turn off the notifications on a per-mine basis. Or set the notification radius, or only notify players within the mine. This command cannot change the message.
+* `/mines set resetTime` : Changes the time between resets, as expressed in seconds. Applies to each mine independently.
+* `/mines set skipReset` : When enabled, can prevent a mine from resetting if it has no activity. Can set a threshold before the mine is reset, such as 80% will require 20% of the blocks be mined before being reset. Can also set a bypassLimit so that if the reset is skipped X number of times, it will force a reset anyway.
+* `/mines set spawn` : Sets the mines spawn point. Whatever you are looking at is what the players will be looking at when they tp to that spot.
+* `/mines set zeroBlockResetDelay` : If the mine runs out of blocks, when enabled, it will force a manual reset after the specified delay. The delay can be zero for instant reset.
+
+Adding the term `help` to the end of any of the above listed commands will display additional information that is available for each command, including the parameters and also all permissions that are associated with the commands.
+
++ + +# Customizing Your Mines + +Now that we have a mine created, let's go ahead and customize it. + +
Inspect our New Mine
+ +Let's first take a quick look at the new mine with this command. Let's view it now, before we start making changes. + +``` +/mines info test1 +``` + + +
+
+
+
+
+Select a Few Blocks
+ +The easiest way to select blocks is to search for them. Let's add a few such as cobble, glowstone, gold ore, and coal ore. Use the block search with cobble: + +``` +/mines block search cobble +``` + +
+
+When using the console with block search limits what you can do with the block search. If you are in game, you can click on a block type that is displayed, and it will auto fill out the block add command for you, such that all you need to do is add the percentage at then end of the command. Also in game, you can page through the results.
+
+This is an example of in game use of this command. Notice by clicking on cobble it pre-fills all the parameters for the `/mines block add`, including the most recently used mine name and the selected block. This screen print shows that I added the value of `20` right after the percent sign.
+
+
+
+Then let's take a look at the `/mines info test1 all` command, where all indicates all pages should be displayed in-line without paging. Notice how Prison automatically provides the balance of air so the total percent is equal to 100.0%.
+
+
+
+
+Now if we perform a `/mines reset test1` then we can see how the cobble is randomly placed at a rate of 20%, and the remainder is air.
+
+
+
+
+Let's add the other blocks, each at 20% then take a look at the mine info and how it generates. Please notice that you can add a single block with as little as 0.01%. You can also add as many different blocks as you please too. There are no meaningful restrictions.
+
+
+With the additions of the other ores, including 1/2 a percent of sealanterns:
+
+
+
+
+
+
+
+Example of a mine reset including a sealantern. Notice that there is still 19.5% air.
+
+
+
+
+
+
++ + + +# Next Steps - Skipping Resets, Notifications, and Zero Blocks + + +The mine is now usable as-is, but there are still a lot of options that we can add to enhance the mine's behavior to better suit our needs. For example, we can set a spawn point so we can control where players are teleported to when the mine resets, or if they tp to the mine. + +For our example, let's use the console to set the notification, resetTime, skipRest, and the zeroBlockResetDelay. We must be in game to set the spawn point since it uses where your player is standing and where you are looking. + + + +
Customizing the Mine
+ +Issuing all these commands through the console, such as the following. Note that the spawn point has been set in game, and the reset time has not be changed. + +
+
+Mine info showing all changes. Observe the spawn location now shows an actual location, but yet it does not show the pitch or yaw. The information also shows that the mine has reset 30 times since there server started, and that you must be standing within the mine to receive reset notifications.
+
+
+
+
+
+Notifications Explained
+ +In the example above, the notifications for that mine was set to only provide them to the players that are within the mine. The other options are disabled and radius from the center of the mine. + +``` +/mines set notification test1 within +``` + + + +Skip Reset Explained
+ +To better explain what the skipReset does, is it uses the threshold percent as the trigger to allow the mine to auto reset. Once the **blocks remaining** value hits that value, or is less than that value, it will alloow the mine to rest at it's normal reset time. If the blocks remaining is higher than the threshold, then it skips the reset and increments the skip counter (not shown in this screen print since it is zero). Once the number of skips reaches, or exceeds, the Skip Limits value, then it will allow the mine to reset. + +This behavior allows unused, or barely used, mines to avoid from always being reset. This can reduce the server load and prevent lag on larger servers, or if there are many mines. + +This feature never will force a mine to reset early, nor will it ever make it reset. The only active behavior it can alter, is to skip the automatic reset behavior. + +If a mine is manually reset, then this feature will never prevent a manual reset from happening. A manual reset will also reset the counter for how many times the mine skipped the automatic resets. + + +Zero Blocks Reset Delay Explained
+ +The feature zero blocks reset delay identifies what should happen when Prison detects that there are no more blocks within the mine. The only action actually is to force an early reset if this feature is enabled, but more specifically, it identifies how many seconds it should delay before forcing the reset. + +If this feature is enabled, and the delay value is set to Zero, then the mine is forced to reset with no delay. If there is a light load of jobs running on the server, then it will be instantly reset, otherwise there will be a delay for the job to wait its turn to run. + +If the reset delay is non-zero, the value is measured in seconds, with a valid value of 0.01 seconds. But keep in mind that in reality the seconds are converted to ticks and is scheduled within the Bukkit job queue. Therefore, since there are 1000 milliseonds within one second, and 20 ticks within one second, one tick is the smaller possible value, which equates to 50 milliseconds. This is equivalent to 0.05 seconds. When the seconds are converted to ticks, the values will be rounded down to a whole integer value. So if a value is provide such as 0.049 it will be submitted as 0 ticks, which will result in zero delay (if possible) before running. + +The bottom line is that this feature can force an earlier reset of the mine when it becomes totally empty of blocks. A delay may be needed, or desired, to reach your perfection for the mine. + + ++ + +# Notifications - Config File & Settings + + +The global `resetMessages`, `resetTime` and `resetWarningTimes`, as found in the configuration file `plugins/Prison/module_conf/mines/config.json` needs a little explanation in what they do. + +The `resetMessages` is used only upon the server startup, and if it is disabled, then it will not use the `resetWarningTimes` and will skip all notifications pertaining to mine resets. The `resetWarningTimes` are global and cannot be customized per mine. If an individual mine's reset time is less than a warning time, then the reset warning will be skipped for that mine. + +The `resetTime` in this configuration file is only used during the creation of a mine and is used to set the initial value for the mine's reset time. If the configuration file's value is changed, it will never effect any preexisting mines, but only ones created after it has been changed. + +All mines use their internal reset time and can be customized on a per mine basis using the following command. The command's time value is expressed in seconds. + +``` +/mines set resetTime
+ + +# Listing All Mines + + +As you start to build your mines, you may find it useful to list them all, or use the listing to search for a specific mine. + + +Here are some basic usages of the command. First let's review the help for the `/mines list` command to see what perms are needed and what parameters are available. If you are in game, clicking on `TP` will teleport you to the mine. Clicking on the name will show you the info on the mine, which is the same as using the `/mines info` command. Of course, clicking on these items only works in game, and not from the console. + + +``` +/mines list help + +/mines list + +/mines list 4 +``` + + +As we can see in the screen print of the help, the command takes optional parameters for the page number. It also has the option of `ALL` which will display the list of all mines, which could be helpful in the console. + + +
+
+
+
+
+There is some useful information in the listing too. This listing shows how soon a mine will **Reset**, and what the reset frequency is. It will show you how many times it has been reset since the server started (**RCnt**). It even shows the percent blocks remaining too (**Rem**). If you've added any **mine commands**, those will indicated in a red **Cmds** entry; see the mine named **trees**. Also if a mine is disabled, it will be listed here too.
+
+
+
+
+This listing also shows more details if you have `/mines stats` enabled. Remember that mine stats is a toggled setting. Run it once to enable it. Run it a second time to disable it.
+
+
+With it enabled, it shows stats on mine resets in mine list, mine info, and when mines reset in general. The following screen print within the console shows how these may look, with the addition of the stats.
+
+
+
+
+
+.
+
+
++ + +# Deleting Mines + +Mines can be deleted with the `/mines delete` command. + +It will prompt you for confirmation. If you are in game you can click on the link then it will fill out the command for you with the parameter `cancel` and you need to rename it to `confirm`. You have one minute to confirm a delete. + +When you successfully delete a mine, it will remove it from memory and from loading. The mine is only virtually deleted, since it will still exist in the server's directory. To undelete it, just rename the file back to a normal mine file name, and it will be loaded the next time the server starts. + + +
+ + +# The Mine Data Files + +The mine data files (and also the ranks and ladders) are stored on the server's file system as a way to store each mine's configurations. These files are intended for internal use only and should never be manually modified. When undeleting mines, you may have to rename the files so they are used the next time the server is started, but you should not change the contents. + +There are many commands that have interdependancies to multiple settings, and those settings are validated only through the use of the commands. Making changes directly to the files bypasses the validation of the commands and may lead to server corruption and failures. + +You are solely responsible for any problems you create by making changes directly to these files. We cannot help undo any problems, issues, failures, or undefined behaviors that may be caused with such tampering. + + +
+ + +# Advanced Topics + + + +### Changing the Size of a Mine + + +
+ + +# Example: A Single Block Mine Grinder + + +To provide a slightly different perspective as to what you can do with your Prison mines, let's build a one block mine and demonstrate the power of what we can down with a few of these settings. We're also going to tie this in to HolographicDisplays and use of the placeholders. + +So let's first setup a temporary placeholder for our new mine. I want it to be a one block mine, one block off the ground. So stack two blocks like this. Added a platform, because why not? + + +
+
+
+
+
+Next, using the Prison wand, right-click and left-click on the top block. This will create a one block selection. Then create the mine, naming it **one**.
+
+```
+/mines create one
+/mines block search ore
+```
+
+Then select the following ores and add them to the new mine, all at 10%. Add gold_ore, iron_ore, coal_ore, Lapis ore, redstone_ore, emerald_ore, diamond ore, etc... Then setup the reset time, turn off notifications, and set zero blocks reset delay to zero.
+
+
+
+
+Now let's test our new mine. But first let's make an OP pick. Open the config file `/plugins/Essentials/config.yml` and search for `unsafe-enchantments` and set the value to `true` and then save and exit the file. You can either restart the server, or use `/essentials reload` to apply those changes. Then issue the commands in game, holding the pick after you get it.
+
+```
+/essentials reload
+/give
+
+
+Now to complete this mine, let's enable auto manager. We can do that by turning on Auto Manager for all of our mines, or we can just add a few ore entries to our OP pick. For this example, let's go with the lore. Enter these commands (assuming you have Essentials installed). Using `/prison autofeatures` command to review the correct names for the lore. Please note for this example I'm using 100% since no numbers are specified with these Lore names.
+
+It should be noted that Prison's Auto Features is currently in a state of development and may change with how these settings should be applied. Efforts will be made to keep these instructions up to date, but they may be missed. If you notice that this has happened, then please contact RoyalBlueRanger on the discord server and he will get this corrected. ### Auto Features are not needed to demonstrate this one block mine, but it does illustrate a few more capabilities that exist within Prison and how a few settings can provide a different experience.
+
+```
+/prison autofeatures
+/i diamondpick 1 efficiency:20 durability:20 fortune:5 lore:Pickup|Smelt|Block
+```
+
+More information on the EssentialX's lore settings can be found here: [EssentialsX Item_Meta](http://ess.khhq.net/wiki/Item_Meta).
+
+
+
+
+Note, because we are using Lore on your pickaxe, we don't have to enable the auto features, such as with `AreEnabledFeatures`, but the individual elements should be all be set to `true`, or the `AllBlocks` should be set to `true`. The Lore on a tool can bypass the global settings. Also make sure you drop back in to survival mode to get the normal speed for your OP pick.
+
+```
+/gamemode survival
+```
+
+
+
+
+
+And that's it for now. This is what I would consider a draft copy, and I will come back in a few days to refine this document (and remove this comment).
+
+
+diff --git a/docs/prison_docs_102_setting_up_ranks.md b/docs/prison_docs_102_setting_up_ranks.md new file mode 100644 index 000000000..573eec30c --- /dev/null +++ b/docs/prison_docs_102_setting_up_ranks.md @@ -0,0 +1,549 @@ + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## Prison - Setting Up Ranks & Ladders + +This document provides information how to setup and use ranks and ladders. + +Information on how to use Prestiges is provided in a separate document: [Setting up Prestiges](prison_docs_107_setting_up_pestiges.md) + + +The use of Ranks, Ladders, and Prestiges are all optional. You can either use these Prison based items, or you can use some other plugin to provide these functionalities. The choice is yours. + + +
+ + +# Overview + + +Prison is more than just mines. Mines provides the physical content of your server. It's the ranks and the ladders that ties everything together. It's the Ranks that provides the hooks in to all of your server's other plugins through the use of Rank Commands. And it's the ladders that provides a logical progression from one rank to the next. + + +Prison Ranks can be very simple in that they don't have to do much. They don't even need to have any Rank Commands, but its through the Rank Commands that provides the power to customize your server in almost any way you can dream. + + +Ladders are a way to logically organize your ranks. The concept is a just like a ladder where you start at the bottom, and to progress up the ladder, one rank (rung) at a time. You cannot skip ranks, but you can also go back down the ladder too. Only admins can demote players, since that's not part of the normal Prison game play. + + +Prison also provides a number of Admin based commands to manage ranks and ladders. Obviously the standards on how to create and edit the Ranks and Ladders, but also Prison provides the tools to manage players within the various ranks and ladders too. + +
+ + +#Ranks + +There are many different ways you can setup your Prison server and ranks is just one small part of how you can customize everything. + + +One way to do ranks is to have a few prison ranks, with working to a "free" rank and beyond. Example would be ranks in the following order: D (default), C, B, A, Free, Citizen, Elite, Rules, Emperor. Where ranks D through A are restricted to the mines within the prison, but then Free and higher have access to the free worlds to gather resources, build bases, and other things such as even factions. A few examples provides screen prints with this design since it's generally fewer overall ranks. + + +Another type of prison game mode is more along the lines of an OP based Prison server where ranks run from A through Z with prestiges and even rebirths. Where the costs of ranking up becomes significantly higher with each rank, but yet the ores and blocks you can mine have much greater worth. The tools are generally very OP and beyond the normal safe enchantments. + + +This documentation uses setups that are fairly simple. The mine names also matches the rank names, but they don't have to. Matter of fact, the rank name and mine names can be almost anything to allow the most flexibility for your setup. + + +
+ + +#Adding Ranks + + +Adding Ranks is pretty simple. + + +The command to add a rank is as follows, along with the help generated for it: + +``` +/ranks create [rankName] [cost] [ladder] [tag] + +/ranks create help +``` + +The first rank you add will become the default rank on the ladder in which you add the rank. As you add more ranks, they will be added to the ladder in the order in which they were added. + + +If you need to change the order of a rank, or even move it to another ladder, you can use the command: `/ranks ladder addrank`. Ranks do not have to be associated with a ladder and with this command, you can actually remove the ladder from the rank, or move it around. See that command under ladders for more information. + + +The `cost` for the default rank, or the first rank on a ladder, should have a value of zero if you expect new players to gain this rank when they join the server. It doesn't have to have a zero cost, but it depends upon what your needs are. If the ladder is not the **default** ladder, then the odds are that the rank is not going to be zero. + + +The `ladder` field for this command is the ladder name to which the new rank will be assigned. If it is a rank that is based upon prison mining and advancement, then the **default** ladder should be used. The **default** ladder name is simply **default** and it does not have to be provided if there are no other parameters that follows. If you want to provide a `tag` name then just use a value of `default` for that parameter. + + +The `tag` parameter is the fancy display name for this given rank. You do not have to specify it on this create command, since you can always add it, or change it later with the `/ranks set tag` command. The tag generally contains additional formatting characters such as color codes and even brackets or other characters. It does not have to contain the rank's name. The tag is what is generally used in placeholders for its special formatting. + +For example a default prestige rank may simply be something like this with the emphasis on the plus sign: `&d[&6+&d]` + + + +
+
+
+
+
++ + +#Rank Information + +Information on a rank can be viewed by using the following command: + +``` +/ranks info [rankName] + +/ranks info help +``` + +This example of rank information includes a rank that has a custom currency. *See more information below on custom currencies.* If a rank does not have a custom currency, then it will not show the currency information. + + +
+
+
+
+#Rank Listings
+
+To list all ranks for a given ladder use the following command:
+
+```
+/ranks list [ladderName]
+
+/ranks list help
+```
+
+The `ladderName` parameter is optional and will default to a value of **default**. To view ranks on another ladder, then you must use that ladder's name. But please notice, that at the bottom of the listing, it shows what other ladders are available to be used with this command. If you use this command in game, then you can click on those displayed commands to show those listings.
+
+
+
+
+
+
++ + + +#Deleting Ranks + +Ranks can be deleted, but when they are, they are simply just removed from Prison and no longer loaded. Deleted Ranks can be undeleted. + +To delete a rank, use the following command: +``` +/ranks delete [rankName] +``` + +Ranks are stored within the server's file system in the following path starting from the server's main directory: + +``` +/plugins/Prison/data_storage/ranksDb/ranks/ +``` + +Internally, all ranks are assigned a serial number which is used to identify the rank. The number starts with a 0 and is incremented as more ranks are added. Ranks that are deleted, may have new ranks reuse the same number. + + +This internal serial number is what Mojang would consider a magic number. In a future version of prison, these magic numbers will probably be eliminated. Their elimination will not impact preexisting prison configurations moving forward, but could impact the ability to down grade prison to an older release. + +When a rank is deleted, it is removed from memory, and the file that is saved in the above directory path is renamed and ignored the next time prison is started. For example, if a rank's file name is **rank_2.json** then when it is deleted it will be renamed **.deleted_rank_2.json_
+ + +#Changing a Rank's Cost + +The Rank's cost is initially set when creating a rank, but it can be changed at any time. The command to change the cost is: + +``` +/ranks set cost [rankName] [cost] + +/ranks set cost help +``` + +The cost of the rank can be any value, up to the max value allowed by a Java double. The limitations of what can be stored in a double is also constrained by Java too. + +As an example, you can be able to use a really large value for a cost, but you may not be able to set the one's digit of that value. For example if you assign a cost of 214748364952382342, note that the last three digits are 342. But when you view the cost that is actually assigned to the rank, it will show the last three digits as 336. This is not an error, but a limitation with how floating numbers, such as doubles, work within computers in general. This is related to the fact the number is stored in more than one part, of which the mantissa and exponent are most significant for costs. If you're going to use really huge values for a cost, you must understand you cannot control some of the digits of a double. + + +
+
+
+
+
+If you are going to assign the rank a custom currency, then you can set the currency at any time, before or after changing the cost.
+
+
++ + +#Changing a Rank's Currency + + +Prison supports custom currencies, instead of the default currency that is used with most plugins such as Vault or Essentials. + + +In order to use any default currency, you first must have a plugin that prison recognizes that supports multiple currencies and that must be a valid currency within that plugin prior to its use. + + +Currently the only plugin that Prison supports for custom currencies is GemsEconomy. GemsEconomy can be used in addition to the default currency as accessed through Vault. At this time, Vault does not support custom currencies, so Prison must be have an integration that supports it. + + +All custom currencies will be validated when they are assigned, changed, or loaded upon server startup. If a custom currency has been added to a Rank, but then removed from the server (removal of the plugin or deletion within the plugin) then Prison will prevent usage of that Rank by the players, even if they had sufficient amounts of that currency since there is no way to perform any of the transactions against it. Upon server startup, if Prison detects that a currency is no long supported, it will display a warning with related details. + + +When Prison is looking for support of a custom currency, it checks all registered economy plugins that have support for custom currencies, and then checks each of those economy plugins to see if any of them supports the custom currency. This actually allows a server environment to use many different economy plugins, even multiple custom currency plugins. + + +To add a currency to a Rank, first create the rank and give it a cost. You cannot assign a custom currency initially, but that's alright and that's expected. + + +Then associate a custom currency with the rank: + +``` +/ranks set currency [rankName] [currency] + +/ranks set currency help +``` + +The currency must exist in one of your economies. How to add it is beyond the scope of Prison's support and this documentation. + + +To currency can be changed to any other custom currency by using this command again. + + +The currency can also be removed, and set back to the default, by leaving the currency name blank. For example this removes a custom currency and returns it to a standard currency. + + +``` +/ranks set currency [rankName] +``` + + +The following is an example of a custom currency, named "puurr" that no long exists with in the server since the GemsEconomy plugin is not currently active. + + +
+
+
+Even though in the above example the custom currency "puurr" does not exist, players cannot rank up to the **Free** rank since Prison cannot confirm that it is a valid currency. But admins can use `/ranks promote`, `/ranks demote`, and even `/ranks set rank` to force a player to have those ranks.
+
+
++ + + +#Changing a Rank's Tag + + +A Rank's tag is a formatted String value that is intended to be used with placeholders when special formatting is needed, or desired, for a given Rank. The tag value can be set when the Rank is initially created, or at any other time. If a tag is not defined, then any access of the tag through placeholders will only return the Rank's name. + + +To change a tag use the following command: + +``` +/ranks set tag [rankName] [tag] + +/ranks set tag help +``` + +All valid color and formatting codes that are based upon the `&` symbol can be used. + + +For example: &0 - &9, &a - &f, &k (magic), &l (bold), &m (strike through), &n (underline), &o (italic), and &r (reset). Google Image search "minecraft color codes" for graphic represtations for what those codes represent. Note that the magic value is controlled by the character that follows it. So if you have `&kaaaa` it will cycle through four magic values and they will all be in sync. But if you have `&kabca` then only the first and fourth digits will be sync'd and `b` and `c` will be viewed as different values. + + +
+ + +#Showing a Player's Ranks + +A player may only have zero or one active rank per ladder. But since a player can have active ranks in more than one ladder, this command will show all ranks within all ladders that are available for the given player. + +``` +/ranks player [playerName] + +/ranks player help +``` + +This command will show the Player's name, the given ladder and the rank name. If the player is not at the highest rank, then it will also show what the next rank's name is, along with the cost to achieve that rank. If the rank has a custom currency, that too will be displayed. + + +The following screen print shows the status of two different players. The **default** ladder is the main ladder for doing the prison ranking. The mobs ladder is a non-related ladder that could represent anything, such as side quests. The Donor ladder represents a ladder used for donors, of which it could have donor specific mines for the players to use. And this also shows that one player has prestiged once but the other player has not. + + +
+
+
+
++ + + +#Promote, Demote, and Set Rank Commands + + +Perhaps the most important thing to understand about these three commands is that it is strongly suggested that you should **never** use the `ranks set rank` command. This will be explained later, and is related to the rank commands that are associated with your ranks. + + +The following commands are intended for the use of admins only. They are to be used for setting up test accounts to see how their server is working, and to help address rank issues that players may be experiencing. + + +``` +/ranks promote [playerName] [ladder] [chargePlayers] +/ranks demote [playerName] [ladder] [chargePlayers] +/ranks set rank [playerName] [rankName] [ladder] + +/ranks promote help +/ranks demote help +/ranks set rank help +``` + + +**Warning: Risk of corruption of player ranks:** +Promote and demote changes the player's rank by just one rank. This is important because if you need to promote a player 3 ranks, and you run this command three times, then all rankup commands are properly ran for the player and when you promote then to the final rank, they will have the correct permissons. If you were to just use `/ranks set rank` and skip the other two ranks, then you risk the player missing important permissions and as such, may require more interventions to correct their ranks. The `/ranks set rank` command is there in case it needs to be used, but as owner/admin, you need to understand it may corrupt the players rank. + + +Demote is just as important as promote. Especially since it has been strongly suggested that when you create a rank command, that you include the commands to take away permissions that a player may have gotten in the next higher rank. If a given rankup command set includes all the commands required for that rank, and all the commands to remove the permissions from the next higher rank, then using `promote` and `demote` will never corrupt any player's rank and will lead to less problems. + + +For the commands's parameter **playerName** is obviously the player's name. + + +The parameter **ladder** is optional, and if not specified will default to the `default` ladder. If you need to use any other ladder you need to supply the ladder name. + +The parameter **rankName** is required and identifies what rank to set the player to. If there is more than one level of promotion or demotion, then there is a risk of corruption of the player's rank and missing permissions with promotions, or permissions the player should not have access to with demotions. + + +The parameter **chargePlayers** will require that the player has enough of the specific currency for promotions, and will subtract that amount from their bank balance. If they do not have enough funds, then they will not be ranked up, just as if they ran the command. If the player is being demoted and this parameter is used, then the player will be issued a refund for the prior rank. + + +The parameter **chargePlayers** when dealing with custom currency: If this parameter is enabled and the currency for the rank is not valid (removed from the economy, or the economy plugin was removed) then the promotion, or demotion, cannot be ran. If this parameter is **NOT** used and the custom currency does not exist on the server any longer, then the promote, or demote, commands will be ran ignoring the currency. The lack of this command can force a player to a rank where there is a custom currency error. + + + +
+ + +#Ladder Overview + + +By default, Prison automatically creates two default ladders so you do not have to create them, you just use them. These two ladders are called **default** and **prestiges**. The **default** ladder contains all of the ranks that are associated with the normal Prison play and ranking. The **prestiges** ladder is strictly for the prestige behavior within prison. + + + +
+ + + +#Create Ladder Command + +This command will create new ladders. Ladders do not need to have any ranks associated with them. + +``` +/ranks ladder create [ladderName] + +/ranks ladder create help +``` + +The parameter **ladderName** is the name of the new ladder. + +
+ + +#Add Rank to a Ladder + +This command will add a rank to the specified ladder. If the rank was on a different ladder, it will be removed and added to the specified ladder. The added rank will be added to the end of the ladder if **position** is not specified. If **position** is specified then this command can be used to move a rank to another position within the ladder. + +``` +/ranks ladder addrank [ladderName] [rankName] [position] + +/ranks ladder addrank help +``` + +The parameter **ladderName** and **rankName** are as expected and described above in the prior commands that have these same parameters. + + +The parameter **position** is optional. If not specified the specified rank will be added at the end of the ladder. If specified, it will insert the rank at the specified position, or if it does not exist, then at the end of the ladder. + + +If the rank already exists within the specified ladder, then this command will move the rank to the specified **position**. If **position** is not specified, then it will move the rank to the end of the ladder. + + +If the rank already exists in another ladder, it will be moved to the specified ladder to the specified position. + + +
+ + +#Ladder Delete Command + +This command will delete the specified ladder. The ranks that are within the ladder will be unassociated with the removed ladder and all of the ranks will then be ladderless. Any player that has that rank will be unable to be promoted or demoted until the ranks are added to another ladder, or the ranks are deleted. + +``` +/ranks ladder delete [ladderName] + +/ranks ladder delete help +``` + +*Note: Ladders are treated similar to ranks as far as how they are saved on the server's file system. The following information is identicial to the ranks.** + + + +Ladders are stored within the server's file system in the following path starting from the server's main directory: + +``` +/plugins/Prison/data_storage/ranksDb/ladders/ +``` + +Internally, all ladders are assigned a serial number which is used to identify the ladder. The number starts with a 0 and is incremented as more ranks are added. Ladders that are deleted, may have new ladders reuse the same number. + + +This internal serial number is what Mojang would consider a magic number. In a future version of prison, these magic numbers will probably be eliminated. Their elimination will not impact preexisting prison configurations moving forward, but could impact the ability to down grade prison to an older release. + + +When a ladder is deleted, it is removed from memory, and the file that is saved in the above directory path is renamed and ignored the next time prison is started. For example, if a ladder's file name is **ladder_3.json** then when it is deleted it will be renamed **.deleted_ladder_3.json_
+ + + + +#Rank Commands + +The use of Rank Commands is what hooks everything together within Prison. It ties Ranks to mines and even hooks it up to other plugins and custom behaviors. + +A good example of how to use it with LuckPerms can be found in the documentation for [Configuring and Using WorldGuard with LuckPerms to Protect Mines](prison_docs_626_configuring_worldguard_regions.md). LuckPerms and WorldGuard is just one use case, but the information provided in that documentation can be applied to any other plugin or another permission plugin. + + +(more information to be added later, for for now, the WorldGuard and LuckPerms document covers a lot of the key features) + + +
+ + +#Example of using Ranks + +(coming soon an example on how to use ranks) + + +
+ + +
+ +#This is a work in progress! + +More coming soon! + + +Please visit our discord server to ask for help if you need it. + +Sorry this document is not yet available. + + +
+ diff --git a/docs/prison_docs_107_setting_up_pestiges.md b/docs/prison_docs_107_setting_up_pestiges.md new file mode 100644 index 000000000..c6e0060c3 --- /dev/null +++ b/docs/prison_docs_107_setting_up_pestiges.md @@ -0,0 +1,199 @@ + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## Prison - Setting Up Prestiges + +This document provides information how to setup and use prestiges. + + +
+ +# Overview + +This document should be able to provide the basic information to get the built in prestiges configured and working. + + +
+ + +# Enabling Prestiges + +By default, prestiges are disabled and must be enabled before you can use them. Edit the following file: + +``` +plugins/Prison/config.yml +``` + +Then set the following item to `true` and then save the file and restart the server. + +``` +prestiges: true +``` + +
+
+
++ + +# The Prestige Ladder + + +The prestige ladder is created by default and is named `prestiges`, even if prestiges are not enabled. Ranks can be added to the presetige ladder, even if it is not enabled. + + +In order to use prestiges, you need to create new ranks for each prestige level. Add them as you would for the default ladder and the normal ranks, but you need to specify the prestige ladder name within the commands. + + +To show all the ladders that are available, use the following command. This can help confirm that the ladder exists (it should be created as default) and it can confirm the correct spelling too. + +``` +/ranks ladder list +``` + +
+
+
++ + +# Adding Prestige Ranks + +In order to add prestige ranks, you add them just like you add ranks, but you specify the prestige ladder within the command. + + +You can name them anything you want, but in our example below we are using p1, p2, etc, with the prestige tag values of `+` for the first prestige rank, then the following would be `+2`, `+3`, etc., wrapped in square brackets and colored. + + +Here is an example of adding the first two prestige ranks. These are the commands: + +``` +/ranks create p1 5000000 prestiges &d[&5+&d] +/ranks info p1 +/ranks create p2 8500000 prestiges &d[&5+2&d] +/ranks info p2 +``` + +This screen print shows the results of the above four commands. + + +
+
+
+
++ + + +# Setting up the Chat Placeholders or Prestige Ranks + +You can add placeholders to the chat prefixes. Please consult your chat documentation on how to do this, but here is an example for Esstentials-X Chat plugin. + + +Enabling the chat placeholder just requires editing one line within the `config.yml` file. Search for the keyword **EssentialsChat** in that file, then edit the `format:` tag. For example: + + format: '<{prison_rank_tag}:{DISPLAYNAME}>{MESSAGE}' + + +Once setup, restart the server. Or use **/essentials reload**. Do not force all the plugins to be reloaded with a tool such as plugman since Prison (and other plugins) may fail to re-load properly. + + +The placeholder `prison_rank_tag` will include all placeholders that are active for the player, including the prestige chat prefixes. The only issue is that you cannot control the order of how they will display. + + +It is possible to manually set the order by using the individual placeholders for each rank you want to show. This allows you to omit certain placeholders too. You can preview all of the placeholders with the placeholder search command. + + +``` +/prison placeholder search
+
+
+In our example, to customize the chat prefixes, we are interested in the following prefixes: `prison_rank_tag_pretiges` and `prison_rank_tag_default`.
+
+
+So to set them up in the EsstentialsX Chat prefix would be as follows:
+
+```
+ format: '<{prison_rank_tag_prestiges}{prison_rank_tag_default}:{DISPLAYNAME}>{MESSAGE}'
+```
+
+
++ + + +# Prestiging + +Prestiging is simple to do. If the player is at the highest default rank, then they can rankup the prestige ladder. Prestiging will reset the player's balance to zero. Currently there is no warning or confirmation so proceed carefully. + +``` +/prestige +``` + +The following screen print is from performing the following commands, where the player does a prestige, then sends a chat message to show the chat prefixes. + +``` +/ranks player
+
+
+
+
+Prestige is only available through a gui interface. You have to hover over the blocks to see the lore, which provides additional information.
+
+
+
+
+
+Showing the Confirm Prestige button.
+
+
+
+
+Showing the cancel button.
+
+
+
+
++ + + +# The prestiges Command + +This command shows the prestige ranks. There are a few ways to get a listing of all of the prestige ranks. + +``` +/prestiges +/prisonmanager prestiges + +/ranks list prestiges +/ranks ladder listranks prestiges +``` + +This command is intended for players and can be enabled, or disabled, within the `plugins/Prison/GuiConfig.yml` file. The command `/prestiges` is less configurable, but not sure why. + + + +
+ + + + + diff --git a/docs/prison_docs_111_mine_commands.md b/docs/prison_docs_111_mine_commands.md new file mode 100644 index 000000000..6f11fbc15 --- /dev/null +++ b/docs/prison_docs_111_mine_commands.md @@ -0,0 +1,172 @@ + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## Prison - Mine Commands + +This document provides information how to setup and use Mine Commands. + + +
+ +# Overview + +Mine Commands can allow you to take your mine to the next level. You have control to run a series of commands before, or after, then mine actually resets. You can even disable the replacement of individual blocks that is traditionally associated with a mine reset. + +The mine commands operate like rank commands, except that they run during a mine reset event. They are ran as console, so they have full perms within the server. They can also run any command that you have access to from the console, so it may be best to test all the commands from the console prior to adding them. + +This document will show a simple example, but your imagination can take it to the next level. + +My personal goals to use this new feature was to dynamically build a large forest. Then upon reset, it would erase all the trees and leaves, including any that grew outside of the mine, then randomly plant new trees. The results would be a new random forest that would be generated each time. Unfortunately, I have most of the details worked out on how it will work, but not 100% done yet, so I do not have this example to share at this time. :( + - Blue + + +
+ + +# Adding and Listing Mine Commands + +The family of mine commands are as follows: + +``` +/mines command +``` + +
+
+
+Add a mine command with the following command. I'll add the same command twice just to illustrate that you can have a command run before, or after a mine reset.
+
+```
+/mines command add
+
+
+The `/mines info trees` command shows how many commands are associated with the mine. It shows that there are two commands at the bottom of the listing.
+
+
+
+
+
++ + +# Mine Command Listing Information + + +One point that needs to be explained has to do with the actual listing of commands. The listings will be in the order that you add them, and that is the order in which they will be ran. But it does not matter if you mix together the **before** and **after**. The whole list is processed in order each time, but a filter only runs the correct command. + +It should also be understood that the **before: ** and **after: ** is actually part of the command and is stored that way. If a command does not have either of those prefixes, then it will never be ran. This is a warning if you are tempted to manually change the commands (could happen). + + +
+ + + +# Mine Resets + + +To test these commands, just perform an manual reset. + +``` +/mines reset trees +``` + + +
+
+
+
+
++ + + +# Deleting Mine Commands + +Deleting is simple, but it may not be quite as obvious. + +First it is suggested that you list all of the commands associated with your mine, then copy the command you want to delete. To copy the command, select everything between the single quotes. Then paste that in to the delete command. + +As a tip, if you are in game and you list the mine commands, clicking on the command in the listing will delete it. This could be dangerous, so because when listing commands in game. This example will showcase the command usage from within the console. + + +Using the these commands to illustrate removing a command, with listing all of the commands before and after removal. Then performing a mine reset to show that only one command is ran. + + +``` +/mines command list trees +/mines command remove trees before: ping +/mines command list trees + +/mines reset trees +``` + +
+
+
+
++ + +
+ + + +# Parent Mine Control + +One feature of interest that was requested by a few people, was to have the ability to use Parent mines to control the child mines. + +A parent mine is a large mine, that has smaller mines nested inside it, or the children could be elsewhere outside of the parent mine. The options are numerous, but the idea is that all the mines reset at the same time as if they are connected. + +To accomplish this, let's use the following for our example. The mines will be based upon the name of **doggo**. Of course, you may have a better name in mind, so let your imagination rule! + +* **Parent Mine:** doggo +* **Child Mine 1:** doggo1 +* **Child Mine 2:** doggo2 + +Create the mines... of course do the selections first. The set the mine reset times, making sure that the children reset times are larger than the parent's. This will ensure that the children will actually never be reset automatically on their own. + +``` +/mines create doggo +/mines create doggo1 +/mines create doggo2 + +/mines set resettime doggo 900 +/mines set resettime doggo1 1000 +/mines set resettime doggo2 1000 +``` + +Then setup the commands on the parent to manually reset the children. + +``` +/mines command add doggo after mines reset doggo1 +/mines command add doggo after mines reset doggo2 +``` + +Now since we are assuming the children are nested within the parent mine, let's prevent the parent mine from destroying the child mine's blocks. We can do that by using the block type IGNORE at 100% within the parent mine. + +``` +/mines block add doggo IGNORE 100.0 +``` + +Then set the blocks in the child mines. + +And that's it. You can tweak some of the other settings on the mines, but this accomplishes what we set out to do: have a parent mine reset the children mine at the same time. Since the children's reset times are much longer than the parents, they will never reset on their own because when they are manually reset, it resets the timer, which will never reach zero. + + + +
+ + + diff --git a/docs/prison_docs_113_setting_up_sellall.md b/docs/prison_docs_113_setting_up_sellall.md new file mode 100644 index 000000000..fc96ac1b6 --- /dev/null +++ b/docs/prison_docs_113_setting_up_sellall.md @@ -0,0 +1,116 @@ +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## Prison - SellAll info + +This document provides info about how to use the SellAll feature and set it up + +
+ +# Overview + +SellAll's a feature with the goal of sell and clear the player inventories from ores or blocks for money. +Essentially, while mining you'll fill your inventory and once full you need to sell what you've mined +to get money and rankup or buy stuff, SellAll will do all the job and give you the money. + +There's also a Multiplier feature which will modify the sellall values of all blocks depending on your prestige but before +using it you should enable ```prestiges: true``` in your ```config.yml``` + +
+ +# Getting started + +First of all, if you want to use this feature, you'll need to enable it in your ```config.yml``` by editing ```sellall: false``` to ```sellall: true``` (by default's on false) and restart the server. +Also if you want give a look to the ```sellallconfig.yml``` and customize it. + +*THE CONFIG SHOULD LOOKS LIKE THIS:* +_It might even be slightly different but it doesn't matter_ + +``` +Options: + GUI_Enabled: 'true' + GUI_Permission_Enabled: 'true' + GUI_Permission: prison.admin + Sell_Permission_Enabled: 'false' + Sell_Permission: prison.admin + Add_Permission_Enabled: 'true' + Add_Permission: prison.admin + Delete_Permission_Enabled: 'true' + Delete_Permission: prison.admin + Player_GUI_Enabled: 'true' + Player_GUI_Permission_Enabled: 'false' + Player_GUI_Permission: prison.sellall.playergui + Multiplier_Enabled: 'true' + Multiplier_Default: '1' + Multiplier_Command_Permission_Enabled: 'true' + Multiplier_Command_Permission: prison.admin +``` + +### Then, you can do two things: +* If you're lazy or just don't want to do a ton of math like me, there's a default setup command which will add all the blocks +you should need for a Prison server with preset values, the command's ```/sellall setdefault```. +Then you could also edit these values if you don't like them with the command ```/sellall edit
+ + +# ADVANCED FEATURES + +**Multipliers:** + +To use this feature, you'll need to enable prestiges in your ```config.yml``` by editing ```prestiges: false``` to ```prestiges: true```, add some Prestiges and enable +multipliers in your sellallconfig.yml by editing ```Multiplier_Enabled: false``` to ```Multiplier_Enabled: true```. + +The command ```/sellall multiplier``` will show all the sub-commands of this feature, right now there're only 2 commands: +``` +/sellall multiplier add
+ + +# Overview + +Placeholders allow the sharing of data from one plugin with another plugin, and without either plugin knowing anything about each other. + +On the surface they appear to be simple, but there are a lot of moving parts below the surface, and with Prison Mines, there are even more things going on. + +Add in to the mix, that different plugins deal with placeholders in slightly different ways, and you can wind up with a challenge to get them to work under different circumstances. + +
+ + +# Requirements + +There is always more than one way to do things, and the same goes for having more than one way to use placeholders. This documentation, and our test servers, primarily rely on the use of PlaceholderAPI as the core component to making placeholders work. Depending upon other plugins that you may use, they may have other dependencies too. + +**PlaceholderAPI** - [Setting up PlaceholderAPI](prison_docs_0xx_setting_up_PlaceholderAPI.md) - Strongly Suggested if using placeholders. + +
+ + +# Placeholder Theory for Prison + +There are two major types of placeholders in prison: Player based and Mine based. + +The player based placeholders can only report on the player that is initiating the command, or request. These placeholders pertain to the player's attributes, such as rank or next rank. Internally, all of these requests must include the player's UUID, which is why you cannot just add them to a sign, since the sign does not know any player's UUID. + +There are actually two kinds of player based placeholders. Rank placeholders that returns all of the player's current attributes for all active ladders they are associated with. For example, if they are active on four ladders, then they will have four active ranks on four ladders with possible values. So it may look something like this: `[mod][Zeus][+2][B]`, of which the ladders could be mod, donor, prestige, and default. The thing to remember about player rank placeholders is that they may return more than one value, and you cannot control the order of the values (yet). + +The other player based placeholders are similar to the player rank placeholders, but are specific to a single ladder. This allows you to get single placeholder, and control the order of placeholders, at the expense of having to specify multiple placeholders. + +The Mine based placeholders provide details about mines, and the mine name becomes part of the placeholder name. Out of all of the possible mine based placeholders, each one is duplicated for each mine. So, in rough terms, if there are different mine placeholders and you have 40 mines, then prison will generate about 400 place holders: 40 mines x 10 placeholders each = 400 placeholders for prison. + +Prison has integrations for direct use of providing placeholder values to to the other plugins. Some of those other plugins request placeholder values using partial placeholder names. Therefore to improve performance and to prevent having to always reconstructing the full placeholder names, prison precomputes the fragments for all placeholders. Therefore, with our example of 40 mines and 10 placeholders, the actual internal number of placeholder combinations that prison will respond to is 800: 40 mines x 10 placeholders per mine x 2 for aliases = 800 placeholders for prison. + +Off hand this may sound bad, but Prison utilizes enumerations for identifying placeholders, so they may be objects, but they are lightweight and helps ensure placeholders align with the code at compile time. This not only provides better performance, and less memory consumption, but programming errors and typos are caught at compile time and not runtime, so they also provide for a more stable and reliable Prison environment. + +Internally, placeholders within Prison are case insensitive. But Prison uses lower cased placeholder names to register with any placeholder integration. Therefore, although prison may be case insensitive, the placeholder plugins may not recognize the placeholders unless you use them as all lower case names. + +Also, internally, prison only responds to the placeholder name without the escape characters. The escape characters are generally curly braces { }, or percents % %, but may be other characters. All placeholder plugins strip off the escape characters before passing anything to prison. So proper use of placeholders is dependent upon what is being required by your placeholder plugin and may require a mix of escape characters. + +
+ + +# Rank Command Placeholders + +The Rank Commands recognize only two placeholders, but they are not considered part of the standard placeholders. There are also only two placeholders that are recognized and both are case sensitive, and must also include curly braces too. + +* {player} +* {player_uid} + +This is mentioned here since these rank command placeholders are not part of all the other placeholders, so as such, it may be difficult to find information for these items. + + +
+ + +# Placeholder Commands + +*Since Prison v3.2.1-alpha.13* + +There are a few commands within prison that will allow you list placeholders, search for placeholders, and to test random text that includes placeholders. + +* **/prison placeholders** + + +* **/prison placeholders list** +* **/prison placeholders search** +* **/prison placeholders test** + + +* **/prison version** Provides the same placeholder listing as /prison placeholders list. + + + +
Prison Placeholder Command Listing
+ +
+
+Example of placeholder command listings
+
+
+Prison Placeholder Listings
+ +
+
+Example of the list of placeholders that is available through **/prison version** and **/prison placeholders list**. Please note that this list may evolve as new placeholders are added. Use these commands to get the current listing that is available on your server.
+
+
+Prison Placeholder Search with Two Search Patters
+ +
+
+This is an example of searching for placeholders using two search patterns: *temp5* and *format*. The term temp5 is the name of a mine and is an example of a the dynamic construction of placeholders, and that you can still perform a search with them. The search patters can be any String fragment found in either the placeholder, or it's alias.
+
+If more than one search pattern is provided, then all patters must hit on the same placeholder to be included in the results. They behave as a logical AND relationship.
+
+
+
+Prison Placeholder Listings - All Placeholders
+ +
+
+In this contrived example, since all placeholders begin with "prison", this search returns a listing of all placeholders. In this example, using the current Prison v3.2.1-alpha.13 release, it has generated 65 pages of results, at 6 placeholders per page which includes the alias.
+
+
+Prison Placeholder Listings
+ +
+
+
+
++ + +# Chat Placeholders + +There are two major ways a placeholder can be resolved within Prison: through chat or through a placeholder integration. + +Chat based placeholders do not rely on other plugins for them to work. Instead they use the org.bukkit.event.player.AsyncPlayerChatEvent, of which Prison will respond and provide translations to prison related placeholders that it find with the chat message. + +Although no plugin is required for Prison to properly handle chat based placeholders, other plugins may be required to generate their use. Such as EssentialsX's Chat plugin. It provides a way to prefix chat messages with placeholders. + + + +
+ + + +# Enabling EssentialX's Chat Placeholders + +Set up the EssentialX's Chat plugin: [Setting up EssentialsX](prison_docs_0xx_setting_up_EssentialsX.md). + +Enabling the chat placeholder just requires editing one line within the `config.yml` file. Search for the keyword **EssentialsChat** in that file, then edit the `format:` tag. For example: + + format: '<{prison_rank_tag}:{DISPLAYNAME}>{MESSAGE}' + +Once setup, restart the server. Or use **/essentials reload**. Do not force all the plugins to be reloaded with a tool such as plugman since Prison (and other plugins) may fail to re-load properly. + + +This will include all placeholders that are active for the player, including the prestige chat prefixes. The only issue is that you cannot control the order of how they will display. + + +It is possible to manually set the order by using the individual placeholders for each rank you want to show. This allows you to omit certain placeholders too. Please see the next section of this document to learn how to set them up. + + +You can preview all of the placeholders with the placeholder search command. + + +``` +/prison placeholder search
+
+
+The placeholders are interested in are: `prison_rank_tag_pretiges` and `prison_rank_tag_default`.
+
+
+So to set them up in the EsstentialsX Chat prefix would be as follows:
+
+
+ format: '<{prison_rank_tag_prestiges}{prison_rank_tag_default}:{DISPLAYNAME}>{MESSAGE}'
+
+
+
+Ladder Specific Placeholders
+ +One of the newer features available for placeholders has to do with ladder specific placeholders. This is similar to the mines placeholders but for ladders specifically. These player ladder placeholders are just the same a the player rank, but only for one ladder. The player rank placeholders will return all ranks on all ladders for that placeholder. + +This is an example of specifying the rank tag for both the prestige and default ladder. This ensures the expected order of these two tags, but it will also exclude other tags from other ladders, such as donor ladders or mod ladders. + + format: '<{prison_rank_tag_prestiges}{prison_rt_default}:{DISPLAYNAME}>{MESSAGE}' + + +Use the placeholder tools under `/prison placeholders` for more information and to see what is available for use. + + + +For example, to preview all of the placeholders with the placeholder search command. + + +``` +/prison placeholder search
+
+
+
+
++ + + + +# Enabling HolographicDisplays Placeholders + +Follow directions on how to install and configure the HolographicDisplays plugin. + + +An important detail to realize, is that HolographicDisplays can only use placeholders that related to the server. It cannot access any of the prison placeholders on its own. It needs the help of other plugins to extend it's functionality. + +* [HolographicDisplays Download](https://dev.bukkit.org/projects/holographic-displays) +* [HolographicDisplays' Documentation](https://filoghost.me/docs/holographic-displays) + +* [HolographicExtension](https://www.spigotmc.org/resources/holographicextension.18461/) +* [PlaceholderAPI Setup Details](prison_docs_0xx_setting_up_PlaceholderAPI.md) +* [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/) + +The simple directions on how to get everything to work is to download these plugins, and place them all in to your server's plugin directory. There is no need to modify any config files to get them to work with prison. Prison will register all of the internal placeholders with PlaceholderAPI so it knows they are valid and where to find them (where to send them to be resolved). + +The simplest way to create a HolographicDisplay would be to stand where you want one. Then enter the following command: + +``` +/hd create test +``` + +Then on the server file system, open the file: + +``` +plugins\HolographicDisplays\database.yml +``` + +Then edit the file. Keep in mind it is a yml file and must be valid yml. + +This is an example of a holographic sign: + +``` +temp5: + location: world, -99.832, 74.500, 191.215 + lines: + - 'Welcome to Prison Mine: temp5' + - 'Reset Interval: {slowest}%prison_mines_interval_temp5% - {slowest}%prison_mines_interval_formatted_temp5%' + - 'Reset Time Left: {medium}%prison_mines_timeleft_temp5% - {fast}%prison_mtlf_temp5%' + - 'Reset Count: {medium}%prison_mines_reset_count_temp5%' + - 'Mine Size: {slowest}%prison_mines_size_temp5%' + - 'Blocks Remaining: {slowest}%prison_mr_temp5% {slowest}%prison_mp_temp5%%' + - 'Players in Mine: {slowest}%prison_mines_player_count_temp5%' +``` + +Notice that the prison placeholders are wrapped in the % % escape characters. The prefixed placeholders such as {slowest} and {fast} are for the plugin HolographicExtensions and they control how frequently the placeholders are refreshed. + +Once you update and save the database.yml file, you can have HolographicDisaplys reload from the files: + +``` +/hd reload +``` + +The above example will produce a holograph that is too tall and the bottom part will be underground. You can raise it up by manually increasing the **Y** value stored in *location:*. As you raise it up, and save the file, then you use **/hd reload** to refresh. It's also easier to make changes directly to the database.yml file. Repeat until it looks right. + + +One word of warning about editing the yml file, is that it must be valid yml, if not, then it could fail to load, or it may reset to a default file. If you're unsure about the file being proper yml, make sure you save a backup before trying to reload the HolographicDisplays settings. You can also run it through an online yml validator to fix any issues. To find an online yml validator, search for: "online yaml lint" or "online yaml validator". + + + + + +
+ + diff --git a/docs/prison_docs_315_guide_scoreboard-r.md b/docs/prison_docs_315_guide_scoreboard-r.md new file mode 100644 index 000000000..363a05368 --- /dev/null +++ b/docs/prison_docs_315_guide_scoreboard-r.md @@ -0,0 +1,12 @@ + + + + + + +https://www.spigotmc.org/resources/scoreboard.14754/ + + + +Animated Scoreboard" (only 1.16.2 scoreboard I could find) + diff --git a/docs/prison_docs_626_configuring_worldguard_regions.md b/docs/prison_docs_626_configuring_worldguard_regions.md new file mode 100644 index 000000000..22ad4b8ae --- /dev/null +++ b/docs/prison_docs_626_configuring_worldguard_regions.md @@ -0,0 +1,611 @@ + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## Configuring and Using WorldGuard with LuckPerms to Protect Mines + +This document explains how to setup WorldGuard to protect your mines and how to prevent players from accessing it when they don't have the correct permissions. It also explains how to setup the permissions in the Prison's **/ranks command add
+ + +# Dependencies + +* Vault - Interfaces with the Permission Plugins +* [Install WorldGuard and WorldEdit](prison_docs_026_setting_up_worldguard_worldedit.md) +* Install a Permissions Plugin that is compatible with Vault + * This guide uses LuckPerms. See [Setting up LuckPerms](prison_docs_020_setting_up_luckperms.md) for more information. + +
+ + + +# Setting up WorldGuard and WorldEdit: + +Install both WorldGuard and WorldEdit as required for your version of the server and Minecraft. Follow the general directions in the link above. If you require additional help, there should be plenty of good resources if you search for them. + +
+ + + +# In Game versus In Console + +**Important to understand:** When you add commands to the **/ranks command add** then they will be executed as if they were being entered through the console. Any references to players within a rank command must be replaced with `{player}` or `{player_uid}`. + +Please note that for WorldEdit and WorldGuard there is a slightly different way of entering commands **in game** versus **in console**. This is very important to understand, because most of the commands may be entered in game, but when you add some of these commands to the **/ranks command add** then they will be executed as if they were being entered through the console. + +When you are in game, the world you are in will be used as a default value in any command that requires a world parameter. When you are entering commands from the console, you must specify the world parameter. Failure to specify the world will prevent the command from running. This will cause problems during the running of the **/rankup** commands. + +The WorldGuard documentation says the following about the `-w` flag. + +``` +-w
+ + + +# Naming conventions to Consider + + +Please note that whatever you choose to use for the region names or the permissions is up to you. It may be easier to understand what is what, if it has some kind of context such as a region named **mine_
+ + + +# Enable Yourself - Op'ing and Wanding + +To simplify things, make sure you are **op**. You should also know how to **deop** yourself too. You can **deop** yourself in game too, just prefix the command with a slash. + +From console: + + op
+ + + +# Protecting the World from Players + +**Purpose:** This prevents players from breaking any blocks in the world. It also prevents mobs from spawning. + + +As op, protect the whole world with a passthrough flag set to deny. This will prevent building, PVP, and everything else. Basically, any action that “passthrough” all over defined regions, will be denied. The command with the **-w world** parameter has been added to the following list too. Use that version from console, the other without **-w world** in game. And where the name **world** is the actual name of your world. + +In game commands: + + /rg flag __global__ passthrough deny + /region flag __global__ mob-spawning deny + /gamerule doMobSpawning false + +Console commands: + + /rg flag -w
+ + + +# Various LuckPerm Commands for Templates and Mines + +The WorldGuard region templates are covered below, but first you need to setup the groups within LuckPerm or the permissions on the child groups will not be tied back to the parent groups within LuckPerms. + + +For prison, we will use the prefix of `prison.mines` so we know what these groups and permissions are related to the mines. + + +LuckPerms commands to create a group, and how to have a child group inherit permissions from a parent. The first command should be used twice, first for the parent, then the child group. The the next command shows how to assign a parent group to a child group. + + /lp creategroup
+ + + + +# Unprotecting a Mine for its members - Required for all Mines + +**Purpose:** This will actually give members the ability to perform mining related tasks within the mine. They need to be able to break the blocks within the mine, and to pickup items, XP, and allows item drops. + + +This defines a WorldGuard region, and needs to be applied to all mines. + + +Select the same area of the mine with the WorldEdit **wand**, then use the following commands to define a mine. It will define a region with the mine’s name, and set the parent to mine_template, with the only member ever being the permission group **prison.mines.
+ + + + + +# Protecting a Mine's Area - Required for all Mine Areas + +**Purpose:** To keep out all non-members from a mining area. The mining area, as in this context, is the area that immediately surrounds a mine, and generally non-members should not have access to it. + + +In general, it may be tempting to restrict access to the mine itself so non-members cannot mine it. But there is a serious problem with just protecting the mine, and that’s when non-members walk on top of the mine. They will fall in to the mine, as expected, but WorldGuard will try to keep them out, so they will be bumped back above the mine, thus triggering a “fly” event, or a “hover” event. This action may trigger anti-hacking software to auto kick them, or auto ban the players, or the players could get stuck, and it may even cause a lot of lag on the server too. + +This also happens really fast, in a very repeated action, so it could lock up the player so they cannot jump back out before they get banned. I do not know if this could contribute to server lag, but a lot of processing appears to be happening so it is possible. + +The suggested action is to create a new region around the mine and protect that from entry from non-members. This region can then be extended from y=0 to y=255 with the WorldEdit command `//expand vert``. If anyone does get past it, they still won’t be able to mine. + + +The primary purpose is to keep non-members out of the region. It will also prevent non-members from TP'ing in to the area too. It will also supply the player with an error message to inform them they don't have the rn + + +Select the an area around the mine with the WorldEdit **wand**. Only select a rectangle area around the mine, ignoring the **y** axis. Then use the following commands to define a mine. It will define a region with the mine’s name, and set the parent to mine_template, with the only member ever being the permission **g:prison.mines.
+ + + + + +# Granting Access to a Mine and Removal of the access + +**Purpose:** From either the console, or from within game, manually grant a player access to a mine. + +To add a player to the mine regions is as simple as giving the user the permission associated with the mine region. + +It's important to understand that you never add a player as a direct member of a mine region, since if you have thousands of players, it will make your configuration files messy, and could add to lag dealing with such large data files per region. + +Instead, you add the players to a permission group that has access to use the mine regions. One way to look at this is that a permission is like a key, and you're giving players a copy of the key access the mines. With a slight twist on that analogy, since we're dealing with groups, everyone within that group shares the same key for the mine regions. + + +The correct way to add a player to a mine region. Indirectly by giving them access to the "keys". Or in other words, since we hooked up the LuckPerms group `g:prison.mines.
+ + + +# Adding Rank Commands to run when /rankup is Performed + +**Purpose:** Adds the permission to access the mine area and to mine within a mine, when a player successfully runs /rankup. + + +Based upon the above documentation, and from within game, we would use the following to *manually* give a player a permission: + + /lp user
+ + + +# Alternatives + +There are many ways to accomplish the same goals and that's what makes Minecraft so versatile and interesting to play. The Prison Plugin does not want to impose a specific way to do most things, since it may not be the ideal way for your sever. + +One of the primary focuses for this document has been protecting the area around your mine to prevent players who should not access the mine, from enter that region. One alternative to needing to protect a mine, would be to limit the access to the mine so it does not have to be protected. One simple way of accomplishing that, is to have the mines in a void world, and then each mine would be a separate island. Then all that would need to be protected, or controlled, would be the warping to that location. + + +
+ + + + + +
+ + +# WG LP Commands - Overview + +These are entered in a step by step process, intended for you to follow. + +These can, and probably will, be translated in to a runnable script within prison that will set everything up for you. Well, once you take care of the basics. + +You should be in game when you run these commands, otherwise you may have to specify the world name with almost all LuckPerm commands. When these are converted to scrips, the world parameter will be added. + +Some code chunks will have **In Game:** which is intended to run from within minecraft. The **Console:** is intended to be ran from the console, where there is no player, so you have to provide the "world". Note that if your world is not named "world" then you will have to change that. If there are any code chunks that are marked as "script" then those provide an example of what kind of placeholders would have to be used. + + +
+ + + +## WG LP Command - Global for whole world + +Run once. + + +In game: + + /rg flag __global__ passthrough deny + /region flag __global__ mob-spawning deny + /gamerule doMobSpawning false + + +Console: + + /rg flag -w world __global__ passthrough deny + /region flag -w world __global__ mob-spawning deny + /gamerule doMobSpawning false + + + +
+ + + +## WG LP Command - Setting up LuckPerm Groups + +Run once. You must know what your mines and ranks will be. Mines are just a simple letter like A through Z. The ranks generally have the same name. + + +For the sake of this document we will assume they will range from A to Z, but we will only create permissions and regions for only one mine, a. Be certain to duplicate this for all of the mines that you have. There could be donor mines too, but for now let's ignore those. + +For each mine, there will be + + /lp creategroup prison.mines.a + + /lp creategroup prison.mines.b + + ... + + /lp creategroup prison.mines.z + + + +## LuckPerms Adding Permissions to the Groups + +Run once for each mine/rank. + +There will be other permissions that players will require in order to use your server. You can add some of these permissions to the LuckPerm groups so when a player becomes a member of that group, then they will inherit the permissions that are in that group. + +A good example of these permissions are of course rank based, such as access to the mine's warp, or even other permissions that everybody should have. + +In this example we will give the group `prison.mines.a` the standard prison rank related permissions, but also other permissions that everyone should have. + + + /lp group prison.mines.a permission set prison.tp.a + /lp group prison.mines.a permission set prison.gui + /lp group prison.mines.a permission set prison.user + + + /lp group prison.mines.a permission set warp + /lp group prison.mines.a permission set warp.list + /lp group prison.mines.a permission set warp.a + + +You can also add in a lot of EsentialX's permissions to fine tune what your players can do. A nice listing of permissions can be found here: https://essinfo.xeya.me/permissions.html + +Since rank A will always be a permission group all your players have, you can use this group as a container for those permissions. + +Then all other ranks would only need what is required of the new ranks. Such as: + + /lp group prison.mines.b permission set prison.tp.b + /lp group prison.mines.b permission set warp.b + + +
+ + + +## Creating the Mine's WorldGuard Region + + +You can either use the worldEdit wand to select what you want to set as a region, or you can use other WorldEdit features to set them. + + +These are a WorldEdit method that can be used in game if you know the x, y, z coordinate. This will not work with scripting because you cannot specify the world to apply it to. + + + //pos1 x, y, z + //pos2 x, y, z + + +Once you have a WorldEdit selection then you can create a WorldGuard region. + + /region define prison_mine_a + /region setpriority prison_mine_a 10 + + /region flag prison_mine_a block-break -g members allow + + /region flag prison_mine_a item-pickup -g members allow + /region flag prison_mine_a exp-drops -g members allow + /region flag prison_mine_a item-drop -g members allow + + /region addowner prison_mine_a g:owner + /region addmember prison_mine_a g:admin + + /region addmember prison_mine_a g:prison.mines.a + + +Repeat the same for mine b. + + + +
+ + +## Creating the Mine Area WorldGuard Region + +The mine area is an area that surrounds the mine to protect the area from players who should not have access. This area should be at least 5 blocks larger in the X and Z axis than the mine, so as to prevent non-member players from being able to attempt mining. + +You need to select the area like the prior region and then define it with the following commands. The following `//pos1` and `//pos2` is just an example of making the selection. The `//expand vert` is required (strongly suggested) to ensure the region extends from the lowest to the highest blocks. + + //pos1 x, y, z + //pos2 x, y, z + + + //expand vert + + /region define prison_mines_area_a + /region setpriority prison_mines_area_a 10 + /region flag prison_mines_area_a entry -g nonmembers deny + /region flag prison_mines_area_a entry-deny-message You must rank-up to access this mine. + + /region addowner prison_mines_area_a g:owner + /region addmember prison_mines_area_a g:admin + + /region addmember prison_mines_area_a g:prison.mines.a + + +Please notice that we have defined two WorldGuard regions: prison_mines_a and prison_mines_area_a. But for both of them, we've assigned the LuckPerms group g:prison.mines.a as members. This means, all we need to do is add the player to that LuckPerms group and they will have access to both the mine_area and also the mine. + + + +
+ + +# Adding the Prison Rank Commands + + +So finally for our example of setting up mines a and b, we now need to add the Rank Commands to active the permission for both. + +For rank a: + + /ranks command add a lp user {player} parent set g:prison.mines.a true + /ranks command add a lp user {player} parent unset g:prison.mines.b + + +For rank b: + + /ranks command add b lp user {player} parent set g:prison.mines.b true + /ranks command add b lp user {player} parent unset g:prison.mines.c + + +And that's it! Just repeat for all your other mines. + + + + + +# Other Commands That May Be Important: + + /region redefine mine_
+ + diff --git a/docs/prison_docs_628_configuring_private_mines.md b/docs/prison_docs_628_configuring_private_mines.md new file mode 100644 index 000000000..1440f41c2 --- /dev/null +++ b/docs/prison_docs_628_configuring_private_mines.md @@ -0,0 +1,133 @@ + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## Setting up Private Mines + +This document explains how to setup private mines that are not accessible to +other players. This document provides an *idea*, but it's up to your to +figure out the details to make it all work. + + +This applies to both personal mines (one player) and also special groups such +as donors or clans or other in-game groups. + + +This process will be a very manual process with a lot of manual steps that +must be repeated over and over again. + +
+ + + +# Dependencies + +* Vault - Interfaces with the Permission Plugins +* [Install WorldGuard and WorldEdit](prison_docs_026_setting_up_worldguard_worldedit.md) Understanding this document is critical for getting things to work. +* Install a Permissions Plugin that is compatible with Vault +* This guide uses LuckPerms. See [Setting up LuckPerms](prison_docs_020_setting_up_luckperms.md) for more information. + +It is very important to understand how to use WorldGuard and LuckPerms with Prison. The +above document explains one way to do that, and it's something that will be expanded +upon in this document. + +
+ + +# Performance Considerations + +As more mines are added to your server, they will have an impact on performance overall. +Here are some possible concerns if you are adding hundreds of private mines. + +* The reset process of replacing blocks is time consuming and processing intensive. The more mines that exist, the more frequent resets will run. Having hundreds of mines will ensure more are resetting every minute, and you could have multiple that try to reset at the same time. +* Mine resets cannot be done asynchronously. Asynchronous replacement of blocks could cause corruption of the world. Even asynchronous reading of block types can corrupt the world IF there are entities in chunks that are loaded to check the blocks. Entities include mobs and even items thrown to the ground, or drops from mining. The point is that mine resets can be expensive. +* Prison "tries" to do as much as possible to minimize the load on the server when doing a mine reset. For example performing precalculations in an asynchornous thread before attempting to replace the blocks. Also it pages the block placements to allow other processes to run on the server which may increase the reset time, but it should minimize impact on TPS when many events are going on at the same time. +* Many mines will require more memory on your server. The amount will be small, but more mines will require more memory. Prison even with hundreds of mines, should not consume a ton of memory, but it will consume more than just a dozen mines. +* Having many mines will slow down the searching for the "right" mine. There are some processes that have to locate which mine is being "used". Unfortunately, the only way to do so, is to go through each mine one at a time looking for a "hit". If you have hundreds of mines and the "hit" is on the last one in the list, then the dealy may be slightly longer than if it "hits" on the first item. + + + +
+ + + +# Mine Names, Permission Names, and Region Names + +You need to figure out how you want to name everything. This includes the name of +the mines, the permissions, and regions. Their names are overall +arbitrary, but they need to make sense to you. There may be a large number that are +needed so it would make sense to use an incrementing number. + +For the purpose of this document, and to keep the mine names simple, +let's name the mines as follows. This will allow for up to 10,000 mines. +* mine0001 +* mine0002 +* mine0003 +* mine0004 + + +Examples of what will be used in this document: +* prison.mines.private.mine0001 +* prison.mines.private.mine0002 +* prison.mines.private.mine0003 +* prison.mines.private.mine0004 + + +Permissions are critical in that it allows you to associate a player with a mine. +When the mine is properly configured with WorldGuard, it will prevent other players +from being able to access it. + + +Region names should follow the same pattern as provided in the WorldGuard documentation. +* mine_mine0001 +* mine_mine0002 +* mine_mine0003 +* mine_mine0004 + + +In the WorldGuard documentation above, the region names used were based upon + +
+ + + +# Creating Mines Using Schematic Files + +If you will provide personal mines, that implies you will have to have a lot of +mines to sell. You can build them individually, but it may be worth figuring out how +to use WorldEdit to save a mine as a schematic File. Once saved as a schematic file, you can +then copy and paste it in your world many, many times. If you need more information on +how to do this, please google: **worldedit using schematics**. + +
+ + +# Hooking it up to BuyCraft or Enjin + +Whatever your store front you use, to provide the players with access and ownership to their +private mines, all you would have to do is provide the player with the permission that +was used to configure that mine. It would be as simple as that. Once the player has +the permission, everything should work fine. + +If you are naming the permission in a sequential order, see above, then the store +fronts may be able to "sell" a range of permissions. Otherwise you would have to +configure each one independently. + +
+ + +# Another Idea on how to Setup Private Mines + +There may be a way to setup a plot world to help with this. +A plot world plugin could generate the repeating patterns of the mines, +and take care of some of the management of them, but it would have to be a manual +process to hook them up to the prison plugin. Such an exercise is far beyond +the scope of this document, or the prison plugin being able to provide an automation +process to manage all of them for you. Good luck, you're on your own +in trying to figure this out. + + + +
+ + diff --git a/docs/prison_docs_630_configuring_warps.md b/docs/prison_docs_630_configuring_warps.md new file mode 100644 index 000000000..11dbefc41 --- /dev/null +++ b/docs/prison_docs_630_configuring_warps.md @@ -0,0 +1,127 @@ + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## Configuring EssentialsX Warps for Mines + +*Note that this is a work in progress and does not include all steps yet.** + +This document explains how to setup the EssentialsX Warps so players can warp when to the mines that they should have access to. + +Please note that within Prison there is the **/mines tp
+ + + +# Dependencies + +* EssentialsX - for the */warps* and */warp* commands. + +
+ + + +# Configuring EssentialsX + +Download and install EssentialsX. + + +In the `plugins/Essentials/config.yml` is this: + +``` +// Set this true to enable permission per warp. +per-warp-permission: false +``` + +Set that to `true`. + + +Then restart the server. + +
+ + + +# Permissions for Warps + + +* **essentials.warp** - Allow access to the /warp command. +* **essentials.warp.list** - Specifies whether you can view warp list with /warp. +* **essentials.warps.[warpname]** - If you have per-warp-permission set to true in the config.yml then you can limit what warps players can use. This also controls what players would see with /warp. + +In the EssentialsX config file, set: + +``` +per-warp-permission: true +``` + +Then use the following permissions. The first two are required, but the last three are examples based upon the three warp names: a, b, and c. These three warp names happen to be the same as the mine's names, but they don't have to be. There is no direct connection between warp names and mine names. And there are no direct connections between warp permissions and mine permissions. +``` +essentials.warp +essentials.warp.list +essentials.warps.a +essentials.warps.b +essentials.warps.c +``` + + +# How to set the warps + + +First you need to set up each warp. Use the `/setwarp [mineName]` command to accomplish that. + + +If you want it to be exactly the same as your prison mine warps (ie... `/mines tp [mineName]`), first tp to that location and do not move or change where you are looking. Next issue the EssentialsX's command `/setwarp [mineName]` to set the warp location. + + +Then add them to the rank commands. Using LuckPerms from within game will look something like this: + +``` +/lp user [playerName] permission set essentials.warps.a true` + +``` + +And adding them to the ranks commands but instead of specifying the actual player name, use the `{player}` placeholder and Prison will substitute the player's name at runtime: + +``` +/ranks command add a lp user {player} permission set essentials.warps.a true +/ranks command add b lp user {player} permission set essentials.warps.b true +/ranks command add c lp user {player} permission set essentials.warps.c true +``` + +Note that with LuckPerms, the add user permission has an optional Boolean value of true at the end. If omitted, it defaults to true, but it is included here since most documentation includes it. + + +# Using PEX permissions with Warps + +If you're using PEX, the rank commands are similar, but using the pex notation. + +From within game the pex command will look something like this: + +``` +/pex user [playerName] add essentials.warps.a +``` + +And adding them to the ranks commands: + +``` +/ranks command add a pex user {player} add essentials.warps.a +/ranks command add b pex user {player} add essentials.warps.b +/ranks command add c pex user {player} add essentials.warps.c +``` + + + +# Links + +[http://ess.khhq.net/wiki/Command_Reference](http://ess.khhq.net/wiki/Command_Reference) + +[http://wiki.mc-ess.net/doc/](http://wiki.mc-ess.net/doc/) + +[https://luckperms.net/wiki/Permission-Commands](https://luckperms.net/wiki/Permission-Commands) + + +
+ diff --git a/docs/prison_docs_810_faq_other_plugins.md b/docs/prison_docs_810_faq_other_plugins.md new file mode 100644 index 000000000..dc2a5c6cb --- /dev/null +++ b/docs/prison_docs_810_faq_other_plugins.md @@ -0,0 +1,81 @@ + + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## FAQ - Other Plugins + +This document covers some common issues that pertain to other plugins, but may not actually be related to Prison. + +
+ +# CMI - Used for the Economy within Prison + +**Symptoms of Issues** + +Symptoms of issues with CMI is when it appears like Vault is using CMI has successfully loaded, but yet the Ranks module fails to load. + + +**Overview of CMI** + +CMI Is a premium plugin and costs about 15.00 Euros. It is a very extensive plugin that covers many aspects of what you could possibly do with a server. The developers claim it is a worthy replacement for EssentialsX. The primary aspects CMI with what Prison needs to use is their economy and permissions. +[CMI on spigotmc.org](https://www.spigotmc.org/resources/cmi-270-commands-insane-kits-portals-essentials-economy-mysql-sqlite-much-more.3742) + + +**How to Resolve the Issues** + +In order to use CMI with prison, it is required that you use Vault. Prison does not have any direct integrations to CMI. Since it is a premium plugin, the CMI integration for Vault is not publicly available in the original Vault plugin. Instead CMI offers their own modified version of Vault that has been recompiled with their hooks added, or an injector that will add it to the original Vault plugin. + + +On their spigotmc.org resource page, they identify there are two way to enable a working version of Vault: +1. Install and use their modified version of Vault (recommended) +2. Or use the CMIEInjector to modify an original Vault (not recommended) + + +**Common Problems** + +1. Make sure you are using the CMI modified version of Vault +2. The CMIEInjector has problems, or will cause problems. So don't use it. +3. Do not use both the CMI modified version of Vault and the CMIEInjector. They were never intended to be used together and they will cause problems with prison. + + +
+ + +# Prison Won't Load - No Modules Loaded - LuckPerms is the Cause + +**Symptoms of Issues** + +Symptoms of issues is that Prison fails to start up and load properly. The biggest symptom is that there are no active modules and most of the prison commands fail to work. + + +**Cause** + +This is caused by LuckPerms. More specifically, trying to use LuckPerms v5.0.x with Prison v3.2.0 or older. LuckPerms v5.0.x is not supported with older version of Prison. + + +**How to Resolve the Issues** + +There are two major ways to resolve this issue. + +1. Down grade to LuckPerms v4.4.1 for use with Prison v3.2.0 and older. + +2. Upgrade Prison to v3.2.1 (or the pre-release version of v3.2.1) or newer. Prison v3.2.1 supports both the newer LuckPerms v5.0.x and the older LuckPerms v4.4.1 and older. + +**Suggested action:** Upgrade Prison to v3.2.1 or newer and use the latest version of LuckPerms. + + +**Background** + +Basically the fault of this issues lies with LuckPerms in using the same registered +plugin name with the bukkit/Spigot Plugin Manager for v5.0.x. By using the same registered +plugin name and the same class name, but an altogether different package name, that broke +the standard way of using the plugin manager to get an instance of the plugin. This would +have caused any plugin to generate a Class Not Found exception. + +They shouldn't have used the same signatures for v5.0.x as they did with v4.x. +If they would have chosen a new signature, such as LuckPerms5, then there would have been no issues since the plugin manager would not falsely report that the old version of LuckPerms +is available and will not try to cast the new packages in to the old variables. + + +
diff --git a/docs/prison_docs_880_faq_misc_01.md b/docs/prison_docs_880_faq_misc_01.md new file mode 100644 index 000000000..fb729bf93 --- /dev/null +++ b/docs/prison_docs_880_faq_misc_01.md @@ -0,0 +1,107 @@ + + +### Prison Documentation +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## FAQ - Miscellaneous Questions + +This document covers some miscellaneous questions pertain to Prison in general. + +
+ +# Paper - Is it supported? + +**Quick Q & A:** Does it work? Yes it should work, but Paper is not supported. + +Although Paper servers are not officially supported, there is a strong interest in making sure Prison will work with Paper. Theoretically since Paper is a direct fork from Spigot, it should always be 100% compatible. So if issues are found with Paper, efforts will be made to fix those issues. + +The primary reason why paper servers are not directly supported has to do with the number of minecraft versions that are supported, and the number of test servers that requires to perform testing upon. By adding in paper as an officially supported platform, that would increase the complexities of testing. Therefore, buy not supporting paper directly, it simplifies the testing phase of development, but at the risk that there may be an ever slight chance of something not working correctly with paper. + +
+ + +# Configuring the Correct Currency Symbol for Prison + + +**Symptoms of Issues** + +The wrong currency symbol is used when showing monetary values. + + +**How to Resolve the Issues** + +Prison can use a standard national currency symbol. It cannot use a custom symbol +for a custom currency. +This FAQ explains how to change the national currency symbol. + + +The current prison plugin is using java internals to set the currency symbol. +As such, currencies within prison may show the wrong currency symbol. + +For example, in RankUpCommand it is using this reference: + + RankUtil.doubleToDollarString(result.rank.cost)); + +which is using this: + + public static String doubleToDollarString(double val) { + return NumberFormat.getCurrencyInstance().format(val); + } + + +If the currency that is shown is not what is configured on the server, +then you currently MUST change the java startup variables to set it +the language and location that you are needing to use. Otherwise +it will be pulling from the file system, which may not match your +in game settings. + + -Duser.language=en -Duser.country=US -Duser.variant=US + +In context the server startup may now look like this: + + java -Xms2g -Xmx8g -Duser.language=en -Duser.country=US -Duser.variant=US -jar spigot-1.13.2.jar + +In the future, Prison may need to switch this over to use either a language config in +a config file somewhere, or use what is defined, or set, within the +currency plugin, such as vault, or EssentialsX. + + +
+ + +# Information on Groupmanager and using it with Rank Commands + + +**Information provided by ChrisGames** + +**groupmanager** + +So what i was trying to do was do this command: + + manuaddp {player} essentials.warps.a + +manuaddp is for 1 specific player, then just the node for warping to a mine +when you give a rank or a specific player a permission you need to do + + /manselect [Worldname] + +To get it to work with the prison ranks you need to have it do manselect (world) before it does the other command. + +if the manuaddp command is higher in the config than the manselect (world) it will not work. + +. + +The commands, as ran from the console, for a player named *TestPlayer* in the world named *PrisonWorld*: + + manselect PrisonWorld + manuaddp TestPlayer essentials.warps.a + + +These are the same commands, but are in the format that is needed to be added to the Prison Rank commands for a rank named "a". Please note that the order in which these commands are entered are the way they will be ran upon rankup. + + ranks command add a manselect PrisonWorld + ranks command add a manuaddp {player} essentials.warps.a + + + +
diff --git a/gradle.properties b/gradle.properties index 636353e94..88361bce4 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,4 +1,9 @@ +## define the global gradle version: +## # This is actually the "correct" place to define the version for the project. +## # Used within build.gradle with ${project.version}. +## # Can be overridden on the command line: gradle -Pversion=3.2.1-alpha.3 +version=3.2.1-alpha.20 ## org.gradle.warning.mode=(all,none,summary) org.gradle.warning.mode=all diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 0d4a95168..5c2d1cf01 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index ae45383b6..0ebb3108e 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.3-all.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-all.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index cccdd3d51..8e25e6c19 100644 --- a/gradlew +++ b/gradlew @@ -1,5 +1,21 @@ #!/usr/bin/env sh +# +# Copyright 2015 the original author or authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + ############################################################################## ## ## Gradle start up script for UN*X @@ -28,7 +44,7 @@ APP_NAME="Gradle" APP_BASE_NAME=`basename "$0"` # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS="" +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' # Use the maximum available, or set MAX_FD != -1 to use that value. MAX_FD="maximum" diff --git a/gradlew.bat b/gradlew.bat index f9553162f..9618d8d96 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -1,3 +1,19 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + @if "%DEBUG%" == "" @echo off @rem ########################################################################## @rem @@ -14,7 +30,7 @@ set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS= +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" @rem Find java.exe if defined JAVA_HOME goto findJavaFromJavaHome diff --git a/knownissues_v3.2.x.md b/knownissues_v3.2.x.md new file mode 100644 index 000000000..7b22aff0a --- /dev/null +++ b/knownissues_v3.2.x.md @@ -0,0 +1,702 @@ +[Prison Documents - Table of Contents](docs/prison_docs_000_toc.md) + +# Prison Known Issues and To Do's for v3.2.x + +This document is intended to keep track of known issues and also provide for +a short list of To Do's. This list is intended to help work through known +issues, and/or to serve as items that should be added, or fixed. + + +# To Do Items - During Beta v3.2.1 + + +* **Rename Mines** +Been a few requests to be able to rename mines. Since so much can go wrong with manually changing the files, this should be a reasonable new feature added before beta. + + +* **New Block Model - Implement in parallel** +Implement and have a fully functional new block handling mechanism that operate in complete parallel to the old method. This way admins can turn it on when they want to use it, otherwise their server will continue to use the old code. + + 1. Done: Create core classes for new block types. String based so 100% flexible. Names based upon XMaterial enums so easy mapping to XMaterial then to system version dependency. + + 2. Done: Available blocks based upon XMateral and spigot version they are running. Create the initial list to be used for block searches. + + 3. Done: Needs Review: Disable MineData.getBlocks() and use that to write all the main parallel code. Reenable. + + 4. Disable BlockType and write parallel code. Reenable. + + 5. Hookup block search. + + + +* **Rework commands within the spigot module so all user facing commands are routed through Prison's Command Interface** + Blue should work on this. + + + + + + * **Problem with rank removal from Ladders** +Create a new rank to the default ladder. Add a player to it. Then remove the rank from the ladder. + +The ladder no longer contains the rank. But the player is still associated with the rank, but yet ranks cannot contain players if they are not on a ladder. The commands expect a valid ladder name. Also there does not appear to be any checks and balances when ranks are moved from one ladder to the other since ranks have no idea what ladder they are in. + +This could cause major corruption if moving ranks between ladders, removing ranks from a ladder, and players being associated with those ranks. + +Create a "void" ladder and prevent ladders from being named: default, void, and prestige. When a rank is removed from a ladder, place it in to none and update all players that use that rank so the rank is still valid. Do not include void ladders in placeholders. + + + +* **Update config.yml when changes are detected** +Preserving the current settings, replace the out of date config.yml file with the latest that is stored within the jar. Updating the settings as it goes. + + +* **Ladder commands - global for all ranks in that ladder** +Add new placeholders for ladder commands to be able to have generic ladder commands that will apply and be ran for all ranks. May be able to eliminate the need for most rank commands. + + +* **Rank Commands - Edit and delete** +Add line numbers and enable the ability to edit and delete by line number. + + + + +GABRYCAToday at 3:46 PM +3.2.1 -> Nothing to fix + +3.3.0 before -> +Bug: Bug fixes which will be reported by the user, if nothing will be reported in a month, then some of the next planned features will be integrated within this: +New: +- Add Ranks, Mines, Prestiges and RankupCommands presets +- Add a walktrough GUI and Command to set up Prison presets on first start in the server +-
Major tasks
+ + + +* **Integration in to WordEdit & WorldGuard** +Largest problem with providing a solution is that prison supports 1.8 through 1.17!! +WE and WG has a strict policy that they only support the current version of spigot/mc. They do not support older versions, but their older versions that worked with older versions still exists to be used. +The major problem is that you cannot run scripts from console since WG and WE require to know what world the actions are in, and they get that from the active player. +There is an API that can be used, but they warn that there are changes to the API from version to version, so it may not be possible to provide the same API calls from 1.8 through 1.17. Will not know until we try to use them? + +Just had this idea... What if for these main commands, for configuration purposes, the player would have to be in game. When they run these commands we TP the admin to the mines' spawn point, then run them through the console on behalf of that player? That way WE and WG could get the world from the on line player. But this will not work for mine resets... :( + + + + + +``` + Note: May be spread out over multiple releases. + 1. New Block handling if not fully apart of v3.2.1. + 2. New Multi-language support. + 3. New Wizard Configuration support. + A. Basic Prison functions. + B. Basic Mine behaviors + C. Basic Rank and Ladder behaviors + D. Basic prestige behaviors + 4.Creation of new scripting language for automation tied to wizards + A. When creating a mine perform scripted actions to configure each one + B. When creating a rank perform scripted actions to configure each rank + C. Create the permission group within the permission plugin selected + D. Add perms for that permission group, including warp support (prison/warps) + E. Auto generate rank commands to add and remove group perms from each rank +``` + +. + + +Higher Priority TO DO Items
+ + +* **Need to figure out how to better handle the Spigot commands that bypass the prison command interface** +They are inconsistent and non-standard to prison. They do not support the `help` keyword, nor do they show what perms they need. + + +* **Refactor GUI?** +Performance updates and validation to ensure computationally expensive processes are not running constantly. + + + +* **Possible Issue with delete Mine** +Delete a mine and try to add a new one right away with the same name. A user said it would not allow them, that the mine already exists. +* Tested on a few versions and could not reproduce. Keeping this entry here to retest in the near future. + + +To consider - Lower priority
+ + + +* **When creating a new mine, register that mine with the placeholders** +Might be easier to just reregister all mines? Not sure if that will work? +Right now, if a mine is added, in order for it to show up in the placeholders, you would have to restart the server so all the placeholders are reregistered. + * * maybe just automatically run reset when vital elements change? * * + + + +* **Add WorldGuard Support** +This is a work in progress. The biggest problem is that although older versions exist, they only support the latest version, and they have removed the older documentation and maven repositories. So access is highly limited to functional resources for performing builds. The current documentation identifies that major functional changes exist even between minor versions. So one API for v6.1 (supports mc 1.7 through 1.8 only) may not work WG v6.2.2 (supports only mc 1.12), and may not even be close to support v7.0.2 (supports 1.14 through 1.15). + +Not knowing what "range" of WorldGuard behaviors are supported through the API, or if they are even the same, the initial range of supported integrations for WorldGuard will be very limited until it can be fully tested to see where those limits are. + +List of features that could be nice to have, ordered from easiest to most difficult to implement, with the possibility of never being able to do any of these: + * Using prison's mine boundaries, set a WorldEdit selection to those same dimensions so the user does not have to reselect the same area. + * Using prison's mine boundaries, define, or resize, a given WorldGuard region. Using a Prison defined naming schema. + * If a prison is deleted, then remove the Prison's WorldGuard region. + * Auto define the WorldGuard global templates and permissions, then auto define, update, and remove all mine related regions as the mines are added, changed, or removed. * Detect if there is an out of sync situation between prison and worldGuard. + + +* **Get started on new Multi-Language Support** +This is put on hold for the v3.2.2 release. + + + +* **Upon startup validate all Blocks that are defined in the mines** + +Upon loading prison, validate that all blocks that are defined within each mine are actually valid for that version of minecraft. This will be important in that it may help eliminate possible errors when the server owner upgrades the server, or other plugins. Also it will be very helpful when Prison's block handling is enhanced since it will be a tool used to verify and maybe even fix incorrect block types. + + + +* **Add to the Command annotations an option of *async* to run that command asynchronously** +Check to see if the commands are being ran sync or async. Add a parameter support so +commands that can be ran async. + + +* **Add prison Placeholders to papi's website for downloads** +Prison is already using papi (PlaceholderAPI). But see if we can add prison to the supported +plugis for papi's cloud. Should time this with the v3.2.1 release so there are more +placeholder to use. + +DeadlyKill: This what he needs ita +Papi +Hook Plugin +They have those expansions which hook other plug-ins + +https://github.com/help-chat/PlaceholderAPI/wiki/Placeholders + + + +* **Improve some of the display pages for ranks and ladders*** +Can add more information to the listings so they have more value. + + +* **Tab Completion*** +Hook up tab completion on the prison commands. + + +* **Better logging of major events*** +Need to log major events such as rankups, both to the server log, and also +to the community. Server logs for these events, especially when money is +involved, is important. + + + + +* **Possible new feature: Track how many blocks a player mines, including types*** +Stats could be interesting over time, and could also be used for in game +bonuses and rewards and incentives. + + +* **Redesign the save files to eliminate the magic numbers*** +Most of the save files within prison, for players, ranks, and ladders, are +using magic numbers which is highly prone to errors and is considered +very dangerous. Also prison would benefit from a redesign in file layout +to improve efficiencies in loading and saving, not to mention greatly reduce +the complexities within the actual prison code, which in turn will help +eliminate possible bugs too and give tighter code. + + + +* **Notification that inventory is full*** +In progress! + + +* **Built in selling system*** + +* **Custom Mine reset messages per mine*** + + +* **Enhancement: Multi-Language Support*** + +Offers for translation: + Italian : Gabryca + Greek : NerdTastic + German: DeadlyKill ?? Did not ask, but a possibility? + French: LeBonnetRouge + Portuguese: 1Pedro ? + + +* **Auto-Config of other Prison Related Plugins*** + +GABRYCA: [Idea] + +Not sure if it's possible, but an hook with worldguard on mine making, like a region where the mine region's made automatically with basic permissions'd be neat + +RoyalBlueRanger: + +Gabryca... yes. I think a "clean" integration in to WorldGuard regions and WorldEdit selection tools would be a great improvement. I've been wanting to do this from day one actually. But I'm not 100% sure how much "automation" can be done here. + +I guess if the first thing you do when you activate prison, is to "confirm" that you want prison that you want to "link" prison to WorldGuard and your Permission plugin (assuming supported ones exist), then auto generate all of the "step" that are outlined in the document that I create on github for WorldGuard. That would really help everyone setup their basic servers. + +A lot of work there.... but it would be VERY beneficial for sure. It could be the foundation of an automated setup where prison "proactively" works with other plugins to help build and configure the server. + +Areas of possibilities in "Auto-Configure Prison Environment": + * WorldGuard - Regions for mines + * WorldEdit - Selection tools + * LuckPerms - Perms + * EssentialsX - Warps tied to mine warps + * QuickSell - Place a [Sell All} sign at the mine warp + * Citizens - NPC generated to replace the QuckSell Sign + * CitizensCMD - Links the Citizen NPC to the QuickSell "tiered" pricing (requires Citizens) + +I think those few integrations could really provide a huge bootstrap to getting the basics of a prison server up and running. + + + +# Features recently added: + + + +* **Done: Prestige references** +Add the prestige command to the /prison version page; rework the commands layout. +Add the documentation for prestige. Gabryca provided the base docs. + + +* **Done: Prestige Fixes** +The existing prestige command is GUI only. That may be an issue with 1.8.x. When testing, it appears to work, but may need an non-gui way to rank up. + +The /prestige command does not show the cost. The cost must be shown, along with a warning that the player's balance will be set to zero. + +Since the player loses their balance, which may be far more than what the prestige may cost, there really must be a confirmation added confirming the cost, and the player's balance. It should also identify that the excess amount of money the player will lose. + +Must change the cancel button lore. It's grammatically incorrect with a double negative. Should only be: "Cancel Prestige". Likewise the confirmation button should just be "Confirm Prestige" since the colon is grammatically ambiguous. + + + +**Done! Parameterize Sort order for /mines list.** +Default sort order should probably be alphabetical. +Currently it is alphabetical with most active mines since restart at the top of the list, based upon blocks mined. + + + +* **Done!! Add GUI support for v1.8.x** + Might be able to add GUI support for 1.8.x with a few simple lines of code? + + + +* **Done: Autosell feature** +Be able to allow the players to toggle it on or off. Will not sell what is in inventory, but only the blocks that they are mining. Use /autosell . +What would be nice is if you could look up all permissions that start with prison.sellall.1.05 where the number at the end is the multiplier. So you setup the multiplier based upon permissions and no other configs. Then take all the multipliers and multiply them together. So if they have a 1.05 (donor), 1.03 (special limited time), 0.97 (prestige penalty... more difficult the higher you go) would have a total of 1.049. So basically different ranks, or even different tools could increase or decrease payout. + + + + +* **FIXED: BUG? Able to add more than 100% in one mine?** +User reported having three copies of everything which totaled more than 300%. +Used the /mines block add function? + + + +* **DONE: Add player names to the player file** + Have no idea who is who in the player files. + Make it an array of a new object, player name that has name and timestamp. + When the file is loaded and the player is online, check name, and if not recorded, then add it. + + + +* **DONE: Add permissions on notifications for mine resets ** +Only send a message to the player if they have the permission set, and follow the other notification settings too. +Add permission `mines.notification.[mineName]` and have each mine have a boolean field to indicate that it should check for permissions on the players prior to sending the message. + + +* **DONE: Broadcast all rankups** +Option to disable it in config settings. + + + +* **DONE: Placeholders - Reregister** +Add a new command `/prison placeholders reload` that will reregister all placeholders. I don't think there is a clean way to unload the registrations, but just going through registration may be good enough. Deleted, or obsolete, placeholders may still be registered, but at least the new ones will get registered too. + + +* **DONE: Placeholders - Add placeholder counts to startup** +Counts on how many placeholders are generate and registered. + + +* **DONE: Placeholders - Add new placeholders** +prison_rankup_cost_remaining +Such that `prison_mines_*_minename` will also be mapped to `prison_mines_*_player` and will only report the values when a player is in a mine. +I think that will be super cool, since you could put some current mine stats in your placeholder such as `prison_mines_timeleft_formatted_player` `prison_mines_remaining_player` and even `prison_mines_player_count_player`. + +NOTE this was added: the new ones are playermines and there are a total of 24 new ones. Will work great with scoreboards. + + + + + * **Not an issue: Prison Wand breaks blocks** + Should probably monitor block break events and cancel breakage with wand. + This was caused by a conflict with a scoreboard plugin that advertised as supporting 1.16.2, but broke a few different plugins. + + + +* **DONE! Complete the new Mines Reset Paging** + Holding up release v3.2.1. + + +* **DONE: Enhance AutoManager** +Make auto manager more like vanilla on the drops and support silking. Try to make more consistent between versions. +This is a lot closer to the vanilla. May need to revisit in the future to enhance even more. + + +* **DONE: Add permissions to the AutoManger*** +Add permission checking to AutoManager to allow a per-mine selection of which mines to enable it in or to tie it to some rank or donor rank. Could also put lore checking in place so tools could be enchanted to perform these functions too. Could have it so there is a percent chance related to the permission or lore. + + +* **DONE: Prestige and Rebirth** + + + +* **Already Exists: Update the Prison command handlers to support help context** +-= Note I was unaware if you use the command `help` as the only parameter it shows the help =- +This would show the parameter details for the commands. Right now the annotations that defines the command parameters has descriptions for the command and the parameters, but they are not displayed anywhere useful. + + + +* **DONE: Add support for player use of /mines tp** + +Could be done through other perms and then checking to see if they have access t + +that mine. Perm: mines.tp (all mines) or mines.tp.An instance of Prison can be retrieved using the static * {@link Prison#get()} method, however in order to use the core libraries, you must call @@ -48,19 +49,34 @@ * @author Faizaan A. Datoo * @since API 1.0 */ -public class Prison implements PluginEntity { - +public class Prison + implements PluginEntity { + + /** + *
This is not exactly a Prison module, but it's name is used within + * the LocaleManager to correct the generation of an incorrect directory + * path for the locale language files for this "core" module. Basically + * this provides consistency in the location of all language files that + * the admins can easily edit and know where to find them. + *
+ * + */ + public static final String PSEDUO_MODLE_NAME = "core"; + public static final int SPIGOTMC_ORG_PROJECT_ID = 1223; //72740; // Singleton public static final int API_LEVEL = 3; private static Prison instance = null; + + private String minecraftVersion; // Fields private Platform platform; private File dataFolder; private ModuleManager moduleManager; + private PrisonCommand prisonCommands; private CommandHandler commandHandler; private SelectionManager selectionManager; private EventBus eventBus; @@ -92,50 +108,69 @@ public static Prison get() { *
* Note that modules should not call this method. This is solely for the implementations.
*/
- public boolean init(Platform platform) {
+ public boolean init(Platform platform, String minecraftVersion) {
long startTime = System.currentTimeMillis();
this.platform = platform;
+ this.minecraftVersion = minecraftVersion;
+
sendBanner();
- Output.get().logInfo("Enable start...");
+ Output.get().logInfo("Enabling and starting...");
// Initialize various parts of the API. The magic happens here :)
if (!initDataFolder()) {
+ Output.get().logInfo("&cFailure: &eInitializing the Prison Data Folders!" );
+ Output.get().logInfo("&e&k!=&d Prison Plugin Terminated! &e&k=!&7" );
return false;
}
initManagers();
if (!initMetaDatabase()) {
+ Output.get().logInfo("&cFailure: &eInitializing the Prison Database!" );
+ Output.get().logInfo("&e&k!=&d Prison Plugin Terminated! &e&k=!&7" );
return false;
}
Alerts.getInstance(); // init alerts
- this.commandHandler.registerCommands(new PrisonCommand());
+ this.prisonCommands = new PrisonCommand();
+ this.commandHandler.registerCommands(prisonCommands);
+ long stopTime = System.currentTimeMillis();
+
Output.get()
.logInfo("Enabled &3Prison v%s in %d milliseconds.", getPlatform().getPluginVersion(),
- (System.currentTimeMillis() - startTime));
+ (stopTime - startTime));
registerInbuiltTroubleshooters();
if (getPlatform().shouldShowAlerts())
scheduleAlertNagger();
-
+
+
+ // Disabled for now. The integrations cannot properly support this yet.
+// List This class contains the data that is used to log the plugins, commands, and their aliases,
+ * that may be setup on the server. This is setting the ground work to store the command
+ * data that can be used to trouble shoot complex problems, such as conflicts, that are
+ * occuring with the prison plugin.
+ * This is just the data, and does not interact, or modify, any of the other commands.
+ * Gets a player by name. If the player is not online, then try to get them from
+ * the offline player list. If not one is found, then return a null.
+ * This command does not do anything, except to provide a command placeholder to
+ * make owners aware that there is auto features enabled within prison.
+ * Running this command will show the permissions needed to use these auto features.
+ * Cannot use the @Command altPermissions parameter since the permissions can be
+ * dynamically altered to fit the needs of the owner's server. Using the command
+ * altPermissions will also require a server restart to reflect any online changes,
+ * not to mention a recompile since the end users cannot make these changes.
+ * Get a String message from the FileConfiguration, and if the key
+ * does not exist, return the default value associated with the enum
+ * entry, if it does not exist, then it returns a blank string value.
+ *
+ *
+ * @param conf
+ * @return
+ */
+ public String getMessage( Map Get's the boolean value from the FileConfiguration, and if the key
+ * does not exist, then it returns the default value associated with the
+ * enum entry, if it does not exist, then it returns false.
+ * @param conf
+ * @return
+ */
+ public boolean getBoolean( Map Get the children nodes to the given item.
+ * Get the children for the specified node.
+ * This updates AutoFeatures with a String value.
+ * This updates AutoFeatures with a boolean value.
+ * This function attempts to save the AutoFeatures configurations to the
+ * file system. This function uses a temporary file to initially perform the save,
+ * then when it is successfully finished, it then deletes the original file, and
+ * renames the temp file to the correct file name. This swapping of files
+ * will prevent the loss of configuration data if something should go wrong in the
+ * initial saving of the data since the original file will not be deleted first.
+ * This function loads a yaml file based upon the AutoFeatures enumeration.
+ * It loads the proper ValueNode based upon the defined value within the
+ * enum. If there is a property that does not exist within the yaml file,
+ * it will add it to the config object with the default value, plus it will
+ * return a list of all features that do not exist (dne). If any new settings
+ * are added to the configuration uploading (ie. new features), then it will
+ * trigger a save to update the file so the new features will exist in there.
+ * This way, if the dne List is not empty, then it needs to be saved to
+ * update what is saved on the file system. Only the new items, with the
+ * default values, will be added; the original values will not be altered.
+ * This is a way for an integration to provide additional information when the
+ * integration is displayed through the /prison version command. This may vary
+ * from integration to integration, or by type. It is perfectly valid for it
+ * to return a null value, which indicates there is nothing available, so ignore
+ * this.
+ * To help admins setup integrations, this is the URL that is generally associated
+ * with the integration. It should usually refer to the spigotmc.org website for
+ * that resource.
+ * This class provides for most of the default implementations for the
+ * Integration interface, and sets up some of the expected core behaviors.
+ * The given place holders should have both the prison prefix and without,
+ * with the without having the suppress value set. The suppressable items
+ * will not always be displayed since it would be implied that the prefix
+ * would have been provided.
+ * Update: The placeholders without the prison prefix have been eliminated
+ * since the prefix is now prepended when it is missing prior to matching to a
+ * valid placeholder enum. This cuts the number of generated placeholders in half.
+ * This is significant since with the addition of the aliases there would be about
+ * 744 placeholders generated if the prison had 30 mines setup! Now a 30 mine prison
+ * would have about 372.
+ * Note: In order to use these placeholders with something like holographic display
+ * you need to also include the placeholderAPI,
+ * plugin holographic extension and protocolib.
+ * In order to get the holographics extension to work it is critical you read
+ * their spigot page since you have to specify a refresh speed.
+ * This function uses the settings within the config.yml to construct a progress
+ * bar. It takes two numeric values and constructs it upon those parameters.
+ * The parameter The lowest range is always zero and If the progress bar is moving in the wrong direction, then set the parameter
+ * Bukkit.getPluginManager().isPluginEnabled(). If the
+ * the given integration has not been registered, then it could be dangerous tying to
+ * access the class files associated with that plugin since it could result in
+ * class not found exceptions, or similar. Some plugins may have the same identifier,
+ * but yet different internal classes depending upon their versions, such as LuckPerms,
+ * so additional code must be used to verify what is actually loaded. Of course there
+ * are always exceptions to the rules too.
+ *
+ * @return true if the requested plugin has been registered with the server engine
+ */
+ public boolean isRegistered();
+
+ /**
+ * Used to identify if the integration (plugin) has been registered with the server
+ * engine.
+ *
+ * @param registered
+ */
+ public void setRegistered( boolean registered );
+
+ /**
* Returns the type of integration that this class provides.
*
* @return The {@link IntegrationType}.
*/
- IntegrationType getType();
+ public IntegrationType getType();
/**
- * Returns the name of the third-party plugin that this class is integrating with.
+ * Returns true if this class has integrated with the provider successfully, or false
+ * otherwise. This should also return false if the third-party plugin which this
+ * integration is built for is not present. This is not the same as isRegistered,
+ * since a few integrations may have different class files backing it (such as LuckPerms).
*
- * @return The name of the provider.
+ * @return true if this class has integrated successfully, false otherwise.
+ */
+ public boolean hasIntegrated();
+
+
+ /**
+ * The function that is called to perform the integration. Generally the check is done
+ * prior to calling this function, but may vary. The attempt at integration used to be
+ * performed in the constructor, but but that prevents storing the failed integrations
+ * which can then be used to inform the admins what's available. If the integration
+ * was successful, then hasIntegrated() will return a value of true.
+ */
+ public void integrate();
+
+ /**
+ * Returns the name of the internal representation that should be used for this integrator.
+ * It may not always be the same as providerName, but in most circumstances it will be.
+ * It's important that this keyName should be unique from any other integration keyName.
+ * For example, since there are two major kinds of LuckPerms that are supported,
+ * these should reflect which one is which. This field is used internally within
+ * collections and for display purposes when listing integrations so it should be
+ * more descriptive than the providerName.
*/
- String getProviderName();
+ public String getKeyName();
/**
- * Returns true if this class has integrated with the provider successfully, or false otherwise.
- * This should also return false if the third-party plugin which this integration is built for is not present.
+ * Returns the name of the third-party plugin that this class is integrating with. This
+ * must be exactly what is provided in the plugin's plugin.yml file that
+ * is within the given jar files for the field called name:.
*
- * @return true if this class has integrated successfully, false otherwise.
+ * @return The name of the provider.
*/
- boolean hasIntegrated();
-
+ public String getProviderName();
+
+ /**
+ * The displayName is the value that is actually used when listing all the integrations.
+ * In general it is the combination of both the providerName and the keyName, but
+ * different integrations could customize it to better suite their unique requirements,
+ * such as with Vault.
+ *
+ * @return
+ */
+ public String getDisplayName();
+
+ /**
+ *
+ * /hd addline temp2 Mine Size: {slowest}{prison_mines_blocks_size_temp2}
+ * or
+ * /hd addline temp2 Mine Size: {slowest}{prison_mines_blocks_size_temp2}
+ * /hd addline temp2 Mine Size: {slowest}%prison_mines_blocks_size_temp2%
+ *
+ *
+ * https://dev.bukkit.org/projects/holographic-displays
+ * https://www.spigotmc.org/resources/placeholderapi.6245/
+ * https://www.spigotmc.org/resources/protocollib.1997/
+ * https://www.spigotmc.org/resources/holographicextension.18461/
+ */
+ public enum PrisonPlaceHolders {
+
+ no_match__(PlaceHolderFlags.SUPRESS),
+
+ // Rank aliases:
+ prison_r(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+ prison_rt(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+ prison_rc(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+ prison_rcp(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+ prison_rcb(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+ prison_rcr(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+ prison_rr(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+ prison_rrt(PlaceHolderFlags.PLAYER, PlaceHolderFlags.ALIAS),
+
+
+ prison_rank(prison_r, PlaceHolderFlags.PLAYER),
+ prison_rank_tag(prison_rt, PlaceHolderFlags.PLAYER),
+ prison_rankup_cost(prison_rc, PlaceHolderFlags.PLAYER),
+ prison_rankup_cost_percent(prison_rcp, PlaceHolderFlags.PLAYER),
+ prison_rankup_cost_bar(prison_rcb, PlaceHolderFlags.PLAYER),
+ prison_rankup_cost_remaining(prison_rcr, PlaceHolderFlags.PLAYER),
+ prison_rankup_rank(prison_rr, PlaceHolderFlags.PLAYER),
+ prison_rankup_rank_tag(prison_rrt, PlaceHolderFlags.PLAYER),
+
+
+ // Ladder aliases:
+ prison_r_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+ prison_rt_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+ prison_rc_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+ prison_rcp_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+ prison_rcb_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+ prison_rcr_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+ prison_rr_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+ prison_rrt_laddername(PlaceHolderFlags.LADDERS, PlaceHolderFlags.ALIAS),
+
+
+ prison_rank_laddername(prison_r_laddername, PlaceHolderFlags.LADDERS),
+ prison_rank_tag_laddername(prison_rt_laddername, PlaceHolderFlags.LADDERS),
+ prison_rankup_cost_laddername(prison_rc_laddername, PlaceHolderFlags.LADDERS),
+ prison_rankup_cost_percent_laddername(prison_rcp_laddername, PlaceHolderFlags.LADDERS),
+ prison_rankup_cost_bar_laddername(prison_rcb_laddername, PlaceHolderFlags.LADDERS),
+ prison_rankup_cost_remaining_laddername(prison_rcr_laddername, PlaceHolderFlags.LADDERS),
+ prison_rankup_rank_laddername(prison_rr_laddername, PlaceHolderFlags.LADDERS),
+ prison_rankup_rank_tag_laddername(prison_rrt_laddername, PlaceHolderFlags.LADDERS),
+
+
+ // Mine aliases:
+ prison_mi_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mif_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mtl_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mtlb_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mtlf_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_ms_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mr_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mrb_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mp_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mpc_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mbm_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+ prison_mrc_minename(PlaceHolderFlags.MINES, PlaceHolderFlags.ALIAS),
+
+
+ // reset_interval, reset_timeleft, blocks_size, blocks_remaining, blocks_percent
+ // player_count
+ // NOTE: Remove PrisonPlaceHolderFlags.SUPRESS when ready to be used:
+ prison_mines_interval_minename(prison_mi_minename, PlaceHolderFlags.MINES),
+ prison_mines_interval_formatted_minename(prison_mif_minename, PlaceHolderFlags.MINES),
+ prison_mines_timeleft_minename(prison_mtl_minename, PlaceHolderFlags.MINES),
+ prison_mines_timeleft_bar_minename(prison_mtlb_minename, PlaceHolderFlags.MINES),
+ prison_mines_timeleft_formatted_minename(prison_mtlf_minename, PlaceHolderFlags.MINES),
+ prison_mines_size_minename(prison_ms_minename, PlaceHolderFlags.MINES),
+ prison_mines_remaining_minename(prison_mr_minename, PlaceHolderFlags.MINES),
+ prison_mines_remaining_bar_minename(prison_mrb_minename, PlaceHolderFlags.MINES),
+ prison_mines_percent_minename(prison_mp_minename, PlaceHolderFlags.MINES),
+ prison_mines_player_count_minename(prison_mpc_minename, PlaceHolderFlags.MINES),
+ prison_mines_blocks_mined_minename(prison_mbm_minename, PlaceHolderFlags.MINES),
+ prison_mines_reset_count_minename(prison_mrc_minename, PlaceHolderFlags.MINES),
+
+
+
+ // PlayerMine aliases:
+ prison_mi_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mif_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mtl_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mtlb_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mtlf_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_ms_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mr_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mrb_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mp_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mpc_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mbm_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+ prison_mrc_pm(PlaceHolderFlags.PLAYERMINES, PlaceHolderFlags.ALIAS),
+
+
+ prison_mines_interval_playermines(prison_mi_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_interval_formatted_playermines(prison_mif_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_timeleft_playermines(prison_mtl_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_timeleft_bar_playermines(prison_mtlb_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_timeleft_formatted_playermines(prison_mtlf_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_size_playermines(prison_ms_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_remaining_playermines(prison_mr_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_remaining_bar_playermines(prison_mrb_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_percent_playermines(prison_mp_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_player_count_playermines(prison_mpc_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_blocks_mined_playermines(prison_mbm_pm, PlaceHolderFlags.PLAYERMINES),
+ prison_mines_reset_count_playermines(prison_mrc_pm, PlaceHolderFlags.PLAYERMINES),
+
+
+
+ ;
+
+
+ private final PrisonPlaceHolders alias;
+ private final Listvalue
is the value that changes, and is the value that
+ * sets where the bar changes. The parameter valueTotal
is the max value
+ * of where the value
is increasing to.
+ * value
will be set to zero if
+ * it is negative. If value
is greater than valueTotal
+ * then it will be set to that value. The valid range for this function is only 0 percent
+ * to 100 percent.
+ * reverse
to true and then the value
will be inverted by subtracting
+ * its value from valueTotal
.
+ *
This function formats all the Integrations, both active and inactive, to be displayed + * to a user, or sent to the server logs. This function returns a List to provide a + * degree of flexibility in where it is being used, without this container + * (The integration manager) having to know where the data will be used. This function + * keeps the business logic of relationship of integrations to Integration Types + * internal so as to no leak that knowledge out of this function. + *
+ * + * @return + */ + public ListWorldGuard Integration is needed because there are two major versions of + * WorldGuard and WorldEdit that needs to be supported. This is required due + * to the wide range of spigot versions that are supported. + *
+ * + *The two different versions WorldGuard, and WorldEdit, may have different + * command sets and parameters, not to mention different class names and + * possibly different package names too. So these integrations are to + * provide a common interface in to any platform, and any version. Hopefully! lol + *
+ * + *Version 6.x is for minecraft versions 1.12.2 and below.
+ * + *Version 7.x is for minecraft versions 1.13.0 and up. + *
+ * + *It is stated that minecraft implementations for spigot have significant + * changes from one version to the next, so one version of WorldEdit and + * WorldGuard may not support any of the older versions. Due to these restrictions + * and warnings, carefully make sure you download the version of WorldGuard and + * WorldEdit that matches the server you are running. All v6.x are not the same, nor + * are all v7.x the same. The best we can do is to make sure you are using the + * correct major version for the version of minecraft that you are running on + * your server; the correct minor version is on you to get correct. + *
+ * + */ +public class WorldGuardIntegration + extends IntegrationCore { + + private boolean integrated = false; + + public WorldGuardIntegration( String keyName, String providerName ) { + super( keyName, providerName, IntegrationType.WORLDGUARD ); + } + + public boolean isIntegrated() { + return integrated; + } + public void setIntegrated( boolean integrated ) { + this.integrated = integrated; + } + + +} diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/CommandSender.java b/prison-core/src/main/java/tech/mcprison/prison/internal/CommandSender.java index 8e88a7142..4f4b3af36 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/CommandSender.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/CommandSender.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -73,5 +73,8 @@ public interface CommandSender { * @param json The JSON message. Must be in proper format. */ void sendRaw(String json); + + + public boolean isOp(); } diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/ItemStack.java b/prison-core/src/main/java/tech/mcprison/prison/internal/ItemStack.java index 22e33680c..a4c5d9ee5 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/ItemStack.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/ItemStack.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/OfflineMcPlayer.java b/prison-core/src/main/java/tech/mcprison/prison/internal/OfflineMcPlayer.java new file mode 100644 index 000000000..6f99e3da0 --- /dev/null +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/OfflineMcPlayer.java @@ -0,0 +1,29 @@ +package tech.mcprison.prison.internal; + +import java.util.UUID; + +public interface OfflineMcPlayer + extends Player { + /** + * Returns the unique identifier for this player. + */ + UUID getUUID(); + + /** + * Returns the player's display name (nickname), which may include colors. + */ + String getDisplayName(); + + /** + * Sets the player's display name (nickname). + * + * @param newDisplayName The new display name. May include colors, amp-prefixed. + */ + void setDisplayName(String newDisplayName); + + /** + * @return Returns true if the player is online, false otherwise. + */ + boolean isOnline(); + +} diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/Player.java b/prison-core/src/main/java/tech/mcprison/prison/internal/Player.java index c359145be..75a3afcf6 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/Player.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/Player.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/Scheduler.java b/prison-core/src/main/java/tech/mcprison/prison/internal/Scheduler.java index 5bffb46fe..7eea4e1c3 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/Scheduler.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/Scheduler.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/World.java b/prison-core/src/main/java/tech/mcprison/prison/internal/World.java index 74ab75a12..9921126e7 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/World.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/World.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -18,11 +18,11 @@ package tech.mcprison.prison.internal; +import java.util.List; + import tech.mcprison.prison.internal.block.Block; import tech.mcprison.prison.util.Location; -import java.util.List; - /** * Represents a world on the Minecraft server. * @@ -36,7 +36,7 @@ public interface World { */ String getName(); - /** + /**O * Returns a list of all the players in this world. */ ListThis class embodies the nature of the block and different behaviors, if + * they exist. + *
+ * + */ +public class PrisonBlock { + private String blockName; + + private double chance; + + private boolean valid = true; + private boolean mineable = true; + + private boolean legacyBlock = false; + + public PrisonBlock( String blockName ) { + this( blockName, 0); + } + + public PrisonBlock( String blockName, double chance ) { + super(); + + this.blockName = blockName; + this.chance = chance; + } + + public String getBlockName() { + return blockName; + } + public void setBlockName( String blockName ) { + this.blockName = blockName; + } + + public double getChance() { + return chance; + } + public void setChance( double chance ) { + this.chance = chance; + } + + public boolean isValid() { + return valid; + } + public void setValid( boolean valid ) { + this.valid = valid; + } + + public boolean isMineable() { + return mineable; + } + public void setMineable( boolean mineable ){ + this.mineable = mineable; + } + + /** + *This value isLegacyBlock indicates that there was not a direct match + * with the stored (saved) name of the block, and list of valid block types + * for the server. In order to find a successful match, had to use the + * obsolete BlockType to make a connection to the valid block types. + *
+ * + *If this value is set to true, it only has a purpose during the loading + * of the mine when the server is starting up. If it is set to true, then it + * indicates that the block name that was saved to disk is not directly translatable + * to a valid block type, and therefore once the mine is loaded, if any of the + * blocks have this set, then the mine must be saved to store the + * correct block name. The next time it is loaded, it will not have to + * fall back to the legacy BlockType for a conversion. + *
+ * + * @return + */ + public boolean isLegacyBlock() { + return legacyBlock; + } + public void setLegacyBlock( boolean legacyBlock ) { + this.legacyBlock = legacyBlock; + } + +} diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/block/PrisonBlockTypes.java b/prison-core/src/main/java/tech/mcprison/prison/internal/block/PrisonBlockTypes.java new file mode 100644 index 000000000..3bcf90bbf --- /dev/null +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/block/PrisonBlockTypes.java @@ -0,0 +1,56 @@ +package tech.mcprison.prison.internal.block; + +import java.util.ArrayList; +import java.util.List; + +import tech.mcprison.prison.Prison; + +/** + *This class is a new way of dealing with blocks within prison. + * All blocks will be stored and used as string values. + *
+ * + */ +public class PrisonBlockTypes { + + private ListThis event monitors the loading of worlds. During the loading of mines, not + * all worlds may be loaded yet, so we need to monitor when they come online + * so we can hook them up to the mines. + *
+ * + *At this point in time, all we need to know is the world name when it loads. + * All other uses of the world can go through the standard procedures since + * it will then be fully loaded. The key is knowing when the world is avialble + * for use. + *
+ * + */ +public class PrisonWorldLoadEvent { + + private String worldName; + + public PrisonWorldLoadEvent(String worldName) { + super(); + + this.worldName = worldName; + } + + public String getWorldName() { + return worldName; + } + public void setWorldName( String worldName ) { + this.worldName = worldName; + } + +} diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/AnvilInventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/AnvilInventory.java index 297491411..8610602c5 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/AnvilInventory.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/AnvilInventory.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BeaconInventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BeaconInventory.java index 07e86ed21..5367e2be2 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BeaconInventory.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BeaconInventory.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BrewerInventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BrewerInventory.java index 1ad58b063..9d601a0d4 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BrewerInventory.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/BrewerInventory.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/CraftingInventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/CraftingInventory.java index 9012f4ebb..3cb8b8cc2 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/CraftingInventory.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/CraftingInventory.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/DoubleChestInventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/DoubleChestInventory.java index 51ebfaa8b..33478166d 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/DoubleChestInventory.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/DoubleChestInventory.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/EnchantingInventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/EnchantingInventory.java index 0d69cd9ec..8cc72e4eb 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/EnchantingInventory.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/EnchantingInventory.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/FurnaceRecipe.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/FurnaceRecipe.java index 5402875d5..d38fd8adb 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/FurnaceRecipe.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/FurnaceRecipe.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Inventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Inventory.java index 9d9003806..1aa117814 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Inventory.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Inventory.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryHolder.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryHolder.java index 41b3f572b..16e40a61a 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryHolder.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryHolder.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryType.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryType.java index 48dcbb6c1..d1bc54828 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryType.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/InventoryType.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/PlayerInventory.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/PlayerInventory.java index ec97c31a1..723b4b11d 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/PlayerInventory.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/PlayerInventory.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Recipe.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Recipe.java index e894aeab5..734c550ce 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Recipe.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Recipe.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapedRecipe.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapedRecipe.java index 045471a71..73cee8c90 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapedRecipe.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapedRecipe.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapelessRecipe.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapelessRecipe.java index 147daf2af..883aed4f2 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapelessRecipe.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/ShapelessRecipe.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Viewable.java b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Viewable.java index 958df5498..759268132 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Viewable.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/inventory/Viewable.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/internal/package-info.java index bcddaa1a7..479705078 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/package-info.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/package-info.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Capability.java b/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Capability.java index bd8c6013e..bbf871610 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Capability.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Capability.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/platform/IncapableException.java b/prison-core/src/main/java/tech/mcprison/prison/internal/platform/IncapableException.java index e7d04b9df..c29b09285 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/platform/IncapableException.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/platform/IncapableException.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -25,8 +25,9 @@ * @since API 1.0 */ public class IncapableException extends RuntimeException { - - private Capability capability; + private static final long serialVersionUID = 1L; + + private Capability capability; public IncapableException(Capability capability) { this.capability = capability; diff --git a/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Platform.java b/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Platform.java index f4a60b486..4a4b8f4b7 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Platform.java +++ b/prison-core/src/main/java/tech/mcprison/prison/internal/platform/Platform.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -18,21 +18,26 @@ package tech.mcprison.prison.internal.platform; +import java.io.File; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.UUID; + import tech.mcprison.prison.commands.PluginCommand; +import tech.mcprison.prison.file.YamlFileIO; import tech.mcprison.prison.gui.GUI; +import tech.mcprison.prison.integration.Placeholders; +import tech.mcprison.prison.internal.CommandSender; import tech.mcprison.prison.internal.Player; import tech.mcprison.prison.internal.Scheduler; import tech.mcprison.prison.internal.World; +import tech.mcprison.prison.internal.block.PrisonBlock; import tech.mcprison.prison.internal.scoreboard.ScoreboardManager; +import tech.mcprison.prison.output.ChatDisplay; import tech.mcprison.prison.store.Storage; import tech.mcprison.prison.util.Location; -import java.io.File; -import java.util.List; -import java.util.Map; -import java.util.Optional; -import java.util.UUID; - /** * Represents an internal platform that Prison has been implemented for. * The internal platform is responsible for connecting Prison's APIs to the underlying server API. @@ -48,6 +53,18 @@ public interface Platform { */ OptionalThis function allows the PrisonCommand to get a list of any possible world + * load failures. + *
+ * + * @param display + * @return + */ + public void getWorldLoadErrors( ChatDisplay display ); + + /** * Returns the player with the specified name. */ @@ -63,6 +80,12 @@ public interface Platform { */ ListThis class uses Jackson's YAML databind tools to + * read and write to yaml configuration files. + *
+ * + *What makes this different, is that the yaml is built + * upon a hierarchy, but when loaded, it must be flattened + * using dot notation to represent the levels within the + * key. + *
+ * + *Since values of the various properties can have + * different types, internally the Jackson's ValueNode object + * is used since it is extended to contain various kinds of + * values. See list: + *
+ * + *Possible ValueNodes values: + *
+ *-
+ *
- com.fasterxml.jackson.databind.node.ValueNode + *
- com.fasterxml.jackson.databind.node.BooleanNode + *
- com.fasterxml.jackson.databind.node.TextNode + *
- com.fasterxml.jackson.databind.node.IntNode + *
- com.fasterxml.jackson.databind.node.DoubleNode + *
Collections based nodes that extend from ValueNode: + *
+ *-
+ *
- com.fasterxml.jackson.databind.node.ArrayNode + *
- com.fasterxml.jackson.databind.node.ObjectNode (a Map) + *
This function will read a yaml file, which loads as a hierarchical +// * map. Then it will flatten the hierarchical map and return it. +// *
+// * +// * +// * @param file +// */ +// public MapThis function will write a flat map to a yaml file after it +// * expands it to an hierarchical map, expanding the key values on +// * their periods. +// *
+// * +// * @param file Target file to save to +// * @param map A flat map of all the configs +// */ +// public void writeYamlConfigFile( File file, MapThis takes a flat map and expands the keys, breaking on the periods, +// * and builds a multi-level hierarchy. +// *
+// * +// * @param map Flat map +// * @return Hierarchical map +// */ +// private MapThe Prison core is not truly a Prison module, so the targetPath that is passed to this function + * is not correctly setup to place the core/lang directory in the correct place. It will try + * to put it in /plugins/Prison/lang which is wrong. This function detects this error and + * will regenerate the targetPath to be /plugins/Prison/module_conf/core/lang. + *
+ * + *Note: There is a unit test that is ran by the gradle build process that hits this + * function. At the time, the value of PrisonAPI.getModuleManager() is null due to the unit test, + * therefore the following function is using static functions to ensure there is not a + * null pointer exception thrown. The unit test does not do anything with the content of + * these directories, but it still hits these functions, so allowing it to proceed, even if the + * paths are incorrect, will have no impact on anything. + *
+ * + * @param targetPath + * @return The corrected targetPath for the core plugin + */ + private File fixPrisonCoreLanguagePath( File targetPath ) { + if ( !targetPath.getAbsolutePath().startsWith( + ModuleManager.getModuleRootDefault().getAbsolutePath() ) ) { + targetPath = Module.setupDataFolder( Prison.PSEDUO_MODLE_NAME ); + } + return targetPath; + } + + private void extractShippedLocales( File targetPath ) { + + targetPath = fixPrisonCoreLanguagePath( targetPath ); + + CodeSource cs = getOwningPlugin().getClass().getProtectionDomain().getCodeSource(); + if (cs != null) { + try { + URL jar = cs.getLocation(); + ZipInputStream zip = new ZipInputStream(jar.openStream()); + ZipEntry entry; + while ((entry = zip.getNextEntry()) != null) { + String entryName = entry.getName(); + + if (entryName.startsWith(internalPath) && entryName.endsWith(".properties")) { + + String[] arr = entryName.split("/"); + String localeName = arr[arr.length - 1]; + + File newLocal = new File( targetPath, localeName ); + + BufferedInputStream inStream = new BufferedInputStream( zip ); + try ( + OutputStream outStream = Files.newOutputStream( newLocal.toPath(), + StandardOpenOption.CREATE_NEW, StandardOpenOption.WRITE ); + ) { + copyStreams( inStream, outStream) ; + } + } + + } + } catch (IOException ex) { + throw new RuntimeException( + "Failed to initialize LocaleManager for plugin " + getOwningPlugin() + + " - Prison cannot continue to load.", ex); + } + } else { + throw new RuntimeException("LocalManager.extractShippedLocales(): " + + "Failed to load code source for plugin " + getOwningPlugin() + + " - Prison cannot continue to load."); + } + + } + + private void copyStreams(InputStream inStream, OutputStream outStream) + throws IOException { + byte[] buf = new byte[8192]; + int length; + while ((length = inStream.read(buf)) > 0) { + outStream.write(buf, 0, length); + } + } + + private void loadShippedLocales() { CodeSource cs = getOwningPlugin().getClass().getProtectionDomain().getCodeSource(); if (cs != null) { @@ -181,6 +284,7 @@ private void loadShippedLocales() { } private void loadLocale(String name, InputStream is, boolean printStackTrace) { + try { Properties temp = new Properties(); temp.load(is); diff --git a/prison-core/src/main/java/tech/mcprison/prison/localization/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/localization/package-info.java index f23816076..0eb959ae4 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/localization/package-info.java +++ b/prison-core/src/main/java/tech/mcprison/prison/localization/package-info.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/modules/Module.java b/prison-core/src/main/java/tech/mcprison/prison/modules/Module.java index 6b9b08d3b..131683eeb 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/modules/Module.java +++ b/prison-core/src/main/java/tech/mcprison/prison/modules/Module.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -18,12 +18,11 @@ package tech.mcprison.prison.modules; +import java.io.File; + import tech.mcprison.prison.Prison; -import tech.mcprison.prison.PrisonAPI; import tech.mcprison.prison.error.ErrorManager; -import java.io.File; - /** * Represents a module, which is a part of Prison that can be enabled and * disabled independently from the rest of the modules. @@ -57,16 +56,42 @@ public abstract class Module implements PluginEntity { public Module(String name, String version, int target) { this.name = name; this.version = version; - this.dataFolder = new File(PrisonAPI.getModuleManager().getModuleRoot(), - name.toLowerCase().replace(" ", "_")); this.apiTarget = target; + + this.dataFolder = setupDataFolder( name ); + this.status = new ModuleStatus(); - if (!this.dataFolder.exists()) { - this.dataFolder.mkdir(); - } this.errorManager = new ErrorManager(this); } + + public static File setupDataFolder( String name ) { + File dataFolder = new File(ModuleManager.getModuleRootDefault(), + name.toLowerCase().replace(" ", "_")); + if (!dataFolder.exists()) { + dataFolder.mkdir(); + } + return dataFolder; + } + + /** + *The getBaseCommands() should return all of the base commands that + * would apply to the module. It should include the / as in /mines or + * the /ranks command. It should be viewed as being ran from in game + * to be consistent. + *
+ * + *An example of what this would return would be: + *
+ * + *-
+ *
- Mines plugin: "&2/mines" + *
- Ranks plugin: "&2/ranks &2/rankup" + *
Displays the associated test based upon the three combinations + * of status codes. + *
+ * + * @return + */ + public String getStatusText() { + return (getStatus() == ModuleStatus.Status.ENABLED ? + "&2Enabled" : + (getStatus() == ModuleStatus.Status.FAILED ? + "&cFailed" : "&9&m-Disabled-" )); + } + + /* * Getters & Setters */ @@ -89,6 +104,14 @@ public String getMessage() { public void setMessage(String message) { this.message = message; } + + public void addMessage(String message) { + if ( this.message == null ) { + setMessage(message); + } else { + setMessage( getMessage() + ". " + message); + } + } public enum Status { ENABLED, DISABLED, FAILED diff --git a/prison-core/src/main/java/tech/mcprison/prison/modules/PluginEntity.java b/prison-core/src/main/java/tech/mcprison/prison/modules/PluginEntity.java index c27cc7602..03b3da3f6 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/modules/PluginEntity.java +++ b/prison-core/src/main/java/tech/mcprison/prison/modules/PluginEntity.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/modules/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/modules/package-info.java index 86de0ce4a..7f8fdba95 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/modules/package-info.java +++ b/prison-core/src/main/java/tech/mcprison/prison/modules/package-info.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/BulletedListComponent.java b/prison-core/src/main/java/tech/mcprison/prison/output/BulletedListComponent.java index 9f3b62aab..82941c26d 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/output/BulletedListComponent.java +++ b/prison-core/src/main/java/tech/mcprison/prison/output/BulletedListComponent.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/ChatDisplay.java b/prison-core/src/main/java/tech/mcprison/prison/output/ChatDisplay.java index 462e6b481..8d3bc8e72 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/output/ChatDisplay.java +++ b/prison-core/src/main/java/tech/mcprison/prison/output/ChatDisplay.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -74,5 +74,12 @@ public void send(CommandSender sender) { component.send(sender); } } + + public void toLog(LogLevel logLevel) { + Output.get().log( title, logLevel ); + for (DisplayComponent component : displayComponents) { + Output.get().log( component.text(), logLevel ); + } + } } diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/DisplayComponent.java b/prison-core/src/main/java/tech/mcprison/prison/output/DisplayComponent.java index c239a48e4..1e790027b 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/output/DisplayComponent.java +++ b/prison-core/src/main/java/tech/mcprison/prison/output/DisplayComponent.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/FancyMessageComponent.java b/prison-core/src/main/java/tech/mcprison/prison/output/FancyMessageComponent.java index c90c7eb5c..c8769183b 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/output/FancyMessageComponent.java +++ b/prison-core/src/main/java/tech/mcprison/prison/output/FancyMessageComponent.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/LogLevel.java b/prison-core/src/main/java/tech/mcprison/prison/output/LogLevel.java index de4785521..6b8c6fc68 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/output/LogLevel.java +++ b/prison-core/src/main/java/tech/mcprison/prison/output/LogLevel.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/Output.java b/prison-core/src/main/java/tech/mcprison/prison/output/Output.java index f57e6b0cb..690cb0040 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/output/Output.java +++ b/prison-core/src/main/java/tech/mcprison/prison/output/Output.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -18,11 +18,11 @@ package tech.mcprison.prison.output; +import java.util.Arrays; + import tech.mcprison.prison.Prison; import tech.mcprison.prison.internal.CommandSender; -import java.util.Arrays; - /** * Standardized output to the console and to players. * @@ -64,9 +64,13 @@ public String format(String message, LogLevel level, Object... args) { * Log a message with a specified {@link LogLevel} */ public void log(String message, LogLevel level, Object... args) { - Prison.get().getPlatform().log(gen("&3Prison") + " " + (level == LogLevel.INFO ? - "&f" : - level == LogLevel.WARNING ? "&6" : "&c") + String.format(message, args)); + if ( Prison.get() == null || Prison.get().getPlatform() == null ) { + System.err.println("Prison: Output.log Logger failure: " + message ); + } else { + Prison.get().getPlatform().log(gen("&3Prison") + " " + (level == LogLevel.INFO ? + "&f" : + level == LogLevel.WARNING ? "&6" : "&c") + String.format(message, args)); + } } /** diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/TextComponent.java b/prison-core/src/main/java/tech/mcprison/prison/output/TextComponent.java index 19f1bcfec..7336b483b 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/output/TextComponent.java +++ b/prison-core/src/main/java/tech/mcprison/prison/output/TextComponent.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/output/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/output/package-info.java index fbfbf44e3..0954a2a44 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/output/package-info.java +++ b/prison-core/src/main/java/tech/mcprison/prison/output/package-info.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/selection/Selection.java b/prison-core/src/main/java/tech/mcprison/prison/selection/Selection.java index 943260cd3..d05003fef 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/selection/Selection.java +++ b/prison-core/src/main/java/tech/mcprison/prison/selection/Selection.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionListener.java b/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionListener.java index b884f7d0c..4c63844d7 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionListener.java +++ b/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionListener.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionManager.java b/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionManager.java index 0484097ac..048e435b3 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionManager.java +++ b/prison-core/src/main/java/tech/mcprison/prison/selection/SelectionManager.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -56,7 +56,14 @@ public Selection getSelection(Player player) { } return selectionMap.get(player.getName()); } + + public void clearSelection(Player player) { + if (!selectionMap.containsKey(player.getName())) { + selectionMap.remove(player.getName()); + } + } + public void setSelection(Player player, Selection selection) { selectionMap.put(player.getName(), selection); } diff --git a/prison-core/src/main/java/tech/mcprison/prison/selection/package-info.java b/prison-core/src/main/java/tech/mcprison/prison/selection/package-info.java index 4ba71405b..38b692d05 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/selection/package-info.java +++ b/prison-core/src/main/java/tech/mcprison/prison/selection/package-info.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by diff --git a/prison-core/src/main/java/tech/mcprison/prison/sorting/PrisonSortable.java b/prison-core/src/main/java/tech/mcprison/prison/sorting/PrisonSortable.java new file mode 100644 index 000000000..f1dea1c2e --- /dev/null +++ b/prison-core/src/main/java/tech/mcprison/prison/sorting/PrisonSortable.java @@ -0,0 +1,5 @@ +package tech.mcprison.prison.sorting; + +public interface PrisonSortable { + +} diff --git a/prison-core/src/main/java/tech/mcprison/prison/sorting/PrisonSorter.java b/prison-core/src/main/java/tech/mcprison/prison/sorting/PrisonSorter.java new file mode 100644 index 000000000..5ff76a53f --- /dev/null +++ b/prison-core/src/main/java/tech/mcprison/prison/sorting/PrisonSorter.java @@ -0,0 +1,10 @@ +package tech.mcprison.prison.sorting; + +import java.util.Set; + +public abstract class PrisonSorter { + + + public abstract Set getSortedSet(); + +} diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/BlockType.java b/prison-core/src/main/java/tech/mcprison/prison/util/BlockType.java index 2623dec61..f5538f0f1 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/util/BlockType.java +++ b/prison-core/src/main/java/tech/mcprison/prison/util/BlockType.java @@ -1,6 +1,6 @@ /* * Prison is a Minecraft plugin for the prison game mode. - * Copyright (C) 2017 The Prison Team + * Copyright (C) 2017-2020 The Prison Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -18,7 +18,9 @@ package tech.mcprison.prison.util; +import java.util.ArrayList; import java.util.Collection; +import java.util.List; import java.util.Map; import java.util.Map.Entry; import java.util.Set; @@ -27,7 +29,19 @@ /** - * All of the blocks in the game. + *All of the blocks in the game. + *
+ * + *The new field altNames contains a list of String values that will help + * XMaterial map these types to valid Material types. These are spigot version + * Dependent, so some blocks may have different altNames for different spigot + * versions. + *
+ * + *XMaterial support for spigot 1.8.8: + * MOSS_STONE = mossy_cobblestone, LAPIS_LAZULI_ORE = "lapis_ore", + * LAPIS_LAZULI_BLOCK = "lapis_block", PILLAR_QUARTZ_BLOCK = "quartz_pillar" + *
* * @author Faizaan A. Datoo * @author Camouflage100 @@ -44,8 +58,43 @@ public enum BlockType { * of the Material. */ + IGNORE( -1, "prison:ignore", -1, MaterialType.BLOCK ), + NULL_BLOCK( -2, "prison:null_block", -1, MaterialType.INVALID ), + + // This was auto-generated from WorldEdit's blocks.json // @formatter:off + + + // NOTE: Double slabs are ones that players cannot naturally place, and they are + // similar to the main block type. It appears like they have been replaced, + // but not sure with what. I suspect no one will use them anyway, and if they + // do, then mapping them to their counter part block. There are a few doubles + // that have been mapped to "smooth" in the later versions, so they are used when + // possible. + + + DOUBLE_STONE_SLAB( 43, "minecraft:double_stone_slab", 0, MaterialType.BLOCK, "smooth_stone" ), + DOUBLE_SANDSTONE_SLAB( 43, "minecraft:double_stone_slab", 1, MaterialType.BLOCK, "smooth_sandstone_slab" ), + DOUBLE_WOODEN_SLAB( 43, "minecraft:double_stone_slab", 2, MaterialType.BLOCK, "OAK_PLANKS" ), + DOUBLE_COBBLESTONE_SLAB( 43, "minecraft:double_stone_slab", 3, MaterialType.BLOCK, "COBBLESTONE" ), + DOUBLE_BRICK_SLAB( 43, "minecraft:double_stone_slab", 4, MaterialType.BLOCK, "BRICKS" ), + DOUBLE_STONE_BRICK_SLAB( 43, "minecraft:double_stone_slab", 5, MaterialType.BLOCK, "STONE_BRICKS" ), + DOUBLE_NETHER_BRICK_SLAB( 43, "minecraft:double_stone_slab", 6, MaterialType.BLOCK, "NETHER_BRICKS" ), + DOUBLE_QUARTZ_SLAB( 43, "minecraft:double_stone_slab", 7, MaterialType.BLOCK, "SMOOTH_QUARTZ" ), + + DOUBLE_OAK_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 0, MaterialType.BLOCK, "OAK_PLANKS" ), + DOUBLE_SPRUCE_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 1, MaterialType.BLOCK, "SPRUCE_PLANKS" ), + DOUBLE_BIRCH_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 2, MaterialType.BLOCK, "BIRCH_PLANKS" ), + DOUBLE_JUNGLE_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 3, MaterialType.BLOCK, "JUNGLE_PLANKS" ), + DOUBLE_ACACIA_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 4, MaterialType.BLOCK, "ACACIA_PLANKS" ), + DOUBLE_DARK_OAK_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 5, MaterialType.BLOCK, "DARK_OAK_PLANKS" ), + + DOUBLE_RED_SANDSTONE_SLAB( 181, "minecraft:double_stone_slab2", 0, MaterialType.BLOCK, "RED_SANDSTONE" ), + PURPUR_DOUBLE_SLAB( 204, "minecraft:purpur_double_slab", 0, MaterialType.BLOCK, "PURPUR_BLOCK" ), + + + AIR( 0, "minecraft:air", 0, MaterialType.BLOCK ), STONE( 1, "minecraft:stone", 0, MaterialType.BLOCK ), GRANITE( 1, "minecraft:stone", 1, MaterialType.BLOCK ), @@ -59,44 +108,52 @@ public enum BlockType { COARSE_DIRT( 3, "minecraft:dirt", 1, MaterialType.BLOCK ), PODZOL( 3, "minecraft:dirt", 2, MaterialType.BLOCK ), COBBLESTONE( 4, "minecraft:cobblestone", 0, MaterialType.BLOCK ), - OAK_WOOD_PLANK( 5, "minecraft:planks", 0, MaterialType.BLOCK ), - SPRUCE_WOOD_PLANK( 5, "minecraft:planks", 1, MaterialType.BLOCK ), - BIRCH_WOOD_PLANK( 5, "minecraft:planks", 2, MaterialType.BLOCK ), - JUNGLE_WOOD_PLANK( 5, "minecraft:planks", 3, MaterialType.BLOCK ), - ACACIA_WOOD_PLANK( 5, "minecraft:planks", 4, MaterialType.BLOCK ), - DARK_OAK_WOOD_PLANK( 5, "minecraft:planks", 5, MaterialType.BLOCK ), + + OAK_WOOD_PLANK( 5, "minecraft:planks", 0, MaterialType.BLOCK, "OAK_PLANKS" ), + SPRUCE_WOOD_PLANK( 5, "minecraft:planks", 1, MaterialType.BLOCK, "SPRUCE_PLANKS" ), + BIRCH_WOOD_PLANK( 5, "minecraft:planks", 2, MaterialType.BLOCK, "BIRCH_PLANKS" ), + JUNGLE_WOOD_PLANK( 5, "minecraft:planks", 3, MaterialType.BLOCK, "JUNGLE_PLANKS" ), + ACACIA_WOOD_PLANK( 5, "minecraft:planks", 4, MaterialType.BLOCK, "ACACIA_PLANKS" ), + DARK_OAK_WOOD_PLANK( 5, "minecraft:planks", 5, MaterialType.BLOCK, "DARK_OAK_PLANKS" ), + OAK_SAPLING( 6, "minecraft:sapling", 0, MaterialType.BLOCK ), SPRUCE_SAPLING( 6, "minecraft:sapling", 1, MaterialType.BLOCK ), BIRCH_SAPLING( 6, "minecraft:sapling", 2, MaterialType.BLOCK ), JUNGLE_SAPLING( 6, "minecraft:sapling", 3, MaterialType.BLOCK ), ACACIA_SAPLING( 6, "minecraft:sapling", 4, MaterialType.BLOCK ), DARK_OAK_SAPLING( 6, "minecraft:sapling", 5, MaterialType.BLOCK ), - BEDROCK( 7, "minecraft:bedrock", 0, MaterialType.BLOCK ), - FLOWING_WATER( 8, "minecraft:flowing_water", 0, MaterialType.BLOCK ), + BEDROCK( 7, "minecraft:bedrock", 0, MaterialType.BLOCK ), + + FLOWING_WATER( 8, "minecraft:flowing_water", 0, MaterialType.BLOCK, "WATER" ), + STILL_WATER( 9, "minecraft:water", 0, MaterialType.BLOCK ), - FLOWING_LAVA( 10, "minecraft:flowing_lava", 0, MaterialType.BLOCK ), + FLOWING_LAVA( 10, "minecraft:flowing_lava", 0, MaterialType.BLOCK, "LAVA" ), STILL_LAVA( 11, "minecraft:lava", 0, MaterialType.BLOCK ), + SAND( 12, "minecraft:sand", 0, MaterialType.BLOCK ), RED_SAND( 12, "minecraft:sand", 1, MaterialType.BLOCK ), GRAVEL( 13, "minecraft:gravel", 0, MaterialType.BLOCK ), - GOLD_ORE( 14, "minecraft:gold_ore", 0, MaterialType.BLOCK ), - IRON_ORE( 15, "minecraft:iron_ore", 0, MaterialType.BLOCK ), - COAL_ORE( 16, "minecraft:coal_ore", 0, MaterialType.BLOCK ), + GOLD_ORE( 14, "minecraft:gold_ore", 0, MaterialType.BLOCK ), + IRON_ORE( 15, "minecraft:iron_ore", 0, MaterialType.BLOCK ), + COAL_ORE( 16, "minecraft:coal_ore", 0, MaterialType.BLOCK ), + OAK_WOOD( 17, "minecraft:log", 0, MaterialType.BLOCK ), SPRUCE_WOOD( 17, "minecraft:log", 1, MaterialType.BLOCK ), BIRCH_WOOD( 17, "minecraft:log", 2, MaterialType.BLOCK ), JUNGLE_WOOD( 17, "minecraft:log", 3, MaterialType.BLOCK ), + OAK_LEAVES( 18, "minecraft:leaves", 0, MaterialType.BLOCK ), SPRUCE_LEAVES( 18, "minecraft:leaves", 1, MaterialType.BLOCK ), BIRCH_LEAVES( 18, "minecraft:leaves", 2, MaterialType.BLOCK ), - UNGL_LEAVES( 18, "minecraft:leaves", 3, MaterialType.BLOCK ), /// ??? Should this be JUNGLE_LEAVES ??? JUNGLE_LEAVES( 18, "minecraft:leaves", 3, MaterialType.BLOCK ), SPONGE( 19, "minecraft:sponge", 0, MaterialType.BLOCK ), WET_SPONGE( 19, "minecraft:sponge", 1, MaterialType.BLOCK ), GLASS( 20, "minecraft:glass", 0, MaterialType.BLOCK ), + LAPIS_LAZULI_ORE( 21, "minecraft:lapis_ore", 0, MaterialType.BLOCK ), LAPIS_LAZULI_BLOCK( 22, "minecraft:lapis_block", 0, MaterialType.BLOCK ), + DISPENSER( 23, "minecraft:dispenser", 0, MaterialType.BLOCK ), SANDSTONE( 24, "minecraft:sandstone", 0, MaterialType.BLOCK ), CHISELED_SANDSTONE( 24, "minecraft:sandstone", 1, MaterialType.BLOCK ), @@ -107,10 +164,10 @@ public enum BlockType { DETECTOR_RAIL( 28, "minecraft:detector_rail", 0, MaterialType.BLOCK ), STICKY_PISTON( 29, "minecraft:sticky_piston", 0, MaterialType.BLOCK ), COBWEB( 30, "minecraft:web", 0, MaterialType.BLOCK ), - DEAD_SHRUB( 31, "minecraft:tallgrass", 0, MaterialType.BLOCK ), + DEAD_SHRUB( 31, "minecraft:tallgrass", 0, MaterialType.BLOCK, "DEAD_BUSH" ), TALL_GRASS( 31, "minecraft:tallgrass", 1, MaterialType.BLOCK ), FERN( 31, "minecraft:tallgrass", 2, MaterialType.BLOCK ), - DEAD_BUSH( 32, "minecraft:deadbush", 0, MaterialType.BLOCK ), + DEAD_BUSH( 32, "minecraft:deadbush", 0, MaterialType.BLOCK, "DEAD_BUSH" ), PISTON( 33, "minecraft:piston", 0, MaterialType.BLOCK ), PISTON_HEAD( 34, "minecraft:piston_head", 0, MaterialType.BLOCK ), WHITE_WOOL( 35, "minecraft:wool", 0, MaterialType.BLOCK ), @@ -129,11 +186,12 @@ public enum BlockType { GREEN_WOOL( 35, "minecraft:wool", 13, MaterialType.BLOCK ), RED_WOOL( 35, "minecraft:wool", 14, MaterialType.BLOCK ), BLACK_WOOL( 35, "minecraft:wool", 15, MaterialType.BLOCK ), + DANDELION( 37, "minecraft:yellow_flower", 0, MaterialType.BLOCK ), - POPPY( 38, "minecraft:red_flower", 0, MaterialType.BLOCK ), + POPPY( 38, "minecraft:red_flower", 0, MaterialType.BLOCK, "RED_ROSE" ), BLUE_ORCHID( 38, "minecraft:red_flower", 1, MaterialType.BLOCK ), ALLIUM( 38, "minecraft:red_flower", 2, MaterialType.BLOCK ), - AZURE_BLUET( 38, "minecraft:red_flower", 3, MaterialType.BLOCK ), + AZURE_BLUET( 38, "minecraft:red_flower", 3, MaterialType.BLOCK, "AZURE_BLUET" ), RED_TULIP( 38, "minecraft:red_flower", 4, MaterialType.BLOCK ), ORANGE_TULIP( 38, "minecraft:red_flower", 5, MaterialType.BLOCK ), WHITE_TULIP( 38, "minecraft:red_flower", 6, MaterialType.BLOCK ), @@ -143,26 +201,21 @@ public enum BlockType { RED_MUSHROOM( 40, "minecraft:red_mushroom", 0, MaterialType.BLOCK ), GOLD_BLOCK( 41, "minecraft:gold_block", 0, MaterialType.BLOCK ), IRON_BLOCK( 42, "minecraft:iron_block", 0, MaterialType.BLOCK ), - DOUBLE_STONE_SLAB( 43, "minecraft:double_stone_slab", 0, MaterialType.BLOCK ), - DOUBLE_SANDSTONE_SLAB( 43, "minecraft:double_stone_slab", 1, MaterialType.BLOCK ), - DOUBLE_WOODEN_SLAB( 43, "minecraft:double_stone_slab", 2, MaterialType.BLOCK ), - DOUBLE_COBBLESTONE_SLAB( 43, "minecraft:double_stone_slab", 3, MaterialType.BLOCK ), - DOUBLE_BRICK_SLAB( 43, "minecraft:double_stone_slab", 4, MaterialType.BLOCK ), - DOUBLE_STONE_BRICK_SLAB( 43, "minecraft:double_stone_slab", 5, MaterialType.BLOCK ), - DOUBLE_NETHER_BRICK_SLAB( 43, "minecraft:double_stone_slab", 6, MaterialType.BLOCK ), - DOUBLE_QUARTZ_SLAB( 43, "minecraft:double_stone_slab", 7, MaterialType.BLOCK ), + + STONE_SLAB( 44, "minecraft:stone_slab", 0, MaterialType.BLOCK ), SANDSTONE_SLAB( 44, "minecraft:stone_slab", 1, MaterialType.BLOCK ), WOODEN_SLAB( 44, "minecraft:stone_slab", 2, MaterialType.BLOCK ), COBBLESTONE_SLAB( 44, "minecraft:stone_slab", 3, MaterialType.BLOCK ), - BRICK_SLAB( 44, "minecraft:stone_slab", 4, MaterialType.BLOCK ), + BRICK_SLAB( 44, "minecraft:stone_slab", 4, MaterialType.BLOCK, "STONE_BRICK_SLAB" ), STONE_BRICK_SLAB( 44, "minecraft:stone_slab", 5, MaterialType.BLOCK ), NETHER_BRICK_SLAB( 44, "minecraft:stone_slab", 6, MaterialType.BLOCK ), QUARTZ_SLAB( 44, "minecraft:stone_slab", 7, MaterialType.BLOCK ), BRICKS( 45, "minecraft:brick_block", 0, MaterialType.BLOCK ), TNT( 46, "minecraft:tnt", 0, MaterialType.BLOCK ), BOOKSHELF( 47, "minecraft:bookshelf", 0, MaterialType.BLOCK ), - MOSS_STONE( 48, "minecraft:mossy_cobblestone", 0, MaterialType.BLOCK ), + MOSS_STONE( 48, "minecraft:mossy_cobblestone", 0, MaterialType.BLOCK, "MOSSY_COBBLESTONE" ), + OBSIDIAN( 49, "minecraft:obsidian", 0, MaterialType.BLOCK ), TORCH( 50, "minecraft:torch", 0, MaterialType.BLOCK ), FIRE( 51, "minecraft:fire", 0, MaterialType.BLOCK ), @@ -177,7 +230,7 @@ public enum BlockType { FARMLAND( 60, "minecraft:farmland", 0, MaterialType.BLOCK ), FURNACE( 61, "minecraft:furnace", 0, MaterialType.BLOCK ), BURNING_FURNACE( 62, "minecraft:lit_furnace", 0, MaterialType.BLOCK ), - STANDING_SIGN_BLOCK( 63, "minecraft:standing_sign", 0, MaterialType.BLOCK ), + STANDING_SIGN_BLOCK( 63, "minecraft:standing_sign", 0, MaterialType.BLOCK, "OAK_SIGN" ), OAK_DOOR_BLOCK( 64, "minecraft:wooden_door", 0, MaterialType.BLOCK ), LADDER( 65, "minecraft:ladder", 0, MaterialType.BLOCK ), RAIL( 66, "minecraft:rail", 0, MaterialType.BLOCK ), @@ -186,7 +239,9 @@ public enum BlockType { LEVER( 69, "minecraft:lever", 0, MaterialType.BLOCK ), STONE_PRESSURE_PLATE( 70, "minecraft:stone_pressure_plate", 0, MaterialType.BLOCK ), IRON_DOOR_BLOCK( 71, "minecraft:iron_door", 0, MaterialType.BLOCK ), - WOODEN_PRESSURE_PLATE( 72, "minecraft:wooden_pressure_plate", 0, MaterialType.BLOCK ), + + WOODEN_PRESSURE_PLATE( 72, "minecraft:wooden_pressure_plate", 0, MaterialType.BLOCK, + "OAK_PRESSURE_PLATE", "WOOD_PLATE" ), REDSTONE_ORE( 73, "minecraft:redstone_ore", 0, MaterialType.BLOCK ), GLOWING_REDSTONE_ORE( 74, "minecraft:lit_redstone_ore", 0, MaterialType.BLOCK ), @@ -201,7 +256,7 @@ public enum BlockType { CACTUS( 81, "minecraft:cactus", 0, MaterialType.BLOCK ), CLAY( 82, "minecraft:clay", 0, MaterialType.BLOCK ), - SUGAR_CANES( 83, "minecraft:reeds", 0, MaterialType.BLOCK ), + SUGAR_CANES( 83, "minecraft:reeds", 0, MaterialType.BLOCK, "SUGAR_CANE" ), JUKEBOX( 84, "minecraft:jukebox", 0, MaterialType.BLOCK ), OAK_FENCE( 85, "minecraft:fence", 0, MaterialType.BLOCK ), PUMPKIN( 86, "minecraft:pumpkin", 0, MaterialType.BLOCK ), @@ -210,10 +265,14 @@ public enum BlockType { SOUL_SAND( 88, "minecraft:soul_sand", 0, MaterialType.BLOCK ), GLOWSTONE( 89, "minecraft:glowstone", 0, MaterialType.BLOCK ), NETHER_PORTAL( 90, "minecraft:portal", 0, MaterialType.BLOCK ), - JACK_OLANTERN( 91, "minecraft:lit_pumpkin", 0, MaterialType.BLOCK ), + + JACK_OLANTERN( 91, "minecraft:lit_pumpkin", 0, MaterialType.BLOCK, "jack_o_lantern" ), + CAKE_BLOCK( 92, "minecraft:cake", 0, MaterialType.BLOCK ), - REDSTONE_REPEATER_BLOCK_OFF( 93, "minecraft:unpowered_repeater", 0, MaterialType.BLOCK ), - REDSTONE_REPEATER_BLOCK_ON( 94, "minecraft:powered_repeater", 0, MaterialType.BLOCK ), + + REDSTONE_REPEATER_BLOCK_OFF( 93, "minecraft:unpowered_repeater", 0, MaterialType.BLOCK, "REPEATER" ), + REDSTONE_REPEATER_BLOCK_ON( 94, "minecraft:powered_repeater", 0, MaterialType.BLOCK, "REPEATER" ), + WHITE_STAINED_GLASS( 95, "minecraft:stained_glass", 0, MaterialType.BLOCK ), ORANGE_STAINED_GLASS( 95, "minecraft:stained_glass", 1, MaterialType.BLOCK ), MAGENTA_STAINED_GLASS( 95, "minecraft:stained_glass", 2, MaterialType.BLOCK ), @@ -230,19 +289,25 @@ public enum BlockType { GREEN_STAINED_GLASS( 95, "minecraft:stained_glass", 13, MaterialType.BLOCK ), RED_STAINED_GLASS( 95, "minecraft:stained_glass", 14, MaterialType.BLOCK ), BLACK_STAINED_GLASS( 95, "minecraft:stained_glass", 15, MaterialType.BLOCK ), - WOODEN_TRAPDOOR( 96, "minecraft:trapdoor", 0, MaterialType.BLOCK ), - STONE_MONSTER_EGG( 97, "minecraft:monster_egg", 0, MaterialType.BLOCK ), - COBBLESTONE_MONSTER_EGG( 97, "minecraft:monster_egg", 1, MaterialType.BLOCK ), - STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 2, MaterialType.BLOCK ), - MOSSY_STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 3, MaterialType.BLOCK ), - CRACKED_STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 4, MaterialType.BLOCK ), - CHISELED_STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 5, MaterialType.BLOCK ), - STONE_BRICKS( 98, "minecraft:stonebrick", 0, MaterialType.BLOCK ), - MOSSY_STONE_BRICKS( 98, "minecraft:stonebrick", 1, MaterialType.BLOCK ), - CRACKED_STONE_BRICKS( 98, "minecraft:stonebrick", 2, MaterialType.BLOCK ), - CHISELED_STONE_BRICKS( 98, "minecraft:stonebrick", 3, MaterialType.BLOCK ), + WOODEN_TRAPDOOR( 96, "minecraft:trapdoor", 0, MaterialType.BLOCK, "oak_trapdoor" ), + + STONE_MONSTER_EGG( 97, "minecraft:monster_egg", 0, MaterialType.BLOCK, "INFESTED_STONE" ), + COBBLESTONE_MONSTER_EGG( 97, "minecraft:monster_egg", 1, MaterialType.BLOCK, "INFESTED_COBBLESTONE" ), + STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 2, MaterialType.BLOCK, "INFESTED_STONE_BRICKS" ), + MOSSY_STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 3, MaterialType.BLOCK, "INFESTED_MOSSY_STONE_BRICKS" ), + CRACKED_STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 4, MaterialType.BLOCK, "INFESTED_CRACKED_STONE_BRICKS" ), + CHISELED_STONE_BRICK_MONSTER_EGG( 97, "minecraft:monster_egg", 5, MaterialType.BLOCK, "INFESTED_CHISELED_STONE_BRICKS" ), + + STONE_BRICKS( 98, "minecraft:stonebrick", 0, MaterialType.BLOCK, "STONE_BRICKS" ), + MOSSY_STONE_BRICKS( 98, "minecraft:stonebrick", 1, MaterialType.BLOCK, "MOSSY_STONE_BRICKS" ), + CRACKED_STONE_BRICKS( 98, "minecraft:stonebrick", 2, MaterialType.BLOCK, "CRACKED_STONE_BRICKS" ), + CHISELED_STONE_BRICKS( 98, "minecraft:stonebrick", 3, MaterialType.BLOCK, "CHISELED_STONE_BRICKS" ), + BROWN_MUSHROOM_BLOCK( 99, "minecraft:brown_mushroom_block", 0, MaterialType.BLOCK ), + HUGE_MUSHROOM_1( 99, "minecraft:brown_mushroom_block", 14, MaterialType.BLOCK ), RED_MUSHROOM_BLOCK( 100, "minecraft:red_mushroom_block", 0, MaterialType.BLOCK ), + HUGE_MUSHROOM_2( 100, "minecraft:red_mushroom_block", 14, MaterialType.BLOCK ), + IRON_BARS( 101, "minecraft:iron_bars", 0, MaterialType.BLOCK ), GLASS_PANE( 102, "minecraft:glass_pane", 0, MaterialType.BLOCK ), MELON_BLOCK( 103, "minecraft:melon_block", 0, MaterialType.BLOCK ), @@ -254,6 +319,7 @@ public enum BlockType { STONE_BRICK_STAIRS( 109, "minecraft:stone_brick_stairs", 0, MaterialType.BLOCK ), MYCELIUM( 110, "minecraft:mycelium", 0, MaterialType.BLOCK ), LILY_PAD( 111, "minecraft:waterlily", 0, MaterialType.BLOCK ), + NETHER_BRICK( 112, "minecraft:nether_brick", 0, MaterialType.BLOCK ), NETHER_BRICK_FENCE( 113, "minecraft:nether_brick_fence", 0, MaterialType.BLOCK ), NETHER_BRICK_STAIRS( 114, "minecraft:nether_brick_stairs", 0, MaterialType.BLOCK ), @@ -265,14 +331,11 @@ public enum BlockType { END_PORTAL_FRAME( 120, "minecraft:end_portal_frame", 0, MaterialType.BLOCK ), END_STONE( 121, "minecraft:end_stone", 0, MaterialType.BLOCK ), DRAGON_EGG( 122, "minecraft:dragon_egg", 0, MaterialType.BLOCK ), - REDSTONE_LAMP_INACTIVE( 123, "minecraft:redstone_lamp", 0, MaterialType.BLOCK ), - REDSTONE_LAMP_ACTIVE( 124, "minecraft:lit_redstone_lamp", 0, MaterialType.BLOCK ), - DOUBLE_OAK_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 0, MaterialType.BLOCK ), - DOUBLE_SPRUCE_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 1, MaterialType.BLOCK ), - DOUBLE_BIRCH_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 2, MaterialType.BLOCK ), - DOUBLE_JUNGLE_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 3, MaterialType.BLOCK ), - DOUBLE_ACACIA_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 4, MaterialType.BLOCK ), - DOUBLE_DARK_OAK_WOOD_SLAB( 125, "minecraft:double_wooden_slab", 5, MaterialType.BLOCK ), + + REDSTONE_LAMP_INACTIVE( 123, "minecraft:redstone_lamp", 0, MaterialType.BLOCK, "REDSTONE_LAMP_OFF" ), + REDSTONE_LAMP_ACTIVE( 124, "minecraft:lit_redstone_lamp", 0, MaterialType.BLOCK, "REDSTONE_LAMP", "REDSTONE_LAMP_ON" ), + + OAK_WOOD_SLAB( 126, "minecraft:wooden_slab", 0, MaterialType.BLOCK ), SPRUCE_WOOD_SLAB( 126, "minecraft:wooden_slab", 1, MaterialType.BLOCK ), BIRCH_WOOD_SLAB( 126, "minecraft:wooden_slab", 2, MaterialType.BLOCK ), @@ -296,40 +359,46 @@ public enum BlockType { FLOWER_POT( 140, "minecraft:flower_pot", 0, MaterialType.BLOCK ), CARROTS( 141, "minecraft:carrots", 0, MaterialType.BLOCK ), POTATOES( 142, "minecraft:potatoes", 0, MaterialType.BLOCK ), - WOODEN_BUTTON( 143, "minecraft:wooden_button", 0, MaterialType.BLOCK ), + WOODEN_BUTTON( 143, "minecraft:wooden_button", 0, MaterialType.BLOCK, "OAK_BUTTON", "wood_button" ), MOB_HEAD( 144, "minecraft:skull", 0, MaterialType.BLOCK ), ANVIL( 145, "minecraft:anvil", 0, MaterialType.BLOCK ), TRAPPED_CHEST( 146, "minecraft:trapped_chest", 0, MaterialType.BLOCK ), WEIGHTED_PRESSURE_PLATE_LIGHT( 147, "minecraft:light_weighted_pressure_plate", 0, MaterialType.BLOCK ), WEIGHTED_PRESSURE_PLATE_HEAVY( 148, "minecraft:heavy_weighted_pressure_plate", 0, MaterialType.BLOCK ), - REDSTONE_COMPARATOR_INACTIVE( 149, "minecraft:unpowered_comparator", 0, MaterialType.BLOCK ), - REDSTONE_COMPARATOR_ACTIVE( 150, "minecraft:powered_comparator", 0, MaterialType.BLOCK ), + + REDSTONE_COMPARATOR_INACTIVE( 149, "minecraft:unpowered_comparator", 0, MaterialType.BLOCK, "COMPARATOR" ), + REDSTONE_COMPARATOR_ACTIVE( 150, "minecraft:powered_comparator", 0, MaterialType.BLOCK, "COMPARATOR" ), + DAYLIGHT_SENSOR( 151, "minecraft:daylight_detector", 0, MaterialType.BLOCK ), REDSTONE_BLOCK( 152, "minecraft:redstone_block", 0, MaterialType.BLOCK ), NETHER_QUARTZ_ORE( 153, "minecraft:quartz_ore", 0, MaterialType.BLOCK ), HOPPER( 154, "minecraft:hopper", 0, MaterialType.BLOCK ), QUARTZ_BLOCK( 155, "minecraft:quartz_block", 0, MaterialType.BLOCK ), CHISELED_QUARTZ_BLOCK( 155, "minecraft:quartz_block", 1, MaterialType.BLOCK ), - PILLAR_QUARTZ_BLOCK( 155, "minecraft:quartz_block", 2, MaterialType.BLOCK ), + + PILLAR_QUARTZ_BLOCK( 155, "minecraft:quartz_block", 2, MaterialType.BLOCK, "QUARTZ_PILLAR" ), + QUARTZ_STAIRS( 156, "minecraft:quartz_stairs", 0, MaterialType.BLOCK ), ACTIVATOR_RAIL( 157, "minecraft:activator_rail", 0, MaterialType.BLOCK ), DROPPER( 158, "minecraft:dropper", 0, MaterialType.BLOCK ), - WHITE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 0, MaterialType.BLOCK ), - ORANGE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 1, MaterialType.BLOCK ), - MAGENTA_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 2, MaterialType.BLOCK ), - LIGHT_BLUE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 3, MaterialType.BLOCK ), - YELLOW_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 4, MaterialType.BLOCK ), - LIME_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 5, MaterialType.BLOCK ), - PINK_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 6, MaterialType.BLOCK ), - GRAY_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 7, MaterialType.BLOCK ), - LIGHT_GRAY_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 8, MaterialType.BLOCK ), - CYAN_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 9, MaterialType.BLOCK ), - PURPLE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 10, MaterialType.BLOCK ), - BLUE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 11, MaterialType.BLOCK ), - BROWN_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 12, MaterialType.BLOCK ), - GREEN_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 13, MaterialType.BLOCK ), - RED_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 14, MaterialType.BLOCK ), - BLACK_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 15, MaterialType.BLOCK ), + + WHITE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 0, MaterialType.BLOCK, "WHITE_TERRACOTTA" ), + ORANGE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 1, MaterialType.BLOCK, "ORANGE_TERRACOTTA" ), + MAGENTA_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 2, MaterialType.BLOCK, "MAGENTA_TERRACOTTA" ), + LIGHT_BLUE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 3, MaterialType.BLOCK, "LIGHT_BLUE_TERRACOTTA" ), + YELLOW_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 4, MaterialType.BLOCK, "YELLOW_TERRACOTTA" ), + LIME_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 5, MaterialType.BLOCK, "LIME_TERRACOTTA" ), + PINK_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 6, MaterialType.BLOCK, "PINK_TERRACOTTA" ), + GRAY_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 7, MaterialType.BLOCK, "GRAY_TERRACOTTA" ), + LIGHT_GRAY_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 8, MaterialType.BLOCK, "LIGHT_GRAY_TERRACOTTA" ), + CYAN_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 9, MaterialType.BLOCK, "CYAN_TERRACOTTA" ), + PURPLE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 10, MaterialType.BLOCK, "PURPLE_TERRACOTTA" ), + BLUE_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 11, MaterialType.BLOCK, "BLUE_TERRACOTTA" ), + BROWN_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 12, MaterialType.BLOCK, "BROWN_TERRACOTTA" ), + GREEN_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 13, MaterialType.BLOCK, "GREEN_TERRACOTTA" ), + RED_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 14, MaterialType.BLOCK, "RED_TERRACOTTA" ), + BLACK_STAINED_CLAY( 159, "minecraft:stained_hardened_clay", 15, MaterialType.BLOCK, "BLACK_TERRACOTTA" ), + WHITE_STAINED_GLASS_PANE( 160, "minecraft:stained_glass_pane", 0, MaterialType.BLOCK ), ORANGE_STAINED_GLASS_PANE( 160, "minecraft:stained_glass_pane", 1, MaterialType.BLOCK ), MAGENTA_STAINED_GLASS_PANE( 160, "minecraft:stained_glass_pane", 2, MaterialType.BLOCK ), @@ -346,7 +415,8 @@ public enum BlockType { GREEN_STAINED_GLASS_PANE( 160, "minecraft:stained_glass_pane", 13, MaterialType.BLOCK ), RED_STAINED_GLASS_PANE( 160, "minecraft:stained_glass_pane", 14, MaterialType.BLOCK ), BLACK_STAINED_GLASS_PANE( 160, "minecraft:stained_glass_pane", 15, MaterialType.BLOCK ), - ACACIA_LEAVES( 161, "minecraft:leaves2", 0, MaterialType.BLOCK ), + + ACACIA_LEAVES( 161, "minecraft:leaves2", 0, MaterialType.BLOCK, "ACACIA_LEAVES" ), DARK_OAK_LEAVES( 161, "minecraft:leaves2", 1, MaterialType.BLOCK ), ACACIA_WOOD( 162, "minecraft:log2", 0, MaterialType.BLOCK ), DARK_OAK_WOOD( 162, "minecraft:log2", 1, MaterialType.BLOCK ), @@ -376,7 +446,7 @@ public enum BlockType { GREEN_CARPET( 171, "minecraft:carpet", 13, MaterialType.BLOCK ), RED_CARPET( 171, "minecraft:carpet", 14, MaterialType.BLOCK ), BLACK_CARPET( 171, "minecraft:carpet", 15, MaterialType.BLOCK ), - HARDENED_CLAY( 172, "minecraft:hardened_clay", 0, MaterialType.BLOCK ), + HARDENED_CLAY( 172, "minecraft:hardened_clay", 0, MaterialType.BLOCK, "TERRACOTTA", "HARD_CLAY" ), BLOCK_OF_COAL( 173, "minecraft:coal_block", 0, MaterialType.BLOCK ), PACKED_ICE( 174, "minecraft:packed_ice", 0, MaterialType.BLOCK ), SUNFLOWER( 175, "minecraft:double_plant", 0, MaterialType.BLOCK ), @@ -392,8 +462,9 @@ public enum BlockType { CHISELED_RED_SANDSTONE( 179, "minecraft:red_sandstone", 1, MaterialType.BLOCK ), SMOOTH_RED_SANDSTONE( 179, "minecraft:red_sandstone", 2, MaterialType.BLOCK ), RED_SANDSTONE_STAIRS( 180, "minecraft:red_sandstone_stairs", 0, MaterialType.BLOCK ), - DOUBLE_RED_SANDSTONE_SLAB( 181, "minecraft:double_stone_slab2", 0, MaterialType.BLOCK ), + RED_SANDSTONE_SLAB( 182, "minecraft:stone_slab2", 0, MaterialType.BLOCK ), + SPRUCE_FENCE_GATE( 183, "minecraft:spruce_fence_gate", 0, MaterialType.BLOCK ), BIRCH_FENCE_GATE( 184, "minecraft:birch_fence_gate", 0, MaterialType.BLOCK ), JUNGLE_FENCE_GATE( 185, "minecraft:jungle_fence_gate", 0, MaterialType.BLOCK ), @@ -415,7 +486,7 @@ public enum BlockType { PURPUR_BLOCK( 201, "minecraft:purpur_block", 0, MaterialType.BLOCK ), PURPUR_PILLAR( 202, "minecraft:purpur_pillar", 0, MaterialType.BLOCK ), PURPUR_STAIRS( 203, "minecraft:purpur_stairs", 0, MaterialType.BLOCK ), - PURPUR_DOUBLE_SLAB( 204, "minecraft:purpur_double_slab", 0, MaterialType.BLOCK ), + PURPUR_SLAB( 205, "minecraft:purpur_slab", 0, MaterialType.BLOCK ), END_STONE_BRICKS( 206, "minecraft:end_bricks", 0, MaterialType.BLOCK ), BEETROOT_BLOCK( 207, "minecraft:beetroots", 0, MaterialType.BLOCK ), @@ -509,7 +580,7 @@ public enum BlockType { MILK_BUCKET( 335, "minecraft:milk_bucket", 0 ), BRICK( 336, "minecraft:brick", 0, MaterialType.BLOCK ), CLAY_BALL( 337, "minecraft:clay_ball", 0 ), - SUGAR_CANES_ITEM( 338, "minecraft:reeds", 0, MaterialType.BLOCK ), + SUGAR_CANES_ITEM( 338, "minecraft:reeds", 0, MaterialType.BLOCK, "SUGAR_CANE" ), PAPER( 339, "minecraft:paper", 0 ), BOOK( 340, "minecraft:book", 0 ), SLIMEBALL( 341, "minecraft:slime_ball", 0 ), @@ -526,11 +597,15 @@ public enum BlockType { PUFFERFISH( 349, "minecraft:fish", 3 ), COOKED_FISH( 350, "minecraft:cooked_fish", 0 ), COOKED_SALMON( 350, "minecraft:cooked_fish", 1 ), + INK_SACK( 351, "minecraft:dye", 0 ), ROSE_RED( 351, "minecraft:dye", 1 ), CACTUS_GREEN( 351, "minecraft:dye", 2 ), COCO_BEANS( 351, "minecraft:dye", 3 ), + + // NOTE: May actually be minecraft:ink_sack which is what XMaterial uses? LAPIS_LAZULI( 351, "minecraft:dye", 4 ), + PURPLE_DYE( 351, "minecraft:dye", 5 ), CYAN_DYE( 351, "minecraft:dye", 6 ), LIGHT_GRAY_DYE( 351, "minecraft:dye", 7 ), @@ -542,6 +617,8 @@ public enum BlockType { MAGENTA_DYE( 351, "minecraft:dye", 13 ), ORANGE_DYE( 351, "minecraft:dye", 14 ), BONE_MEAL( 351, "minecraft:dye", 15 ), + + BONE( 352, "minecraft:bone", 0 ), SUGAR( 353, "minecraft:sugar", 0 ), CAKE( 354, "minecraft:cake", 0 ), @@ -628,7 +705,7 @@ public enum BlockType { ENCHANTED_BOOK( 403, "minecraft:enchanted_book", 0 ), REDSTONE_COMPARATOR( 404, "minecraft:comparator", 0, MaterialType.BLOCK ), NETHER_BRICK_ITEM( 405, "minecraft:netherbrick", 0, MaterialType.BLOCK ), - NETHER_QUARTZ( 406, "minecraft:quartz", 0, MaterialType.BLOCK ), + NETHER_QUARTZ( 406, "minecraft:quartz", 0 ), MINECART_WITH_TNT( 407, "minecraft:tnt_minecart", 0 ), MINECART_WITH_HOPPER( 408, "minecraft:hopper_minecart", 0 ), PRISMARINE_SHARD( 409, "minecraft:prismarine_shard", 0 ), @@ -683,6 +760,32 @@ public enum BlockType { DISC_11( 2266, "minecraft:record_11", 0 ), WAIT_DISC( 2267, "minecraft:record_wait", 0 ), + +// Testing to see if we can inject 1.13 block types: :( nope... does not work. +// Commenting out for now, will revisit later. +// +// AIR_113( "air", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// +// QUARTZ_113( "quartz", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// NETHER_QUARTZ_ORE_113( "nether_quartz_ore", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// QUARTZ_BLOCK_113( "quartz_block", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// CHISELED_QUARTZ_BLOCK_113( "chiseled_quartz_block", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// QUARTZ_PILLAR_113( "quartz_pillar", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// QUARTZ_SLAB_113( "quartz_slab", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// SMOOTH_QUARTZ_113( "smooth_quartz", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// +// OAK_LOG_113( "oak_log", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// SPRUCE_LOG_113( "spruce_log", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// BIRCH_LOG_113( "birch_log", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// JUNGLE_LOG_113( "jungle_log", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// +// OAK_WOOD_113( "oak_wood", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// SPRUCE_WOOD_113( "spruce_wood", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// BIRCH_WOOD_113( "birch_wood", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// JUNGLE_WOOD_113( "jungle_wood", MaterialType.BLOCK, MaterialVersion.v1_13 ), +// + + ; // @formatter:on @@ -690,13 +793,41 @@ public enum BlockType { private final String id; private final short data; private final MaterialType materialType; + private final MaterialVersion materialVersion; + + private final ListThis function is for legacy versions of spigot that + * uses the data value. This function will returns a + * string value of a material name that + * XMaterial will be able to use to look up the correct + * bukkit material type. + *
+ * + *The way it needs to be constructed, is by taking the id, + * dropping the "minecraft:" prefix, then if data is non-zero, + * add a colon and the value of data. + *
+ * + * + * @return + */ + public String getXMaterialNameLegacy() { + String xMatName = getId().replace( "minecraft:", "" ) + + ( getData() > 0 ? ":" + getData() : "" ); + return xMatName; + } + + /** + *This function will return the lower case name of the BlockType.
+ * This should match
+ * @return
+ */
+ public String getXMaterialName() {
+ return name().toLowerCase();
+ }
+
+ public List This function will determine if the given location is within a radius of the Bounds'
+ * center. This will return a true or false value.
+ * To keep the calculations simple, if the worlds are the same, then it will create a new
+ * Bounds object and then utilize the computed values for width and length by feeding it in
+ * to a Pythagorean theorem to compute the hypotenuse (distance) between these two points.
+ * There maybe other unused values calculated, but going for the simplicity of reusing existing code.
+ * Ignore Y since this is the radius from the center axis of the mine.
+ * playerCache tries to provide a faster way to identify which mine a player is
+ * in. The theory is that there is a very high chance it will be the last mine
+ * they were in. So this records the last mine they were in, and if that is not
+ * where they are, then, and only then, do we check all mines to see if it may
+ * be something else.
+ * Search all mines to find if the given block is located within any
+ * of the mines. If not, then return a null.
+ * The following command will change the mine's time between resets. But it will
+ * not be applied until after the next reset.
+ * The following command will change the mine's time between resets. But it will
+ * not be applied until after the next reset.
+ * When a mine reaches zero blocks, a manual reset will be issued to run. By default
+ * it will have a 0 second delay before running, but this command controls how long of
+ * a delay to use.
+ * Although the delay is in seconds, it should be known that the value will be multiplied
+ * by 20 to convert it to ticks. So any value less than 0.05 will be treated as zero and
+ * effectively will be in 0.05 increments. Give or take a tick should not matter, but
+ * beware if a player, or owner, complains that 0.17 is the same as 0.15.
+ * The following command will change the mine's time between resets. But it will
+ * not be applied until after the next reset.
+ * This is called when a mine is first created.
+ * Loads a mine from a document.
+ * Note that the location where the loadFromDocument() occurs in the whole
+ * "create the objects" is in the "middle". All classes that are extended
+ * from are instantiated first due to the super() function call. So when Mine
+ * tries to be instantiated, it first drills all the way down to MineData and
+ * then runs all the initialization code within MineData and then works back
+ * through all of the classes, instantiating everything, one layer at a time.
+ * Then when it gets back up to this class, Mine, all parents have been fully
+ * instantiated so all collections will have been assigned non-null values
+ * as an example. Then this class loads the data from the document object.
+ * This is important, since all parents have been initialized, now the document
+ * loader is making it a "mine".
+ * Then at that point, after the mine data is loaded, it once again drills all the
+ * way down to the MineData ancestor class, using the initialize() functions, where
+ * it then starts to initialize all classes from MineData, back up to Mine.
+ * What this enables and allows, is when a class is initialized, it will have access
+ * to the fully loaded mine data. This is a perfect example of being able to start
+ * submitting the mine reset jobs since all data has been loaded, and all lower
+ * functions have been ran.
+ * So the over all design of the Mine objects is that all ancestors instantiate
+ * first, from MineData to Mine. Then the mine is loaded from the file system.
+ * Then all ancestors are initialized from MineData to Mine. This gives a high
+ * degree of control over when actions can be ran over a mine, and have confidence the
+ * data and conditions will be there.
+ * This initialize function gets called after the classes are
+ * instantiated, and is initiated from Mine class and propagates
+ * to the MineData class. Good for kicking off the scheduler.
+ * The loading of a mine checks to ensure if the world exists. If not, then
+ * traditionally, it would not load the mine. The problem with this model is
+ * the world may not exist yet, if running Multiverse-core (or another similar
+ * plugin) and as such, may falsely cause mine failures. This is the situation if
+ * the mine exists within a world that must be loaded by Multiverse-core. If it was
+ * a standard world, then it would be fine.
+ * Soft dependencies do not provide a solution. One bad solution for this
+ * situation, is to manually add a hard dependency to Multiverse-core. This
+ * should not be used.
+ * As a better solution to this problem, mines will be loaded as normal, but
+ * if the world does not exist, then their initialization, or enablement, will be
+ * delayed until the world is available.
+ * This function teleports players out of existing mines if they are within
- * their boundaries within the world where the Mine exists. Using only players within the existing world of the current mine, each
- * player is checked to see if they are within the mine, and if they are they
- * are teleported either to the mine's spawn location, or straight up from the
- * center of the mine, to the top of the mine (assumes air space will exist there). This function eliminates possible bug of players being teleported from other
- * worlds, and also eliminates the possibility that the destination could
- * ever be null. This function will teleport the player out of a given mine, or to the given
- * mine. It will not confirm if the player is within the mine before trying to
- * teleport.
- * This function will teleport the player to the defined spawn location, or it
- * will teleport the player to the center of the mine, but on top of the
- * mine's surface. If the player target location has an empty block under its feet, it will
- * then spawn in a single glass block so the player will not take fall damage.
- * If that block is within the mine, it will be reset at a later time when the
- * mine resets and resets that block. If it is part of spawn for the mine, then
- * the glass block will become part of the landscape.
- *
- *
- * @param player
- */
- public void teleportPlayerOut(Player player) {
-
- Location altTp = new Location( getBounds().getCenter() );
- altTp.setY( getBounds().getyBlockMax() + 1 );
- Location target = isHasSpawn() ? getSpawn() : altTp;
-
- // Player needs to stand on something. If block below feet is air, change it to a
- // glass block:
- Location targetGround = new Location( target );
- targetGround.setY( target.getBlockY() - 1 );
- if ( targetGround.getBlockAt().isEmpty() ) {
- targetGround.getBlockAt().setType( BlockType.GLASS );
- }
-
- player.teleport( target );
- PrisonMines.getInstance().getMinesMessages().getLocalizable("teleported")
- .withReplacements(this.name).sendTo(player);
+ private Location getLocation(Document doc, World world, String x, String y, String z, String pitch, String yaw) {
+ Location loc = getLocation(doc, world, x, y, z);
+ loc.setPitch( ((Double) doc.get(pitch)).floatValue() );
+ loc.setYaw( ((Double) doc.get(yaw)).floatValue() );
+ return loc;
}
- /**
- * This is a temporary fix until the Bounds.within() checks for the
- * same world. For now, it is assumed that Bounds.min and Bounds.max are
- * the same world, but that may not always be the case.