Fixes break clue initialization

All clues now support worldguard_region clue data. Block break, place, and harvest use the exact block, all others reference the player's current location.

You must enable "check-worldguard-region-clue-data" option in the config to check worldguard regions.

1.21.4 support

1.21.3 support

• Added 1.21.1 support
• Added enchantment support to enchant clue. See below for example usage. Added totalenchants and explevelcost to data. enchant([enchantments], material, custommodeldata, itemdata, itemname, totalenchants, explevelcost, world)
• Added entitydye(entitytype, entitycustomname, color, world) clue [compatible on paper 1.18+ only]
• Added fertilizeegg(entitytype, entitycustomname, bredwith, experience, world) clue [compatible on paper 1.19.1+ only]
• Added sheepdye(entitytype, entitycustomname, color, world) clue [compatible on paper 1.18.2+ only]
• Updated smithing clue to support 1.20+ armor trim templates. smith(templatematerial, inputmaterial, mineralmaterial, outputmaterial, world)
• Updated harvest clue to support sweet_berries, glow_berries, and kelp. Kelp counts the height of the broken plant. harvest(material, blockdata, world)
• Added placedBlocksBypass list to skip checking if certain blocks are natural (ex: tree logs grown from sapling are marked as player placed)

The enchant clue now supports specifying required enchantments. A separate enchantment section is used in the data section for this. Extra enchantments beyond the specified ones (such as lure in the screenshots) do not stop the enchanted item from being counted. To make a clue that explicitly requires only a specific set of enchantments, specify their other possible enchantments as level 0.

Example:

Block tracking performance fix

1.21 update

1.20.5/6 support

Playtime clue ignores essentials or CMI afk players

ItemsAdder update and new clues

* itemsadder_blockbreak (namespacedid, material, blockdata, blockx, blocky, blockz, world)
* itemsadder_blockplace (namespacedid, material, blockdata, blockx, blocky, blockz, world)
* itemsadder_blockinteract (namespacedid, action, equipmentslot, material, blockdata, blockx, blocky, blockz, world)
* itemsadder_customentitykill (namespacedid, entitytype, entitycustomname, world)
* itemsadder_furniturebreak (namespacedid, world)
* itemsadder_furnitureplace (namespacedid, world)

* Updated the fish clue type to support custommodeldata

New documentation to help configure items adder https://wiki.electro2560.com/en/cluescrolls#itemsadder-configuration

https://wiki.electro2560.com/en/cluescrolls/clue-creation#itemsadder

Fixes ultimatestacker not counting towards kill clue
Fixes mythicmobs version error

Update 4.8.9

• Added material_tag and material_tag_papermc as data types for all clues that use material data
• Fixed custom model data for command item rewards

Available Tags

Spigot can only use material_tag. PaperMC can use material_tag or material_tag_papermc. Any clue that uses material data can use a material tag. Tags contain a list of materials and make configuration quicker. Servers that update to new game versions also benefit by not having to update configs. Existing scrolls in-game will immediately have new applicable materials count towards their clues.

material_tag: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Tag.html
material_tag_papermc: https://jd.papermc.io/paper/1.20/com/destroystokyo/paper/MaterialTags.html


Example clue:

Registrar has taken over operations. Join our discord for support: https://discord.gg/XdgkfcabbW

- Added 1.20.2 support

1.20 support

1.19.3 support

4.8.5

- Fixed crafting clue bug

Added range placeholder for command rewards

Format: %range_#_#%
Example usage: %range_50_100% will give a whole number between 50 and 100 inclusive.

Added use-biome-clue-data to ignore biome data in clues that support it

• Automatically remove or modify expired scrolls
• Placeholder bug fix

Added rivalharvesterhoes_break(material, blockdata, blockx, blocky, blockz, world) clue

- Fixed chest inventory slot bug
- Fixed craft clue bug
- Added voteparty_vote(world) clue

MythicMobs 5 Support

- 1.18.2 support

- %reward_name% placeholder is available for command-successful message

Performance improvements

Updates Jobs Clues

Performance improvements

TreeAssist update

Bug fix

4.7.0

- Disabled messaging firework damage

4.6.9

- Added auto-optimize setting
- Scroll chests automatically resize if permissions change

- Added SQL SSL support
- Walk, glide, and swim clues now support biome type data
- Added global blockbreak ignoreSilkTouch option
- Added silktouch data to block break clue type
- Fixed cluescrolls editor

Fix default config

4.6.6

