Awards System (3.0.9)

[Todge]

This will allow you to give your members awards. The awards your members have will be visible in their profile and in their mini-profiles beside their posts.

First, download and install the plugin..

Awards System

Direct Link
Current Version 3.0.9

Once you have imported the plugin, you will need to give it some information.

Your Awards



Base Folder
If you host all of your awards in the same folder, or at the same host, you can put the 'base folder' here.

The base folder is the beginning part of the URL that ALL of your images share.

Your Award Images
This part needs to be filled in, at least in part. As you add one award, room will be made for another, etc.
There are 4 sections for each award...

Award URL
This part has to be filled in!
If you have filled in the Base Folder field, above, all you need to add here is the remainder of the URLs.

Title & Short Description
If you wish, you can add a title and/or a short description of the award.

The Title and Description of the awards will be displayed when you hover over the award images, along with the amount of that award they have.

Protect Award
Protected awards can only be given/taken by staff members. Options for this are in the next section.

DO NOT RE-ORDER YOUR AWARDS, OR REMOVE ANY FROM THE LIST AFTER THE PLUGIN HAS BEEN ENABLED!!
DOING SO WILL MEAN THAT SOME OF YOUR MEMBERS MAY END UP WITH THE WRONG AWARDS.
If you wish to remove an award from the list, replace the URL with N/A and leave the other fields blank. 


Award Settings



Award Title
If you wish the awards to be called something different on your forum, you can add your chosen title here.

No Awards
If a member has no awards, you can choose to have a message displayed instead.

Administrators
This part has to be filled in!
The main Admin can award him/herself. Select whether you'd like other staff groups to have this ability..

If you ticked 'Yes', you will need to list the group numbers in the field below.
Separate the group numbers with a comma only.. NO SPACES!!

Regular Members
This part has to be filled in!
You also need to decide whether you'd like regular members the ability to give and/or take awards.

This is where the Protected Awards come in.. Regular members will not be able to give or take the awards you protected in the previous tab.
Be aware that any changes your members make can not easily be undone, so allow them this ability at your own risk!

Self Award
If you'd like your members to give themselves awards, tick the box.
This will not allow the to award each other.

Multiple Awards
This part has to be filled in!
Decide how many times your members can receive the same award..

Mini-Profile Awards
This is where you decide how you'd like the awards to be displayed in the mini-profiles..

If you are using a non-standard theme, and the class-name of the mini-profile cell has been changed, put the new class-name in the first field.
You can ignore this part if you wish, and add <div class="awards $[user.id] $[user.name]"><br></div> to your mini-profile template(s) instead. Using this option also allows you to decide where in the mini-profiles you'd like the awards to be displayed.

You now need to chose how you'd like the awards to be displayed in the mini-profiles, or to not have them displayed there at all.
This part has to be filled in!

If you chose to have the awards in a pop-up, the next 3 options allow you to change the pop-ups background color, width and height.

If you chose to have the awards to be displayed as a list, the next 3 options allow you how to align the awards within the mini-profile, the height of the images themselves and whether to add the awards to any gifts that your members may have.
The last option has to be filled in!

Award Size
If you'd like the awards to be displayed at a set height, add a height (in pixels) here.

Give/Take Awards
To give or take awards, you will need to click a new tab on the members' profile page, doing so will create a pop-up, displaying the awards. here you can chose a background color and a width of that pop-up.

Protected Awards
'Protected' awards can still be given and taken by any staff member with the ability to edit member profiles. If you have any protected awards, you can chose not to allow these staff members to use them.

Award Styling

Here you can change the look of the awards by using CSS...
The class-names and IDs are listed below..

On the main profile page...

