Merge pull request #33 from myzticbean/release/v2.0

Release/v2.0

CHANGELOG.md

@@ -1,3 +1,8 @@
+## Release 2.0.6.1
+### Bug fixes
+- Changed scheduled task loggers to debug-mode only ([#29](https://github.com/myzticbean/QSFindItemAddOn/issues/29))
+- Fix for players not getting teleported ([#30](https://github.com/myzticbean/QSFindItemAddOn/issues/30))
+
 ## Release 2.0.6.0
 ### Changes (Feature request [#23](https://github.com/myzticbean/QSFindItemAddOn/issues/23))
 - Plugin updated for Minecraft version 1.20.5.
@@ -68,3 +73,35 @@ player-shop-teleportation:
 - Fix for Issue [#24](https://gitlab.com/ronsane/QSFindItemAddOn/-/issues/24)
 - Fixed a bug related to nearest warp teleportation algorithm
 - Other minor bug fixes
+
+## Snapshot 2.0
+### Changes
+- **QuickShop-Hikari Support:** It now supports both QuickShop-Reremake and QuickShop-Hikari.
+- **Hexcode color support:** All messages in the config.yml now support hexcodes so you can get a lot more creative with colors.
+- **Different commands for players and admins**
+  - The /finditem command is now split into two:
+    - `/finditem` - This will support the usual shop searches and hiding
+    - `/finditemadmin` or `/fiadmin` - This will support plugin reloads. For example: `/fiadmin reload`.
+- **View all shops on server:** Now you can do `/finditem TO_BUY *` or `/finditem TO_SELL *` to view all shops on the server. As of this version, the sequence is always randomized. Sorting options are a work in progress.
+- **New shop visit count:** Now you can choose to display shop visits count in the shop lore in Search GUI. Just add the placeholder {SHOP_VISITS} in the "shop-gui-item-lore" in config.yml. To prevent visit spamming, a new config property "shop-player-visit-cooldown-in-minutes" has been added. Please don't use decimals here LOL.
+- **New storage format:** The "hiddenShops.json" will automatically be converted to a new file called "shops.json" which will store data of all shops along with their player visit count and whether they are hidden from searches.
+- **New Next/Back buttons:** The default next/back buttons are now fancy playerheads to make more sense. If you don't wish to use them, just specify the material in the config.yml.
+- **Customizable command aliases:** Added a new property in config.yml called "command-alias" where you can specify your own list of command aliases for /finditem command. If you don't wish to add any, just make it as:
+```yaml
+command-alias: []
+```
+- **Compatibility with QuickShop-Hikari v2.0.0.0:** Added support for Per Shop permission management for "quickshop-hikari.search". If for a shop, the shop owner Steve configures Alex to be in a group that does not have "quickshop-hikari.search" permission, then Alex won't be able to see that shop in GUI when searching.
+- **Added finditem sub-command for /qs:** Now you can try the below commands, same functionality. This feature removes the original /qs find sub-command to avoid confusion among players.
+- Added a new sample-config.yml file which will be copied over to the plugin folder. This file is just for your reference when editing the fields in the actual config.yml file.
+
+### Bug fixes
+- Removed an erroneous config field "warp-player-to-nearest-warp".
+- Fixed an issue where it will load up the plugin before QuickShop is done loading causing it to disable itself. Thanks Baran for reporting :)
+- Added support for EssentialsX /back.
+- Fixed a bug that broke autocompletes for all commands in-game.
+- Made minor bug fixes when enabling plugin.
+- Made some fixes in the search system for shops that are buying items.
+- Some other minor stability fixes.
+- Fixed bug in which the new `/qs finditem` sub-command was not showing up in `/qs help`.
+- Fixed a NullPointerException bug for PlayerWarps plugin integration.
+- Updated PlayerWarps API to latest version and fixed a NPE console error

README.md

@@ -1,5 +1,5 @@
 # Shop Search AddOn For QuickShop
-### Version: 2.0.6.0-RELEASE
+### Version: 2.0.6.1-RELEASE
 
 An unofficial add-on for the QuickShop Hikari and Reremake spigot plugin.
 Adds a `/finditem` command in game for searching through all the shops on the server.

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.myzticbean.FindItemAddOn</groupId>
     <artifactId>QSFindItemAddOn</artifactId>
-    <version>2.0.6.0-RELEASE</version>
+    <version>2.0.6.1-RELEASE</version>
     <packaging>jar</packaging>
 
     <name>QSFindItemAddOn</name>

src/main/java/io/myzticbean/finditemaddon/Commands/QSSubCommands/FindItemCmdHikariImpl.java

@@ -1,3 +1,21 @@
+/**
+ * QSFindItemAddOn: An Minecraft add-on plugin for the QuickShop Hikari
+ * and Reremake Shop plugins for Spigot server platform.
+ * Copyright (C) 2021  myzticbean
+ * <p>
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * <p>
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * <p>
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
 package io.myzticbean.finditemaddon.Commands.QSSubCommands;
 
 import com.ghostchu.quickshop.api.command.CommandHandler;

src/main/java/io/myzticbean/finditemaddon/Commands/QSSubCommands/FindItemCmdReremakeImpl.java

@@ -1,3 +1,21 @@
+/**
+ * QSFindItemAddOn: An Minecraft add-on plugin for the QuickShop Hikari
+ * and Reremake Shop plugins for Spigot server platform.
+ * Copyright (C) 2021  myzticbean
+ * <p>
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * <p>
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * <p>
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
 package io.myzticbean.finditemaddon.Commands.QSSubCommands;
 
 import io.myzticbean.finditemaddon.FindItemAddOn;
@@ -14,6 +32,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * @author myzticbean
+ */
 public class FindItemCmdReremakeImpl implements CommandHandler<Player> {
 
     private final String hideSubCommand;

src/main/java/io/myzticbean/finditemaddon/Commands/SAPICommands/BuySubCmd.java

@@ -1,3 +1,21 @@
+/**
+ * QSFindItemAddOn: An Minecraft add-on plugin for the QuickShop Hikari
+ * and Reremake Shop plugins for Spigot server platform.
+ * Copyright (C) 2021  myzticbean
+ * <p>
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * <p>
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * <p>
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
 package io.myzticbean.finditemaddon.Commands.SAPICommands;
 
 import io.myzticbean.finditemaddon.FindItemAddOn;

src/main/java/io/myzticbean/finditemaddon/Commands/SAPICommands/HideShopSubCmd.java

@@ -1,3 +1,21 @@
+/**
+ * QSFindItemAddOn: An Minecraft add-on plugin for the QuickShop Hikari
+ * and Reremake Shop plugins for Spigot server platform.
+ * Copyright (C) 2021  myzticbean
+ * <p>
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * <p>
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * <p>
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
 package io.myzticbean.finditemaddon.Commands.SAPICommands;
 
 import io.myzticbean.finditemaddon.FindItemAddOn;

src/main/java/io/myzticbean/finditemaddon/Commands/SAPICommands/ReloadSubCmd.java

@@ -1,3 +1,21 @@
+/**
+ * QSFindItemAddOn: An Minecraft add-on plugin for the QuickShop Hikari
+ * and Reremake Shop plugins for Spigot server platform.
+ * Copyright (C) 2021  myzticbean
+ * <p>
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * <p>
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * <p>
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
 package io.myzticbean.finditemaddon.Commands.SAPICommands;
 
 import io.myzticbean.finditemaddon.Handlers.CommandHandler.CmdExecutorHandler;

src/main/java/io/myzticbean/finditemaddon/Commands/SAPICommands/RestartSubCmd.java

@@ -1,3 +1,21 @@
+/**
+ * QSFindItemAddOn: An Minecraft add-on plugin for the QuickShop Hikari
+ * and Reremake Shop plugins for Spigot server platform.
+ * Copyright (C) 2021  myzticbean
+ * <p>
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * <p>
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * <p>
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
 package io.myzticbean.finditemaddon.Commands.SAPICommands;
 
 import io.myzticbean.finditemaddon.Handlers.CommandHandler.CmdExecutorHandler;

src/main/java/io/myzticbean/finditemaddon/Commands/SAPICommands/RevealShopSubCmd.java

@@ -1,3 +1,21 @@
+/**
+ * QSFindItemAddOn: An Minecraft add-on plugin for the QuickShop Hikari
+ * and Reremake Shop plugins for Spigot server platform.
+ * Copyright (C) 2021  myzticbean
+ * <p>
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * <p>
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * <p>
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
 package io.myzticbean.finditemaddon.Commands.SAPICommands;
 
 import io.myzticbean.finditemaddon.FindItemAddOn;

src/main/java/io/myzticbean/finditemaddon/Commands/SAPICommands/SellSubCmd.java

@@ -1,3 +1,21 @@
+/**
+ * QSFindItemAddOn: An Minecraft add-on plugin for the QuickShop Hikari
+ * and Reremake Shop plugins for Spigot server platform.
+ * Copyright (C) 2021  myzticbean
+ * <p>
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * <p>
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * <p>
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
 package io.myzticbean.finditemaddon.Commands.SAPICommands;
 
 import io.myzticbean.finditemaddon.FindItemAddOn;

src/main/java/io/myzticbean/finditemaddon/ConfigUtil/ConfigProvider.java

@@ -1,3 +1,21 @@
+/**
+ * QSFindItemAddOn: An Minecraft add-on plugin for the QuickShop Hikari
+ * and Reremake Shop plugins for Spigot server platform.
+ * Copyright (C) 2021  myzticbean
+ * <p>
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * <p>
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * <p>
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
 package io.myzticbean.finditemaddon.ConfigUtil;
 
 import io.myzticbean.finditemaddon.Utils.LoggerUtils;
@@ -8,6 +26,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * @author myzticbean
+ */
 public class ConfigProvider {
 
     private static final String FIND_ITEM_COMMAND = "find-item-command.";
@@ -41,7 +62,7 @@ public class ConfigProvider {
     public final String SHOP_SEARCH_GUI_TITLE = ConfigSetup.get().getString("shop-search-gui-title");
     public final int NEAREST_WARP_MODE = ConfigSetup.get().getInt("nearest-warp-mode");
     public final List<String> SHOP_GUI_ITEM_LORE = (List<String>) ConfigSetup.get().getList("shop-gui-item-lore");
-    public final boolean TP_PLAYER_DIRECTLY_TO_SHOP = ConfigSetup.get().getBoolean(PLAYER_SHOP_TELEPORTATION + DIRECT_SHOP_TP_MODE + " tp-player-directly-to-shop");
+    public final boolean TP_PLAYER_DIRECTLY_TO_SHOP = ConfigSetup.get().getBoolean(PLAYER_SHOP_TELEPORTATION + DIRECT_SHOP_TP_MODE + "tp-player-directly-to-shop");
     public final String CLICK_TO_TELEPORT_MSG = ConfigSetup.get().getString(PLAYER_SHOP_TELEPORTATION + DIRECT_SHOP_TP_MODE + "click-to-teleport-message");
     public final String SHOP_TP_NO_PERMISSION_MSG = ConfigSetup.get().getString(PLAYER_SHOP_TELEPORTATION + DIRECT_SHOP_TP_MODE + "shop-tp-no-permission-message");
     public final String UNSAFE_SHOP_AREA_MSG = ConfigSetup.get().getString(PLAYER_SHOP_TELEPORTATION + DIRECT_SHOP_TP_MODE + "unsafe-shop-area-message");

src/main/java/io/myzticbean/finditemaddon/ConfigUtil/ConfigSetup.java

@@ -1,3 +1,21 @@
+/**
+ * QSFindItemAddOn: An Minecraft add-on plugin for the QuickShop Hikari
+ * and Reremake Shop plugins for Spigot server platform.
+ * Copyright (C) 2021  myzticbean
+ * <p>
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * <p>
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * <p>
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
 package io.myzticbean.finditemaddon.ConfigUtil;
 
 import io.myzticbean.finditemaddon.FindItemAddOn;
@@ -10,6 +28,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * @author myzticbean
+ */
 public class ConfigSetup {
 
     private static File configFile;

src/main/java/io/myzticbean/finditemaddon/Dependencies/EssentialsXPlugin.java

@@ -1,3 +1,21 @@
+/**
+ * QSFindItemAddOn: An Minecraft add-on plugin for the QuickShop Hikari
+ * and Reremake Shop plugins for Spigot server platform.
+ * Copyright (C) 2021  myzticbean
+ * <p>
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * <p>
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * <p>
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
 package io.myzticbean.finditemaddon.Dependencies;
 
 import com.earth2me.essentials.Essentials;
@@ -39,7 +57,6 @@ public static Essentials getAPI() {
 
     public static void updateAllWarps() {
         long start = System.currentTimeMillis();
-//        LoggerUtils.logInfo("Updating Essentials warps list...");
         if(essAPI.isEnabled()) {
             Collection<String> allWarps = EssentialsXPlugin.getAPI().getWarps().getList();
             allWarpsList = new ArrayList<>();
@@ -52,7 +69,7 @@ public static void updateAllWarps() {
                 } catch (Exception ignored) { }
             });
         }
-        LoggerUtils.logInfo("Update complete for Essentials warps list! Found " + getAllWarps().size() + " warps. Time took: " + (System.currentTimeMillis() - start) + "ms.");
+        LoggerUtils.logDebugInfo("Update complete for Essentials warps list! Found " + getAllWarps().size() + " warps. Time took: " + (System.currentTimeMillis() - start) + "ms.");
     }
 
 }