⭐ ClueScrolls ⭐

Clue scrolls is an amazing plugin to use on your factions, survival and even prison servers! You can create clues in the config to be used on the scrolls. The default config contains 3 tiers of scrolls and 200+ clues! When a player completes all the clues of a scroll they will automatically receive their rewards. You can create custom rewards by tier defined with weights using the command /cluescrolls. The higher the weight the more common a reward will be. You can even create command rewards which are given to the player as an item and can be executed by the player upon interaction.

  Old

Don't forget to check out the NEW documentation! https://wiki.electro2560.com/cluescrolls

• 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 and 1.20 support
• Highly configurable
• Create your own tiers
• Create your own clues
• Fully configured default configuration and rewards are provided
• Reward system to give items and/or execute command rewards
• 155+ unique clue types! Full list of clue types available here: https://wiki.electro2560.com/cluescrolls/clue-creation
• Full message customization
• Developer scrolls API
• Developer event API
• Vault integration
• Cooldowns for scroll purchases
• Customizable purchase and rewards inventories
• Purchase scrolls for experience, money, or other currencies
• Crosses out completed clues
• Option to show only one clue at a time
• Specify the number of clues put onto a generated scroll
• Specify the number of rewards a scroll will receive with ranges
• Make scrolls glow
• Title bar and chat notifications
• Command tab auto-complete
• Ability to not duplicate clues on a scroll
• Ability to not duplicate rewards given from a scroll
• Tier specific rewards
• Weights determine how common a reward is
• Automatically updates files when you download a new version
• WorldGuard, Towny, Votifier, ASkyBlock, ChatReaction, AutoSell, Vault, Boss, MythicMobs integration and much more! Full list of clue types available here: https://wiki.electro2560.com/cluescrolls/clue-creation

Support is provided via Discord.

• Add clues to the tiers via a command.
• Custom inventory sounds
• Custom particle effects
• Brew potion clue
• cut blocks with shears (cobweb, leaves, etc?)
• debug feature
• Sound effects & particle effects for clue completion, opening a mystery scroll, etc.
• Option to randomly place reward items in GUI
• • Placeholders - Hooks with PlaceholderAPI and allows the ability to show the player how many clues they've completed, the tier
  • Riddle clues - Players need to solve a riddle in order to pass the stage, could have it so they need to be standing in a certain spot with specific items equipped or being held.
  • Spend Money clue - Requires the player to spend a certain amount of money in the shop
  
  Post any additional ideas in the discussion.

Aliases: [cluescrolls, cluescroll]

• /cluescrolls - Open inventory
• /cluescrolls help - Help
• /cluescrolls give - Give a scroll to a player
• /cluescrolls giveall - Give a scroll to everyone online
• /cluescrolls reload - Reload all config files
• /cluescrolls additem - Add an item as a reward
• /cluescrolls addcommand - Add a command as a reward
• /cluescrolls removereward - Remove a reward
• /cluescrolls listrewards - List rewards
• /cluescrolls rewardinfo - Display info about a reward
• /cluescrolls getreward - Used to get a reward for debug purposes
• /cluescrolls resetcooldown - Reset cooldowns of specific identifiers or players. Useful for testing.
• /cluescrolls customtrigger - Trigger an event for a custom trigger

More command information available on the wiki: https://wiki.electro2560.com/cluescrolls#commands



Available at the documentation site: https://wiki.electro2560.com/cluescrolls#permissions


Installing Clue Scrolls is easy as can be. Follow the few steps below and you'll be all set.

• Purchase and download the ClueScrolls.jar.
• Upload the ClueScrolls.jar into your plugins folder.
• (Optional) - If you wish to use any features which involve the exchange of money, you will need vault. You can download and follow the instructions found here.
• Start/restart/reload your server. Default configuration files will automatically be generated at this point in your plugins/ClueScrolls/ directory.
• Read about the configuration files, clue creation, and adding rewards found below to configure the plugin exactly to your liking.
• Have fun! Feel free to PM or post to the discussion any issues you experience or recommendations you have for features.

The default config, rewards, and messages file will be generated automatically when you first load ClueScrolls! The following links can be used as a reference.

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

Work-in-progress /cluescrolls editor
(Displaying the defaults clues + rewards)

Editor menu viewing default tiers


Viewing default legendary tier clues


Viewing default common rewards


Viewing default special rewards


Viewing default legendary rewards

NEW documentation is available at https://wiki.electro2560.com/cluescrolls/clue-creation
Be sure to check it out for more details, examples, and a full list of all clues available!

Under the clues section of a tier, you can add and edit your clues.

The clueType must be the name of the clue type. Below this section is a list of all clue types that you can currently use.

The data is optional and can be used to specify specific requirements that must be met in order to count towards that clue. If you don't want to specify any data, you don't need to include it in the config. In the list below this section, there is a list for each clue type with the various data types you can specify. Some you specify text, others you specify numbers, and others are material types, entity types, color types, etc which can be found in the links below.
Material - https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
Entity -
Horse Variant - https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Horse.Variant.html
Horse Style - https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Horse.Style.html
Horse Color - https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Horse.Color.html
Dye Color - https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/DyeColor.html
Bucket Contents - water, lava, or milk

The amount is simply the number of times that clue must be completed. You can also use a range such as 10-25.

The lore is what is displayed on the scroll item.

The objective and clueName are used in title bar messages when you complete a clue, and if you have only one clue being revelled on a scroll at a time, in a chat message telling the player more information on their next clue.

  Examples

If there is a certain data you don't want to specify, you can either use the wildcard character to skip over and ignore it, or just don't including it in the config. When using the wildcard character * for either a data or metadata, it should be noted that is must always be surrounded by single quotes to prevent errors when loading the plugin configuration. It is just the way YAML treats the character. You should use it as a value like so '*'.

Some Examples:

clue0:
    lore: '&f* Kill %amount% skeleton: %completed%'
  clueType: kill
  amount: 10
  objective: Kill %amount% skeleton
  clueName: Skeleton Killer
  data:
    entitytype: skeleton
    entitycustomname: '&bSkelly Man'

clue10:
  lore: '&f* Shear %amount% pink sheep: %completed%'
  clueType: shear
  amount: 32-64
  objective: Shear %amount% pink sheep
  clueName: Pink Shearer
  data:
    entitytype: sheep
    woolcolor: pink

fisherman:
  lore: '&f* Fish %amount% items: %completed%'
  clueType: fish
  amount: 3
  objective: Fish %amount% items
  clueName: Item Fisher

killmythicmobsclue:
  lore: '&f* Kill %amount% Angry Sludge: %completed%'
  clueType: mythicmobs_death
  amount: 8
  objective: Kill %amount% angry sludge
  clueName: Sludge Killer
  data:
    mythicmobtype: AngrySludge

bosskill:
  lore: '&f* Kill %amount% the James Boss: %completed%'
  clueType: boss_death
  amount: 1
  objective: KillJames
  clueName: James Killer
  data:
      #File name is James.yml
    bossname: James

Internal Clues (data):

• break (material, blockdata, blockx, blocky, blockz, world)
• place (material, blockdata, blockx, blocky, blockz, world)
• breed (entitytype, entitycustomname, world)
• bucketfill (bucketcontents, world)
• bucketempty (bucketcontents, world)
• chat (sentence)
• command (command, fullcommand)
• craft (material, itemdata, itemname, world)
• death (cause, world)
• eat (material, itemdata, itemname, world)
• enchant (material, itemdata, itemname, world)
• expgain (world)
• fish (material, itemdata, itemname, world)
• glide (world)
• harvest (material, blockdata, world)
• horsejump (variant, color, style, world)
• interactentity (entitytype, entitycustomname, 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 Clues (data):

ASkyBlock

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

AuctionHouse

• auctionhouse_sell (soldprice, material, itemdata, itemname)
• auctionhouse_start (startingprice, material, itemdata, itemname)
• auctionhouse_win (soldprice, material, itemdata, itemname)

Auctions

• auctions_sell (soldprice, bidincrement, material, itemdata, itemname)
• auctions_start (startingprice, bidincrement, material, itemdata, itemname)
• auctions_win (soldprice, bigincrement, material, itemdata, itemname)

AutoRank

• autorank_promote (fromgroup, togroup, world)

AutoSell

• autosell_autosell (material, itemdata)
• autosell_sellall (material, itemdata)
• autosell_signsellall (material, itemdata)

Boss

• boss_death (entitytype, entitycustomname, bossname, world)

ChatReaction

• chatreaction_win (word)

CrateReloaded

• cratereloaded_opencrate (cratename, cratetype)

CrazyCrates

• crazycrates_opencrate (cratename, cratetype)

DeluxeChat

• deluxechat_chat (cratename, cratetype)

EpicBosses

• epicbosses_death (entitytype, bossname, world)

MoreFish

• morefish_catch (length, name rarity)

MythicMobs

• mythicmobs_death (entitytype, entitycustomname, mythicmobtype, world)

Towny

• towny_townenter (town, world)
• towny_townexit (town, world)
• towny_towncreate (town, world)
• towny_nationenter (nation, world)
• towny_nationexit (nation, world)
• towny_nationcreate (nation, world)

uSkyBlock

• uskyblock_islandcreate (schematicname)
• uskyblock_joinisland (islandowner)
• uskyblock_leaveisland (islandowner)
• uskyblock_islandrestart ()

Votifier
Also works with NuVotifier

• votifier_vote (service, address)

World Guard

• worldguard_regionenter (region, world)
• worldguard_regionexit (region, world)

Full list of clues is available on the wiki!
https://wiki.electro2560.com/cluescrolls/clue-creation


There are two types of rewards: item and command. To add rewards, use the following commands.

/cluescrolls additem [Tier] [Name] [Weight]

/cluescrolls addcommand [Tier] [Name] [Weight] [Command].

Adding an item adds the item in your main hand to the rewards for the given tier.

When adding a command you can use the placeholder %player% to represent the player's name.

The higher the weight (can be any number, even above 100), the higher the chance of it being given as a reward.

More info available at: https://wiki.electro2560.com/cluescrolls#api



Metrics: http://mcstats.org/plugin/ClueScrolls/ (Added since the first release)
bStats: https://bstats.org/plugin/bukkit/ClueScrolls (Less accurate. Added in v1.6.6) bStats is not currently working

• You are not permitted to resell this plugin.
• You are not permitted to redistribute this plugin in any way.
• Chargebacks are forbidden and will result in a ban of your account.
• You may not use this on more than one server/network.
• No refunds.
• As the author, I am not required to provide updates.
• Terms & Conditions may change at any time without notice.
• Support will only be offered to an account that has purchased.

If there is an error, your best course of action is to send me a PM or post a comment with the stack trace in the discussion of this plugin before leaving a review and I will get it fixed asap.

If you have any ideas/features you would like to be added to the plugin, just send me a PM or leave them on the discussion page of this plugin.

If you like this resource, don't forget to leave a review! ;)

Enjoy! :)