- - -# Features recently added for v3.2.11 - - - - - - - - - - -* DONE: New update to combine block processing results in many block.getDrops() being combined. Since they are combined, the extended fortune calculations may not work properly since it does not know how many original blocks were included. -- May need to have an intermediate object to better collect original blocks, drops, and targetBlocks. It can include some of the more basics that are not tracked, such as original block count to better calculate the fortunes. - - - -* DONE: Rewrite the `/prison utils titles` to use XSeries' title commands. XSeries only supports 1.9+ so I still need to support 1.8.8 directly within prison. - - - -* DONE: Common messaging framework so if hundreds of messages are sent, only one is displayed. Eliminate the duplicates. - - - - -* DONE: Revert a mine to a virtual mine. Maybe with the command: `/mines set area *virtual*`. Backup the mine's data file before updating and saving. - - -* DONE: the command /mines reset *all* is not working correctly. Could be an issue with the chaining not submitting the next reset since this is all done through async processes right now. - - -* DONE: Add a few more options to auto features for auto sell, such on full inventory. This was removed recently to stabilize some of the new code. - - Just refined what was already there. - - - - -* DONE: Concurrent modification error on the MineTargetPrisonBlock when resetting the mine. - tech.mcprison.prison.spigot.game.SpigotWorld.setBlocksSynchronously() (146). - Serialize Id the mine resets and provide a locking mechanism that will prevent auto features from being processed when it goes in to a reset mode. Also when in a reset mode, prevent another reset from being submitted so they cannot run concurrently or back to back. Maybe attach a cooldown to the resets too, such as 10 seconds would be long enough to prevent a runaway chained reaction. - - DONE: Create an object such as a MineStateToken that will hold the state of the mine reset (in progress, mineable, stable, usable, locked, etc... not sure proper terminology right now... or how many states), with a serial number that will be incremented on each reset. - - (on hold) Do not perform a clear on the collection of MineTargetPrisonBlocks within the mine. Just replace the collection with a new collection and let the garbage collection handle reclaiming all resources. Carefully review for possible memory leaks. May be a good idea to hold on to that collection and submit a task that runs in about 30 seconds to perform a clear on the collection to release the resources. This may be important since the target blocks contains references to the stats blocks and may not be GC'd automatically. May want to null those refs first too. - MineReset.clearMineTargetPrisonBlocks() (1799) - -* DONE: PlayerCache Time per Mine stats - not recording correctly. - -* DONE: new auto features autosell should place items in inventory that have no sell value. Items that cannot be auto sold. - - - - - -# Features recently added for v3.2.10 - - -# TODOs for v3.2.10 release: - -1. DONE: Final testing of ladder rank multipliers -2. DONE: /ranks ladder moveRank not working -3. DONE: Forced global refresh of rank multipliers when a ladder multiplier is changed. - - Should be simple - - Run as async task - - DONE: Force update when updating a ladder's multiplier - all players - - DONE: Force update when changing ranks - only targeted player -4. DONE: Add ladder base cost multiplier to /ranks autoConfigure. Start with a simple 10%. - - Include message that it's enabled and how to change it or disable it: - - /ranks ladder rankCostMultiplier prestiges 0 -5. Add to /ranks player the detail information on rank cost multipliers -6. DONE: For '/ranks autoConfigure' add an alias to '/prison autoConfigure' - -7. DONE: Change /ranks list so if non-op it does not show all the extra details. A simplified list for plain players. - -8. DONE: Liners: Some are only for later releases and do not work with 1.8.8. So need to setup something to restrict the liners that are not functional for the older releases of spigot. - -9. DONE: Hook up Prison's Explosion event. - - -### Others - -* DONE: Add a rank cost multiplier to ladders. Sum all active ranks a player has to get the total multiplier to use for rank costs. -* DONE: Fix the "next rank" value with PlayerRanks.... needs to recalc with the new rank. -* DONE: When a ladder's rate cost multiplier is changed, need to recalculate all player's multipliers. Setup a task? - - - -* DONE: /ranks ladder moveRank did not work to move from one ladder to another - -* DONE: When adding a new rank or mine, auto reload all placeholders so they pick up the new entry. - - - - - -# Features recently added since v3.2.9 - - - -* DONE: Enable and disable confirmations for prestiges - - DONE: Put in config.yml under the existing: prestiges. settings. - - DONE: Move the GUI confirm to the same group of prestiges. settings. - - - Player Cache possibilities? - * DONE: money earned per mine? - - -* DONE: Make ranks more expensive on each prestige.... - - -* NOT-AN-ISSUE: If automanager is turned off, and /prison reload automanager is ran, it will reload the settings, but the event listeners are only registered upon server startup. So if that condition happens... should display a warning indicating the server must be restarted. -- NOT-AN-ISSUE: Add a warning about event priority changes needing a server restart: --- NOTE: these are no longer an issue since event listeners are reloaded when the auto features are reloaded. - - - -* DONE **Get new block model working** - * Start to enable and test various functions - * Add in Custom Items Integration - * Code Integration for CI - Key to specific version due to api changes - * Pull in custom blocks from CI API - * Place blocks with CI api - * Not sure how block break would work with CI api? - * Setup sellall to work with CI api - - - -DONE: - Block constraint error when there are no blocks spawned when applying min to add more... - - if rangeHigh and rangeLow are zero, or the same, then need to set the high and low values. - - May need to even set them when there are only a few? - - maybe rangeHigh and rangeLow should be the actual limits, and not the high and low range of where those blocks actually spawned? Right now it's actual spawned blocks, but if either, or both are 5000 blocks from the true limit, then the range of actual adjustments is artificially limited and narrowed. - - Maybe add 2 new fields: rangeHighLimit and rangeLowLimit that is the actual boundaries? These could be used to help normal spawning? - - -* DONE: On prison support submit mines, include /mines info a all? - -* DONE: To all headers that are displayed in prison commands, show the prison's version to the far right. - - -* CANNOT REPRODUCDE: The command /mines delete does not appear to be working - User error? - - -* DONE: Add an *all* for mine names under blockEvent add: - - -* DONE: ladder commands - - - -* DONE: On default ladder, at top rank, if prestige is enabled, then show a message that can be configured. - - -* DONE: Add hunger to auto features calculations - - -* DONE: /prison placeholders list - group by placeholder type. - - -* DONE: Placeholders for items in hand: name, - - -* DONE: try out the new event priority code. if it works, apply it to all classes - - Player Cache possibilities: - * DONE: blocks per mine? - * DONE: time mining per mine? - - -* DONE: Issue with placeholders bars and rankup costs... - - -* DONE: prison should "scan" offline players upon startup and auto add anyone not already hooked up. This will help reduce a lot of questions and make the first experience with prison smoother.... - - -* DONE: Bug: placeholders are not working correctly when player is offline... - - Example with the bar graph placeholders. - - -- blockEvent - - DONE: simplify add - use common defaults - can change features with the other commands - - DONE: Add a target block name - - Not an issue: "Use of placeholders is failing %prison_ is failing on %p" Turned out they were trying to use %player% instead of {player}. - - - - -Completed for v3.2.9: - - -* DONE: BlockEvents - add block filters - tested successfully - -* DONE: decay: Add a util function to respawn the block that was mined... use it with blockEvents. - -* DONE: Ladder commands: - -* DONE: Delete by line number: - - -* **Commands - Enhancement** -DONE: Be able to select rank and mine commands for edit and deletion, or even moving, with line numbers. - - -* **Rank Commands - Edit and delete** -DONE: Add line numbers and enable the ability to edit and delete by line number. - - -* **Ladder commands - global for all ranks in that ladder** -DONE: 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. - - - - -**For v3.2.8 Release - - Preparing for Java 16** - - - * DONE: Update Gradle to most recent release - - - * On going: Review other dependencies and update them too, if possible. - - - * DONE: Update development environment, and system to support Java 16 - - - * DONE: Update XSeries to support the new block types. Updated to v8.0.0 and then v8.1.0. - - - * DONE: Enable the new block model - 73.5% are currently using v1.16.x so with the new 1.17 more people will be expecting the new blocks. - - - * DONE: Auto Refresh for language files when version detects new update is available and if auto update is enabled for that language file. - - - * DONE: In /prison version, if auto features are disabled, show NO details. - - - * DONE: Confirm duplicates on BlockBreakEvents makes sense. Fixed the BlockBreakEvents by making sure they all had their own classes so they could be identified as to what they really are. This cleaned up a lot, and also eliminated one set of duplicates too. - - - * Works: This was not an issue. Ranks info raw tag is not showing the editing formats... The rank I saw this on did not have any formatting. - - - * DONE: Fortune on all blocks is not working... - - - * DONE: Hook up java version on /prison version's plugin listings - - - * DONE: Issue with nms with SpigotPlayer... does not work with 1.17. - - Disabled when fails. No longer produces stack traces. - - -**Other additions and changes:** - - -* **Prestige Options** - - DONE: Reset money on prestige - boolean option - - DONE: Prevent reset of default ladder on prestiging. - - DONE: rankmax - keep applying rankups until run out of funds - - -- DONE: Update /prison autofeatures to include new settings. - - -- DONE: Could make /prison autofeatures reload happen. Alias: /prison reload autofeatures - - -- DONE * Mines TP warmup - - - -- DONE: * Issue with removing a BlockEvent by clicking on the remove link. It converts all of the & to the raw code. - - `/mines blockEvent remove` now uses line numbers so this is no longer an issue. - - -- DONE - Used load delays - Rare condition caused by FAWEs where prison loads before CMI even though it all configured to do so otherwise. - - May be able to provide a way to force the ranks module loading so that way it can just "assume" everything is working. - - Force the loading of Ranks module if there is a failure. Found that FAWEs is screwing up the loading sequence of prison when dealing with CMI, and as such, ranks are failing to load since CMI loads after prison. Setting softdepend for all of these do not help. - - -DONE * Add `/prison debug` targets so specific kinds of debug messages can be turned on and off so it does not flood the console with tons of irrelevant messages. - - -DONE * replace ranks with mine related commands with ranks. - - can eliminate permissions on /mtp and mine accessperms. - - -DONE * Add system stats to `/prison version` - - - - -DONE: If starting up prison and there are 0 ranks and 0 mines, then submit a delayed job that will run in 10 seconds to print out a message to console on how to run `/ranks autoConfigure` for quick setup... include link to the online docs. - - -DONE: rank commands - remove by line number - - DONE: Same for mine commands - - - - - -* **Works fine: Bug in /ranks autoConfigure??: Confirmed everything is OK... No bugs** -An admin must have messed up mine A since blocks were gone and other settings were not correct. They could have ran `/ranks autoConfigure force` after creating mine a manually. - - - -* **Rework rank permissions to eliminate need to put perms in rank commands** - - **NOTE: This was a fail!!** - - This did not work because: - 1. You cannot access group perms through bukkit - 2. You cannot create new group perms through vault - 3. It's not possible to easily check perms through vault - - This has been made obsolete with the use of Access by Rank !! -- Enhance the PermissionIntegration abstract class to also work with group perms. -- Add to ranks two new fields: permissions and permissionGroups. Save and load. -- Add a new boolean field to ranks: usePermissions. Save and load. -- Add support for these perms within rank commands -- Rewrite rankups to use these perms when ranking up, promote, demote, and also for prestiges - - - - - -
- - - -* **NOTICE - About Prison, Java 16, and Minecraft 1.17** - -Prison is all about providing the best experience for your server environment.In order to look toward the future, so we can continue to provide the best possible experience, we have to set limits on what we can actually provide support on. We are currently entering a challenging period of time where we will have to make some difficult decisions to help ensure the best possible future for Prison. - -Minecraft 1.17 is scheduled to be released on June 8th, 2021. The release of 1.17 brings with it some major changes that will have significant ripples throughout the minecraft server community, mostly due to the heavy dependency upon Java 1.8 for many years. This ultimately means there are a lot of unknowns that we will have to work through and there will be situations that were unexpected. - -One major change in our support statement is that Prison, as of right now, will only *officially* support Spigot v1.8.8 (10.9% usage), v1.12 (10.9% usage), and v1.16.5 (73.5% usage). These three versions of Spigot represents 95.3% of all servers using the Prison plugin. This does not include any server that has disabled the bstats, which is one reason why you should keep that enabled so you can be represented in our stats and our plans for the future. - -Note: The follow up versions in descending order of usage are: v1.14.4 (1.6% usage), v1.13.2 (1.2% usage), v1.15.2 (1.2% usage), and v1.11.2 (0.9% usage). No other versions are recorded by bStats. - -But please keep in mind, as with our official stance of only supporting Spigot, we will also *provide* as-needed support for Paper and other Spigot compatible platforms. We want you to have the flexibility to use the platform that best suites your needs. We just will not pre-test on those platforms, but we will try to address any issues that are brought to our attention. The non-supported versions of Spigot falls under this same limitation of support: we will not pre-test for the non-supported versions, but if you are using them and find issues, we will work with you to resolve them. The actual impact of dropping support for 1.9, 1.10, 1.11, 1.13, 1.14, and 1.15 should have no impact on quality for those releases of Spigot, but it will free up a lot of time spent on testing. - - -Some initial testing with running a prison server using Java 16: -* Spigot v1.8.8 will startup and run. But there are major failures with missing classes that are critical for the core bukkit and Java components to work properly. It is doubtful a fix will ever be provided. -* It has been noted that bukkit/spigot 1.8 through 1.11 will not work with Java 11 and later. -* Spigot v1.12.2 compiled with Java 1.8 appears to work perfectly well with Java 16 running on the server. -* Spigot v1.16.5 compiled with Java 1.8 appears to work perfectly well with Java 16 running on the server. - - -I have not tried to compile anything with Java 16 since I need to first update the Prison build environment to support it. But these are tests that will be explored in the very near future so as to get a better understanding on what we can expect from the build process. - - -In the last few days, I've updated gradle to the latest release so it will support Java 16. Other resources have been updated too. More work will be done over the next week or two to prepare for MC 1.17 and Java 16. - - -NOTE: At this time, I think there will have to be two builds. One with Java 1.8 for Spigot versions 1.8 through 1.16.5. Then another build with Java 16 that will support Spigot 1.12 through 17. This will give admins the flexibility to choose the version of Java to run on their servers that they are most comfortable with. Initially, these builds will be automated, but initially they may be a manual process. - - - -**Prison v3.2.8 will be targeted to support Java 16, and hopefully, Minecraft v1.17 too.** - - - -Java 1.8 and Java 11 have a built-in javascript engine. Java 16 does not. -This plugin provides support, and compatibility, with javascript processing. -Other plugins that use javascript, such as papi, would have to be compiled -to work with this plugin. -https://polymart.org/resource/jsengine.1095 - - - -
diff --git a/docs/knownissues_v3.3.x_resolved.md b/docs/knownissues_v3.3.x_resolved.md new file mode 100644 index 000000000..4cd3b9557 --- /dev/null +++ b/docs/knownissues_v3.3.x_resolved.md @@ -0,0 +1,1345 @@ +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +# Prison Known Issues and To Do's - Completed listings + +These have been marked as completed over the last few years, and encompasses many different versions. The original known issues doc was over 1500 lines so they are being moved to here to shorten that document + +- - - + +These known issues are an informal list of concerns and bugs. Also includes some wish-list items too. + +These are notes for personal references. These are not intended to explain anything useful, but they do track some issues and perspectives that may not be fully expressed in the change logs because initial impressions may not turn out to be the actual problem or the final course of changes and enhancements. + + +
+ + + + + +DONE - permission for prestiges not working correctly +Rayne - Today at 9:52 AM +hey @RoyalBlueRanger, so someone is trying to prestige and they can't? +there's no errors or anything and they don't get a message it worked for me when i was op +Rayne - Today at 10:52 AM +So it turns out that the ranks.rankup.prestige permission works but not the ranks.user +- NOTE: Fixed some issues with prestiges and perms. But mostly was an issue with the help not properly explaining how important the perms are. Also added a new feature to turn off the need for the presetige perms so all players can use it without the perms; they may still need to have ranks.user enabled. + + +DONE - budderman18 reports: +Budderman18 - 06/21/2023 11:56 AM +If your server runs any plugin using java 19 or higher (java 18 might be the case as well), prison won't be able to startup +- NOTE: Updated NBT-api for v1.20.1. Found out Prison's use of NBT-api was setup wrong which caused conflicts. Now working the way it should. + + + +- DONE: change BLOCKEVENTS to use MONITOR priority - PrinceHatem + +- DONE: add option to allow AIR when at MONITOR priority - PrinceHatem + - issue with when a break is canceled on RevEn such as when durability is zero. + +- DONE - Add a command usage count to commands. Then a simple report to list what commands were used, along with total command count of active commands. + + +- DONE - Expand upon the config.yml command lockout so that if the player does not have access to a command, then suppress that command from all players, including command listings. Not all commands will be able to reject access due to the nature of the commands (all access to everyone) and/or the use of alt-perms (programmatic evaluation to the commands). - Josh-65 + + + + +DONE: > noza3 - 2023-06-29 at 1:09 PM +> Thanks royal blue but i've already fixed it. Only problem I was facing was using /mtp {minename} after creating the mines, which would say this is a virtual mine blah blah, but madog told me to do a restart which fixed the issue, so I created all of my mines, set them up properly, then restarted the server and all of the /mtp {minename} works now. Also the portal at my spawn that allows people to jump into and go to their mine works, now that I use the player command /mtp with the portal. Thanks for the help +- NOTE: could not reproduce this issue. + + + +- DONE - fix gui ranks to remove italics from the rank names. This may be the gui ranks and/or the gui prestiges. - Bryton + Cannot reproduce - No italics are being added by prison. + Changed the player gui for ranks and mines so it does not add anything extra. Can now fully control all of the lore. + + +- DONE: Gui prestiges - option to remove the gui prestige button. Not sure if any of the options in the config.sys really supports that. - Bryton + + + +- Prestige - needs improvements + DONE: rewrote the prestige handling to exist in the ranks module. Everything is handled properly now. The GUI is passed the correct lore so no rankup logic is in the gui anymore. Prechecks are now enabled too. + - DONE: Confirmation does not perform any prechecks to confirm if the player can even prestige + - DONE: Confirmation does not reflect prestige settins. It always shows that rank and balance will be reset, even if that is disabled. + - DONE: It's not clear how to confirm via chat + + +- bStats: + - DONE: Remove Plugins & Prison Ladders + - DONE: Add: modules, Economy (integrations), Perms (integrations), Placeholder (intg) + - DONE: Add: Language + - Eliminate zero counts (don't report) + - DONE: validate that plugins listed in other reports are being removed from plugins a-z. + - DONE: Removed the a-z listings of plugins. + + + + +DONE - TEST: Add nbt support to gui menus. Issue with rankup not getting the correct ladder name. + - Partially added and is working. Expand to other menu options, which will be time consuming. + + +- DONE?: Archive old players - budderman18 + - archive all player files to a zip. Remove the originals. If player logs back on, then restore the archives. Prevent startup from adding these players back. + - Archiving players in topN - this may address the archive needs. Part of the issue was related to performance calculations upon startup, which the new topn does address. + + +-> DONE: Hook in to quests - Only on block break events so may not work as expected? + + + +- DONE: prison commands if using ; for multi-commands, and if a space follows ; then it's not working. + + +- DONE: The command `/rankupmax` needs to be fixed - redonthehead + - DONE: `/rankupmax`, or `/rankupmax default` is fine, but replaced getting the next rank with the new code so it works better. + - DONE: `/rankupmax prestiges` is the same as `/prestige` and `/rankup prestiges`. Change so it will go through the default ladder, then prestige, then repeat if enough money. + + +- NOT AN ISSUE: In the GUI menu, the config setting: Enchantment_effect_current_rank is off by 1. If D rank it shows E being unlocked. - CITYJD + - Looking at the code where this is used (player ranks and prestiges), the intention of this setting is to highlight the player's next rank. So the settings name is wrong... It should be `Enchantment_effect_next_rank: true` + - Locate docs that covers this topic and make a note explaing what this is for and why the settings name is wrong. + + + +- DONE: Add `*all*` to `/mines set notification` - CITYJD + - Fixed a few other commands too to provide applying the command to all mines. + + + +- DONE: Force sellall before prestiges - kikiisyourfriend + +- DONE: Auto-Forced-Rankups and prestiges when the player has enough money. Kikiisyourfriend + - a new autoFeatures entry + +- DONE: Enable Access to prior mines - kikiisyourfriend + - disable to prevent going back to prior rank mines. + - See `prison-mines.access-to-prior-mines` in config.yml + + +- DONE: prison_rank__linked_mines_rankname prison_r_lm_rankname provide a placeholder for the mine's tags. B0mer + + +- DONE: Mines tp: option to list all available mines per rank? Thaysa + + +- DONE: Option to skip applying the rank cost multiplier to a specific ladder. + + + +. DONE: Use of placeholders in gui mines is not working correctly - PassBl + - Trying to use: - '&7Test Cost P1: &3%prison_rank__player_cost_formatted_p1%' + - Using deluxe menus - may not be sending player info with placeholders? + - Fixed: complex new calculations for `prison_rank__player_cost` calculations. + + +- DONE: Mine Bomb Name and tags not showing color - Thaysa + - Works with 1.8.8 + - Fails with 1.18.2 - colors are fine in GUIs and commands + + +- DONE: Modified the `/mine blockEvent` commands to auto show the existing rows if only the mine name is entered for the command. It will show the list of rows, then the user can select it, then continue entering the rest of the command. There has been a lot of confusion on how to work with the blockEvent rows since it was not obvious they had to first "list" the blockEvents for that mine. + + +- DONE: If prison cannot hook in to the economy, prison should see if CMI is a plugin on the server, then it should try to enable the delayed startup for CMI. Kind of a forced-auto-enable if CMI is detected. + + +- DONE: Mine bombs - If at rank d and in mine w and I set off a mine bomb, it will not break any blocks, but it will lock them and prevent others at that rank from breaking them. - redonthehead + - player should not be able to "lock" blocks + - DONE: Player should not be able to drop a mine bomb in a mine they don't have access to + + +- DONE: command `/ranks topn` - does not appear to be sorting by prestiges first - redonthehead + - Fixed? Force sort when using the command each time. + - When player's rankup, should probably force a sort. + - The sorting should be somewhat low cost, since if players are in the same position, it short-circuits the sorting so there is less processing. Ie.. if nothing is sorted, it's only one quick pass. If only one player changes, then it's only moving that player. + + - DONE: Issue with topn Rank-Score. When player is at top of default ladder and has not prestiged yet. + - Rank-score looks like it's just their money balance? + + +- DONE: Sellall enablement - needs to be in module.yml, but must enable it in config.yml? + - bug in alpha.12? + + +- DONE: A placeholder in PLAYER that will show the next tag for both default and prestige. - surawesome + - but only show next prestige if on last rank in default. Default will show first rank. + - {prison_rankup_linked_rank_tag} <- [p]\\[d] + - {prison_rankup_linked_rank_tag_prestiges} {prison_rankup_linked_rank_tag_default} + +- DONE: Top block and top tokens - Phoung Nguyen + + +- DONE: When placing a mine, it spams resets while it's setting up the liner and the primary mine. May be an issue with zero block resets and having zero block counts remaining. May want to initially set the block counts to something like 1, then after the mine is done being laid out, then reset it. When it's in "tracer" mode, no blocks exist that can be broken, so a value of 1 cannot be decreased.i + + + +- DONE: percent is not being filtered from `/mines blockevent percent` and is causing errors in the formatting of the number. Percent is also not showing the list of events to get the rows... + + +- Mine Bomb Issues + - DONE: Not dropping blocks + - DONE: give bombs only works with lower case... camel case not working + - DONE: with a stack of 2 oof bombs, setting off one removes both. + - The is happening when the bomb is so large that it breaks the durability on the pseudo tool, which then removes whatever is in the player's hand when it breaks the item. + - DONE: color names for bombs do not work - xGeorge26 + - DONE: Control Y adjustment when setting the bomb. Defaults to -1. + - DONE: armorstand appears in animation when using color coded bomb name? - xGeorge26 + - DONE: Update to include more colorful names.. + - DONE: Provide a "count down" placeholder function within the armor stand bomb name?? + +- DONE: Need to externalize the time defaults... like Mine x will reset in x seconds from now. 1 seconds. - ShockCharge + +- DONE: Six - air count needs to be asynch'd since it is causing server not to respond for more than 10 seconds upon startup. + - Most mines are greater than 120,000 blocks. + + + +- DONE reload is doing NPE when blockconverters are not setup and disabled. + +- DONE mine gui - add custom lore to the configs + - DONE: can now use either `{mineName}` or `{mineTag}` and title is now rankTag too. fix using the mine tag and not mine name + +* FIXED: GUI Ladders - Perms are not checked so anyone can run these GUIs. But other than viewing the ladders, they cannot run successfully the /rankup ladder command. + + +- FIXED: autosell not working. McPingvin + + +- FIXED: Sellall signs not working when variant is other than oak. BOmer + +- DONE: placeholders are not using the time units as the mine notifications are using. Therefore, they are continuing to use english units. Need to fix the placeholders. One is `prison_mines_timeleft_formatted_Mine`. kstance + + +- DONE: add support for NBTs - mine bombs - ClumbsyIsNotReal + - having problems formatting mine bomb lore with current restrictions since it prevents bombs from working. + + +- DONE: placeholders - show next rank is skipping p1 when no p is assigned to player. xGeorge26 + + +- DONE: Many errors when prison hits a standard potion. - jamo + + +- DONE: autofeatures BLOCKEVENT priority - check for full inventory and perform sellall - Ryankayz + + +- DONE: Rankup - Still not working correctly. + - DONE: takes money but does not rank them up? + - DONE: rank changes does not alter the list of players at the ranks + + +- DONE: Top-n: hookup rank-score and penalty. + - Placeholders - hookup placeholders to support top=n players. +- DONE: Top-n balance calculations using essentials - 2 mins 31 secs - Budderman18 + - DONE: move to async thread on startup - high priority +- Top-n - phuong Nguyen +- CustomItems drops - harold +- DONE: Sellall - custom blocks/items and items that have been renamed - harold & RomainD +- DONE: sellall - no sell renamed items - RomainD +- DONE: mine bombs - fortune not using the mine bomb's pick with fortune.. always zero - RomainD + - debug is showing fortune 0 +- DONE: CustomItems - not doing drops, even when drops are set - harold +- DONE: CustomItems - Not block counting custom blocks +- DONE: Upgrade bStats to v3.0.0 +- auto features - normal drops may not be happening. May be using auto pickup code. + + + +* DONE: The function isUnbreakable could return a null for the SpigotBlock/PrisonBlock. Change it so the primary check for that function is location, then block is optional. This is failing because the bukkit block cannot be mapped to a XMaterial which should not be a factor. XMaterial will be null for custom blocks. + + +- (done ??) Placeholder bar is reversed. As the player earns more money, it shrinks instead of grows. - harold + - prison_rankup_cost_bar_default + + + +* Mine bombs: + - DONE: prison reload bombs + - DONE: validate mine bombs when initially loading... + - bomb name cannot have spaces or color formatting + - initial validation added + +* DONE: Works for me. HiPriority: Inventory full not producing any messages. alexaille + + +* DONE: HiPriority: NPCs are generating a lot of errors. Real_Ganster + - Citizens running command `mines` as player +` Prison | VaultEconomyWrapper.getBalance(): Error: Cannot get economy for player vote so returning a value of 0. Failed to get an bukkit offline player.` + - https://pastebin.com/JusySWDs + + +* DONE: HiPriority: Add a event priority of BLOCKEVENTS which only does the block events and counts. + +- DONE: **Fixed issues with vault economy and withdrawing from a player's balance.** +It now also reports any errors that may be returned. + + + +- DONE: placeholder for player blocks mined. artic1409 + - maybe use **prison_player_total_blocks__blockname** + +- DONE: update placeholderAPI with prison's updated placeholders + +- DONE: prison support submit are only sending to console, not the user if they are in game + +- DONE: When a mine reset time is disabled... it cancels/stops a /mines reset *all* + + +- DONE: when rank tag = none - was showing "null" for placeholder + +- DONE: work on getting CustomItems working in mines again + +- DONE: remove this warning message: no longer used. + 18:58:51 INFO: | Prison | Cannot initialize NMS components - ClassNotFoundException - NMS is not functional - net.minecraft.server.v1_18_R1.EntityPlayer + +- DONE: RankPlayer addBalance cache for default currency +- RankPlayer addBalance cache for custom currency - still needed! + + + - DONE: You cannot afford the rankup is using a NBSP for the thousand separator. Using Prison v3.2.11, Java 16, and spigot 1.16.5. Cannot reproduce. Was a server hosting config issue, but not sure why it only impacted that one message. + + + - DONE: SELLALL has huge performance issues! It takes 2.3 ms to autosell, and full auto features block handling is 4.2 ms!! Serious performance issue with sellall, and autosell is bypassing the command handler too! + - added 'autosellTiming:' stats to auto features autosell to track actual sell time using nano-seconds... initial tests show there maybe significant performance issues. + - autosell in auto features causing lag? Flaco21 + - Issue with autosell causing lag? + - DONE: see RankPlayer addBalance cache - 1250 times improvement! + + +- DONE: admin gui - allows them to bypass No Economy safeguards. + + +* DONE: Add commands to list shop prices in console. Currently sellall is 100% gui so cannot be used offline. + + +- DONE: lapis lazuli is not auto selling + + +- DONE: Upon startup the first time, broadcast to everyone that they should use /ranks autoConfigure. + - Broadcast failed ranks too. + +- DONE: update CMI delayed loading docs... they are "backwards" + + + - DONE: No economy error message not showing + - works on delayed startup + - Fails when not delayed - gui ranks was registering on top of ranks warning + +- DONE: /ranks autoConfigure - review setup and maybe enable skip resets and tweak some notification settings. + + + + +# TODO Items for v3.2.11-alpha.13 + + + +**Tasks needed for the v3.2.11 release:** +* Review some documentation and udpate... especially with the luckperms. +* Finalize the event listeners to use only one event (was three, now two, but reduce down to one). +* Review placeholders +* Try to hook up a top-n command - may be too complex and may need to be pushed over to the next release +* Review Mine Bombs and see if there are some simple updates +* Backpacks - may need to push over to next version +* GUI menus - Add the new GUI Tools to more of the GUI menus to simplify some of the commands? + + + +* test Mine placements and resizing. Something does not look correct with tracer and liners. + + + +* create a command placeholder that will be able to add a delay between submitting commands. Have it based upon ms.. and have it setup to be used when more than one command is combined with others. + + +* Command cooldowns - ranks - use config file to customize on a per command basis. Modify the prison command handler to manage cooldows as a new attribte to the commands. + + +* Mine Bombs: identify bombs... new way. +See SelectionManager... Prison wand uses the whole items stack to identify a wand, instead of just one small part, such as name or lore. Well, actually, its only the display name and material... no lore. + + +* Add Mine Regions - Similar to mines in a way, where they will allow players to have access to the region, have mine effects (outside of a mine)... and mine effects would also be tied to these too. + + +* Placing mines could triggers many resets... also placing mines may not clear all blocks. + + +* DONE: command handler - Ignore commands in certain worlds + + +* DONE: Player Cache - Make sure the cache is loadable otherwise a new instance may be created that could wipe out the existing data. + - All player loads block... they do not submit a task anymore. + - ~block for all loads - currently it may return a null and load via async~ + - (no) Track file last saved date and if they don't match, then create a backup of the file version and don't delete it. + + +* GUI Menu Tools + - Page prior and page next + - Current page + - Go Back button + - Background colored panes when no options + - Current version is not tied to configs... future options... + -- Hook up to more gui menus + + +* DONE: Add a base class for the mine bomb configs... + - DONE: Add a version so as to be able to auto refresh the formats + + +* New documentation - Madog's knowledge + - look for pins + + +* Add mine effects. See conversation with Madog. + - Use PlayerCache and existing utils. + - Simple to implement some features, including flying in a mine. + + +**List for v3.2.11 release:** + + +* DONE: Players need to be restructured. Move rank player object, or at least most of the core, to the core project so as to reduce the number of player types. + +* Cache player + - cache player's balance - Hmm... may need to put it in RankPlayer + - cache player's ranks... only prestiges, default + +* Top-n ranks + - total blocks mined + - total tokens earned (or currently has) + - balance + - highest rank: prestiges, default, balance + - most online time, or most mining time (which will probably be better) + + +* DONE: FIXED: Issue with blocks. Explosions are creating "untouchable" blocks that cannot be included in other explosions. + - My observations were with multiple explosions leaving rings that are within the the radius of an explosion + - I could break the blocks. + - jamo said that the pillars that were created on his server could not be broke + + + +* Review placeholders - add and test placeholders that are tied to playerCache stats + +* Mine Bombs - Finish + - Add sound and particle effects + - Other features? + - Make sure the bomb is set within a mine. Do not allow it to be placed outside of a mine. + - DONE: When exploding large bombs with block decay, there is a chance that you can get the first block in the decay as part of the drops. + - DONE: Check to make sure the block broke is the one in the target block. If not, then ignore. + - make sure the block is not "locked" + + +* Add a top 10 listing commands + - Top player on server (rank / ladder) + - Top player per mine? + - Top Player per Blocks + - Top Player per time + +* Add Block & Time requirements for rankups + - Upon rankup, player will get a new "object" that would track rankup progress + - Would record current blocks and time for that rank, which is needed for when they + prestige. The rankup Progress won't change until they rankup and it will be reset. + It's used to subtract from current stats to get "progress". + +* BackPacks & Vaults & Warehouses - rewrite + - Add PlayerCache support with integrated backpack data object to track details + - Create new gradle module for backpacks and other items. Call it something like Accessories. + - Remove hooks in the spigot module except for the code to read existing old backpacks to migrate contents. + - Backpacks are able to have pickup and sell used against them. + - Vaults are protected from pickup and sell - Have to manually move items in and out to main inventory in order to sell them. Max size limit is a double chest. + - Backpacks can be protected from pickup and sell via command, which can be used to charge players. + - Warehouses are not normal player inventory/chests. They are virtual containers for items and blocks. + - Warehouses have slots, where each slot is one item. A slot can have a dynamic amount of items it can store. The player can buy more slots in their warehouse and increase the capacity of each slot. + - Warehouses - have formula to calculate costs of slots and capacity, where prices increase on both depending upon number of slots, and total capacity size of warehouse. + - Warehouses - Initial capacity of 5 slots, each at 100 to 200 capacity. + - Should vaults be tied to a physical location, such a server-wide "bank"? If so, then players has to physically go there to access their vaults. Same with warehouses. A defined bank or warehouse would be similar to a mine in such it would be 3d and access would work anywhere in there. Or a given mine could be designated as a bank or mine. So like for example, mine c could be the bank so a player would have to rank up to C to access it. Then a vault could be tied to a third tier prestige or something (but those don't have physical locations, but could make it mine a) or create a new mine that is empty, then link that new mine to that prestige rank so players have access to it. + + + + + + +* Mine reset messages: Have setting to control by percent remaining in the mine. + + +* Save files do not include the block type prefix. Such as used with CustomItems. +Not sure if it needs to? Need to test and confirm if working correctly. World coordinates would be wrong if missing. + + + + +- Not sure why the following would be needed: +* Auto Features Settings : Create an API object that has the auto features settings listed. Basically this would serve as a simple cache with a life span of about 10 seconds. So if a player is mining hundreds of blocks within 10 seconds, odds are these settings will not be changing... both server config settings, and the player's permissions. Can provide helper classes that will a simple check of all these details, such as passing tool in hand to check perms for auto pickup settings for the server, the player's perms and lore on the tool. ... as an example. +- Store in the player cache object, but make transient. Refresh every 10 to 15 seconds.. maybe even 30? +- Add to the auto features event so its available there +- Change function parameters to use the event and this new object as parameters... reduces number of parms... + + + + + +* Multi-language - Unable to create a custom language file that is not within the prison jar. It's been reported by Ingrosso that cannot create a new language file that does not match a file within the jar? + + +* BlockEvent processing queue - submit blockEvents to a job queue to run in another async thread... the individual commands would have to run in a sync thread. + - This will release the block break thread faster and won't contribute to lag. + + + + +* DONE: https://github.com/PrisonTeam/Prison/issues/222 + DecimalFormat not being used correctly in saving mine data so if different Locale is used, other than EN US, then parsing the saved file can result in a failure. + - MineBlockEvent is an example of where this was a problem + - The offending sections were corrected and should now work + + +* Add option to /ranks to rename a rank. Tag too? + + + + +# Start on mine bombs + + 1. Select size of bomb. Configuration. + 1a. DONE: Identify items to use as bombs + 1b. DONE: Bomb size + 1c. DONE: Bomb explosion pattern. Currently only sphere, but could include other shapes. + 2. DONE: Select list of blocks that will be effected by bomb explosion + 3. Throw bomb, or place bomb... start processing count down. + 4. Pre-fire effects: sound & particles (low priority) + 5. fire event + 6. Post-fire effects: sound & particles (low priority) + 7. Hook up prison's event handler for prison's explosion event + + + + +* DONE: Modified /ranks list to provide this feature + - Maybe provide a /rankcost command? Show current player rank costs with rank cost multipliers applied + - /rankcost
+ + +# Features recently added for v3.2.11 + + + + + + + + + + +* DONE: New update to combine block processing results in many block.getDrops() being combined. Since they are combined, the extended fortune calculations may not work properly since it does not know how many original blocks were included. +- May need to have an intermediate object to better collect original blocks, drops, and targetBlocks. It can include some of the more basics that are not tracked, such as original block count to better calculate the fortunes. + + + +* DONE: Rewrite the `/prison utils titles` to use XSeries' title commands. XSeries only supports 1.9+ so I still need to support 1.8.8 directly within prison. + + + +* DONE: Common messaging framework so if hundreds of messages are sent, only one is displayed. Eliminate the duplicates. + + + + +* DONE: Revert a mine to a virtual mine. Maybe with the command: `/mines set area *virtual*`. Backup the mine's data file before updating and saving. + + +* DONE: the command /mines reset *all* is not working correctly. Could be an issue with the chaining not submitting the next reset since this is all done through async processes right now. + + +* DONE: Add a few more options to auto features for auto sell, such on full inventory. This was removed recently to stabilize some of the new code. + - Just refined what was already there. + + + + +* DONE: Concurrent modification error on the MineTargetPrisonBlock when resetting the mine. + tech.mcprison.prison.spigot.game.SpigotWorld.setBlocksSynchronously() (146). + Serialize Id the mine resets and provide a locking mechanism that will prevent auto features from being processed when it goes in to a reset mode. Also when in a reset mode, prevent another reset from being submitted so they cannot run concurrently or back to back. Maybe attach a cooldown to the resets too, such as 10 seconds would be long enough to prevent a runaway chained reaction. + - DONE: Create an object such as a MineStateToken that will hold the state of the mine reset (in progress, mineable, stable, usable, locked, etc... not sure proper terminology right now... or how many states), with a serial number that will be incremented on each reset. + - (on hold) Do not perform a clear on the collection of MineTargetPrisonBlocks within the mine. Just replace the collection with a new collection and let the garbage collection handle reclaiming all resources. Carefully review for possible memory leaks. May be a good idea to hold on to that collection and submit a task that runs in about 30 seconds to perform a clear on the collection to release the resources. This may be important since the target blocks contains references to the stats blocks and may not be GC'd automatically. May want to null those refs first too. + MineReset.clearMineTargetPrisonBlocks() (1799) + +* DONE: PlayerCache Time per Mine stats - not recording correctly. + +* DONE: new auto features autosell should place items in inventory that have no sell value. Items that cannot be auto sold. + + + + + +# Features recently added for v3.2.10 + + +# TODOs for v3.2.10 release: + +1. DONE: Final testing of ladder rank multipliers +2. DONE: /ranks ladder moveRank not working +3. DONE: Forced global refresh of rank multipliers when a ladder multiplier is changed. + - Should be simple + - Run as async task + - DONE: Force update when updating a ladder's multiplier - all players + - DONE: Force update when changing ranks - only targeted player +4. DONE: Add ladder base cost multiplier to /ranks autoConfigure. Start with a simple 10%. + - Include message that it's enabled and how to change it or disable it: + - /ranks ladder rankCostMultiplier prestiges 0 +5. Add to /ranks player the detail information on rank cost multipliers +6. DONE: For '/ranks autoConfigure' add an alias to '/prison autoConfigure' + +7. DONE: Change /ranks list so if non-op it does not show all the extra details. A simplified list for plain players. + +8. DONE: Liners: Some are only for later releases and do not work with 1.8.8. So need to setup something to restrict the liners that are not functional for the older releases of spigot. + +9. DONE: Hook up Prison's Explosion event. + + +### Others + +* DONE: Add a rank cost multiplier to ladders. Sum all active ranks a player has to get the total multiplier to use for rank costs. +* DONE: Fix the "next rank" value with PlayerRanks.... needs to recalc with the new rank. +* DONE: When a ladder's rate cost multiplier is changed, need to recalculate all player's multipliers. Setup a task? + + + +* DONE: /ranks ladder moveRank did not work to move from one ladder to another + +* DONE: When adding a new rank or mine, auto reload all placeholders so they pick up the new entry. + + + + + +# Features recently added since v3.2.9 + + + +* DONE: Enable and disable confirmations for prestiges + - DONE: Put in config.yml under the existing: prestiges. settings. + - DONE: Move the GUI confirm to the same group of prestiges. settings. + + + Player Cache possibilities? + * DONE: money earned per mine? + + +* DONE: Make ranks more expensive on each prestige.... + + +* NOT-AN-ISSUE: If automanager is turned off, and /prison reload automanager is ran, it will reload the settings, but the event listeners are only registered upon server startup. So if that condition happens... should display a warning indicating the server must be restarted. +- NOT-AN-ISSUE: Add a warning about event priority changes needing a server restart: +-- NOTE: these are no longer an issue since event listeners are reloaded when the auto features are reloaded. + + + +* DONE **Get new block model working** + * Start to enable and test various functions + * Add in Custom Items Integration + * Code Integration for CI - Key to specific version due to api changes + * Pull in custom blocks from CI API + * Place blocks with CI api + * Not sure how block break would work with CI api? + * Setup sellall to work with CI api + + + +DONE: - Block constraint error when there are no blocks spawned when applying min to add more... + - if rangeHigh and rangeLow are zero, or the same, then need to set the high and low values. + - May need to even set them when there are only a few? + - maybe rangeHigh and rangeLow should be the actual limits, and not the high and low range of where those blocks actually spawned? Right now it's actual spawned blocks, but if either, or both are 5000 blocks from the true limit, then the range of actual adjustments is artificially limited and narrowed. + - Maybe add 2 new fields: rangeHighLimit and rangeLowLimit that is the actual boundaries? These could be used to help normal spawning? + + +* DONE: On prison support submit mines, include /mines info a all? + +* DONE: To all headers that are displayed in prison commands, show the prison's version to the far right. + + +* CANNOT REPRODUCDE: The command /mines delete does not appear to be working - User error? + + +* DONE: Add an *all* for mine names under blockEvent add: + + +* DONE: ladder commands + + + +* DONE: On default ladder, at top rank, if prestige is enabled, then show a message that can be configured. + + +* DONE: Add hunger to auto features calculations + + +* DONE: /prison placeholders list - group by placeholder type. + + +* DONE: Placeholders for items in hand: name, + + +* DONE: try out the new event priority code. if it works, apply it to all classes + + Player Cache possibilities: + * DONE: blocks per mine? + * DONE: time mining per mine? + + +* DONE: Issue with placeholders bars and rankup costs... + + +* DONE: prison should "scan" offline players upon startup and auto add anyone not already hooked up. This will help reduce a lot of questions and make the first experience with prison smoother.... + + +* DONE: Bug: placeholders are not working correctly when player is offline... + - Example with the bar graph placeholders. + + +- blockEvent + - DONE: simplify add - use common defaults - can change features with the other commands + - DONE: Add a target block name + - Not an issue: "Use of placeholders is failing %prison_ is failing on %p" Turned out they were trying to use %player% instead of {player}. + + + + +Completed for v3.2.9: + + +* DONE: BlockEvents - add block filters - tested successfully + +* DONE: decay: Add a util function to respawn the block that was mined... use it with blockEvents. + +* DONE: Ladder commands: + +* DONE: Delete by line number: + + +* **Commands - Enhancement** +DONE: Be able to select rank and mine commands for edit and deletion, or even moving, with line numbers. + + +* **Rank Commands - Edit and delete** +DONE: Add line numbers and enable the ability to edit and delete by line number. + + +* **Ladder commands - global for all ranks in that ladder** +DONE: 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. + + + + +**For v3.2.8 Release - - Preparing for Java 16** + + + * DONE: Update Gradle to most recent release + + + * On going: Review other dependencies and update them too, if possible. + + + * DONE: Update development environment, and system to support Java 16 + + + * DONE: Update XSeries to support the new block types. Updated to v8.0.0 and then v8.1.0. + + + * DONE: Enable the new block model - 73.5% are currently using v1.16.x so with the new 1.17 more people will be expecting the new blocks. + + + * DONE: Auto Refresh for language files when version detects new update is available and if auto update is enabled for that language file. + + + * DONE: In /prison version, if auto features are disabled, show NO details. + + + * DONE: Confirm duplicates on BlockBreakEvents makes sense. Fixed the BlockBreakEvents by making sure they all had their own classes so they could be identified as to what they really are. This cleaned up a lot, and also eliminated one set of duplicates too. + + + * Works: This was not an issue. Ranks info raw tag is not showing the editing formats... The rank I saw this on did not have any formatting. + + + * DONE: Fortune on all blocks is not working... + + + * DONE: Hook up java version on /prison version's plugin listings + + + * DONE: Issue with nms with SpigotPlayer... does not work with 1.17. + - Disabled when fails. No longer produces stack traces. + + +**Other additions and changes:** + + +* **Prestige Options** + - DONE: Reset money on prestige - boolean option + - DONE: Prevent reset of default ladder on prestiging. + - DONE: rankmax - keep applying rankups until run out of funds + + +- DONE: Update /prison autofeatures to include new settings. + + +- DONE: Could make /prison autofeatures reload happen. Alias: /prison reload autofeatures + + +- DONE * Mines TP warmup + + + +- DONE: * Issue with removing a BlockEvent by clicking on the remove link. It converts all of the & to the raw code. + - `/mines blockEvent remove` now uses line numbers so this is no longer an issue. + + +- DONE - Used load delays - Rare condition caused by FAWEs where prison loads before CMI even though it all configured to do so otherwise. + - May be able to provide a way to force the ranks module loading so that way it can just "assume" everything is working. + - Force the loading of Ranks module if there is a failure. Found that FAWEs is screwing up the loading sequence of prison when dealing with CMI, and as such, ranks are failing to load since CMI loads after prison. Setting softdepend for all of these do not help. + + +DONE * Add `/prison debug` targets so specific kinds of debug messages can be turned on and off so it does not flood the console with tons of irrelevant messages. + + +DONE * replace ranks with mine related commands with ranks. + - can eliminate permissions on /mtp and mine accessperms. + + +DONE * Add system stats to `/prison version` + + + + +DONE: If starting up prison and there are 0 ranks and 0 mines, then submit a delayed job that will run in 10 seconds to print out a message to console on how to run `/ranks autoConfigure` for quick setup... include link to the online docs. + + +DONE: rank commands - remove by line number + - DONE: Same for mine commands + + + + + +* **Works fine: Bug in /ranks autoConfigure??: Confirmed everything is OK... No bugs** +An admin must have messed up mine A since blocks were gone and other settings were not correct. They could have ran `/ranks autoConfigure force` after creating mine a manually. + + + +* **Rework rank permissions to eliminate need to put perms in rank commands** + - **NOTE: This was a fail!!** + - This did not work because: + 1. You cannot access group perms through bukkit + 2. You cannot create new group perms through vault + 3. It's not possible to easily check perms through vault + - This has been made obsolete with the use of Access by Rank !! +- Enhance the PermissionIntegration abstract class to also work with group perms. +- Add to ranks two new fields: permissions and permissionGroups. Save and load. +- Add a new boolean field to ranks: usePermissions. Save and load. +- Add support for these perms within rank commands +- Rewrite rankups to use these perms when ranking up, promote, demote, and also for prestiges + + + + + +
+ + + +* **NOTICE - About Prison, Java 16, and Minecraft 1.17** + +Prison is all about providing the best experience for your server environment.In order to look toward the future, so we can continue to provide the best possible experience, we have to set limits on what we can actually provide support on. We are currently entering a challenging period of time where we will have to make some difficult decisions to help ensure the best possible future for Prison. + +Minecraft 1.17 is scheduled to be released on June 8th, 2021. The release of 1.17 brings with it some major changes that will have significant ripples throughout the minecraft server community, mostly due to the heavy dependency upon Java 1.8 for many years. This ultimately means there are a lot of unknowns that we will have to work through and there will be situations that were unexpected. + +One major change in our support statement is that Prison, as of right now, will only *officially* support Spigot v1.8.8 (10.9% usage), v1.12 (10.9% usage), and v1.16.5 (73.5% usage). These three versions of Spigot represents 95.3% of all servers using the Prison plugin. This does not include any server that has disabled the bstats, which is one reason why you should keep that enabled so you can be represented in our stats and our plans for the future. + +Note: The follow up versions in descending order of usage are: v1.14.4 (1.6% usage), v1.13.2 (1.2% usage), v1.15.2 (1.2% usage), and v1.11.2 (0.9% usage). No other versions are recorded by bStats. + +But please keep in mind, as with our official stance of only supporting Spigot, we will also *provide* as-needed support for Paper and other Spigot compatible platforms. We want you to have the flexibility to use the platform that best suites your needs. We just will not pre-test on those platforms, but we will try to address any issues that are brought to our attention. The non-supported versions of Spigot falls under this same limitation of support: we will not pre-test for the non-supported versions, but if you are using them and find issues, we will work with you to resolve them. The actual impact of dropping support for 1.9, 1.10, 1.11, 1.13, 1.14, and 1.15 should have no impact on quality for those releases of Spigot, but it will free up a lot of time spent on testing. + + +Some initial testing with running a prison server using Java 16: +* Spigot v1.8.8 will startup and run. But there are major failures with missing classes that are critical for the core bukkit and Java components to work properly. It is doubtful a fix will ever be provided. +* It has been noted that bukkit/spigot 1.8 through 1.11 will not work with Java 11 and later. +* Spigot v1.12.2 compiled with Java 1.8 appears to work perfectly well with Java 16 running on the server. +* Spigot v1.16.5 compiled with Java 1.8 appears to work perfectly well with Java 16 running on the server. + + +I have not tried to compile anything with Java 16 since I need to first update the Prison build environment to support it. But these are tests that will be explored in the very near future so as to get a better understanding on what we can expect from the build process. + + +In the last few days, I've updated gradle to the latest release so it will support Java 16. Other resources have been updated too. More work will be done over the next week or two to prepare for MC 1.17 and Java 16. + + +NOTE: At this time, I think there will have to be two builds. One with Java 1.8 for Spigot versions 1.8 through 1.16.5. Then another build with Java 16 that will support Spigot 1.12 through 17. This will give admins the flexibility to choose the version of Java to run on their servers that they are most comfortable with. Initially, these builds will be automated, but initially they may be a manual process. + + + +**Prison v3.2.8 will be targeted to support Java 16, and hopefully, Minecraft v1.17 too.** + + + +Java 1.8 and Java 11 have a built-in javascript engine. Java 16 does not. +This plugin provides support, and compatibility, with javascript processing. +Other plugins that use javascript, such as papi, would have to be compiled +to work with this plugin. +https://polymart.org/resource/jsengine.1095 + + + + + + +
+ + + diff --git a/docs/prison_changelog_v3.3.0-alpha.14.md b/docs/prison_changelog_v3.3.0-alpha.14.md index 90628eeb1..e995dab6c 100644 --- a/docs/prison_changelog_v3.3.0-alpha.14.md +++ b/docs/prison_changelog_v3.3.0-alpha.14.md @@ -4,7 +4,7 @@ ## Build logs - **[v3.3.0-alpha - Current](changelog_v3.3.x.md)** - - [v3.2.0 through v3.3.0-alpha.14](prison_changelogs.md) + - [v3.2.0 through v3.3.0-alpha.15](prison_changelogs.md) These build logs represent the work that has been going on within prison. @@ -55,6 +55,9 @@ The following are significant changes that are included in the alpha.14 release * Prison support new feature: tracking command usage along with average run times: `/prison support cmdStats`. +* Improved some of the `/prison support submit` features to include more of the newer data that prison is using. + + * Updates to a number of libraries that prison uses: placeholderApi: v2.10.9 to v2.11.2 XSeries: v9.0.0 to v9.2.0 diff --git a/docs/prison_changelog_v3.3.0-alpha.15.md b/docs/prison_changelog_v3.3.0-alpha.15.md new file mode 100644 index 000000000..80f7b0ef7 --- /dev/null +++ b/docs/prison_changelog_v3.3.0-alpha.15.md @@ -0,0 +1,290 @@ +[Prison Documents - Table of Contents](prison_docs_000_toc.md) + +## Prison Build Logs for v3.3.x + +## Build logs + - **[v3.3.0-alpha - Current](changelog_v3.3.x.md)** + - [v3.2.0 through v3.3.0-alpha.15](prison_changelogs.md) + + +These build logs represent the work that has been going on within prison. + + +# 3.3.0-alpha.15 2023-07-07 + + + +The following is a highlight of changes for the alpha.15 release since the alpha.14 release. + +-Full support for 1.20.x including the heights and blocks. + +- MineBombs - Added a new field specifically for use with item names which supports color codes. + + +- AutoFeatures - Fine tune block break priorities for custom events. New feature to process MONITOR and BLOCKEVENTS only if the current block is AIR. + + +- New feature: If invalid player access, then TP player to their current mine. Optional Setting. + + +- Expand Prison's debug block inspector: added more information. + + +- Updates to many internal libraries. + + +- Added support for silk touch + +- Added a fortune multiplier - this is used to fine tune highly OP tools so the drops can be better controlled. + +- Fix: Rev Enchants JackHammerEvent: found out that this event returns the corner blocks of a cuboid of blocks. Now calculates all included blocks to process this event correctly. + +- Sellall now partially works when ranks are disabled. + +- Fixed problems introduced when config files were manually edited incorrectly and they were injecting null values in to some properties. + +- Fixed how NBT-api is being shadowed and used to get it to work properly with Spigot 1.20.x. + +- Minor fixes and enchancements: blockEvents, autoFeatures and monitor priorities, GUI Player Mine config options, prevent GUI configs from loading twice, when mining now can control non-prison placed blocks to pass through to be handled by bukkit, fix autosell when disabled, hooked up support for minecraft stats to track block mining, prevent zero drops if calcs are less than 1, fix sellall trying to sell an invalid stack, fix prison utils potion effects when no player is provided, support for ExaltedEconomy, able to bypass adding new players on startup, updated Prison's jar reporter to identify Java versions 19, 20, and 21, clearified help on `/rankup` and `/presetige`, update of how topN is being processed, added topN stats which reports some of the core info. + + + +- = - = - = - = - = - = - + + +**2023-07-07 v3.3.0-alpha.15 Released** + + +* **Added comments to the prison-spigot/build.gradle configs to add more descriptive comments.** +Checked the libraries and all are up to date. + + +* **Setup the topN stats to be included in the /prison version information.** + + +* **Added the language files for the three new topN messages.** + + +* **Update the topN command to eliminate the use of the save file.** +All players are dynamically loaded by the refresh task. Stats have been added and are not a new option for the command. +To act as a form of debugging feature, the save of the topN data has been disconnected from the current process. + + +* **Updated ItemsAdder from v3.2.5 to v3.5.0b** +because github's build was failing to find v3.2.5 online and was killing the prison build. + + +* **Update topN Stats.** This is not the same as topNPlayers and this is not yet being used. +This tracks topN on blocks mined, tokens, and the player's ranks and balances. +The comparator was not correct and was fixed. + + +* **MC 1.18 new world height support.** +Prison now supports the newer world heights as found in mc 1.18.x and newer. +The new range for Y is from -64 to 320. + + +* **Bug fix: found that under a rare situation that it was trying to use an empty String with decimal formatting.** +This was found while testing some placeholders while players were offline. + + +* **I made a mistake when adding the new feature to skip player scans on startup.** +I added a new root perm in config.yml that started with `prison-ranks` when `ranks` already existed. Therefore, I changed the defaults in config.sys to fix this and changed the code to allow the old version of the config (the bad version) and the newer version. + + +* **Changes to the help for `/rankup` and `/prestige` commands to make it a little more clearer** as to what is expected with perms and to provide more details. +Added a new config setting to disable the need to use the prestige perm `ranks.rankup.presetiges` which may make it easier to get presetiges working on most servers. +Prestiges still requires the use of the `ranks.user` perm which is the same perm used for `/rankup`. + + +* **Updated the PrisonJarReporter tool to include java versions 19, 20, and 21.** +Also fixed a bug in which if the version signature is not known, then it was returning a null. Now it returns an enum of type "JavaSE_UnknownVersion" which will prevent future errors. + + + +* **2023-06-20: Version 3.3.0-alpha.14c released** + + +* **Totally stupid change: github's compiler forgot how to use overloaded functions so it was trying to use the wrong one.** +Renaming the function should help it's anti-AI skill sets. + + +* **Fixed the way prison was using the nbt-api.** +Now using the correct repo and the newer API functions. + + +* **Trying to get nbt-api setup properly with shadowing.** It looks like it's correctly shadowed, but it's being improperly reported as not being shadowed. I have a conversation with the developer open to figure out what's going on with this issue. + + +* **Update the item-nbt-api library to v2.11.3 from v2.11.2.** +Turned out the maven repo they actually use was not mavencentral.com, of which, has not yet pulled in the updated version. Using the correct repo now. + + +* **Update libraries:** +Update bstats from v3.0.0 to v3.0.2. +Update XSeries from v9.2.0 to v9.4.0. +Update vaultAPI from v1.7.0 to v1.7.1. + + +* **Changed config.yml to be able to bypass the add new player at prison startup.** This would be more related to servers that already have a large player base when they switch to this plugin. +NOTE: It's not possible to fully test all conditions where a player object may be null. Use at your own risk if you do not allow prison to scan for new players at startup. If an error is found, please contact support ASAP in our discord server so we can get it fixed for you. + + +2023-06-13 : +* **Update how the player objects are written when dirty.** There were some situations where the RankPlayer object would be written to the file system 2 or 3 times for one change. +The logic of how things are nested remains the same (to minimize breakage of the code), but the RankPlayer is not utilizing a dirty flag internally so if it's saved once, it skip the other attempts to save without changes. + + +* **Simple example illustrating the weakness of doubles with large values.** + + +* **Update nbt api to v2.11.2 from v2.11.1** + + +* **Added ExaltedEconomy to the soft depends so prison will wait until it is loaded before trying to startup.** 2023-05-24 + + +* **Fixed an issue that if the prison config files are manually modified and as a result, the block events cannot be parsed, this fix prevents a null value being inserted in to the loaded block events.** +For example, a trailing comma would produce a null block event because the parser that prison uses will read the comma, then with nothing else following it, it injects a null in to the collection of raw data for the block events. Then when that raw data is parsed, it passed along that null as a valid block event. The fix, prevents any of the nulls from being added to the active block events. + + +* **A sellall gui message that was supposed to say that the gui was not enabled only said sellall was not enabled. Added a new message to clearly state it's the gui that is not enabled.** + + +* **Get part of sellall to work if ranks are disabled. The command /sellall sell works, but the other sellall commands need to be tested and fixed.** + + +* **Bug fix: bstats and topn was using the wrong function to check to see if ranks were enabled.** + + +* **Fixed an issue when cannot get a player from bukkit** + + +* **AutoFeatures bug fix: If normal drops is enabled (no auto pickup), and sellall was disabled, then normal drops were being disabled.** +The location of checking for if sellall was active was in the wrong location, which was preventing prison from actually dropping the blocks for the player. + + +* **Fixed an issue with prison utils potions where if the player was null, then it was throwing an NPE. ** + + +* **AutoFeatures: Rev Enchants JackHammerEvent: Bug fix: The jackhammer event was not returning a list of all of the blocks involved in the event, which could be excluding hundreds if not more than 1000 blocks.** +The fix, uses the two points to calculate which blocks to include, and then include them through that cuboid instead of getting a list of blocks from the event. + + +* **BugFix: Fixes an issue with sellall where it is trying to sell an invalid ItemStack.** +As a result, the sellall pays the player for the itemstack but the itemstack is not removed. This fixes it by not trying to sell the questionable itemstacks. + + +* **AutoFeatures: Add a bukkit drops multiplier which is applied to the bukkit drops before the fortune calculations are performed.** +This can be used to reduce the total number of drops if a value less than 1.0 is used. A value of 1.0 does nothing. A value greater than one will increase the bukkit drops. All values are floored and are integers. + + +**Update to v3.3.0-alpha.14b** 2023-02-26 + + +* **AutoFeatures bug fix: If global fortune multiplier is set to a value lower than 1, then there is a risk of zero drops; this prevents zero drops and returns a drop of one.** + + +* **Fixed an issue with the initial event check for events that will break multiple blocks.** +The issue is that the initial check will ignore the event if the primary block is air. The issue is that since the events are fired based upon the BlockBreakEvent then the odds of the primary block is AIR is very high. So for those events, the primary block should not be checked for AIR to be bypassed. This fix allows things like explosions to work. + + +**Update to v3.3.0-alpha.14a** 2023-02-25 + + +* **Enhanced the debug reporting for fortune calculations and fixed a few uses of the newer fortune settings, some of which were used in the wrong locations.** + + +* **Updated the formatting on the prison's mine wand for debug reporting of which blocks are clicked on.** +The information has been cleaned up to be easier to read and follow. It's now being logged in the console too so the details can more easily be reported back for troubleshooting. + + +* **Updated the auto features config file to include the ACCESS priorities in the list of priorities so its better understood what the real options are.** + + +* **Enhanced some of the auto features logging related to fortune, silk touch, and event and drop canceling to eliminate ambiguity and provide more specific details.** + + +* **Fixed an issue with player counts being doubled. Counts should no longer be done within the auto pickup or the normal drops... it's being handled at a higher level for consistency with other priorities.** + + +* **Added a fortune multiplier that is applied to all fortune calculations, which allows for increasing or decreasing the results of the fortune.** + + +* **French support added by Maxcension. Thanks Maxcension!** + + +* **Move the check for access to the OnBlockBreakMines.ignoreMinesBlockBreakEvent so it is logged with the other conditions.** + + +* **Setup minecraft statistics so prison can report block mining through a new setting within the auto features.** + + +* **Enable silk touch enchantment by dropping the actual blocks that are being broke.** +If alt fortune is being used, then fortune will apply to these silked drops. +If players place silked blocks back in the mines (fi that feature is enabled), prison will ignore those blocks and won't break them... it will let bukkit or another plugin deal with them, but it will not apply any fortune to them. + + +* **Bug Fix autosell: was trying to access autosell when it was disabled.** + + +* **Update google gson (json IO tool) from v2.8.6 to v2.10.1** + + +* **Update google guava from v19.0 to v31.1-jre. Guava is used for internal event listeners.** + + +* **Prison Debug Block Inspector: Expand and enhanced the prison tool to provide an inspection of the block break events.** +Added event block details and drops being canceled for each listener. Reformatted to make it easier to read. + + +* **Remove the optional from getModule functions since java 17.0.6 was failing.** +Not sure if it's an actual java issue, or a problem caused by another plugin, or etc... this works well with java 17.0.2. + + +* **Minor improvements to the EventResultsReasons to show a success and more detailed debug logging.** + + +* **Relocate the ACCESS failure which will trigger a TP to an accessible mine...** +this is relocated because it's not an event, but a behavior triggered by an event condition. + + +* **Setup a temp test to test ItemsAdder.** + + +* **AutoFeatures: new feature to process MONITOR and BLOCKEVENTS only if the block is AIR.** +The reason for this is that if we are monitoring a blockbreak event, then we can assume that the block should be AIR. This setting is important for enchantment plugins handling the block break events, since a non-AIR value would indicate that the player was not successful in breaking the block. +Added more detailed debugging logging if the event is fast-failed or under normal conditions. + + +* **Change the block break priority BLOCKEVENTS to MONITOR. Updated the docs too.** + + +* **Add new autoFeature setting to allow non-prison placed blocks to be handled by bukkit: ifBlockIsAlreadyCountedThenCancelEvent: true. (default setting).** +Prison was canceling the event if it found a block placed in the mine that it did not place during a mine reset. This would allow players to place blocks and then remove them if they have the worldguard perms to do block breaks. +These blocks are not tracked in prison and are not handled. Prison just ignores them. + + +* **Fixed the gui config which it needed to load after loading ranks and mines. So it's initialized a second time in the startup process.** + + +* **Gui Player Mine config settings: Added `Options.Mines.MaterialType.NoMineAccess` which defaults to REDSTONE_BLOCK.** +If it does not exist in a player's GuiConfig.yml file, it will now be auto added. +Also if the `Options.Mines.MaterialType` block list of material types to use for each mine does not exist, it will auto add them, using the first block in the mine's block list. + + +* **Some adjustments to AutoFeatures and monitor priority... it was processing block events under some conditions.** + + +* **Mine BlockEvents: Enables the use of pipes in commands and messages now.** + + +* **MineBombs: Added a new field specifically for the item name for the bomb.** +The mine bombs now auto load upon startup and will auto update now if there is a change in mine data versions. + + +* Changed the example world names in the config.yml file where Prison is disabled. Too many people were running in to the problem where they just happened to have those worlds, and that's where they were trying to use prison. So they were thinking Prison was not working instead of Prison being disable in those worlds because that's what was in the configs. + + + + diff --git a/docs/prison_changelogs.md b/docs/prison_changelogs.md index b39762745..2a221dcc9 100644 --- a/docs/prison_changelogs.md +++ b/docs/prison_changelogs.md @@ -1,8 +1,19 @@ [Prison Documents - Table of Contents](prison_docs_000_toc.md) -## Prison Build Logs for v3.3.x +## Prison Change Logs for v3.3.x -## Build logs + +## Known Issues + +These are internal notes that may initially record ideas and issues. They may not +reflect the final actions taken as expressed in the change logs below, so these +may be insightful in to some of the evolutionary processes. + +* [Known Issues - Open](knownissues_v3.2.x.md) +* [Known Issues - Resolved](knownissues_v3.2.x_resolved.md) + + +## Change logs These build logs represent the work that has been going on within prison. @@ -10,6 +21,7 @@ These build logs represent the work that has been going on within prison. - Future updates will be under the v3.3.x release + - [v3.3.3-alpha.15 - 2023-07-07](prison_changelog_v3.3.0-alpha.15.md) - [v3.3.3-alpha.14 - 2023-01-23](prison_changelog_v3.3.0-alpha.14.md) diff --git a/docs/prison_docs_000_toc.md b/docs/prison_docs_000_toc.md index b9b9c3e19..2221917bd 100644 --- a/docs/prison_docs_000_toc.md +++ b/docs/prison_docs_000_toc.md @@ -9,7 +9,9 @@ * **[Prison README](prison_readme.md)** High level information, plus how to use with gradle builds. * **[Prison License](prison_license.md)** GNU General Public License * **[Prison Change logs](prison_changelogs.md)** Detailed changes to prison. -* **[Prison Known Issues](knownissues_v3.3.x.md)** Known Issues and To Do's. +* **[Prison Known Issues - Open](knownissues_v3.3.x.md)** Known Issues and To Do's. +* **[Prison Known Issues - Resolved](knownissues_v3.3.x_resolved.md)** Resolved Known Issues and To Do's. + * **[Prison Discord Server](https://discord.gg/DCJ3j6r)** Get help here. @@ -27,12 +29,12 @@
-# Prison Supports Spigot 1.8 through Spigot 1.19.x -# Prison Supports Java 1.8 though Java 19 +# Prison Supports Spigot 1.8 through Spigot 1.20.x+ +# Prison Supports Java 1.8 though Java 20+ # Prison is created for the Spigot Platform, and works on other platforms based upon Spigot -Prison supports Spigot 1.19.x, along with Java 17 and 18. At this time there hasn't been any reports of incompatibilities. Since prison is using a library to support the correct blocks for the version of the server that you are running, we are limited to when updates are released for that library. Luckily they have had a couple of releases and we have applied them to the latest alpha releases. So if you are wanting to maximize the new Spigot 1.19 experience, please upgrade to the latest alpha release as found on our discord server in the #alpha channel. +Prison supports Spigot 1.20.x, along with Java 1.8 through Java 20. At this time there hasn't been any reports of incompatibilities. Since prison is using a library to support the correct blocks for the version of the server that you are running, we are limited to when updates are released for that library. Luckily they have had a couple of releases and we have applied them to the latest alpha releases. So if you are wanting to maximize the new Spigot 1.20 experience, please upgrade to the latest alpha release as found on our discord server in the #alpha channel. ### Newer features and updates in Prison: diff --git a/docs/prison_docs_012_setting_up_prison_basics.md b/docs/prison_docs_012_setting_up_prison_basics.md index 2429d4229..0dee13510 100644 --- a/docs/prison_docs_012_setting_up_prison_basics.md +++ b/docs/prison_docs_012_setting_up_prison_basics.md @@ -7,7 +7,7 @@ This document provides a quick overview on how to install Prison and get it running. -*Documented updated: 2023-01-14* +*Documented updated: 2023-01-28*
@@ -196,22 +196,42 @@ But perhaps the biggest reason why I dropped support for MVdW is because it's 10 ### Enchantment Plugins -* **CustomItems** - Recommended - Premium Plugin - Allows for the use of custom blocks within Prison. This provides for a great deal of customizations, including custom textures for your custom blocks. Prison supports CI at about 95% or more. If you need additional support added for CI, please contact Blue and he will add it for you. +* **CustomItems** - Recommended - *A Premium Plugin* - Allows for the use of custom blocks within Prison. This provides for a great deal of customizations, including custom textures for your custom blocks. Prison supports CI at about 95% or more. If you need additional support added for CI, please contact Blue and he will add it for you. [https://polymart.org/resource/custom-items.1](https://polymart.org/resource/custom-items.1) -* **TokenEnchant** - Recommended - Premium Plugin - This is one of the few recommended premium plugins that we would recommend, but it works very well with prison. It took a lot of effort to get this to work with Prison, but is perhaps the most supported one too. Keep in mind that it is premium and they also charge for other add on features, so the initial cost may not be your final cost. +* **TokenEnchant** - Recommended - *A Premium Plugin* - This is one of the few recommended premium plugins that we would recommend, but it works very well with prison. It took a lot of effort to get this to work with Prison, but is perhaps the most supported one too. Keep in mind that it is premium and they also charge for other add on features, so the initial cost may not be your final cost. [https://polymart.org/resource/tokenenchant-1-7-10-1-17.155](https://polymart.org/resource/tokenenchant-1-7-10-1-17.155) -* **Prison Enchants** Newest supported enchantment plugin supported. More information will be added soon. +* **Prison Enchants** Newest supported enchantment plugin supported. * **Crazy Enchantments** - Optional - Some support is provided for Crazy Enchantments, but it may not be at 100% in all areas. This is an open source project and supports Spigot 1.8 through 1.16. [https://www.spigotmc.org/resources/crazy-enchantments.16470/](https://www.spigotmc.org/resources/crazy-enchantments.16470/) -* **RevEnchants** - Prison now supports RevEnchants through their ExplosiveEvent and JackHammerEvent! To enable prison to work better with RevEnchants, you can enable it within the `autoFeaturesConfig.yml` file. Prison supports RevEnchants v11.2 or newer. It may work with older versions, but if there are issues, we cannot provide support if the older version of RevEnchants is missing either of the events. +* **RevEnchants** - *A Premium Plugin* - Prison now supports RevEnchants through their ExplosiveEvent and JackHammerEvent! To enable prison to work better with RevEnchants, you can enable it within the `autoFeaturesConfig.yml` file. Prison supports RevEnchants v11.2 or newer. It may work with older versions, but if there are issues, we cannot provide support if the older version of RevEnchants is missing either of the events. + +To use RevEnchant's block break handling, prison needs to just monitor the events so it can update the block counts. This is an example of what settings are needed if you are using Prison's Block Events. + +```yaml + blockBreakEventPriority: ACCESSBLOCKEVENTS + + RevEnchantsExplosiveEventPriority: BLOCKSEVENTS + RevEnchantsJackHammerEventPriority: BLOCKEVENTS +``` + +Or if you are not using Prison Block Events, then just MONITOR should be used for better performance. + +```yaml + blockBreakEventPriority: ACCESSMONITOR + + RevEnchantsExplosiveEventPriority: MONITOR + RevEnchantsJackHammerEventPriority: MONITOR +``` + +**Please note:** These settings may also apply to the other enchantment plugins if you do not want to use Prison's block handling. @@ -223,22 +243,24 @@ Warning: People have paid for this plugin only to find out after the fact that i If you purchase this plugin to use on your server, do so with great caution since it is not supported and it may not integrate with prison. [ * Not supported * Tokens * Not supported * ](https://www.spigotmc.org/resources/%E2%9A%A1%EF%B8%8F-tokens-%E2%9A%A1%EF%B8%8F-40-enchantments-%E2%AD%95-free-expansions-%E2%AD%95-25-off.79668/) +**Please Note:** There is another plugin by the same name "Tokens" that strictly deals with tokens and not enchantments, which works just fine with prison. + ### Enchantment Plugin Features Supported This table of supported Enchantment Plugins are plugins that have an event that Prison is able to hook in to for the purpose of communicating multiple block breakage. It should be noted that all of these events are related to block breakage, and originate from the original bukkit's **BlockBreakEvent**, but the other plugins takes the single block, then applies "effects" that expands the one block breakage to multiple blocks. These events are the mechanism for conveying the list of included blocks to Prison so Prison can do what it needs to do with the blocks. -| Plugin | Event | Settings ID | Cancel
Events | Cancel
Drops | External
Hooks | -| --- | --- | ----------- | :---: | :----: | :----: | -| Bukkit/Spigot | **BlockBreakEvent** | `blockBreakEventPriority` | **Yes** | **Yes** | **Yes** | -| Prison | **ExplosiveBlockBreakEvent** | `ProcessPrisons_ExplosiveBlockBreakEventsPriority` | **Yes** | *No* | *No* | -| TokenEnchant | **TEBlockExplodeEvent** | `TokenEnchantBlockExplodeEventPriority` | **Yes** | *No* | *No* | -| CrazyEnchants | **BlastUseEvent** | `CrazyEnchantsBlastUseEventPriority` | **Yes** | *No* | *No* | -| PrisonEnchants | **PEExplosionEvent** | `PrisonEnchantsExplosiveEventPriority` | **Yes** | *No* | *No* | -| RevEnchants | **ExplosiveEvent** | `RevEnchantsExplosiveEventPriority` | **Yes** | *No* | *No* | -| RevEnchants | **JackHammerEvent** | `RevEnchantsJackHammerEventPriority` | **Yes** | *No* | *No* | -| Zenchantments | **BlockShredEvent** | `ZenchantmentsBlockShredEventPriority` | **Yes** | **Yes** | **Yes** | +| Plugin | Event | Settings ID | Cancel
Events | Cancel
Drops | External
Hooks | ACCESS
Priority
Supported | +| --- | --- | ----------- | :---: | :----: | :----: | :----: | +| Bukkit/Spigot | **BlockBreakEvent** | `blockBreakEventPriority` | **Yes** | **Yes** | **Yes** | **Yes** | +| Prison | **ExplosiveBlockBreakEvent** | `ProcessPrisons_ExplosiveBlockBreakEventsPriority` | **Yes** | *No* | *No* | *No* | +| TokenEnchant | **TEBlockExplodeEvent** | `TokenEnchantBlockExplodeEventPriority` | **Yes** | *No* | *No* | *No* | +| CrazyEnchants | **BlastUseEvent** | `CrazyEnchantsBlastUseEventPriority` | **Yes** | *No* | *No* | *No* | +| PrisonEnchants | **PEExplosionEvent** | `PrisonEnchantsExplosiveEventPriority` | **Yes** | *No* | *No* | *No* | +| RevEnchants | **ExplosiveEvent** | `RevEnchantsExplosiveEventPriority` | **Yes** | *No* | *No* | *No* | +| RevEnchants | **JackHammerEvent** | `RevEnchantsJackHammerEventPriority` | **Yes** | *No* | *No* | *No* | +| Zenchantments | **BlockShredEvent** | `ZenchantmentsBlockShredEventPriority` | **Yes** | **Yes** | **Yes** | *No* | @@ -248,6 +270,8 @@ This table of supported Enchantment Plugins are plugins that have an event that 3. **External Hooks** refers to custom hooks in to mcMMO, EZBlock, and Quests. See config settings within **AutoFeaturesConfig.yml**. It's strongly suggested to use **Cancel Drops** instead so you won't have to enable these features. These provides a hacky-fix for the limitations when using **Cancel Events** and may not be perfect. 4. Zenchantments is flexible in how it's **BlockShredEvent** works, mostly because it extends the bukkit **BlockBreakEvent**. The events can possibly mix with normal **BlockBreakEvent**s. 5. It may take some effort to find the ideal priorities to use for your environment to ensure everything works as you envision it. +6. **ACCESS Priority Supported*** only the **BlockBreakEvent** should be used with the ACCESS, ACCESSBLOCKEVENTS, or ACCESSMONITOR. All events supports the use of ACCESS, but only the first block in their list is check. Therefore it really won't be ideal. Plus all of these events originate through the **BlockBreakEvent** so if that is checking ACCESS then it should be sufficient. + ### Event Listener Priorities @@ -255,30 +279,47 @@ This table of supported Enchantment Plugins are plugins that have an event that The above listed supported Events are assigned one of the available Prison Event Priorities. This table illustrates what features are associated with each priority, which can be somewhat complex and confusing. -| Priority | Access | In
Mine | In
World | Ignores
Canceled
Events | Block
Break | Block
Count | Reset
Threshold | Block
Events | Mine
Sweeper | AutoSell | -| --- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| DISABLED | *No* | *No* | *No* | *No* | *No* | *No* | *No* | *No* | *No* | *No* | -| ACCESS | **Yes** | **Yes** | *No* | *No* | *No* | *No* | *No* | *No* | *No* | *No* | -| ACCESSBLOCKEVENTS | **Yes** | **Yes** | *No* | *NoYes* | *No* | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | -| ACCESSMONITOR | **Yes** | **Yes** | *No* | *NoYes* | *No* | **Yes** | **Yes** | *No* | **Yes** | *No* | -| LOWEST | **Yes** | **Yes** | *No* | *No* | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | -| LOW | **Yes** | **Yes** | *No* | *No* | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | -| NORMAL | **Yes** | **Yes** | *No* | *No* | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | -| HIGH | **Yes** | **Yes** | *No* | *No* | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | -| HIGHEST | **Yes** | **Yes** | *No* | *No* | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | -| BLOCKEVENTS | *No* | **Yes** | *No* | **Yes** | *No* | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | -| MONITOR | *No* | **Yes** | *No* | **Yes** | *No* | **Yes** | **Yes** | *No* | **Yes** | *No* | -| *priority temp* | Access | In Mine | IN Wrld | IgCanEv | Blk Brk | Blk Cnt | ResetTh | BlkEvnt | MineSwp | AutoSel | +* **DISABED** - The event is not enabled within Prison's event monitoring. The event will not be included in the command `/prison support listeners blockBreak` command. + +* **ACCESS** - Access uses the identified block within the event to identify which mine the player is in, and if the player has access to the mine. This Prison priority will run at the bukkit priority of `LOWEST`. If the player does not have access, then the event is canceled. If the event has more than one block in the event, and it does not specifically identify which block was broken, it will use the first block in the provided block list. Therefore, it may make the most sense that this priority, and it's variations, are best suited to be used with the Bukkit/Spigot's **BlockBreakEvent** since all other events originate through this event. + +* **ACCESSBLOCKEVENTS** - Same as ACCESS in that it generates a listener that for just mine access, but it also creates another listener for BLOCKEVENTS. This will be seen as two different listeners. + +* **ACCESSMONITOR** - Same as ACCESS in that it generates a listener that for just mine access, but it also creates another listener for MONITOR. This will be seen as two different listeners. + +* **LOWEST** - **HIGHEST** - These are the normal bukkit event priorities. The lower the priority, then it will handle the event before other plugins with higher priorities. + +* **BLOCKEVENTS** - Same as MONITOR, but also includes the processing of the Prison Block Events and sellall (auto sell) if enabled for full inventory. This Prison priority will run at the bukkit priority of `MONITOR`. + +* **MONITOR** - Monitor performs no block handling within prison, but it will try to update the block counts. MONITOR will process the event even if it is canceled. + + +| Priority | Actual
Event
Priority | Access | In
Mine | In
World | Ignores
Canceled
Events | Block
Break | Block
Count | Reset
Threshold | Block
Events | Mine
Sweeper | AutoSell | +| --- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | +| DISABLED | -note1- | *No* | *No* | *No* | *No* | *No* | *No* | *No* | *No* | *No* | *No* | +| ACCESS | LOWEST | **Yes** | **Yes** | *No* | *No* | *No* | *No* | *No* | *No* | *No* | *No* | +| ACCESSBLOCKEVENTS | -note1- | **Yes** | **Yes** | *No* | *NoYes* | *No* | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | +| ACCESSMONITOR | -note1- | **Yes** | **Yes** | *No* | *NoYes* | *No* | **Yes** | **Yes** | *No* | **Yes** | *No* | +| LOWEST | LOWEST | **Yes** | **Yes** | *No* | *No* | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | +| LOW | LOW | **Yes** | **Yes** | *No* | *No* | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | +| NORMAL | NORMAL | **Yes** | **Yes** | *No* | *No* | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | +| HIGH | HIGH | **Yes** | **Yes** | *No* | *No* | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | +| HIGHEST | HIGHEST | **Yes** | **Yes** | *No* | *No* | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | +| BLOCKEVENTS | MONITOR | *No* | **Yes** | *No* | **Yes** | *No* | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | +| MONITOR | MONITOR | *No* | **Yes** | *No* | **Yes** | *No* | **Yes** | **Yes** | *No* | **Yes** | *No* | +| *headers* | EvntPri | Access | In Mine | IN Wrld | IgCanEv | Blk Brk | Blk Cnt | ResetTh | BlkEvnt | MineSwp | AutoSel | **Notes:** -1. **DISABLED** will prevent a listener from starting, and it will prevent any processing of that event. -2. **Access** managed by Prison requires the use of Access by Rank (perferred) or Access by Perms. It also will vary in effectives based upon the priority level in relation to other plugins, where any plugin that has a lower priority than Prison will bypass Prison's attempts to control access. -3. **ACCESSBLOCKEVENTS** and **ACCESSMONITOR** are able to have a duel behavior because these priorities will create two different listeners, each at a different priority, and each having a different purpose. -4. **Block Break** refers to Prison handling the whole block break processing and drops. -5. **Mine Sweeper** should never be used unless there is no other way to count all the broken blocks. -6. Support for outside of the mine for auto features maybe added soon. The way it will probably be supported would be through a list of worlds in which it should be active, plus the use of WG regions too. -7. The **MONITOR** priority, including ***BLOCKEVENTS*** will ignore all events that have been canceled and will process them anyway. Therefore **ACCESSBLOCKEVENTS** and **ACCESSMONITOR** will fail on the "access" part if the event is canceled when Prison gets ahold of it the first time, which will deny access to the mines, but it will also still process the event under the priority of MONITOR or BLOCKEVENTS. +1. **ACCESSBLOCKEVENTS** and **ACCESSMONITOR** will run two events. One of which will be **ACCESS** which will have an actual bukkit priority of `LOWEST`. And the other listener will run a **BLOCKEVENTS** or **MONITOR** Prison priority which both will have an actual bukkit priority of `MONITOR`. +2. **DISABLED** will not have an actual event priority. **ACCESSBLOCKEVENTS** will have two processes; see actual priorities for ACCESS and BLOCKEVENTS. **ACCESSMONITOR** will have two processes; see actual priorities for ACCESS and MONITOR. +3. **DISABLED** will prevent a listener from starting, and it will prevent any processing of that event. +4. **Access** managed by Prison requires the use of Access by Rank (preferred) or Access by Perms. It also will vary in effectives based upon the priority level in relation to other plugins, where any plugin that has a lower priority than Prison will bypass Prison's attempts to control access. +5. **ACCESSBLOCKEVENTS** and **ACCESSMONITOR** are able to have a duel behavior because these priorities will create two different listeners, each at a different priority, and each having a different purpose. +6. **Block Break** refers to Prison handling the whole block break processing and drops. +7. **Mine Sweeper** should never be used unless there is no other way to count all the broken blocks. +8. Support for outside of the mine for auto features maybe added soon. The way it will probably be supported would be through a list of worlds in which it should be active, plus the use of WG regions too. +9. The **MONITOR** priority, including ***BLOCKEVENTS** will ignore all events that have been canceled and will process them anyway. Therefore **ACCESSBLOCKEVENTS** and **ACCESSMONITOR** will fail on the "access" part if the event is canceled when Prison gets a hold of it the first time, which will deny access to the mines, but it will also still process the event under the priority of MONITOR or BLOCKEVENTS. diff --git a/docs/prison_docs_107_setting_up_prestiges.md b/docs/prison_docs_107_setting_up_prestiges.md index 0f3934547..c57100e20 100644 --- a/docs/prison_docs_107_setting_up_prestiges.md +++ b/docs/prison_docs_107_setting_up_prestiges.md @@ -7,6 +7,8 @@ This document provides information how to setup and use prestiges. +*Documented updated: 2023-06-24* +
# Overview @@ -17,13 +19,15 @@ This document should be able to provide the basic information to get the built i Prestiges are generally used to track how many times a player has gone through all of the default ranks. There are many variations on how prestiges are implemented, but they area always a status symbol that sets the top players from the rest. Some features may include resetting a player's monetary balance to zero, setting their rank back to the beginning, or some other change to make the next pass through the ranks slightly different, but usually more difficult. +Please use the command `/prestige help` within the console for more information about this command.
# Enabling Prestiges -By default, prestiges are disabled and must be enabled before you can use them. Even though the prestiges feature is disabled, prison still auto generates a prestige ladder. +By default, prestiges are now enabled. They may be disabled by changing the configuration setting within the +`config.yml` file. Even if the prestiges option is disabled, Prison will generate a prestige ladder. Edit the following file: @@ -32,22 +36,197 @@ Edit the following file: plugins/Prison/config.yml ``` + +Prestiges are enabled with the settings `prestige.enabled: true`. + +``` +prestige: + enabled: true + resetMoney: true + resetDefaultLadder: true + confirmation-enabled: true + prestige-confirm-gui: true + force-sellall: false + no-prestige-value: "" + enable__ranks_rankup_prestiges__permission: false +``` + + + +Note: The following setting is obsolete, but still active for now. If you have this setting in your +existing `config.yml` file, then you can still use it. But please consider updating to the newer +settings. You can "upgrade" by ranaming `config.yml` to something else, like `config_old.yml`, and +then restart your server. A new fresh copy of the `config.yml` file will be added when the +server starts up. + Then set the following item to `true` and then save the file and restart the server. ``` prestiges: true ``` -
+# Required Permission to use the `/prestige` Command
+
+In order for players to use the `/prestige` command, they must have the follow permission:
+`ranks.user`
+
+
+This permission is not related to just `/prestige`, but enables the players to use the
+`/rankup` command too.
+
+
+This permission is a core perm for the rankup commands, and therefore the Prison command handler will
+enforce this perm on all players trying to use `/prestige`. If players do not have this perm,
+then attempts to use the command will just end silently.
+
+
+To differentiate `/prestige` from `/rankup`, at least on controlling who can use this command,
+there is a prestige specific permission that needs to be set:
+`ranks.rankup.prestiges`
+
+
+This prestige permission can actually be disabled. See the section below titled "Prestiges: Enable the use of the perm `ranks.rankup.prestiges`" for more information.
+
+
+
+
++ + + + +# Other Prestige Settings + + +Within the `config.yml` file, there are a few other prestiges settings that can help customize how +Prestiges works on your server. Please see the config settings list above. + + +### Prestiges: Reset Money + +`prestige.resetMoney: true` + + +When enabled, the player's balance will be reset to zero. + + + +
+ + + +
+ + +### Prestiges: Reset Default Ladder + +`prestige.resetDefaultLadder: true` + + +When enabled, the player's default rank will be reset to the default rank. +Generally that is Rank A as configured with the command `/ranks autoConfigure`. + +Please use the following command in the console to check for the default rank: +`/ranks list` + + + +
+ +### Prestiges: Confirmation Enabled + +`prestige.confirmation-enabled: true` + + +When enabled, the player will be required to reenter the command a second time +with the keyword `confirm` to provide confirmation that they want to prestige. +This is not a GUI option. + +``` +/prestige +/prestige confirm + +``` + +Please see the command `/presetige help` to see more information about the command usage. + +
+ +### Prestiges: Confirmation Enabled for the GUI + +`prestige.prestige-confirm-gui: true` + +When enabled, the player will need to confirm the prestige through a GUI confirmation +dialog. + + +
+ + +### Prestiges: Force SellAll + +`prestige.force-sellall: false` + + +When enabled, the player will be forced to go through a `/sellall` command process +when the prestige is successful. This is performed before the player's money is +reset if that option is enabled. + +The purpose of this setting is to clear the player's inventory and backpack so they +cannot sell all of it at the next higher rank which may provide far more money. +As an example, the if the highest default rank's mine has emerald blocks, and if they +fill up their inventory, and backpack, then after prestiging, they sell everything +at rank A, they may earn enough money to skip over a few of the lower default ranks. + +
+### Prestiges: No Prestige Value + +`prestige.no-prestige-value: ""` + + +This is a value that will be used within the placeholders for players that do not +have a prestige rank. This will be applied to the rank's name and tag value. + +Example of a placeholder that would use this setting would be +`prison_rank_laddername`. So inserting "prestige' for the *laddername* would result in: +`prison_rank_prestige`. + + + +
+ + +### Prestiges: Enable the use of the perm `ranks.rankup.prestiges` + +`prestige.enable__ranks_rankup_prestiges__permission: false` + + +When this setting is enabled, then all players who may use the `/prestige` command +would have to have the permission `ranks.rankup.prestiges`. + + +When this setting is disabled, all players will be able to use the `/prestige` +command without having to have a permission set. + + +
+ + + +
+ + + + # 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. +The prestige ladder is created by default and is named `prestiges`, even if prestiges are not enabled. Ranks can be added to the prestige 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. @@ -201,6 +380,3 @@ This command is intended for players and can be enabled, or disabled, within the
- - - diff --git a/docs/prison_docs_311_guide_automanager.md b/docs/prison_docs_311_guide_automanager.md index debd2dc93..3cbe8227f 100644 --- a/docs/prison_docs_311_guide_automanager.md +++ b/docs/prison_docs_311_guide_automanager.md @@ -14,15 +14,22 @@ See below for information on: # Auto Manager -Other content is coming soon... +AutoManager is Prison's block handler. It provides support for breaking blocks within mines, auto pickup, normal drops, fortune, mine access, block events, auto-sell, and many other features. Auto Manager has been one of the most enhanced features of Prison, and what it is capable of doing is probably more that what has been documented in this document due to the complexities involved, and the number of new features added that have not made it to this document. +Extensive work has been done with auto manager to improve the performance, and to extend the compatibility with other plugins. Many plugins have direct support (Auto Manager has event listeners for their custom events), but prison has been modified to work with many plugins that do not provide custom events too. + + +*Documented updated: 2023-02-28*
# Auto Manager Event Listener Priorities -Prison listens to a number of block break event types, and each one can be enabled or disabled. By enabling these listeners, any combination of priorities can be applied to any of the listeners. +Prison listens to a number of block break event types, and each one can be enabled or disabled. By enabling these listeners, any combination of priorities can be applied to any of the listeners. These priorities cover the standard Bukkit priorities (LOWEST to HIGHEST, plus MONITOR), but also has custom Prison priorities to extend the behaviors. + +At this time, these event listeners only apply within mines. In the near future they may be extended to work outside of mines and in other worlds too, but for now, they are only Prison mine specfic. + Valid values for the priorities are: @@ -36,12 +43,23 @@ Valid values for the priorities are: - `MONITOR` - This priority only allows Prison to record which blocks were broken in the mines. It will update the counts for the mines and the players. This setting will NOT run any Prison blockEvents. -Valid event listeners are as follows, including their default values: +- `ACCESS` - This is a new priority, where prison will check to see if a player has access to a mine, and if not, then it will cancel the block break event. If they have access, then Prison will ignore the event and will not process anything else. This `ACCESS` is designed to be used in place of WorldGuard regions if your other plugins do not require the use of WorldGuard regions. This priority does not count any block breakage. This `ACCESS` prison priority uses an event priority of `LOWEST` so it is one of the first plugins to check if a player has access to break the blocks. + +- `ACCESSMONIOR` - Same as `ACCESS` but adds a second listener to the stack for a `MONITOR` priority too. So this generates two listeners; see both `ACCESS` and `MONITOR`. + +- `ACCESSBLOCKEVENTS` - Same as `ACCESS` but adds a second listener to the stack for a `BLOCKEVENTS` priority too. So this generates two listeners; see both `ACCESS` and `BLOCKEVENTS`. + + + +Valid event listeners are as follows, including their default values. Any of the above Prison priorities can be used with the following: - `blockBreakEventPriority: LOW` - This applies to the org.bukkit.BlockBreakEvent and is the primary way Prison deals with standard block events. There may be some situations where prison would need to DISABLE this listener. - `ProcessPrisons_ExplosiveBlockBreakEventsPriority: LOW` - This is the event that must be enabled for Prison Mine Bombs to work. Other plugins may also use this Prison multi-block explosion event too. - `TokenEnchantBlockExplodeEventPriority: DISABLED` - For TokenEnchant (premium) - `CrazyEnchantsBlastUseEventPriority: DISABLED` - For CrazyEnchant (open source) +- `RevEnchantsExplosiveEventPriority: DISABLED` - For RevEnchants ExplosiveEvent (premium) +- `RevEnchantsJackHammerEventPriority: DISABLED` - For RevEnchants JackHammerEvent (premium) + - `ZenchantmentsBlockShredEventPriority: DISABLED` - For ZenChantments (open source) - `PrisonEnchantsExplosiveEventPriority: DISABLED` - Pulsi's Plugin - (Premium and free... not currently in active development for at this time) @@ -49,6 +67,24 @@ Valid event listeners are as follows, including their default values: Do not enable any event listener if you are not using that plugin. Doing so will not contribute to lag, but it will try to setup a useless event listener that could delay startup, and consume a little more memory. + + +
+ + +# Sync Tasks for Breaking Blocks + +Prison is trying its best to optimize performance so your server will have the best experience with no lag. In order to provide the best performance, some features do not always work the best on all servers due to memory limitations, processor performance, huge number of plugins, or almost any other variable which is outside of the control of Prison. Therefore, there are some performance features that work really well on some servers, but not on others. This is not a "problem" with any specific plugin, or server, but it's an expected behavior because all servers are different and they can perform in very different ways based upon configurations. + +One way Prison is able to improve performance when breaking blocks, is to process as much as it can within the block break events, except for breaking the actual blocks, and for that, prison submits a task that performs the actual block breakage. Since the act of breaking the blocks can be considerably slower than performing the calculations that lead up to the block breakage, it has been shown that by submitting the breakage as a task will improve the overall performance when you have very high over powered tools, and when there are many players online mining. + +But like everything else, there is a chance that because the block breakage is submitted as a task, that it can lead to some perceptions of lag. Its not actually causing lag on a server, but since there can be a longer delay between the calculations and the actual breaking of the blocks, it can appear as if it is lag. It's actually just a longer delay that becomes noticeable. Sometimes it's been described as it takes a while for the blocks to disappear, or the disappear for a split second, they reappear, then are removed again. This is not always related to a slow server, but can also be related to a server that has a lot of plugins that are trying to run at the same time (so the time between when the block breaks are calculated and when the submitted task to break the blocks actually runs becomes too great). + +This feature can be turned off with a simple setting change. The following is the default setting which enables the submission of the synchronized tasks. To turn it off, and to break the blocks when the listeners process the block break calculations, set this to a value of `FALSE`. + +`applyBlockBreaksThroughSyncTask: TRUE` + +
@@ -66,6 +102,9 @@ This was the original way of handling block breaks, and is the ONLY way of deali You can still cancel the events with newer versions of Spigot, but if you run in to compatibility issues with other plugins, then it may be the easiest solution. +**NOTE:** In the future, these two settings will be removed and replaced with just one setting to control what gets canceled, either the event or the drops. This will eliminate the risk of both settings being set to the same value. + + **Canceling the block break Events:** This is the default settings for Prison's Auto Features. This is the setting that must be used on Spigot versions prior to 1.12.x (Spigot 1.8.x through 1.11.x). It can also be used on newer versions of Spigot, but it may cause compatibility issues with some other plugins that need to monitor the event, which canceling the event will cause those plugins to ignore the event. @@ -84,6 +123,8 @@ options: cancelAllBlockEventBlockDrops: false ``` +*WARNING: Never set them to the same value.* + **Canceling the block drops:** @@ -106,6 +147,7 @@ options: cancelAllBlockEventBlockDrops: true ``` +*WARNING: Never set them to the same value.*
@@ -247,6 +289,78 @@ Enable by setting to any value other than `DISABLED`.
+# AutoFeatures & NormalDrops + +AutoFeatures is related to auto-pickup, auto-smelt, and auto-blocking. These are enabled with the following setting, which is on by default: + +`autoFeatures.isAutoFeaturesEnabled: TRUE` + +Please note, that these settings are "chained" together. If you disable auto-pickup, then auto-smelt and auto-block will not apply. If you have auto-pickup enabled, but disable auto-smelt, then auto-blocking is disabled too. + + +These auto features ONLY apply on priorities of LOWEST to HIGHEST. They do not apply to MONITOR, BLOCKEVENTS, ACCESS, ACCESSMONITOR, or ACCESSBLOCKEVENTS. + + +It is important to note, that this setting is a "global" setting. If it is set to `FALSE`, then it turns if off for everything, which includes the global settings, the permissions, and the lore that applies to auto-pickup, auto-smelt, and auto-blocking. + +**Global Settings** + +The following three "global" settings are on by default. This means that all players in all mines will be able to get auto-pickup, auto-smelting, and auto-blocking by default, in all mines. + +`autoPickupEnabled: TRUE` +`autoSmeltEnabled: TRUE` +`autoBlockEnabled: TRUE` + +If you do not want to apply these auto features to all players in all mines, then set the above three values to `FALSE` and then use a combination of permissions and/or lore to enable them, if desired. + + +**Permissions:** + +When using permissions for the auto features, the setting `isAutoFeaturesEnabled: TRUE` still must be enabled, but the other three "auto"s should be disabled globally. + +The default values for the perms are as follows, of which you can change the perms to anything you want them to be. + +`permissionAutoPickup: prison.automanager.pickup` +`permissionAutoSmelt: prison.automanager.smelt` +`permissionAutoBlock: prison.automanager.block` + +So any player who has these perms, whenever they are in any mine, these perms will enable auto-pickup, auto-smelt, and/or auto-blocking for them. + + +**Lore:** + +An alternative to global and perms with the auto features, is to use lore on your tools. Any tools that have these lore values will enable auto-pickup, auto-smelt, and/or auto-blocking when they are using in any Prison mine. + +The following setting must be enabled, which is set to `TRUE` by default: + +`lore.isLoreEnabled: TRUE` + +Then the following controls the lore for the auto features. These are the default values, but can be changed to "match" what is used on other enchantment plugins. The Color codes are ignored when performing the comparisons so if they vary, they should still work. + +`lorePickupValue: &dAuto Pickup&7` +`loreSmeltValue: &dAuto Smelt&7` +`loreBlockValue: &dAuto Block&7` + + +Keep in mind that any combination of Perms, Lore, or global settings will work together (global overriding everything), but `isAutoFeaturesEnabled: TRUE` must be enabled for them to work. + + + +**Normal Drops:** + +Since prison is handling the block breakage, the bukkit drops are actually disabled and will not happen. So these normal drops are enabled by default and will exist just in case the auto-pickup is disabled for the player. Keep in mind, that auto pickup can be globally disabled, and yet it can be overridden (enabled) by perms and lore. + +`handleNormalDropsEvents: TRUE` +`normalDropSmelt: TRUE` +`normalDropBlock: TRUE` + +Keep in mind, if auto-pickup is disabled for the player, and if `handleNormalDropsEvents` is also disabled, then no drops will happen even though the player "successfully" breaks the blocks. + +If auto-pickup is disabled, the the auto-smelt and auto-blocking is automatically disabled too. Hence why there is a `normalDropSmelt` and a `normalDropBlock`. + +For the `normalDropBlock` it is important to realize the blocking is based upon only the "drop" and not what is in the players inventory. So if redstone requires 9 redstone dusts to make one block, and if the player only has 8, then no blocking will happen and it will drop 8 redstone dusts. If the player has a stack of 64 redstone dust in their inventory (which has no bearing on the blocking) and they drop 14 redstone dusts, then the `normalDropBlockk` will drop ONE redstone_block, and 5 redstone dusts; their inventory has no bearing on the blocking. + + # BlockEvents - Fortune Features @@ -254,13 +368,52 @@ Enable by setting to any value other than `DISABLED`. Prison provides a few options for controlling fortune. But before those options are discussed, the process of how fortune is calculated may be a very important topic to understand since it's not a simple calculation. -Initially, prison uses Bukkit's Block.getDrops() function to get a set of ItemStacks of the drops related to the block that is being broken. These drops are not fully inclusive as you would find within a vanilla game, but are somewhat limited, and they do vary from one version of spigot to another (1.8 vs 1.16 could be drastically different). +To enable Fortune calculations within Prison, the following setting must be set to a value of `TRUE`, which is the default value: + +`fortuneFeature.isCalculateFortuneEnabled: TRUE` + + +Once fortune is enabled within Prison, there are two types of fortune calculations that can be used. Both have their own benefits, but each also has their limitations. Both cannot be be used together, as only one can be enabled at a time. + + +Both types of fortune calculations are able to use fortune multipliers, the default values are shown here: + +`fortuneMultiplierGlobal: 1.0` +`fortuneMultiplierMax: 0` +`fortuneBukkitDropsMultiplier: 1.0` + + +The `fortuneMultiplierGlobal` is a multiplier that is applied to all calculations that determine how many blocks are included in the drops. This is applied after calculating the fortune. A value of **1.0** changes none of the calculations and allows them to be applied as they are calculated. A value less than one will reduce the amount of the drops. A value greater than one will increase the value of the drops. All drops are forced to integer values (you won't get fractional drops). The lowest value that can be returned from this adjustment is ONE; cannot return a zero value. + + + +The setting `fortuneMultiplierMax` is a way to prevent OP (over powered) tools with super high fortune enchantment levels from destroying the game play, or the economy. What it does, is it sets the maximum permitted fortune level on tools, such that if a tool has a fortune level higher than that value, then the max value is used for all fortune calculations. For example, if you set it to a value of 200 and someone has a pickaxe with a fortune of 379, then all calculations will be performed with a fortune level of **200**. A max value of ZERO disables the fortune max limit and any value will be valid, even if it's well above 1000. + + +The new setting `fortuneBukkitDropsMultiplier` has a default value of 1.0 and is applied to the bukkit drops before any fortune is applied. This actually adjusts the bukkit drops so if bukkit is dropping too many items or ores compared to normal blocks, this can help reduce those amounts before the fortune calculations. This is a good way to control fortune on drops that are too plentiful since it can reduce the amount that spigot is suggesting. Use a value of 1.0 (the default) to prevent the drops from being modified. + +Use a value less than one to reduce the drops, or a value greater than one to increase the drops. The minimal result value is set to one; cannot be zero. The drops are expressed in integers and no rounding is performed so a calculated value of 1.9 will have a drop of 1. + + +The use of `fortuneBukkitDropsMultiplier` is a great way to control how much bukkit drops, to keep the drops closer to a value of one per block. And then with the use of `fortuneMultiplierGlobal` it controls how generous all the calculated drops are. A combination of settings can help reduce how many redstone drop, without hurting the normal block drops. + + + +**Extending Bukkit Drops** + + +Initially, prison uses Bukkit's Block.getDrops() function to get a set of ItemStacks of the drops related to the block that is being broken. These drops are not fully inclusive as you would find within a vanilla game, but are somewhat limited, and they do vary from one version of spigot to another (1.8 vs 1.19 could be drastically different). + + +The extended bukkit fortune calculations are enabled with the following, which is enabled by default: + +`isExtendBukkitFortuneCalculationsEnabled: TRUE` So to correct for omissions, such as a percent chance flint would be dropped with mining of gravel, and to adjust for the limited range of fortune within the vanilla server, prison has to make adjustments. -With Fortune, the standard is for fortune 1 through 3. But with OP prison setups, Prison needs to support higher fortune levels. +With Fortune, the bukkit standard is for fortune levels 1 through 3. But with OP prison setups, Prison needs to support higher fortune levels, including hundreds of levels. With a standard block break event, you break one block and you get one drop. That is standard without fortune. So the way Prison detects if fortune is applied, is if there is more than one block provided for a drop. With fortune 3 being the highest possible level to influence the drops, Prison checks the tool to see what it's fortune level is, then uses that within the calculations. @@ -272,10 +425,36 @@ So if the tool has a fortune level of three or less, then Prison does nothing wi The way prison extends the drops for higher fortune levels for tools with a fortune over three, is to divide the standard drop by three (since it maxes out at three), then multiplies that value by the actual fortune level on the tool. The reason is that all of the random variables that went in to calculating the standard drop have already been applied, so all that needs to be done is to extend the total drop amount to cover the tool's actual fortune level. Since a fortune 3 has a higher chance to adding more to the drop compared to a fortune 1, then we can assume those random chances are reflected in the standard drop. This also means prison should not apply a random chance to the drops since that chance was already applied. -One issue with extending the fortune on the standard drops is that the amounts can appear to be much higher than what would be expected. So prison provides a way to apply a multiplier to the results to pull down that generated value. +One issue with extending the fortune on the standard drops is that the amounts can appear to be much higher than what would be expected. So prison provides a way to apply a multiplier to the results to adjust the generated values so the drops have more variability. There are two settings that allow you to control the calculated range of drops. With the bukkit drops being at 100 percent, these two allow you to extend the drops to become a percentage range, such as 70 percent to 110 percent (the default values). + +`extendBukkitFortuneFactorPercentRangeLow: 70` +`extendBukkitFortuneFactorPercentRangeHigh: 110` + + +So if a given pickaxe's OP fortune always drops 50 diamonds when mining DIAMOND_ORE, this will allow it to change the range of the drops from 35 (50 * 0.70) to 55 (50 * 1.10) diamonds, which provides a greater variability in what is being dropped. Keep in mind that bukkit will have a slight variability in the drops, but they will fall in to about 3 to 5 different values, and when extended, will still be only 3 to 5 different values. So this extendedBukkitFortuneFactor range prevents the same quantity for each drop. + + + +**Prison's Alternative Fortune Calculations** + +If you want to use the alternative fortune calculations, then you need to disable the above `isExtendBukkitFortuneCalculationsEnabled: FALSE` and then enable it with the following setting, which `FASLSE` is the default value. +`isCalculateAltFortuneEnabled: FALSE` -**If Auto Pickup is enabled** +The limitations of the bukkit fortunes, is that they will never apply fortune to some blocks, such as diamond_block, emerald_block, or other solid blocks that may not be naturally occurring in the wild. + + +The alt fortune is initially based upon the bukkit drops. Therefore there is a risk that ores, such as redstone or lapis, could drop huge amounts when processed by the alt fortune. This can be controlled by the `fortuneBukkitDropsMultiplier` to lower the range of the bukkit drops, and also use `fortuneMultiplierGlobal` to adjust the final calculations. + +The alt fortune calculations are based upon the formulas provided within the Minecraft Wiki's for standard fortune levels. The big difference is that it applies to all blocks, not just a select few. But some blocks, such as diamond_ore and redstone_ore, gets higher multipliers as with their vanilla counter parts. Also Prison's alt fortune provides higher fortune levels and will support an unlimited high fortune. + + +Remember that the settings for `fortuneBukkitDropsMultiplier`, `fortuneMultiplierGlobal` and `fortuneMultiplierMax` apply too, so you can have some better control over the overall drop amounts. + + + + +**Some general notes to better explain the logic of how the extended bukkit fortune is calculated:** * Bukkit's Block.getDrops() * If drops == 1 then no fortune has been added. @@ -287,41 +466,100 @@ One issue with extending the fortune on the standard drops is that the amounts c * Formula: raw_adjusted_drops x -**If Auto Pickup is disabled, and Process Normal Drops is Enabled** +
-
+# Durability Calculations (Wear) +By default, Prison does not apply any durability (wear) to the tools that are being used within the mines. The reason Prison does not apply wear by default, is that it depends upon the version of spigot that you are running on your server, or the flavor of spigot (paper). Sometimes bukkit handles the wear, sometimes it doesn't. If bukkit is applying the wear, and you enable it within Prison too, then a tool can actually wear out twice as fast as it normally should wear out. So to error on the safe side, Prison will not enable durability calculations by default. +`durability.isCalculateDurabilityEnabled: FALSE` -# BlockEvents - Silk Touch Features +To enable it, set the value to `TRUE`. +When it is calculated to apply wear to the tools, it only adds 1 to the total durability on the tool. When the durability, or wear, exceeds the max durability level for the tool, then the tool will break. + +The tool's durability level will impact, and reduce, the chance to add wear to the tool. Also if the tool has the Durability Resistance enchantment, levels 1 through 100, it too will make it more difficult to add wear to the tool. If the Durability Resistance enchantment has a level of 100 (or no specified level assumes to be 100), then no wear will ever be applied to the tool. +To prevent Prison from breaking the tool when it wears out, set the following configuration settings: + +`isPreventToolBreakage: FALSE` +`preventToolBreakageThreshold: 10` + +If `isPreventToolBreakage` is enabled, then prison will not allow a tool with a threshold of the specified value, or less, to break any blocks. If a player tries, nothing will happen. Also the tool will not be worn down any more, and it will remain at that threshold value. + +The reason why there is a threshold value, is to prevent the tool from reaching ZERO and having some other plugin, or the vanilla bukkit, break the tool. It's an insurance policy to help prevent the tool from breaking. + +Please be aware that Prison will NOT prevent the tool from breaking by another plugin or by bukkit. So if a tool reaches the threshold and is not able to workk within the mines, if they use the tool out in the wild, outside of a mine, then bukkit can continue to wear the tool down until it breaks. + +Prison's preventToolBreakage is a simple process for Prison's purpose. It is not a global, complex solution that will ensure the tool will never-ever break and be lost. + + +**Durability Resistance Lore:** + +Prison has it's own custom lore that will prevent durability from being applied to the tool that is used for mining, and it is disabled by default. + +`lore.loreDurabiltyResistance: FALSE` +`loreDurabiltyResistanceName: &dDurability Resistance&7` + +To use this lore, Prison's lore handling must also be enabled. + +`lore.isLoreEnabled: TRUE` + + +When it's enabled, it is treated as a percentage from 1 percent to 100 percent. The percentage is a number that follows the durability resistance's name. If no number is provided, then it is treated as 100 percent. + +If a random number is "rolled", from 0 to 99, and that number is greater than the durability resistance value, then prison will allow durability to be calculated normally. + +If the random number is the same as the durability resistance value, or less, then the durability calculations will be skipped. + +High values for Durability Resistance is not recommended since it will prevent wear to the tools. Smaller values could help extend the life of the tools, especially when the tools are being used with Prison explosions which may include hundreds of blocks in one hit. -At this time, Prison does not provide any support for silk touch. Internally the basics are in place, but there has never been a request to enable anything related to silk touch within the mines.
-# BlockEvents - Durability (Wear) Calculations -Sometimes the durability on the tools used for mining are applied, and sometimes they are not. +# Silk Touch Features -Prison has the ability to enable durability calculations to add wear to the tools, if needed. If bukkit is applying the durability calculations and wear, and if the prison calculations are also enabled, then too much durability wear could be applied to your tools (a doubling effect). -When it is calculated to apply wear to the tools, it only adds 1 to the total durability on the tool. When the durability, or wear, exceeds the max durability level for the tool, then the tool will break. +If a tool with Silk Touch enchantment is used, then no fortune is applied, and the blockk that is broken, is the blockk that is provided. The bukkit drops, or the alt drops, are ignored. + +Silk is enabled with the following setting, which defaults to enabled: + +`general.isCalculateSilkEnabled: TRUE` -The tool's durability level will impact, and reduce, the chance to add wear to the tool. Also if the tool has the Durability Resistance enchantment, levels 1 through 100, it too will make it more difficult to add wear to the tool. If the Durability Resistance enchantment has a level of 100 (or no specified level assumes to be 100), then no wear will ever be applied to the tool.
+# Dropping Extras + +Dropping extras is enabled by default, and an example would be dropping flint when mining gravel. The odds for dropping flint is based upon the published rates as defined by the Minecraft wiki pages. + + +`general.isCalculateDropAdditionsEnabled: TRUE` + + +
+ -# BlockEvents - XP +# Giving XP Prison has the ability to give the player XP for mining certain kinds of blocks. The XP can be give either directly, or though the generation of XP Orbs. + +The following are the default settings: + +`general.isCalculateXPEnabled: true` +`general.givePlayerXPAsOrbDrops: false` + + +Please note that drop XP as Orbs is disabled by default. If dropping by orbs, they behave as normal XP orbs behave. As such, the player may not be able to collect them all, if any, and other players may collect the XP instead of the player that earned them. There is no way to change this default orb behavior within Prison, so use with caution. + + +
@@ -331,6 +569,124 @@ Prison has the ability to give the player XP for mining certain kinds of blocks. Prison provides block break counts on tools through the use of lore, if enabled. This will track how blocks a tool has broken over it's life span. + +
+ + + +# Minecraft Stats Reporting + +*since v3.3.0-alpha.15a* + +Java based minecraft clients keep track of some basic stats. Prison, now supports updating these stats by default: + +`general.isMinecraftStatsReportingEnabled: TRUE` + +Older versions of Prison did not update them, and therefore, if you set the value to `FALSE` then it will not provide any updates to the stats. + + +
+# Calculating Food Exhaustion + +By default it is enabled: + +`general.isCalculateFoodExhustion: TRUE` + +
+ + +# Cancel Event if Block is Already Counted (prevent player placed blocks from breaking) + +This setting is enabled by default. This is a performance consideration that prevents prison from processing blocks that it has already counted and processed before. + +`general.ifBlockIsAlreadyCountedThenCancelEvent: TRUE` + +If this is set to a value of `FALSE`, Prison will then immediately ignore the event, and won't cancel it. It's impossible to "force" prison to process the same block twice. + +When this is set to a value of `TRUE`, it will prevent any player placed blocks in the mine from being broken. This includes OP'd players too. + +Setting this value to `FALSE` will allow other plugins, or bukkit, to break the block if world has be configured to allow players to break blocks within the mines. Prison will not have anything to do with the permissions on player placed blocks. For example, a world guard region would need to be setup to allow players to break blocks within a mine even if Mine Access by Rank is enabled. Some servers may allow players to place block in mines, and then break them too. This is the only way to allow Prison to ignore such blocks so they can be broken by other means. + + +
+ +# MONITOR Priority Only with AIR + +The following setting is enabled by default. It allows MONITOR priorities to be enabled only when the block that is being processed is an AIR block. This helps to ensure that the player was successful in being able to break the block. + +`general.processMonitorEventsOnlyIfPrimaryBlockIsAIR: TRUE` + +An example of where this will prevent a block from being processed under a MONITOR or BLOCKEVENTS priority, would be if the player tried to mine a block in a mine they have access to, but their pickaxe is worn out and they were not able to break the block. Because they did not break the block, the block is not an AIR block, and therefore should not be counted and processed as if it was successfully broken. + + +
+ + +# ACCESS failure - TP Player to A Mine they have access to + +This defaults to enabled: + +`general.eventPriorityACCESSFailureTPToCurrentMine: TRUE` + +When using one of the ACCESS priorities, and if a player tries to mine in a mine they do not have access to, then this feature will force the player to TP to a mine they have access to. + +This runs the command for the player: +`/mines tp` + +The behavior of `/mines tp` when no mine is specified, is that it will take the player's current rank, and find the first mine that is linked to that rank, and then it will TP them to that mine. + +If the player does not have a rank, or the ranks are not tied to mines, then this command will do nothing. + +
+ + +# Prison Tokens + +Prison tokens are not enabled by default: + +`tokensEnabled: FALSE` +`tokensBlocksPerToken: 100` + + +When they are enabled, the `tokensBlocksPerToken` defines how many blocks need to be broken before the player earns one token. + +Currently there is nothing within prison that can use tokens, but there are a some commands that can be used with other plugins to create custom uses for tokens. + +The following command will show all Prison token commands: + +`/prison tokens` + +When a player earns tokens, prison tracks which mines they earned each token in, and their total tokens earned, and their current token balance. Since tokens will be used internally in the future to control different features and allow players to "earn" specific rewards, prison also tracks how many tokens admins gave them, or removed from their balance. So for example, if a mine requires that a player earns 500 tokens within that mine, or just earn 500 tokens in general, then they cannot use tokens that were "given" to them by other players, or by admmins. Prison will be able to differentiate earned tokens from given tokens. + + +Prison command options are "add", "balance", "remove", and "set" tokens for a player. + +``` +/prison tokens add help +/prison tokens balance help +/prison tokens remove help +/prison tokens set help +``` + +If a player is given any of the tokens by these commands, they are tracked as if they are given, or removed, by an admin. There is an "option" on these commands called `forcePlayer` which forces the token transaction to be treated as if the player earned them, or spent them under normal conditions. It is not advisable to use the `forcePlayer` option since it will potentially break quests that require the player to earn tokens on their own. + +Another token option is `silent` which will prevent any notifications from being sent to the player. + +In the near future, rankup requirements will be expanded to include: + - A monetary cost (currently how rankups work) + - Require so many blocks be mined (anywhere) + - Require so many blocks be mined within the current rank's mines + - Require so many tokens be earned (anywhere) + - Require so many tokens be earned within the current rank's mines + - Require a token cost with tokens earned (or any tokens) + - And other requirements as considered possible, such as mining a specific number of blocks of a specific type from a specific mine, etc... + + + + + +
+ diff --git a/gradle.properties b/gradle.properties index 0d2683ffa..1e461305f 100644 --- a/gradle.properties +++ b/gradle.properties @@ -3,7 +3,7 @@ ## # 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.3.0-alpha.14 +version=3.3.0-alpha.15 diff --git a/prison-core/build.gradle b/prison-core/build.gradle index 32998645b..d158f866a 100644 --- a/prison-core/build.gradle +++ b/prison-core/build.gradle @@ -42,7 +42,10 @@ processResources { shadowJar { dependencies { include(dependency('org.apache.commons:commons-lang3:3.12.0')) - include(dependency('com.google.code.gson:gson:2.8.6')) + + // https://mvnrepository.com/artifact/com.google.code.gson/gson + include(dependency('com.google.code.gson:gson:2.10.1')) + //include(dependency('com.google.code.gson:gson:2.8.6')) } classifier 'API' archiveVersion = null 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 56db240b5..6598e41b4 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/PrisonCommand.java +++ b/prison-core/src/main/java/tech/mcprison/prison/PrisonCommand.java @@ -1032,6 +1032,8 @@ public void autoFeaturesInformation(CommandSender sender) { afw.isBoolean( AutoFeatures.isCalculateXPEnabled )); display.addText( "&b options.general.givePlayerXPAsOrbDrops %s", afw.isBoolean( AutoFeatures.givePlayerXPAsOrbDrops )); + display.addText( "&b options.general.fortuneMultiplierGlobal %s", + afw.getMessage( AutoFeatures.fortuneMultiplierGlobal )); display.addText( "&b options.general.fortuneMultiplierMax %s", afw.getMessage( AutoFeatures.fortuneMultiplierMax )); 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 index 0d3ea8fb8..b2498aff3 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/autofeatures/AutoFeaturesFileConfig.java +++ b/prison-core/src/main/java/tech/mcprison/prison/autofeatures/AutoFeaturesFileConfig.java @@ -130,7 +130,8 @@ public enum AutoFeatures { blockBreakEvents__ReadMe(blockBreakEvents, "Use the following event priorities with the blockBreakEvents: " + - "DISABLED, LOWEST, LOW, NORMAL, HIGH, HIGHEST, BLOCKEVENTS, MONITOR" ), + "DISABLED, LOWEST, LOW, NORMAL, HIGH, HIGHEST, BLOCKEVENTS, MONITOR, " + + "ACESS, ACCESSBLOCKEVENTS, ACCESSMONITOR"), blockBreakEvents__ReadMe2(blockBreakEvents, "MONITOR: Processed even if event is canceled. Includes block counts, " @@ -147,13 +148,6 @@ public enum AutoFeatures { + "ACCESSMONITOR combines two priorities: ACCESS and MONITOR." ), - eventPriorityACCESSFailureTPToCurrentMine(blockBreakEvents, true ), - - blockBreakEvents__ReadMe4(blockBreakEvents, - "ACCESS failure: if 'TPToCurrentMine' is enabled, then a failure with the " - + "ACCESS priority will TP the player back to the mine that is linked to " - + "their current rank using '/mines tp' with no mine specified." ), - general(options), @@ -166,6 +160,20 @@ public enum AutoFeatures { isCalculateXPEnabled(general, true), givePlayerXPAsOrbDrops(general, false), + ifBlockIsAlreadyCountedThenCancelEvent(general, true), + + processMonitorEventsOnlyIfPrimaryBlockIsAIR(general, true), + + + isMinecraftStatsReportingEnabled(general, true), + + + eventPriorityACCESSFailureTPToCurrentMine(general, true ), + + general__ReadMe1(general, + "ACCESS failure: if 'TPToCurrentMine' is enabled, then a failure with the " + + "ACCESS priority will TP the player back to the mine that is linked to " + + "their current rank using '/mines tp' with no mine specified." ), inventory(options), @@ -264,8 +272,11 @@ public enum AutoFeatures { fortuneFeature(options), isCalculateFortuneEnabled(fortuneFeature, true), + + fortuneMultiplierGlobal(fortuneFeature, 1.0 ), fortuneMultiplierMax(fortuneFeature, 0 ), + fortuneBukkitDropsMultiplier(fortuneFeature, 1.0 ), isExtendBukkitFortuneCalculationsEnabled(fortuneFeature, true), diff --git a/prison-core/src/main/java/tech/mcprison/prison/bombs/MineBombData.java b/prison-core/src/main/java/tech/mcprison/prison/bombs/MineBombData.java index 5dce27843..f7a41d20d 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/bombs/MineBombData.java +++ b/prison-core/src/main/java/tech/mcprison/prison/bombs/MineBombData.java @@ -9,6 +9,8 @@ public class MineBombData { + public static final String MINE_BOMB_DEFAULT_ITEM_NAME = "&c-= &7{name}&c =-"; + private String name; private String description; @@ -31,6 +33,20 @@ public class MineBombData { */ private String nameTag; + + /** + *
The itemName is the displayname that is used for the items. + * This can be customized without impacting the bomb's name, the bomb's nameTag, + * etc... + *
+ * + *If no value is provided, then the name will be used. + *
+ * + */ + private String itemName; + + /** *The String name of an XMaterial item to use as the "bomb". *
@@ -193,9 +209,11 @@ public MineBombData( String name, String itemType, String explosionShape, this(); this.name = name; + this.nameTag = "{name}"; + this.itemType = itemType; + this.itemName = MINE_BOMB_DEFAULT_ITEM_NAME; - this.nameTag = "{name}"; this.explosionShape = explosionShape; this.radius = radius; @@ -239,6 +257,8 @@ public MineBombData clone() { cloned.setNameTag( getNameTag() ); + cloned.setItemName( getItemName() ); + cloned.setToolInHandName( getToolInHandName() ); cloned.setToolInHandFortuneLevel( getToolInHandFortuneLevel() ); cloned.setToolInHandDurabilityLevel( getToolInHandDurabilityLevel() ); @@ -324,6 +344,16 @@ public void setItemType( String itemType ) { this.itemType = itemType; } + public String getItemName() { + if ( itemName == null ) { + itemName = MINE_BOMB_DEFAULT_ITEM_NAME; + } + return itemName; + } + public void setItemName(String itemName) { + this.itemName = itemName; + } + public PrisonBlock getItem() { return item; } diff --git a/prison-core/src/main/java/tech/mcprison/prison/bombs/MineBombDefaultConfigSettings.java b/prison-core/src/main/java/tech/mcprison/prison/bombs/MineBombDefaultConfigSettings.java index 265f4e2a9..89494b456 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/bombs/MineBombDefaultConfigSettings.java +++ b/prison-core/src/main/java/tech/mcprison/prison/bombs/MineBombDefaultConfigSettings.java @@ -53,6 +53,8 @@ public void setupDefaultMineBombData(MineBombs mineBombs) "SmallBomb", "brewing_stand", ExplosionShape.sphere.name(), 2, "&dSmall &6Mine &eBomb &3(lore line 1)" ); mbd.setNameTag( "&6&kABC&r&c-= &7{name}&c =-&6&kCBA" ); + mbd.setItemName( MineBombData.MINE_BOMB_DEFAULT_ITEM_NAME ); + mbd.setToolInHandName( "DIAMOND_PICKAXE" ); mbd.setToolInHandFortuneLevel( 0 ); @@ -85,6 +87,7 @@ public void setupDefaultMineBombData(MineBombs mineBombs) "but supercharged with a strange green glowing liquid."); mbd.setNameTag( "&6&k1 23 456&r&a-=- &7{name}&a -=-&6&k654 32 1" ); + mbd.setItemName( MineBombData.MINE_BOMB_DEFAULT_ITEM_NAME ); mbd.setToolInHandName( "DIAMOND_PICKAXE" ); mbd.setToolInHandFortuneLevel( 3 ); @@ -108,6 +111,10 @@ public void setupDefaultMineBombData(MineBombs mineBombs) { MineBombData mbd = new MineBombData( "LargeBomb", "tnt", ExplosionShape.sphereHollow.name(), 12, "Large Mine Bomb" ); + + mbd.setNameTag( "&a-=- &7{name}&a -=--" ); + mbd.setItemName( MineBombData.MINE_BOMB_DEFAULT_ITEM_NAME ); + mbd.setRadiusInner( 3 ); mbd.setDescription("A large mine bomb made from TNT with some strange parts " + "that maybe be described as alien technology."); @@ -136,6 +143,7 @@ public void setupDefaultMineBombData(MineBombs mineBombs) mbd.setRadiusInner( 3 ); mbd.setNameTag( "&c&k1&6&k23&e&k456&r&a-=- &4{countdown} &5-=- &7{name} &5-=- &4{countdown} &a-=-&e&k654&6&k32&c&k1" ); + mbd.setItemName( MineBombData.MINE_BOMB_DEFAULT_ITEM_NAME ); mbd.setDescription("An oof-ably large mine bomb made with a minecart heaping with TNT. " + "Unlike the large mine bomb, this one obviously is built with alien technology."); @@ -193,6 +201,7 @@ public void setupDefaultMineBombData(MineBombs mineBombs) // mbd.setLoreBombItemId( "&7A &2Wimpy &cBomb &9...&02A3F" ); mbd.setNameTag( "&7A &2Wimpy &cBomb" ); + mbd.setItemName( MineBombData.MINE_BOMB_DEFAULT_ITEM_NAME ); mbd.setRadiusInner( 2 ); mbd.setDescription("A whimpy bomb made with gunpowder and packs the punch of a " + @@ -243,6 +252,9 @@ public void setupDefaultMineBombData(MineBombs mineBombs) mbd.setDescription("The most anti-round bomb you will ever be able to find. " + "It's totally cubic."); + mbd.setNameTag( "&a-=- &7{name}&a -=--" ); + mbd.setItemName( MineBombData.MINE_BOMB_DEFAULT_ITEM_NAME ); + mbd.setToolInHandName( "DIAMOND_PICKAXE" ); mbd.setToolInHandFortuneLevel( 7 ); mbd.setRemovalChance( 100.0d ); diff --git a/prison-core/src/main/java/tech/mcprison/prison/bombs/MineBombs.java b/prison-core/src/main/java/tech/mcprison/prison/bombs/MineBombs.java index fb872a6ff..2f65a6392 100644 --- a/prison-core/src/main/java/tech/mcprison/prison/bombs/MineBombs.java +++ b/prison-core/src/main/java/tech/mcprison/prison/bombs/MineBombs.java @@ -3,6 +3,7 @@ import java.io.File; import java.util.ArrayList; import java.util.List; +import java.util.Set; import tech.mcprison.prison.file.JsonFileIO; import tech.mcprison.prison.internal.block.PrisonBlock; @@ -161,13 +162,14 @@ public void loadConfigJson() { MineBombsConfigData.MINE_BOMB_DATA_FORMAT_VERSION ) { // Need to update the format version then save a new copy of the configs. + mineBombApplyVersionUpdates( configs ); // first backup the old file by renaming it: int oldVersion = configs.getDataFormatVersion(); String backupTag = "ver_" + oldVersion; - File backupFile = fio.getBackupFile( configFile, backupTag, ".bu" ); + File backupFile = fio.getBackupFile( configFile, backupTag, "bu" ); boolean renamed = configFile.renameTo( backupFile ); @@ -194,6 +196,36 @@ public void loadConfigJson() { } + /** + *This function will process older config data versions and apply updates to the + * various fields to bring it up to date. For example, if a new field is added, the + * default value would be null, so this is a way to ensure there is a non-null default + * value added. Keep in mind that if the field is null, then it will not be saved in + * the json file which means that when the file is edited the person won't know there + * is a new field added. + *
+ * + * @param configs + */ + private void mineBombApplyVersionUpdates( MineBombsConfigData configs ) { + + // If dataFormatVersion is 0, then need to fix the new itemName field so it + // is set to the new default value, otherwise it will remain null. + if ( configs.getDataFormatVersion() == 0 ) { + + SetThis will apply simple validation to the mine bombs that were just loaded.
@@ -433,6 +465,52 @@ public List This is a comparator for the basic TopNStatsData.
+ * It first compares the Prestiges ladder ranks, if both are the
+ * same then it will compare the Default ladder ranks.
+ * If both of those are the same, then it will compare the
+ * balances.
+ * This class contains the user data that is used for TopN stats.
+ * It keeps track of the player's stats for totalBlocks, tokens, balance,
+ * and their Prestiges and Default rank position.
+ * This data prevents the need to access the player's cache object.
+ * For the user of the prestiges Rank object, and the default Rank object,
+ * upon first access, it will try to look up those values and will store the
+ * Rank object in a local variable for faster access later. Those stored
+ * objects will not be persisted and hence why there is string field for their
+ * names.
+ * This function finds a rank with the given name. The rank name
+ * must be an exact match, but it's case insensitive.
+ * This function will return the next rank that they player will have upon
@@ -1671,8 +1705,8 @@ public String printRankScoreLine1( int rankPostion ) {
String sPenaltyStr = PlaceholdersUtil.formattedKmbtSISize( getRankScorePenalty(), dFmt, " " );
String message = String.format(
- " %-3d %-18s %-7s %-7s %9s %9s %9s",
- (rankPostion > 0 ? rankPostion : ""),
+ " %-3s %-18s %-7s %-7s %9s %9s %9s",
+ (rankPostion > 0 ? Integer.toString(rankPostion) : ""),
getName(),
prestRankTagNc,
defRankTagNc,
@@ -1718,8 +1752,8 @@ public String printRankScoreLine2( int rankPostion ) {
String ranks = prestRankTagNc + defRankTagNc;
String message = String.format(
- " %-3d %-9s %6s %-17s %9s",
- (rankPostion > 0 ? rankPostion : ""),
+ " %-3s %-9s %6s %-17s %9s",
+ (rankPostion > 0 ? Integer.toString(rankPostion) : ""),
ranks,
dFmt.format( getRankScore() ),
getName(),
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 74294ab16..0bcb4dba5 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
@@ -18,6 +18,7 @@
package tech.mcprison.prison.util;
+import tech.mcprison.prison.Prison;
import tech.mcprison.prison.internal.World;
/**
@@ -165,6 +166,9 @@ public Bounds( Bounds bounds, Edges edge, int amount ) {
int zMin = bounds.getzBlockMin();
int zMax = bounds.getzBlockMax();
+ int worldMinY = Prison.get().getPlatform().getMinY();
+ int worldMaxY = Prison.get().getPlatform().getMaxY();
+
switch ( edge )
{
case top:
@@ -172,8 +176,8 @@ public Bounds( Bounds bounds, Edges edge, int amount ) {
if ( yMax < yMin ) {
yMax = yMin;
}
- if ( yMax > 255 ) {
- yMax = 255;
+ if ( yMax > worldMaxY ) {
+ yMax = worldMaxY;
}
break;
@@ -182,8 +186,8 @@ public Bounds( Bounds bounds, Edges edge, int amount ) {
if ( yMin > yMax ) {
yMin = yMax;
}
- if ( yMin < 0 ) {
- yMin = 0;
+ if ( yMin < worldMinY ) {
+ yMin = worldMinY;
}
break;
diff --git a/prison-core/src/main/java/tech/mcprison/prison/util/ExampleJavaDoubleVsBigDecimal.java b/prison-core/src/main/java/tech/mcprison/prison/util/ExampleJavaDoubleVsBigDecimal.java
new file mode 100644
index 000000000..a856abc35
--- /dev/null
+++ b/prison-core/src/main/java/tech/mcprison/prison/util/ExampleJavaDoubleVsBigDecimal.java
@@ -0,0 +1,63 @@
+package tech.mcprison.prison.util;
+
+import java.math.BigDecimal;
+import java.text.DecimalFormat;
+import java.util.ArrayList;
+
+import tech.mcprison.prison.Prison;
+
+public class ExampleJavaDoubleVsBigDecimal {
+
+ public static void main( String[] args ) {
+
+ ExampleJavaDoubleVsBigDecimal app = new ExampleJavaDoubleVsBigDecimal();
+
+ ArrayList This is singleton that manages the topNPlayers.
+ * NOTE: This no longer saves and loads the json file.
+ * Timing was an issue and not really sure if it was even
+ * worth trying to bypass a full reload.
+ * NOTE: The saved file is no longer being loaded. It only is used for
+ * debugging stats testing to identify how long it would take if it was actually
+ * being used. But the loaded data is not saved and it is not being used.
+ * Upon server startup, in an asynch thread, this function should be called
* to load the saved data from the file system. If there is no saved data,
* then this function will access the PlayerManager and build an initial
@@ -144,10 +169,9 @@ private void launchTopNPlayerUpdateAsyncTask() {
public void loadSaveFile() {
// If Ranks module is not loaded, then do not try to load any save file:
- if ( PrisonRanks.getInstance().getPlayerManager() != null ) {
- // Ranks is not loaded, so reset to empties:
+ if ( PrisonRanks.getInstance().getPlayerManager() == null ) {
- // Load from file was successful!
+ // Ranks is not loaded, so reset to empties:
setTopNList( new ArrayList<>() );
setTopNMap( new TreeMap<>() );
setArchivedList( new ArrayList<>() );
@@ -156,44 +180,54 @@ public void loadSaveFile() {
return;
}
+ long start = System.nanoTime();
+
JsonFileIO jfio = new JsonFileIO();
TopNPlayers temp = (TopNPlayers) jfio.readJsonFile( getSaveFile(), this );
+ temp.sortTopN();
+
+ // The following is disabled because this is just a performance test.
+
+
+// if ( temp != null &&
+// (temp.getTopNList().size() > 0 ||
+// temp.getArchivedList().size() > 0 )) {
+//
+// // Load from file was successful!
+// setTopNList( temp.getTopNList() );
+// setTopNMap( temp.getTopNMap() );
+// setArchivedList( temp.getArchivedList() );
+// setArchivedMap( temp.getArchivedMap() );
+//
+// // Since loading from a file, some players may now need to be archived:
+// checkArchives();
+// }
+// else {
+// // load from file was not successful, probably because there is no file.
+// // So create a new collection of players from the PlayerManager:
+// List If silk touch is enabled, then use block-for-block block mined is the blocks dropped.
+ * No provision is provided for the block types.
+ * This function has yet to be implemented, but it should implement behavior if
* silk touch is enabled for the tool.
* BLOCKEVENT will run with a priority of HIGHEST, but will process the same as
- * MONITOR with the addition of running the BlockEvents. This will NOT break any
+ * BLOCKEVENT will run with a priority of MONItoR, but will process the same as
+ * MONITOR with the addition of running the BlockEvents and enabling sellall on
+ * full inventory. This will NOT break any
* blocks, or process any drops.
* This function will return information on the item in the item stack, which is for
diff --git a/prison-spigot/src/main/java/tech/mcprison/prison/spigot/bstats/PrisonBStats.java b/prison-spigot/src/main/java/tech/mcprison/prison/spigot/bstats/PrisonBStats.java
index c4fc01adb..6b36cc4eb 100644
--- a/prison-spigot/src/main/java/tech/mcprison/prison/spigot/bstats/PrisonBStats.java
+++ b/prison-spigot/src/main/java/tech/mcprison/prison/spigot/bstats/PrisonBStats.java
@@ -4,7 +4,6 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
-import java.util.Optional;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;
@@ -119,8 +118,8 @@ public void initMetricsOnEnable() {
getbStatsMetrics().addCustomChart( spApiLevel );
- Optional Based upon the RankPlayer's addBalance, except that this does not cache any
+ * of the transactions, so it could possibly lead to lag due to the economy plugin
+ * not have good performance on many rapid payments.
+ * References: This gets the player's inventory, ignoring the armor slots. Just a wrapper to reload mine bombs so it does not have to pass a null value.
+ * This can also be used for initially loading the configs to force data updates.
+ *