#profile_awards {} the cell containing the awards.
.awdDiv {} the awards themselves (each award is contained within it's own<div>tag).

.awards {} the awards pop-up you get when you click the Awards tab.
.awardsCell {} Both the Available Awards and the Received Awards cells share this class-name.
#receivedAwards {} The Received Awards cell.

In the mini-profiles...

.miniProfileAwards {} The containing cell if you have them displayed as a list.
.awdDiv {} The class-name of each awards containing<div>tag.
.awdDiv {} Is also the class-name of the containing<div>tags in the pop-up.

Using the class-names and IDs above, you should be able to target most sections of the awards.

Key Settings
This part has to be filled in!

Assuming everything has been filled in correctly, you can have both sections here set to 'Everyone'.

As mentioned before, if you want more control of how or where the awards are displayed, you can add <div class="awards $[user.id] $[user.name]"><br></div> to your mini-profile templates or <div class="awards $[user.id]"><br></div> to the summary section of the profile template.

You can also choose where to have the 'Awards' button in the Profile page by adding <div id="awards_button"><br></div> to the 'Summary' section of the profile page template.

Re-ordering Awards
If you choose to re-order your awards and you are not using the key, you will be given a code, that code needs to be copied and pasted here, removing any old code. Make sure you paste the entire code.

To re-order your awards, DO NOT CHANGE THE ORDER IN THE AWARDS LIST, this may change the awards that some of your members already have. Instead, while on th profile page, open the awards pop-up to give a member an award. You should see a 'cog' button to the left of the 'Save' button. Clicking that will change the pop-up to one that allows you to change the order of your awards.

In the left bos will be your awards in the order they are currently displayed, minus any categories you have added. Click each award to move them to the right-hand box in the new order. If you want to add a category name at any point, type the title into the field below and click the green button to the right. You can drag and drop the awards in the right-hand box if you make any mistakes.

When finished click the 'Set' button, you will be given a code. ou need to copy and paste this code into the award settings as described above.

If you prefer, instead of copy/pasting the code, you can use a key to save the awards order.. Just download and install this plugin key, the awards plugin will see this and save it to the key automatically.

That's all there is to it.



Award Notifications

If you would like a pop-up notification to appear when you receive or lose an award, download and install this plugin.

Please be aware that this plugin uses another key.

SPOILER: Click to show

3.0.7
Added option to display multiple awards side by side instead of having one image with a pop-up saying how many.

3.0.61
Added 'pointer' to catagory button.

3.0.6
Updated re-order function and added ability to categorise your awards.

3.0.5
Added a function to change the order in which awards are displayed.

3.0.4
Added option to display title even if the member has no awards.

3.0.3
Fixed issue where mini-profile awards cell doesn't contain user ID

3.0.2
Updated the way the awards pop-up is activated from the mini-profile.
Added option to leave a message in a members mini-profile if they have no awards.

3.0.1
Small fix when displaying 2 sets of awards.

3.0.0
Update to allow for an extra set of awards.

2.8.7
Fixed issue where display name contained hyphens.

2.8.6
Fixed issue with the Awards Notification sometimes displaying the wrong awards.

2.8.5
Added option not to display award in the mini-profiles.

2.8.4
Added option to allow members to give but NOT TAKE awards.
Added option for members to award themselves.

2.8.3
Added paranthesis around award quantities received.

2.8.2
Small update to miniprofile awards.

2.8.0
Tied in the Notification Plugin.

2.7.2
Fixed small problem with extra admin groups.

2.7.1
Fixed error that occurred if you only had 1 award listed.

2.7.0
Updated mini-profile awards again. Hopefully for the last time.

2.6.9
Added ability to have the awards button elsewhere in the profile page.
Fixed issue with pop-up title.

2.6.8
Added options to set the profile pop-ups' width and color.
Tidied up the settings tab a little.

2.6.7
Added an Auto Form to make it 'easier' to enter awards.
You can now remove an award from your list by replacing it's URL with N/A.

2.6.6
Added awards to message mini-profiles

2.6.5
Added options to change dimension of pop-up.

2.6.4
Updated to play nicely with the 'Icon Next To Members Name' plugin.
Placed awards UI into a pop-up to hopefully make it work with the most bizarre profile pages.
Fixed mini-profile pop-up (Awards name could be missing).

2.6.3
Edited to work with Wormo's Colorsmear plugin.

2.6.1
Added protection to giveable awards.

2.6.0
Added ability to protect awards from being removed by non-staff.

2.5.9
Added ability to place the awards wherever you want in the user profile page.

2.5.8
Added ability to add awards to the gifts list in the mini-profile.

2.5.7
Added Key Settings to unsure non-staff members can give/take awards if so desired.

2.5.6
And again....

2.5.5
Updated yet again to work with most(all?) mini-profiles.

2.5.4
Fixed positioning of multiple award numbers.

2.5.3
Enabled styling options that I had forgotten to do.
Tweaked the mini-profile awards.

2.5.2
Updated to allow extended award titles.

2.5.1
Updated to allow more than one extra admin group award themselves.

2.5.0
Fixed issue with alignment of some images.

2.4.9
Added quantity to bottom right of award images.

2.4.8
Updated mini-profile location yet again, and hopefully for the last time.

2.4.7
Updated pop-up to use Proboards alerts.

2.4.6
Added option for regular members to give/take awards.
Updated to help it work on more profile templates.

2.4.5
Fixed problem with the Awards button not showing on forums.net forums.

2.4.4
Added 'failsafe' option heavily modified mini-profiles.

2.4.3
Updated 'Awards' tab placement and function.

2.4.2
Fixed problem finding<div class="awards"><br></div>and tidied up the code a little.

2.4.1
Updated mini-profile tracking to help it work with more templates.

2.4.0
Avoided conflict with the shoutbox by removing it from the awards page.

2.3.9
Added mini profile alignment option for 'List'.

2.3.8
Fixed problem with some themes in profile page and fixed conflict with Colorsmear Plugin.

2.3.7
Added an extra check to ensure those who cannot give awards cannot see the awards tab.

2.3.6
Updated profile check to ensure moderators which cannot edit profiles cannot give/take awards.

2.3.5
Updated mini-profile location search to hopefully make it more compatible with non-standard mini-profiles.

2.3.4
Added option to enter an extra Administrator group number.

2.3.3
Added option for all admins to self award.

2.3.2
Updated user Interface.

2.3.1
Updated mini-profile username retrieval.

2.3.0
Fixed IE sizing problem.

2.2.9
Added option for no award title.

2.2.8
Fixed bug causing conflict with Post options.

2.2.7
Fixed '<div class="awards">' location check bug.

2.2.6
Added a fix for redesigned mini-profiles.

2.2.5
Updated pagination so as not to conflict with other plugins.

2.2.4
Fixed problem where non-staff could give awards.
Removed 'X Received' if multiple awards is set to 1.
Fixed problem with certain domain names.

2.2.3
Add pop-up color option.

2.2.2
Re-arranged code into functions and updated pagination function

2.0.2
Fixed conflict with chatbox when any awards given would be awarded to the awarder and not the receiver.

2.0.1
Edit to allow Admins to award themselves.

2.0.0
Complete re-write to use keys instead of localStorage.

Hunting for award images? Try...

Searching for 'Vector Images', lots are free and can be downloaded and cropped to your requirements. (Thanks to Eluzyion for this suggestion).

I have collected and put together a handful of images you are welcome to try/use..

Awards Images.zip (2.18 MB)

Download, unzip, edit them as you wish and upload them to your chosen host..</div></div></div></div>

[Peter]

The code can handle over 500 awards, but as the awards
are saved in the Custom Title field, you are limited to giving any
member a maximum of around 140 awards, depending on whether they have a
custom title or not.

How come you aren't using a key?

[Todge]

I haven't really looked into the keys as yet, but from what I gather, a key can store information for a user, a thread, a post or a conversation. Neither of which would work here as the data would need to be viewable by everyone, no matter who was online at the time, and also in the profiles as well as in the threads, so unless I'm mistaken, a key couldn't be used.

[Thesealion]

I think a key would still work. The Profile keys are (someone correct me if I am wrong) for storing information about a user's profile. Thread keys would be storing info about a thread. Since this needs to be viewable to everyone you'd probably use a Super User key which would store info for a profile, but every other profile would be able to access that data. For instance in my rules system I store info in a User key. This key is set as accepted for users who accept the rules. If I accept the rules than the key is set as accepted for me. I can read this value on my account, but you on your account would be unable to tell that I have accepted the rules. In a super user key when I accepted the rules you also would be able to access that key and see that I had accepted the rules...

I hope you can understand at least some of that

[VS Admin]

Super User keys are for storing data that you want to access relating to a user on any page. Any time a user is on the page, the super user key data for that user is available. I would think a super user key is what you are wanting to use here.

[Peter]

Dec 20, 2012 19:35:49 GMT -8 Todge said:

I haven't really looked into the keys as yet, but from what I gather, a key can store information for a user, a thread, a post or a conversation. Neither of which would work here as the data would need to be viewable by everyone, no matter who was online at the time, and also in the profiles as well as in the threads, so unless I'm mistaken, a key couldn't be used.

As VS Admin said, a Super User key is what you want.

Checkout my monetary plugin for an example.  It will show your money to everyone.

Here's the source if you want to look over how it's done...

pixeldepth.net/proboards/plugins/monetary_system/monetary_system.js

The key thing here, is to setup a "Super User" key.  You will be able to store a ton of awards as well.  It's what I intend to use when I rewrite my trophy code.  Also, if staff have permission to write to the key, they can award awards to members manually as well.

[Todge]

Dec 20, 2012 20:46:03 GMT -8 VS Admin said:

Super User keys are for storing data that you want to access relating to a user on any page. Any time a user is on the page, the super user key data for that user is available. I would think a super user key is what you are wanting to use here.

Dec 21, 2012 2:38:31 GMT -8 Peter said:

As VS Admin said, a Super User key is what you want.

Checkout my monetary plugin for an example.  It will show your money to everyone.

Here's the source if you want to look over how it's done...

pixeldepth.net/proboards/plugins/monetary_system/monetary_system.js

The key thing here, is to setup a "Super User" key.  You will be able to store a ton of awards as well.  It's what I intend to use when I rewrite my trophy code.  Also, if staff have permission to write to the key, they can award awards to members manually as well.

Ahh.. When I read this 'Whenever a user is displayed on the screen, their plugin key data will be available to access', I mistakenly took it for being the data would be available only when that member was online.

But what about the space available. I read somewhere that a key has 4k of available space? If a forum has 100 members, and each member has an average of 20 awards, because each award uses 2 characters, that would fill up the key, and I know of at least a couple of forums that want the ability to give a lot more than 20 awards to any member.

[VS Admin]

It's 4 kilobytes of space *per user*. So each of the 100 members each has 4k of space.

[Todge]

Ahhhhhhhhhhhhhhhhhh...

That makes more sense. Thanks.

I spoke too soon.

Is it possible for the admin, or any other staff member, to write data to another user's key while viewing their profile, whether that user is online or not?
It seems a key can only be updated while that particular user is online.

[Mike]

Todge, I used drop box for my base folder and have an image there but when I set it up and looked for it, its not there. It only says "available awards" with nothing there.
Can ya help me Pleeaze!

[Todge]

Dropbox is for file storage/sharing, it will not work as an image host. Try posting your image here and you'll get the same result.

You will need to use someone like Photobucket, TinyPic, ImageShack or similar.

[Mike]

Todge. I tried it with photobucket and the same no images at all. Just so you know i'm using FF.
When you get the chance help me out buddy.
Thanks

[Todge]

How, exactly, are you filling out the award images/descriptions part?

[Mike]

Ship|Its a ship

[Todge]

What about the Base Folder and Awards Images parts?