config.yml

Default config.yml that is generated with comments

# +----------------------------------------------------+
# <           ClueScrolls Configuration File           >
# <    To reload your changes, /cluescrolls reload     >
# <                                                    >
# <     https://www.spigotmc.org/resources/30276/      >
# <  http://dev.electro2560.com/plugins/ClueScrolls/   >
# +----------------------------------------------------+

#In this section, you can create as many tiers as you want.
tiers:
  #This tier will be called common.
  common:
    #You get anywhere between 2 and 7 rewards when completed.
    items: 2-7
    #The scroll item will have 3 to 5 scrolls that must be completed.
    clueCount: 3-5
    #This is a weight of how often you will get a scroll of this tier from a mystery scroll. This can be any number, even bigger than 100.
    chance: 100
    item:
      #The title of the common scrolls
      title: '&a&lCommon Clue Scroll'
      #Theses lores is displayed on top of the clues
      lore-prefix:
        - ''
        - '&a&lCLUES:'
      #These lores are displayed below the clues
      lore-suffix:
        - ''
      #When a clue on a scroll is completed, should it be crossed out?
      cross-out-completed: true
      #Only show one clue on a scroll at a time.
      one-clue-show: false
      #What material is the scroll item? Full list of items can be found here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
      material: PAPER
      hide-first-clue:
        #When getting a new scroll, the player must right click to reveal the clues.
        enabled: false
        #This lore will be displayed if enabled and no clues are shown yet.
        lore:
        - ''
        - '&4Right click in hand to reveal.'
    #When obtaining this scroll, the player will be sent this message.
    receiveMessage: '&a&l+ %amount% Common Clue Scroll'
    #If bound, other players will not be able to complete or use this scroll.
    bind: false
    #This contains all the possible clues on a scroll. For an in depth guide on creating clues, tkae a look at the Clue Creation section on the plugin page.
    clues:
      clue0:
        lore: '&f* Kill %amount% skeleton: %completed%'
        clueType: kill
        data: skeleton
        metadata: '*'
        amount: 10
        objective: Kill %amount% skeleton
        clueName: Skeleton Killer
      clue1:
        lore: '&f* Craft %amount% diamond axe: %completed%'
        clueType: craft
        data: diamond_axe
        metadata: '*'
        amount: 5
        objective: Craft %amount% diamond axes
        clueName: Diamond Axe Crafter
      clue2:
        lore: '&f* Break %amount% dirt: %completed%'
        clueType: break
        data: dirt
        metadata: '*'
        amount: 64
        objective: Break %amount% dirt
        clueName: Dirt Breaker
      clue3:
        lore: '&f* Place %amount% stone: %completed%'
        clueType: place
        data: stone
        metadata: '*'
        amount: 64
        objective: Place %amount% stone
        clueName: Stone Placer
      clue4:
        lore: '&f* Eat %amount% cooked beef: %completed%'
        clueType: eat
        data: cooked_beef
        metadata: '*'
        amount: 5
        objective: Eat %amount% cooked beef
        clueName: Beef Eater
      clue5:
        lore: '&f* Fish %amount% items: %completed%'
        clueType: fish
        data: '*'
        metadata: '*'
        amount: 3
        objective: Fish %amount% items
        clueName: Item Fisher
  special:
    items: 2-7
    clueCount: 5-7
    chance: 55
    item:
      title: '&d&lSpecial Clue Scroll'
      lore-prefix:
        - ''
        - '&a&lCLUES:'
      lore-suffix:
        - ''
      cross-out-completed: true
      one-clue-show: false
      material: PAPER
      hide-first-clue:
        enabled: false
        lore:
        - ''
        - '&4Right click in hand to reveal.'
    receiveMessage: '&d&l+ %amount% Special Clue Scroll'
    bind: false
    clues:
      clue0:
        lore: '&f* Kill %amount% skeleton: %completed%'
        clueType: kill
        data: skeleton
        metadata: '*'
        amount: 10
        objective: Kill %amount% skeletons
        clueName: Skeleton Killer
      clue1:
        lore: '&f* Craft %amount% diamond axe: %completed%'
        clueType: craft
        data: diamond_axe
        metadata: '*'
        amount: 5
        objective: Craft %amount% diamond axes
        clueName: Diamond Axe Crafter
      clue2:
        lore: '&f* Break %amount% dirt: %completed%'
        clueType: break
        data: dirt
        metadata: '*'
        amount: 64
        objective: Break %amount% dirt
        clueName: Dirt Breaker
      clue3:
        lore: '&f* Place %amount% stone: %completed%'
        clueType: place
        data: stone
        metadata: '*'
        amount: 64
        objective: Place %amount% stone
        clueName: Stone Placer
      clue4:
        lore: '&f* Eat %amount% cooked beef: %completed%'
        clueType: eat
        data: cooked_beef
        metadata: '*'
        amount: 5
        objective: Eat %amount% cooked beef
        clueName: Cooked beef Eater
      clue5:
        lore: '&f* Fish %amount% items: %completed%'
        clueType: fish
        data: '*'
        metadata: '*'
        amount: 3
        objective: Fish %amount% items
        clueName: Item Fisher
  legendary:
    items: 2-7
    clueCount: 7-10
    chance: 20
    item:
      title: '&6&lLegendary Clue Scroll'
      lore-prefix:
        - ''
        - '&a&lCLUES:'
      lore-suffix:
        - ''
      cross-out-completed: true
      one-clue-show: false
      material: PAPER
      hide-first-clue:
        enabled: false
        lore:
        - ''
        - '&4Right click in hand to reveal.'
    receiveMessage: '&6&l+ %amount% Legendary Clue Scroll'
    bind: false
    clues:
      clue0:
        lore: '&f* Kill %amount% skeleton: %completed%'
        clueType: kill
        data: skeleton
        metadata: '*'
        amount: 10
        objective: Kill %amount% skeleton
        clueName: Skeleton Killer
      clue1:
        lore: '&f* Craft %amount% diamond axe: %completed%'
        clueType: craft
        data: diamond_axe
        metadata: '*'
        amount: 5
        objective: Craft %amount% diamond axes
        clueName: Diamond Axe Crafter
      clue2:
        lore: '&f* Break %amount% dirt: %completed%'
        clueType: break
        data: dirt
        metadata: '*'
        amount: 64
        objective: Break %amount% dirt
        clueName: Dirt Breaker
      clue3:
        lore: '&f* Place %amount% stone: %completed%'
        clueType: place
        data: stone
        metadata: '*'
        amount: 64
        objective: Place %amount% stone
        clueName: Stone Placer
      clue4:
        lore: '&f* Eat %amount% cooked beef: %completed%'
        clueType: eat
        data: cooked_beef
        metadata: '*'
        amount: 5
        objective: Eat %amount% cooked beef
        clueName: Cooked Beef Eater
      clue5:
        lore: '&f* Fish %amount% items: %completed%'
        clueType: fish
        data: '*'
        metadata: '*'
        amount: 3
        objective: Fish %amount% items
        clueName: Item Fisher
