Scavenger Hunt

Current Version: 1.0.4
Library Link: www.proboards.com/library/plugins/item/1809
Keys Used: 3 (1 Private User key, 1 Super User key & 1 Super Forum Key)

Need to set up an Opt Out option for your members?: Setting up an Opt Out option

Need to set up a Forced Opt Out option for your members?: Setting up a FORCED Opt-Out option


I've been granted permission to take over David Clark's Scavenger Hunt plugin. David's support thread can be found here: support.proboards.com/thread/602987/scavenger-hunt-beta-1

Version 0.2.0 added in a new tab (Modifiers) that were from requested mods to the plugin. This new tab now allows you to make those mods without having to edit the code in the Build of the plugin.




- Multiple Items: With David's original code, you couldn't get more than 1 item per find if the Halloween Feature was turned off. This option will now let you allow members finding multiple items even if the Halloween Feature was turned off and this is set to Allow.

- Collected Items before Multiple Items: This option allows you to easily change the minimum number of items the member has to have in their prize bag before multiple items are found in 1 "find".

- Random Number Range: Originally, at most, you could only get up to, and including, 6 items in 1 find. This option allows you to raise or lower that maximum amount. So, if you entered a 10 in this field, then when a Member is eligible to get multiple items in a find, this would pick a random number from 1 to 10, inclusive, to give them.

- Frequency: This allows you to make it harder to find items. The default is a frequency of 2 (from David's code). Raise this number to make finding items more rare.

- Prize Detector Available: Originally, the little prize detector that appeared on the PBN Bar showed up after a member had 5 items in their prize bag. This option allows you to change the minimum amount needed before that detector shows up. So, if you set this to 10, for example, the prize detector would not show up until after the member had 10 items in their prize bag.

---

VERSION 1.0.4 is now in the library and addresses:

- Clicking the prize bag on a member's mini-profile had a popup that had a title of "Trick or Treat". There is now an option that allows you to change that popup title. This is located in the What's the prize? tab and is named Container Title. If this option is left blank, the plugin will use "Trick or Treat" as the title. Just put in your own title in that option field and the plugin will use that instead.

VERSION 1.0.3 is now in the library and addresses 2 things:

1. A small codefix that will hopefully prevent anyone from getting a "null" as their count; and

2. A button that now appears on Profile pages that allow Staff to clear that particular member's key data - and only that person's data - as well as remove them from the leaderboard. When the button is clicked, it will set that person's count back to 0 and remove their entry from the leaderboard.


WARNING: There is no check (yet) to ask "are you sure" when you click the button. Right now, the data gets cleared for that person as soon as the button is clicked. You will get a popup notice informing you that the data has been cleared. Be sure your Staff know not to just click the button to "test" it. Remember that "Staff" includes any member who is in any member group that has Staff set to Yes - whether that group is the current group being displayed or not for that member.

---

YES! The Scavenger Hunt with Leaderboard has been submitted to the Library. If / When accepted, it will show up as Version 1.0.0 Beta. PLEASE NOTE that it will require room for a Super Key (in addition to the 2 keys already needed).

IMPORTANT:

1. Setup needed for the Leaderboard:
   
   1. Create a Custom Page. If you're not sure how to, read the Help Guide article on Creating a Custom Page.
   2. The Custom Page MUST have a Page ID of: scavenger-hunt
   3. Create a BLANK page WITH Forum Wrapper.
   4. Once created, there is NO need to add any widgets. The Leaderboard will look for the Page ID to display its contents.
   5. Add a link to your navbar (or wherever you want to) that points to the Custom Page you made.
2. Things you should know:
   
   1. Unlike the mini-profile, the Leaderboard requires a refresh to see the new count (it doesn't update without a refresh).
   2. Do NOT use the browser's Back button (or equivalent) as it may (temporarily) throw the count off. Use the Leaderboard link that your Admin placed.
   3. Bad news for IE11 Users - this does not seem to work in IE11. I doubt I'll do a fix for that. Besides, if you're still using IE ... WHY? (Should work on IE11 now)
   4. There is a default color for the count (#0000ff), but that can be changed with CSS (see below).
   5. WARNING: If you utilize a Member Group for Opt-Outs, please be aware that installing this new version may clear that. If Opted-Out members are suddenly seeing the plugin, go to Admin > Plugins > Manage and click on the plugin's EDIT button (NOT on the Plugin's name) and see if your Opt-Out Group is still listed.
   6. There is a new set of key permissions on the What's the Prize? tab, named: Key - Leaderboard. It should already have READ = "Everyone" and WRITE = "Members & Staff". If not, please set them to those settings and save.

TARGETABLE CSS:

- You can target the count color by adding this to the bottom of your stylesheet (or surround it with <style> tags and place in Global Footer):


.scavenger-hunt-leaderboard-item strong {
  color: #rrggbb;
}


substituting #rrggbb with an actual hex color or recognized color name.

- You can also target the Rank numbers (the number to the left of the member's name in the leaderboard). Each Rank number has its own class in the form of: shlb-rank-## where ## is the Rank number you want to affect. This ONLY affects the Rank number itself and not the member's name or count. As such, it does not look at who is in that Rank, but it just looks at the Rank number. The Rank number is also contained in a span, so we can use that for specificity. This probably needs an example, so let's use this for the example:

- Rank #1 gets color #00ff00
- Rank #2 gets color #0000ff
- Rank #'s 3 and 4 get color #ffff00
- Rank #'s 5 and 6 get color #ff0000

This would be the CSS for it:


span.shlb-rank-1 {
  color: #00ff00;
}
span.shlb-rank-2 {
  color: #0000ff;
}
span.shlb-rank-3, span.shlb-rank-4 {
  color: #ffff00;
}
span.shlb-rank-5, span.shlb-rank-6 {
  color: #ff0000;
}


Again, this would go at the bottom of your stylesheet (or surrounded in <style> tags and placed in your Global Footer). You can use other CSS properties - I only used color for a quick example.

- Lastly, if you have the PB shoutbox show on all pages (default if on - as the template variable is in the Forum Wrapper template), but don't want it on the leaderboard page, you can edit your Forum Wrapper template to exclude showing the shoutbox on the Leaderboard page:

FIND:

$[content]
$[shoutbox]


CHANGE TO:

$[content]
{if $[route.params.page_id] != "scavenger-hunt"}
$[shoutbox]
{/if}


HAVE FUN!



New in Version 1.0.1 - Maintenance Mode

Maintenance Mode, when turned on, will stop new items from appearing - so they can't be collected. However, it does leave the Leaderboard visible so Staff can do a final tally for end-of-hunt. This makes sure that no one can add to their collection while counts are being checked.

Why call it "Maintenance Mode"? Well, disabling the plugin will, of course, disable the Leaderboard. This can mean that Staff need to put their forum in Maintenance Mode so they can enable the plugin, get the counts, then disable the plugin again and disable Maintenance Mode on the forum. This option now makes it so the forum doesn't need to go into Maintenance Mode so Staff can get the final counts - they only need to turn Maintenance Mode on in the plugin.

This setting can be found on the Modifiers tab at the bottom.

VERSION 1.0.2 contains IE fixes - the plugin should run for IE users now.

---

Version 1.0.0:

Leaderboard added!


Happy Scavenger Hunting!

Changelog: