Yet Another Awards System (YAAS)© 2.x Manual

Author: HacNho
Support thread: http://www.vbulletin.org/forum/showthread.php?t=142487

Table of Contents

- Yet Another Awards System
- Installing Yet Another Awards System
- Upgrading Yet Another Awards System
- How to Use YAAS in Admin Control Panel
  - Award Category Manager
  - Award Manager
  - Add/Edit Awards
  - Mass Move
  - Manage Award / Give Awards to members
- Awards System Settings
- Awards Usergroup Permission

- YAAS in Forum Home
  - Awards List
  - Award in User Profile
  - Award in Postbit
  - Award Request Form

# I. Yet Another Awards System | Back to Top

Yet Another Award System 2.x © by HacNho
Copyright (C) 2005 by HacNho, All rights reserved.
Hack Version: 2.x
Compatible vB version: 3.5.x and 3.6.x
Support: http://www.vbulletin.org/forum/showthread.php?t=142487

DESCRIPTION:
This is a Medals/Awards system. Admin can give members awards, and award icons will be displayed in member's profile, posts, as well as in a award list.
FEATURES:
In AdminCP
- Can Create/Edit/Delete/Reorder categories/sub-categories in ACP (with category name and description)
- Can Create/Edit/Delete awards in ACP (with Award Name, Description, Icon URL, Image URL)
- Can Move one (or all) award(s) from one category to another
- Can set some awards un-classified (not displayed for public)
- Can re-order awards in awards showcase
+ Issue awards to members, based on username or userid, with Issue Reason
+ Remove awards from members
- Options to set number of awards displayed in postbit
- Options to turn on/off showing award icon, images, award requests in awards list, awards icons in memberlist
- Option to turn on/off Award system in ModCP
In ModCP
+ Issue awards to members, based on username or userid, with Issue Reason
+ Remove awards from members
Front page
- Display awards list in with: Award Name, Description, Icon, Image, and Members who get each award.
- Display awards showcase in profile, with Award information, Issue time and reason
- Display award icons in postbit (showthread, showpost, announcement, private)
- Display limit awards in postbit, with total awards, and a link to awards showcase in member profiles.
- Award request, link to a form sending to email/PM/new thead or post (based on Dr Erwin Loh's Form hack)
- Display award on Memberlist page (by trulylowcarb)
CHANGES/MODIFICATION:
- Tables to add: 3 (award, award_user, award_cat)
- Files to add: 4 (/awards.php, /award_request.php, /admincp/award.php, /admincp/award_cat.php)
- Files to edit: 8 (/admincp/index.php, member.php, showthread.php, showpost.php, announcement.php, private.php, memberlist.php, /include/functions_online.php)
- Templates to add: 9 ('AWARDS', 'awards_awardbit','awards_awardusers_bit','awards_bit','awards_userawards_bit','awards_category','awards_categorybit', 'awards_request_form', 'awards_request_formanswers')
- Templates to edit: 6 (MEMBERINFO, postbit, postbit_legacy, memberlist, memberlist_resultsbit, navbar )
- Phrases to add: 49
HISTORY:
For detail, please click here
(v.1.0.0)
- Create/Edit/Delete awards in ACP, with Award Name, Description, Icon URL, Image URL (for bigger image)
- Manage awards in ACP, including
+ Issue awards to members, based on username or userid, with Issue Reason
+ Remove awards from members
- Display awards list in frontpage, with: Award Name, Description, Icon, Image, and Members who get each award
- Display awards list in profile, that one member get, with Award information, Issue time and reason
(v.1.0.1)
- Display awards in postbit (showthread, showpost, announcement, private)
(v.1.0.1b)
- Display awards in postbit for hybrid and threaded mode
(v.1.0.1c)
- Optimize code. Instruction in UPGRADE3.txt (optional)
(V.1.1)
- Can Create/Edit/Remove/Reorder categories/sub-categories in ACP (with category name and description)
- Can Move one (or all) award from one category to another, or set it un-classified (not displayed in the list in public site)
- Can re-order awards (in ACP)
(v.1.1b)
- Fix display in showthread
(V.1.2)
[1.2] Options to set number of awards displayed in postbit
[1.2] Options to turn on/off showing award icon, images, award requests in awards list, awards icons in memberlist
[1.2] Display limit awards in postbit, with total awards, and a link to awards showcase in member profiles.
[1.2] Award request, link to a form sending to email/PM/new thead or post (based on Dr Erwin Loh's Form hack)
[1.2] Display award on Memberlist page (by trulylowcarb)
V.2.1.2
- Transport to vBulletin 3.5.0
- PM/Email user when he/she get an award.
V. 2.1.3
- Modify for vBulletin 3.6.x
- Add option to notify awarded user by email
- Add YAAS section in ModCP

Additional information:
- There are few queries running to add phrases and templates.
- When running, there is 01 extra query executed in the pages where awards displayed.

FUTURE PLAN:
- Allow comments on user's award (by Arial)
- Allow voting on user's award (by Arial)
CREDIT:
Idea has been carried on by many people, here are some:
- Lesane for original Award hack for vB2, eventhough I've never use his hack
- AnimeWebby for Awards/ Medals/ Cards Hack [vB3], which I write new code based on his.
- Mac ycl6 for phpBB Medal System for phpBB forum
- Dr Erwin Loh for FORM TO THREAD/ FORUM/ PM/ EMAIL hack
and all others for supports
IMPORTANT:
- BACKUP modified files and templates before making changes.
- Backup database is recommended.
- This hack is NOT compatible with AnimeWebby's Awards/Medals/CardsHack [vB3], there are some duplicated table name, so youCANNOTuseboth hacks at the same time. If you want to install this one, you have to UNINSTALL the other hack, or errors will occur.

# II. INSTALL Yet Another Awards System | Back to Top

Follow instruction in README.txt and INSTALL.txt

Step 1: Unzip the files to a directory on your computer.
Step 2: Upload the files in UPLOAD folder to your forums directory.
Directory structure:
{ROOT}/awards.php
{ROOT}/award_request.php
{ROOT}/admincp/award.php
{ROOT}/admincp/award_cat.php
{ROOT}/includes/settings.award.php
{ROOT}/includes/xml/cpnav_awards.xml
{ROOT}/images/medals/*
Step 3: Import the YAAS Product into your plugin system
- Go to AdminCP/Plugin System/Manage Products/[Add/Import Product]
- Select the file: product-yet_another_award_system.xml
- Click Import
The installer will create new tables for awards, add new phrases, and templates to your database.
Step 4. Edit templates. Read instruction in /docs/awards_install_template.html
Step 5: Edit AdminCP/Award System Settings
Step 6: Enjoy your new hack, give me feedback, and click install.

# III. UPGRADE Yet Another Awards System | Back to Top

From time to time it will be necessary to upgrade your YAAS installation to the latest version, either to gain new features or to fix newly discovered bugs in PHP, MySQL or YAAS itself.
The upgrade process differs depending upon the version of YAAS currently installed on your web server. Please refer to UPGRADEx.txt for detail
Warning:
We recommend that you back up your database prior to any upgrade.

# IV. How to Use YAAS in Admin Control Panel | Back to Top

Looking at the Admin CP navigation panel you will find a section for Awards

Awards Menu
| Within the Award section you will find all the tools you need to control your YAAS The tools here allow you to setup and manage your award categories and awards, give awards to user or remove awards from users

## 4.1. Award Category Manager | Back to Top

Award Category Manager allows you to add/remove category, sub-category, set category display order.

You can add or edit a category, set category title, with some description. The description will be display underneath Category title, in the Award Display List. You can also set up parent category or "No one"

If you want to remove a category, you will have an option to delete all awards belong to the category, or move them to some other category.
If the awards moved to "No one" category, those awards will be set and display as Un-classified in Award Manager, and NOT display in public awards list.

## 4.2. Award Manager | Back to Top

Award manager allows you to add/remove/move awards, give/remove award to/from members. You can also set awards display order in each category.
In Award Manager, you will be able to see awards with their information, in each category, and the users who receive awards.
All awards in Un-classify list will not be displayed in front awards list for public. They are for admin to control only

## 4.2.1. Add/Edit Awards | Back to Top

You can add award to some category, with award name, description, URL for icon and image.
Award icon is a small icon for your award. The icon will be displayed in user postbit (threads, posts, announcements, PM), and next to award image in profile and award list.
Award image is a bigger image of your award. The image will be displayed in user profile and in awards list.
The URLs should be FULL path to your images, for example: http://yourwebsite/forum/images/medals/xxx.gif

If award available, you can edit them with the same manner.

## 4.2.2. Mass Move | Back to Top

Mass Move is an easy tool for you to move awards from one category to another, in case you have to re-organize all awards. You can also move one single award to a different category by editing that award (as show above)

## 4.2.2. Manage Awards / Give Awards to members | Back to Top

Manage Award allow you to edit/delete one award, as in [Edit] and [Delete] links

"Give award to user" allow you to issue the award to your user, based on userid OR username. If you have both userid and usename field filled, only userid is used in the search, regardless usename is match with the given userid or not. You only can add award to one user at a time. Issue time and Issue Reason (as given here) will be displayed in user profile. Click Save to execute action.

"Users Who Have Already Received Awards" section show you those who got the award, with Issue reason and time. You can remove any given issue by chosing the Delete option and click Remove.

## 4.3. Awards System Settings | Back to Top

Award System Settings allows you to control the way awards to be displayed in frontpage.

- Display in Memberlist allows you to the choice to display awards column in memberlist or not.
- Display in Postbit allows you to the choice to display awards in postbit or not. Postbit is displayed in user's thread, post, announcement, PM.
- Maximum Awards Displayed allows you to the choice number of awards to display in postbit.
- Display Icon/Image/Award Name/Members Who Received Awards/Request Award Link/ in Awards List allows you to display or hide the coresponding column in the award list page.

## 4.4. Awards Usergroup Permission Settings | Back to Top

Award Usergroup Permission Settings allows you to control which group can access Award Request page.

# V. YAAS in Forum Home | Back to Top

When you are done setup award in Admin Control Panel, you now can enjoy your result.

## 5.1. Awards List | Back to Top

Lets go to your Awards List at the address: http://yourdomain/forum/awards.php
All your awards will be listed in categories. Award icons, Award Images, with their name and description are listed. All users who get awards are also listed with each award. If you click on username, it will bring you to that user profile, at the location of the targeting award.

## 5.2. Awards in User Profile | Back to Top

In User profile, if user has award, a list of awards will be displayed with Award Name, Description, Issue time and reason.
Click on Award Image to go to Awards List, locating at the targeted award.

## 5.3. Award icons in postbit | Back to Top

Awards icons will also be displayed in user postbit (thread, post, announcement, PM), underneath your contact YIM, AIM ... icons.
Total amount of awards a member has is also displayed, with a link to an award showcase in member profile.

## 5.4. Award Request Form | Back to Top

Awards Request Form allow member to request or suggest some award to some members. Request form can be sent to some forum as a new thread, or reply to some thread, or PM or email to some member.

© 2005 Yet Another Awards System