- Added revealMessage option to hide-first-scroll
- Scrolls chest can now work with any slot count (cluescrolls.chestsize.#)
- Fixed VotingPlugin

Login Performance Fix

Fixes command clue

4.6.3

- Added votingplugin_vote(service_site_raw, service_site_display, world) clue
- Added worlds option to whitelist works for clue tiers.

Added buildentity(entitytype, entitycustomname, world) clue for iron golems, snowman, and wither

Note: Cooldowns will reset to utilize the new cooldowns system!

• Cooldowns are now stored in SQL. If you use a remote SQL server you can sync cooldowns between servers.
• Bug fix with player logins
• The cooldown messages for purchase actions now support all messaging tags https://wiki.electro2560.com/cluescrolls#message-configuration
• Added <closeinventory> messaging action. Ex: when a player has a cooldown, trigger to close their shop inventory
• Purchase actions cooldown messages can now be provided as a list of messages

MC 1.18 support

Fix crystal storage in chest

Mob scroll drops bug fix

Fixes eat clue

Bug fixes

Towny fix

Improves config validation

4.5.0

- Fixed craft clue bug
- Fixed chestinv loading bug
- Added hideAttributes options
- Fixed towny clues
- Fixed enable-chestinv config setting

Bug fix for old worldguard versions

Craft clue bug fix

Added shopguiplus_transaction(material, itemdata, action, id, price)
Available actions: BUY, SELL, SELL_ALL

Updated SpecializedCrates clue

Async bug fix

Bug fix for non essentials users

Fixes database bug with new installations

Fertilize clue bug fix

Bug fix for Sqlite users in v4.3.8+ updates

Fixes major bug with loading v4.3.8

• Replaced /cluescroll openinv with /cluescroll shop
• Updated permission cluescrolls.command.openinv to cluescrolls.command.shop

• Added cluescrolls chest for players to store their scrolls in. Their storage amounts are configured with the permission cluescrolls.chestsize.# where # is the amount of storage slots available. Must be a multiple of 9 and a maximum of 54. [9, 18, 27, 36, 45, 54]
• Added /cluescroll chest
• Added permission cluescrolls.command.chest
• Added inventory.chest.title configuration option
• Added chestinv-auto-save configration option (in minutes)

• Added /scrolls and /cluescrolls alias

• Split /cluescroll help into separate user and admin messages
• Replaced cluescrolls.command.help with separate user and admin permissions: cluescrolls.command.help.user and cluescrolls.command.help.admin
• Updated default help message

• Added default-command-open-shop config option to control if the cluescroll command should open the shop directly or show players a help message with available options

• Improved legacy statistics conversion

• Split database configuration into a separate database.yml file

• Rewards are saved immediately when created or modified
• /cluescroll reload now works properly with manually edited rewards.yml

• Fixed storing scroll items in barrels

• Added AureliumSkills clues:
• aureliumskills_levelup(skillname, newlevel, world)
• aureliumskills_xpgain(skillname, world) clue amount is skill's experience

• Fixed bug with WildStacker

• Some performance optimizations

• New vanilla clues:
• anvil(material, itemname, world)
• bedsleep(itemdata, itemname, world)
• bookedit(signed, pagecount, author, title, generation, world)
• bucketentity(entitytype, world)
• campfire(material, world)
• cartography(inputmaterial, additionalmaterial, outputmaterial, itemname, world)
• compost(material, oldlevel, newlevel, levelincreased, world)
• compostcollect(world)
• drop(material, itemdata, itemname, world)
• fertilize(material, world) 1.13+
• grindstone(material, itemname, world) 1.14+
• hoetilling(material, blockdata, world)
• interactblock(action, equipmentslot, material, blockdata, blockx, blocky, blockz, world)
• loom(material, basecolor, patterncolor, patterntype, itemname, world) 1.14+
• projectileentityhit(projectiletype, entitytype, killed, world)
• projectilelaunch(projectiletype, world)
• raidloss(duration, totalheroes, world) duration in seconds, 1.14+
• raidvictory(duration, totalheroes, world) duration in seconds, 1.14+
• riptide(material, world) 1.13+
• smelt(material, inventorytype, world) - also works with smoker, blast furnace, etc in 1.14+ specified inventory type
• smith(inputmaterial, mineralmaterial, outputmaterial, itemname, world) 1.14+
• statistic(statistic, statistictype, material, entitytype, previousvalue, newvalue, difference, world) statistic <https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Statistic.html> & statistictype <https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Statistic.Type.html>
• stonecutter(inputmaterial, outputmaterial, itemname, world) 1.14+

• Replaced /cluescroll openinv with /cluescroll shop
• Updated permission cluescrolls.command.openinv to cluescrolls.command.shop

• Added cluescrolls chest for players to store their scrolls in. Their storage amounts are configured with the permission cluescrolls.chestsize.# where # is the amount of storage slots available. Must be a multiple of 9 and a maximum of 54. [9, 18, 27, 36, 45, 54]
• Added /cluescroll chest
• Added permission cluescrolls.command.chest
• Added inventory.chest.title configuration option
• Added chestinv-auto-save configration option (in minutes)

• Added /scrolls and /cluescrolls alias

• Split /cluescroll help into separate user and admin messages
• Replaced cluescrolls.command.help with separate user and admin permissions: cluescrolls.command.help.user and cluescrolls.command.help.admin
• Updated default help message

• Added default-command-open-shop config option to control if the cluescroll command should open the shop directly or show players a help message with available options

• Improved legacy statistics conversion

• Split database configuration into a separate database.yml file

• Rewards are saved immediately when created or modified
• /cluescroll reload now works properly with manually edited rewards.yml

• Fixed storing scroll items in barrels

• Added AureliumSkills clues:
• aureliumskills_levelup(skillname, newlevel, world)
• aureliumskills_xpgain(skillname, world) clue amount is skill's experience

• Fixed bug with WildStacker

• Some performance optimizations

• New vanilla clues:
• anvil(material, itemname, world)
• bedsleep(itemdata, itemname, world)
• bookedit(signed, pagecount, author, title, generation, world)
• bucketentity(entitytype, world)
• campfire(material, world)
• cartography(inputmaterial, additionalmaterial, outputmaterial, itemname, world)
• compost(material, oldlevel, newlevel, levelincreased, world)
• compostcollect(world)
• drop(material, itemdata, itemname, world)
• fertilize(material, world) 1.13+
• grindstone(material, itemname, world) 1.14+
• hoetilling(material, blockdata, world)
• interactblock(action, equipmentslot, material, blockdata, blockx, blocky, blockz, world)
• loom(material, basecolor, patterncolor, patterntype, itemname, world) 1.14+
• projectileentityhit(projectiletype, entitytype, killed, world)
• projectilelaunch(projectiletype, world)
• raidloss(duration, totalheroes, world) duration in seconds, 1.14+
• raidvictory(duration, totalheroes, world) duration in seconds, 1.14+
• riptide(material, world) 1.13+
• smelt(material, inventorytype, world) - also works with smoker, blast furnace, etc in 1.14+ specified inventory type
• smith(inputmaterial, mineralmaterial, outputmaterial, itemname, world) 1.14+
• statistic(statistic, statistictype, material, entitytype, previousvalue, newvalue, difference, world) statistic <https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Statistic.html> & statistictype <https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Statistic.Type.html>
• stonecutter(inputmaterial, outputmaterial, itemname, world) 1.14+

Grindstone bug fix

Fish clue console error bug fix

Bug fix for scroll interaction

Fixes negative clue overflow bug

1.17 Support

1.17 support added.

An improved default config and bug fixes to follow.

InteractiveChat support

Messaging system bug fix

Fixes WilderStacker feature

As usual, all config updates will happen automatically!

• All messages are now provided as a list
• 10 messaging types
• HeadDatabase support for defining skull items
• GUI menus no longer have material_data option. GUI materials are provided by XSeries names
• Sounds provided by XSeries
• Replaced scroll completeMessage with specific completeMessage.broadcast and completeMessage.player to better support actions only applying to the player who completed a scroll. Broadcast messages are sent to all players, except the player who completed the scroll.
• WildStacker support

HeadDatabase material example:
Prefix a material with <hdb> followed by the skull ID found on minecraft-heads
material: <hdb>307

Messaging Types & Examples:

• <command>broadcast Hello
• <console>Hello to console
• <sound>ENTITY_PLAYER_LEVELUP
• <title>&bDisplay a title<subtitle>&fadd a subtitle in the same line
• <subtitle>&bDisplay only a subtitle
• <actionbar>Send an action bar to the player
• Requires MC1.9+: <bossbar color="RED" style="SEGMENTED_20" length="100">&5Display a bossbar for 5 seconds!</bossbar>
• <center>&eCenter this text sent to the player
• <delay=20>This tag in front of any other tag will provide a delay before executing
• <delay=40><firework power="127" detonate="20"><effect type="BALL_LARGE"
  flicker="true" color="#f5d400,#fff199,ORANGE" fade="WHITE"/></firework>

Fireworks can provide multiple effects.

Hex color support using format: <#hexcode>
Example: <#e096ff>

Supported in all messages, inventory, scrolls, and anywhere else you'd use chat colors.

Model data inventory bug fix

Custom model data bug fix for scrolls

Dupe fix

Bug fix for if a player completes a scroll stored in their armor slot

Database efficiency update

v4.2.0

• Database update
• Placeholders!!! (extremely efficient too!)

As usual, the plugin will automatically update and import legacy data.

%cluescrolls_scrolls_completed% - Total count of all completed scrolls
%cluescrolls_scrolls_completed_[tier]% - Count of completed scrolls of given tier
%cluescrolls_clues_completed% - Total count of all completed clues
%cluescrolls_clues_completed_[clueType]% - Count of completed clues of given clue type
%cluescrolls_rewards_received% - Total count of all rewards received
%cluescrolls_rewards_received_[tier]% - Count of received rewards of given reward tier

Crystals craft inventory bug fix

Boss plugin API updated

VentureChat clue bug fix

VentureChat clue bug fix

Temporary inventory bug fix

Fix startup Error Prior 1.16.x

1.12.2 Bug fix

Bug fix for 1.12.2

Fixed UTF-8 support

MC 1.16.2 support

Added CustomClue#handle(Player player, int amount, ClueDataPair... clueDataPairs) to api

Added clues for auctionhouse

• auctionhousekiranhart_sell (soldprice, material, itemdata, itemname, transactiontype)
• auctionhousekiranhart_start (startingprice, material, itemdata, itemname)
  
• auctionhousekiranhart_win (soldprice, material, itemdata, itemname, transactiontype)

4.0.1

- Added zauctionhoue clues
- zauctionhouse_buy(soldprice, material, itemdata, itemname)
zauctionhouse_sell(soldprice, material, itemdata, itemname)
- Fixed cooldown translation
- Internal architecture improvements

Fixes rewards/clues editor GUI for MC 1.16.1

Fix previous update

Added 1.16.1 support

Added page support for reward editor

3.9.3

Added SpecializedCrates clue

- Added specializedcrates_opencrate(cratename, animationtype) clue

3.9.2

- Added Vouchers clues
- Added vouchers_redeemvoucher(vouchername, world) clue
- Added vouchers_redeemvouchercode(vouchername, world) clue

More bug fixes for SuperiorSkyblock errors

Bug fixes for superiorskyblock

• Ability to hide scroll and crystal receiveMessage

New clues:

• expgain (world)

MarriageMaster

• marriagemaster_bonusexpsplit (world)
  
• marriagemaster_bonusheal (regainreason, amount, world)
  
• marriagemaster_chat (message)
  
• marriagemaster_deletehome
  
• marriagemaster_divorce (world)
  
• marriagemaster_giftgive (material, itemdata, itemname, fromworld, toworld)
  
• marriagemaster_giftreceive (material, itemdata, itemname, fromworld, toworld)
  
• marriagemaster_hug (world)
  
• marriagemaster_kiss (world)
  
• marriagemaster_marry (world)
  
• marriagemaster_priestmarry (world)
  
• marriagemaster_sethome (world)
  
• marriagemaster_tphome (fromworld, toworld)
  
• marriagemaster_tpspouse (fromworld, toworld)

Fixes 3.8.6 bug

3.8.6

- Added %bindplayer% placeholder for scroll lore prefix, suffix, mystery lore, and crystal lores. This placeholder will only work for scrolls which have the bind option enabled
- Updated ClueScrolls API

Placeholder bug fix

3.8.4

- Added venturechat_chat (chat, text, format, recipientcount) clue
- Added %date_created% and %date_expires% placeholders for lore prefix and suffix
- Added placeholder-formats for locale customization



Sample usage:

• Time formats can be translated by editing the new time-format section in the config.yml.

All config updates are automatic! No action is necessary.

Bug fix

Added /cluescrolls givereward command

3.7.9

- Fixed superiorskyblock_levelcalculated clue in newer SuperiorSkyblock2
versions

Fixes complete message and config updated

• New default config and rewards
• Fix give and giveall messages
• Internal bug fixes

config.yml [1.8.x-1.12.x]
config.yml [1.13.x]
config.yml [1.14.x+]
rewards.yml [1.8.4+]
messages.yml

Added support for newer boss api

Fixed bentobox_challengecomplete and bentobox_levelcalculated clues

3.7.3

- Fix default help message
- Fix randompackage_claimenvoycrate clue name
- Added ability for customModelData (similar to customDurability)
- Renamed tiers.[tier].items to tiers.[tier].rewards
- Reworked API
- API is now publicly available at https://github.com/electro2560/ClueScrollsAPI

A custom durability amount can now be specified for MC versions 1.9+ to support custom texture resource packs.

Works for scrolls, crystals, mystery scrolls, mystery crystals, and command items. Just specify customDurability: #

Ex:

Fixes new version of MythicMobs

• Added scroll-complete-actions to config. This stores a list of actions to execute when a scroll is complete. Actions can be an internal ClueScroll message or command.
• Renamed messages.yml scroll-complete %type% placeholder to %tier%
• Updated RandomPackage support for newer versions

Remember: ClueScrolls automatically updates configurations and messages!

By default the config will be set to.

The command-successful can be removed by setting it to "" in the messages.yml

Remove debug message. Ooops.

1.15 Support

Fixes error loading in v3.6.5

Added customtrigger(identifier) clue.

This clue type allows you an easy code-free way of creating your own events. Using the /cluescroll customtrigger (player) (identifier) [amount] command you can call for a clue to be marked. Amount is optional and wi

Example:
Have a customtrigger with identifier (voter). When your vote plugin executes vote rewards for a player, have it issue the command: /cluescroll customtrigger (player) voter 1 to update the player's clue.

- Fixes issue with using newer UltimateTimber versions
- Fixes issues with missing config options

* Fixes crystal duplication bug
* Added SCROLL_ALREADY_COMPLETE to messages.yml

Fixes bug with plugin loading in 3.6.1

Added itemsadder_blockbreak (customname, material, blockdata, blockx, blocky, blockz, world) clue

Added the ability to remove clue-complete message in messages.yml by setting it to be empty.

Ex:
clue-complete: ""

Fixes %remaining% with skip crystals. Previously the placeholder would appear on the scroll lore after using a crystal.

Added %remaining%

You can now use this placeholder in a clue to specify how many more of the action must be completed.

Example:

Fixes errors with Jobs clues

Fixes error with horse clue

Fixes essentials_balanceupdate clue

Added essentials_balanceupdate (type, amount, world) event.

Type: gain or loss
amount: number of the amount of money that was lost or gained

Number data types will require an exact number. Ex: the amount maybe 50 to specify exactly 50 gained. The clue will only count if the amount gained was 50. Numbers can also be specified by range. Ex: 50-1000000.

This clue would require the user to gain at least $50 from one transaction.

Black Friday Sale - 20% off!

- Updated editor GUI to rename clues and rewards
- Added Jobs clues:

• jobs_expgain (exp, jobname, world)
  
• jobs_join (jobname, world)
  
• jobs_leave (jobname, world)
• jobs_levelup (level, jobname, world)
• jobs_payment (level, money, points, world)

- Added SuperiorSkyblock clues:

• superiorskyblock_createisland (schematicname, protetcionsize)
• superiorskyblock_disbandisland (islandowner, protetcionsize)
  
• superiorskyblock_enterisland (islandowner, protetcionsize)
  
• superiorskyblock_exitisland (islandowner, protetcionsize)
  
• superiorskyblock_joinisland (islandowner, protetcionsize)
  
• superiorskyblock_leaveisland (islandowner, protetcionsize)
  
• superiorskyblock_levelcalculated (level, worth)
  
• superiorskyblock_missionname (missionname)
  
• superiorskyblock_visit (islandowner, protetcionsize)

Added BentoBox clues:
- bentobox_createisland( islandowner, gamemode)
- bentobox_enterisland( islandowner, gamemode)
- bentobox_exitisland( islandowner, gamemode)
- bentobox_jointeam( islandowner, gamemode)
- bentobox_leaveteam( islandowner, gamemode)
- bentobox_resetisland( islandowner, gamemode)
- bentobox_visitisland( islandowner, gamemode)

Added BentoBox Challenge Clues:
- bentobox_challengecomplete (challengeid, completedcount)

Added BentoBox Level Clues:
- bentobox_levelcalculated (level)

islandowner represents the name of the island owner
gamemode represents the BentoBox gamemode name of the island

challengeid represents the challenge id of a challenge
completedcount represents the number of the amount completed

level represents the level as a number

Renamed fabledskyblock_islandcreate clue to fabledskyblock_createisland

Added FabledSkyblock clues:
- fabledskyblock_createisland(structure)
- fabledskyblock_deleteisland
- fabledskyblock_enterisland(islandowner)
- fabledskyblock_exitisland(islandowner)
- fabledskyblock_joinisland(islandowner)
- fabledskyblock_leaveisland(islandowner)
- fabledskyblock_level(level, points)
- fabledskyblock_visitisland(islandowner)

structure is the name of the structure used by the created island.

islandowner represents the name of the island owner

level & points represent a number. For example, setting a level of 25 would require at least a level of 25 to be met by the island. The level clue will be counted towards online players' scrolls when the /is level command has been run by an island member.

Fixes developer API

Fixes default config

Fixes compatibility with CrazyEnchantments so that blast enchantments count towards block breaking.

Ability to create custom clues with ClueScrolls API and register them in your own plugins.

https://wiki.electro2560.com/cluescrolls#custom-clues

Fixes bug regarding automatic clue rehook

Fixes NBT errors in console from previous version

- FabledSkyblock clues
- Adds cluescroll editor command
- Reward GUI editor additions. Working, but most options are still
missing.
- Fixes NBT bug

- Added RandomPackage clues
- Added Citizens clues
- Fixed bucket clue errors
- Added /cluescroll rewardeditor
- Added /cluescroll editreward
- Added nearplayers clue
- Added PhatLoots clues
- Added playtime clue
- Now supports WorldGuardEvents as an alternative WG hook to
WGRegionEvents
- Added scroll-slot-refresh option
- Added CrackShot clues

Documentation will be added to https://wiki.electro2560.com/ within the next day.

Fixes a bug where sometimes rewards could sometimes be given duplicated for a scroll

This should fix a bug where scroll rewards would sometimes duplicate.

- Fixed boss hook for new version
- Fix scroll complete logger not properly logging the scroll tier
- Fix block break & place clues
- Added mobarena_newwave(arenaname, wavenumber, world) clue

THIS IS A DEVELOPMENT BUILD OF CLUESCROLLS. DO NOT USE THIS ON A PRODUCTION SERVER - USE 3.3.6 INSTEAD.

This version has been tested as much as I could and appears to be working correctly. This features entirely async clue handling and should remove any sort of lag previously caused by ClueScrolls. DO NOT ATTEMPT TO USE THIS ON A PRODUCTION SERVER. If you wish to try this out, be advised to have backups in case any unforeseen glitch occurs. I have tested this in version 1.8-1.14 and could not find any errors myself. Inventories appear to update correctly and no errors are caused. Feel free to leave me feedback on how this performs. Once more testing is completed this version will be released as stable for production servers.

Fixed /cluescrolls rehook

Internal changes + bug fixes

Fixes a bug where CrazyCrates sometimes fails to hook

Fixes bug in MassiveStat's code
Adds legacy compatibility to CrateReloaded hook

Added support for 1.14

Added API for custom clues!
Documentation will be available here: https://wiki.electro2560.com/cluescrolls#api

Fixes major bug with previous release where internal dependencies were missing.

Bug fix for hooks

Fixes bugs with the harvest and break clues, and worldguard.

AutoSell bug fix

Currency Type fix

Fix for CrazyCrates clue data

Fix for where items could be taken from the scroll menu if opened from ChestCommands.

Fixes a bug for people using a mystery crystal. Regardless of if bind was enabled or not, players would not be able to redeem a regular crystal from the mystery when right clicking because it was considered to be not bound to them. No changes to config or items are needed, this is only a code fix.

Fixes BlockBreakEvent console error

Fixes crazycrates clue

Fixes a bug where the mythicmobs_death clue would not work correctly in newer releases of mythicmobs.

Fixes a bug where the harvest clue had errors if the config updater tried to update it in 3.1.0.

Added interactentity clue. Right click a certain entity to complete this clue.
Data: entitytype, entitycustomname, world

Bug fix for errors from the death clue

Fixes bug from 3.0.4 where server versions prior to 1.13 would have spamming console errors.

Fixes an error for some users when their configs automatically update

If you're running 3.0.0+, you need this update to fix an issue with the purchase inventory not working.

• Multiple scroll and crystal mystery types can now exist
• Fixed rewardinfo command
• Rewritten give and giveall command
• Mystery crystals
• renamed receive-items message to receive-rewards
• Changes to ClueScrollsAPI
• Added instant-command-reward-execution option to config

New format for give and giveall commands:

/cluescrolll give (player) (scroll/crystal) (tier/mystery) (name) [amount]
/cluescroll giveall (scroll/crystal) (tier/mystery) (name) [amount]

As usual, all config and message files will update automatically after making backups.

Adds commandReward.bind option. By default this is false. If you want to prevent players from selling off or trading their command rewards, this can be set to true so that other players cannot use the command reward on themselves.

Fixes bug with pvppoints currency not working.

Adds commandReward.bind option. By default this is false. If you want to prevent players from selling off or trading their command rewards, this can be set to true so that other players cannot use the command reward on themselves.

Fixes bug with pvppoints currency not working.

Permissions can now be specified for the scrolls in the purchase GUI.

Example:

Scroll can now have a time set to expire.

Under each scroll in the config, there's an added expire option. By default this is -1 and will not expire. It represents how many seconds a player has to complete a scroll. For example, by setting it to 604800 seconds, they will have a week to complete it since receiving it. After that time has passed, they're no longer able to work on the scroll and when they try to right click it or apply crystals, it will tell them.

Bug fixes for 1.7 servers

== Version 2.8.9 ==

- Fix uncolored receive messages for crystals
- Fixed mystery crystals not turning into a random crystal when right clicked in hotbar
- Bug fixes

== Version 2.8.8 ==

- Fix craft clue error in server versions prior to 1.9.x

Fixes an error with 1.8.x servers

Fixes some errors seen in console

== Version 2.8.5 ==

- Major rewrite
- Fixes missing permissions for givecrystal command

== Version 2.8.4 ==

- Fixes bug with some scrolls having clues which were not completable

2.8.3

• 1.13.2 support
• Fixed bug with bucket fill and empty clues in 1.13+
• Added cod, pufferfish, salmon, and tropical_fish as bucket contents types for 1.13+
• Eating cake will now count towards the eat clue for the cake material
• Rewards given are now logged in ClueScrolls/logs directory
• Multiple commands can now be given as a single reward. When creating a new command reward, use a semicolon between commands to specify multiple. For example "say Good job %player%!;eco give %player% 100"

== Version 2.8.2 ==

- Added PointsAPI currency (points_api_minehome) https://www.spigotmc.org/resources/pointsapi.13957/

If you're currently running the crystal update (2.8.0), this update is a necessity to fix a major bug!

== Version 2.8.0 ==

- Crystals!!!! (Click on a scroll with one to skip the current clue!)
- Added /cluescrolls givecrystal command
- Prevent crystals and scrolls from being used in crafting tables
- Ability to sell crystals in purchase inventory
- Option to remove crystals or scrolls from player's inventory if they die (disabled by default)
- Fix for deluxechat_chat clue
- Updates to the reward system

As usual the config will automatically update. Here is a specific list of everything that will change:

- Added glow-crystals
- Rename mystery.item to mystery.scroll
- Added mystery.crystal
- Move mystery.receiveMessge to mystery.scroll.receiveMessage
- Move mystery.bind to mystery.scroll.bind
- Move tiers.[tier].item to tiers.[tier].scroll for all tiers
- Add tiers.[tier].crystal
- Move tiers.[tier].receiveMessage to tiers.[tier].scroll.receiveMessage
- Move tiers.[tier].bind to tiers.[tier].scroll.bind
- Move inventory.purchase.items.[#].purchaseAction.type to inventory.purchase.items.[#].purchaseAction.tier
- Add inventory.purchase.items.[#].purchaseAction.type (scroll or crystal)
- Added remove-scrolls-on-death
- Added remove-crystals-on-death


Coming soon!
- Better documentation! The current documentation has outgrown what can be fit onto the plugin page.
- Brew clue! Already made, although it still has a few bugs that need to be fixed before it is released.

Fix for the error messages related to the swim clue from the last update in server versions less than 1.13.

New:

• world date for votifier_vote clue

Bug fixes:

• Cooldowns didn't work sometimes
• Custom inventory names had issues in 1.13.x
• Remove debug message from mythicmob_death clue
• Fixes error other errors that would occasionally throw in console

== Version 2.7.1 ==

- Added support for 1.13.1
- Fix for mythicmobs clue
- Added chat clue type chat(sentence)
- Added deluxechat clue type deluxechat_chat(sentence,identifier)
- Bug fixes

== Version 2.7.0 ==

- Added support for 1.13
- Renamed MONEY currency to VAULT for GUI purchase actions
- Added TokenManager currency (TOKEN_MANAGER)
- Added PlayerPoints currency (PLAYER_POINTS)
- Added PointsShop currency (POINTS_SHOP)
- Added SoulPoints currency (SOUL_POINTS)
- Added PvpPoints currency (PVP_POINTS)
- Added PointsAPI currenct (POINTS_API)
- Added uSkyBlock clues. uskyblock_islandcreate(schematicname), uskyblock_joinisland(islandowner), uskyblock_leaveisland(islandowner), uskyblock_islandrestart()
- Added expgain(world) clue
- Fixed distance related clues counting distance from telepoting
- clueName can now use the %amount% placeholder

Bug fixes

Additional bug fix for 1.7 servers

Fixes various bugs. WGRegionEvents is now required for using any clues that use WorldGuard.
Setting the scroll-complete message to be empty quotes in the messages.yml will now no longer broadcast the message.

Fixes various errors

Removes some debug messages that were accidentally left in from a few updates ago. On some older generated scrolls they may broadcast debug messages. This update fixes this.

Small bug fix, nothing major.

What's next?
mcMMO!

== Version 2.4.0 ==

- MoreFish hook
- Added morefish_catch clue (length, name, rarity)
- You can only purchase a cluescroll if there's space in your inventory. If there is no space, it is not purchased and the player is messaged that they need inventory space.
- Data that uses numbers, you can now specific a range. Example: 10-50. Ex: On the new morefish_catch clue you can use ranges for the length
- CrateReloaded hook
- Added AuctionHouse hook
- Added Auctions hook
- Added Autorank hook
- Added auctionhouse_start clue (startingprice, material, itemdata, itemname)
- Added auctionhouse_win clue (soldprice, material, itemdata, itemname)
- Added auctionhouse_sell clue (soldprice, material, itemdata, itemname)
- Added auctions_start clue (startingprice, bidincrement, material, itemdata, itemname)
- Added auctions_win clue (soldprice, bidincrement, material, itemdata, itemname)
- Added auctions_sell clue (soldprice, bidincrement, material, itemdata, itemname)
- Added autorank_promote clue (world, fromgroup, togroup)

Another small update, but a much needed feature. In the lore for clues, you can now use %newline% to specify a new line. Please not that colors won't be carried to the new line, you'll need to include them again for the new line.

Without specifying new colors this happens:


When you specify the new colors you can create something nice like this:


Example:

Added inventory.reward.gui-enabled option to the config with the default option of true. If you don't want the GUI showing when a scroll is completed, setting this to false will instead attempt to put the reward items in the player's inventory, or drop them if their inventory is full.

A larger update with new features is on the way

Fixes issue with mythicmobs_death clue saying it's missing the boss hook which isn't necessary

• There's is an entirely new way of defining clues in the config with much more options available! These will be documented in more detail on the plugin page.
• Added MythicMobs support with the mythicmobs_death clue
• Added Boss support with the boss_death clue
• Permission clue is now disabled by default (set to -1 in config). It is known to pose many lag issues.
• Change to PlayerClueCompletedEvent
  

As usual, configs will update themselves.


======================================
============== INTERNAL ==============
======================================

horsejump: variant, color, style, world
blockbreak: material, blockdata, blockx, blocky, blockz, world
blockplace: material, blockdata, blockx, blocky, blockz, world
breed: entitytype, entitycustomname, world
bucketempty: bucketcontents (water, lava, or milk), world
bucketfill: bucketcontents (water, lava, or milk), world
craft: material, itemdata, itemname, world,
eat: material, itemdata, itemname, world
enchant: material, itemdata, itemname, world
fish: material, itemdata, itemname, world
glide: world
harvest: material, blockdata, world
kill: entitytype, entitycustomname, world
permission: permission
ride: vehicletype (an entitytype), world
shear: entitytype, woolcolor (DyeColor string) or wooldata (to specify the data id value of the color), world
swim: world
tame: entitytype, entitycustomname, world
walk: world

======================================
============== EXTERNAL ==============
======================================

askyblock_challengecomplete: challengename, rewardtext
askyblock_islandcreate: schematicname, protectionsize
askyblock_warpcreate: NONE
askyblock_enterisland: islandowner (player name), protectionsize
askyblock_exitisland: islandowner (player name), protectionsize
askyblock_joinisland: islandowner (player name), protectionsize
askyblock_jointeam: teamleader (player name)
askyblock_leaveisland: islandowner (player name), protectionsize
askyblock_leaveteam: teamleader (player name)
askyblock_minishopbuy: material, itemdata
askyblock_minishopsell: material, itemdata
askyblock_warpremove: NONE
askyblock_islandreset: NONE
askyblock_visitisland: islandowner (player name), protectionsize

autosell_autosell: material, itemdata
autosell_sellall: material, itemdata
autosell_signsellall: material, itemdata

chatreaction_win: word

towny_nationcreate: nation, world
towny_nationenter: nation, world
towny_nationexit: nation, world
towny_towncreate: town, world
towny_townenter: town, world
towny_townexit: town, world

votifier_vote: service, address

worldguard_regionenter: region, world
worldguard_regionexit: region, world

boss_death: entitytype, entitycustomname, bossname, world

mythicmobs_death: entitytype, entitycustomname, mythicmobtype, world

=== 2.2.2 ===

• Fixed issue with removing rewards
• Fixed issue with not being able to sell scrolls for money

A feature update is on the way soon

Removes a debug message when generating a scroll.

Fixes issue where 2.1.9 would not load

• Fixes data in eatcluelistener used for eat clue
• Fixed askyblock_visitisland clue. Incorrect name, missing 'i' in name
• PlayerClueCompleteEvent now returns a double getAmount instead of int
• Fixes block break clue (had issues with worldguard)
• Added AutoSell hook
• Added autosell_autosell clue. Data is item type, metadata is item data id. The amount can be a decimal. Player must sell that amount.
• Added autosell_sellall clue. Data is item type, metadata is item data id. The amount can be a decimal. Player must sell that amount.
• Added autosell_signsellall clue. Data is item type, metadata is item data id. The amount can be a decimal. Player must sell that amount.
• Added scrolls-unique-ids to config with default of true. If enabled, scrolls will be assigned a unique ID in NBT and will not be able to stack.

NOTE: Please hang tight while the plugin page is updated and documented.

== Version 2.1.8 ==

- Added word "mystery" to give and giveall command autocomplete. Fixes it in the ClueScrollsAPI class where the command tab complete gets it from.
- Added harvest clue (wheat, carrot, potato, and beet root in 1.9+)
- Added support for world guard. (Block break will not count if the player's access is denied)
- Added horsejump clue (dataType of Horse.Varient & metadata of wildcard (none). In the future metadata could specify style and color of Horse)
- Added some internal things to help implement new hooks into plugins.
- Added WorldGuard hook
- Added worldguard_regionenter clue. data is region name, meta data is world name.
- Added wordguard_regionexit clue. data is region name, meta data is world name. Must be either spawn, move, or teleport. A disconnection does not count.
- Changes to ClueScrolsAPI (giveScroll and giveRandomScroll will not obey if bind is enabled. There are new variations which allow you to specify the player, their UUID, or UUID string if obeying bind is needed)
- Added bind option to all tiers (and mystery scroll)
- Added not-bound-to-player message to language file
- Added config option inventory.reward.size
- Added config option inventory.reward.randomly-place-items to randomly place the reward items in the inventory
- Reward inventory has protection if there are more rewards to be given when there is space. On loading the plugin you will also receive a warning. Without these checks, it would be possible to crash the server upon receiving rewards.
- Added bucketfill and bucketempty clues. Uses data string water, lava or milk
- Added ASkyBlock hook
- Added askyblock_challengecomplete clue. Data is the challenge name, no meta data
- Added askyblock_islandcreate clue. Data is island shcematic name, no meta data
- Added askyblock_islandreset clue. No data, no meta data
- Added askyblock_enterisland clue. Walk/Enter an island. Data of island owner's name, no meta data
- Added askyblock_exitisland clue. Walk/Leave an island. Data of island owner's name, no meta data
- Added askyblock_joinisland clue. Join/become a member of an island. Data of island owner's name, no meta data
- Added askyblock_leaveisland clue. Leave/de-member from an island. Data of island owner's name, no meta data
- Added askyblock_minishopbuy clue. amount is quantity purchases, data is item type/material, meta data is item data
- Added askyblock_jointeam clue. data is team leader's name, no meta data
- Added askyblock_leaveteam clue. data is team leader's name, no meta data
- Added askyblock_warpcreate clue. no data, no meta data
- Added askyblock_warpremove clue. no data, no meta data
- Added askyblock_vistisland clue. data is island owner's name. no meta data. Similar to askyblock_enterisland clue except it only counts if the player is not owner or member of the island that is entered.
- Added Towny hook
- Added towny_townenter clue. data is town name, meta data is world name.
- Added towny_townexit clue. data is region name, meta data is world name. Must be either spawn, move, or teleport. A disconnection does not count.
- Added towny_towncreate clue. data is town name, meta data is world name.
- Added towny_nationcreate clue. data is nation name, meta data is world name.
- Added towny_nationenter clue. data is nation name, meta data is world name.
- Added towny_nationexit clue. data is nation name, meta data is world name. Must be either spawn, move, or teleport. A disconnection does not count.
- Added ChatReaction hook
- Added chatreaction_win clue. data is word name, no meta data
- Added votifier hook
- Added votifier_vote clue. data is service name, meta data is address
- New system of notifying if dependencies are missing. Will only notify if they're attempted being used.

• Fixes help message.

Coming next:
New clues and features!

Adds the /cluescroll resetcooldown command. The permission is cluescroll.command.resetcooldown

There's also now a discord which you can reach out on for additional support. https://discord.gg/U7usCMr

When holding any item in your off hand, you would get a message saying it must be used in your main hand. This is now fixed and is only messaged to a player when holding a cluescroll in their off hand.

Fixes a major performance issue occurring in all versions since 2.1.0.

• Adds a missing piece to config and defaults in case it does not exist.

• Fixes updater backup system. (In 1.7.10 there was a problem)
• Fixes craft clue to work in all versions. (Previously broke in versions 1.11 and up)
• JAVA 8 NOW REQUIRED
• You can now specifiy the amount of scrolls to give with the give and giveall commands (Optional argument)
• Adds command.give.error-invalid-amount and command.giveall.error-invalid-amount to lang.yml
• Adds command.give.amount-not-negative and command.giveall.amount-not-negative
• Updates give and giveall incorrect args messages.
• Tab complete for all commands
• Rewards will only repeat if necessary
• Ability to not show clues until right clicked on a new clue (disabled by default)
• Custom materials for scrolls
• Bug fixes

What's next? Major performance fixes

As usual, all configuration files are automatically updated.

• Updates rewards to be base64 encoded rather than ItemStack serialized. This will allow items with NBT to be saved (such as other clue scrolls)
• Bug fixes to a few utilities
• Backups of files are created if they get updated
• Fixes using the custom material type for mystery scrolls added in v2.1.1 (when clicked they wouldn't do anything if they weren't paper or had a custom name)
• Fixed breed clue (it can only work versions 1.11 and up)
• Fixes glow (caused errors on 1.7 versions)