mystery:
  item:
    material: PAPER
    title: '&b&lMystery Clue Scroll'
    lore:
      - '&7Click to unlock a &b&lMystery &7clue scroll.'
  receiveMessage: '&b&l+ %amount% Mystery Scroll'
  #If bound, other players will not be able to complete or use this scroll.
  bind: false
#Should this plugin check for updates and alert players with permission?
checkForUpdates: true
#When a clue is completed, should the scroll automatically be checked if it's completed?
auto-complete-scrolls: true
#Do you want cluescrolls to have a glow effect?
glow-scrolls: true
#If enabled, each scroll will receive a unique NBT ID which will prevent stacking
scrolls-unique-ids: true
#If a block is in the blacklist, it will not count towards clues. Set to [] for none.
block-place-blacklist:
  - SEEDS
#If a block is in the blacklist, it will not count towards clues. Set to [] for none.
block-break-blacklist:
  - SEEDS
#For the title bar, these are the timings used in ticks. (20 ticks per second)
title:
  fadeIn: 20
  fadeOut: 20
  stay: 80
#Should players be limited to how often they can open the scroll inventory? In seconds. Set to -1 to disable.
inventoryCooldown: -1
inventory:
  #The purchase inventory from the command /cluescrolls or /cluescrolls open
  purchase:
    #The title of the inventory
    title: '&b&lClue Scrolls'
    #Inventory size must be a multiple of 9 up to 54.
    size: 9
    #In the items you can add items to the inventory. In the example, '5' is the slot number which is in the center.
    items:
      '5':
        #Name of the items. Valid place holders if you choose to use them like the example are: %mystery_title%, %common_title%, %special_title%, and %legendary_title%
        name: '%mystery_title%'
        lore:
          - '&7Click to unlock a &b&lMystery &7clue scroll'
          - ''
          #The %cost% will be replaced with the cost specified lower down in the purchaseAction section of this item.
          - '&a&lCOST:&r&a %cost% &a&lXP'
        #For a list of valid materials, look here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
        material: PAPER
        #The material data (useful for wool, flowers, etc)
        material_data: 0
        #How many are in this item stack?
        amount: 1
        #The purchase action is where you specify what happens when they click it
        purchaseAction:
         #The type can currently be: mystery, common, special, or legendary.
         type: mystery
         #Value currencies are EXP and MONEY
         currency: EXP
         #How many of the scrolls are given
         amount: 1
         #How much exp/money does this cost them?
         cost: 1000
         cooldown:
           identifier: scroll_purchase
           time: -1
           message: '&cToo soon, you must wati %cooldown% before using this again.'
  #In the reward inventory, you can currently set the title.
  reward:
    title: '&b&lClue Scroll Reward'
    #Size of the inventory. Multiple of 9 up to 54.
    size: 27
    #Should rewards items randomly be placed inside of the inventory?
    randomly-place-items: true
commandReward:
  material: PAPER
  title: '&b&lReward Command'
  lore:
  - '&aRight click to have executed'
  - ''
  - '&a%reward_name%:'
  - '&b/%command%'
#A range of how many garbage NBT tags to add to scrolls to prevent guessing of their contents. You can disable it by setting to 0.
garbageNBT: 5-25
runnableClueRefreshRate:
  distance: 5
  permission: 60
#Do not edit this!
version: 2.1.8