I. Yet Another Awards System

Yet Another Award System 1.1 © by HacNho
Copyright (C) 2005 by HacNho, All rights reserved.

Hack Version: 1.1.050402
Compatible vB version: 3.0.7. It should be compatible with all vB 3.x version, but not tested.
Support: http://www.vbulletin.org/forum/showthread.php?t=78934

DESCRIPTION/FEATURES:
(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

CHANGES/MODIFICATION:
- Tables to add: 3 (award, award_user, award_cat)
- Files to add: 3 (/awards.php, /admincp/award.php, /admincp/award_cat.php)
- Files to edit: 6 (/admincp/index.php, member.php, showthread.php, showpost.php, announcement.php, private.php)
- Templates to add: 7 ('AWARDS', 'awards_awardbit','awards_awardusers_bit','awards_bit','awards_userawards_bit',' awards_category','awards_categorybit'
)
- Templates to edit: 3 (MEMBERINFO, postbit, postbit_legacy)
- Phrases to add: 30

HISTORY:
For detail, please click here
2005.04.03: Version 1.1
2005.03.29: Version 1.0.1b
2005.03.28: Version 1.0.1
2005.03.28: Initial release

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:
- Option to allow comments on user's award
- Option to PM/Email user when he/she get an award.

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
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

Follow instruction in README.txt and INSTALL.txt

Step 1: Unzip the files to a directory on your computer.
Step 2: Upload the files to your forums directory.
Directory structure:
{ROOT}/awards.php
{ROOT}/admincp/awards_install.php
{ROOT}/admincp/award.php
Step 3: Run YAAS Installation Script from your admincp folder, in order to prepare your database.
The Installer runs as a PHP script using your web browser. To start the installation process, open your browser and type the HTTP address of your forums directory, followed by /admincp/awards_install.php

The installer will add new phrases, and templates to your database, and tell you how to edit files and templates.
You can also read the instruction how to modify files and templates from
/docs/awards_install_file.html
/docs/awards_install_template.html
Note: AUTOMATIC file modification is also available. See /docs/BoardMod_Automatic_File_Editing.htm for instruction

Step 4: Enjoy your new hack, give me feedback, and click .

III. UPGRADE Yet Another Awards System

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

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

Awards
	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

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

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

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

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

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.

V. YAAS in Forum Home

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

5.1. Awards List

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

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

Awards icons will also be displayed in user postbit (thread, post, announcement, PM), underneath your contact YIM, AIM ... icons.