/*======================================================================*\
|| #################################################################### ||
|| # vBExperience 4.1                                                 # ||
|| # ---------------------------------------------------------------- # ||
|| # Copyright 2006-2011 Marius Czyz / Phalynx. All Rights Reserved. # ||
|| #################################################################### ||
\*======================================================================*/

In this readme you can find additional informations about the vBExperience Promotion System.
Basically it is a system to promote a user from one group to another, based on his points.



/***** Compatibility *****\
Compatibility to the legacy old vBExperience Promotions (vBExperience 3.8.4 and older)
You can import the existing defined promotions (AdminCP, Experiencer, Manage Promotions, Import...)


Compatibility to the default vBulletin Promotions
I don't recommend to have both systems active, but it is possible. You have to take care that no promotion demotes users that were promoted using the other system.
Currently you cannot import the existing vBulletin promotions.



/***** Short explanation of the GUI *****\

	Display Order
		The Display Order decides which promotions will be taken in first place. So if there are two promotions for one usergroup, it will promote the user only on the first promotion that meets the conditions.
		A Display Order of 0 will deactivate a promotion.
	
	Field
		This is the field the condition will be checked with.
	
	Compare
		Define the way a condition should be checked. A "<" is lower than, for a "=" the value must be exact the same, for ">" the value must be higher.
	
	Value
		Condition in Achievements and Promotions are calculated in POINTS, not in counts of items.
		If you choose 10 Day, you must enter the points needed for this.
		For example: You have an achievement for 10 days. You have set 2 points for every day since registering. Calculation: 10*2 = 20
		You will have to set 20 as the condition.
	
	
	Usergroup
		Select in the upper field the usergroup that the user must have to be promoted. In the second field you will have to select the usergroup where the user will be promoted to, if the condition is true.
	
	
	Demote
		If selected, all users that qualified for this promotion (and therefore are in the usergroup of the second field), will be demoted to the usergroup of the first field
	
	
	Delete
 		Deletes this promotions. No user will be touched



/***** How it works *****\
The systems is searching for a promotion that fits the users usergroup. If positive, it analyzes the conditions for it. If the user has met the conditions, he will be promoted to the given usergroup.



/***** Demoting is not implemented in the current version. *****\
Instead, you must create a second promotion from the promoted to the first group and revert the condition. For example:
First Promotion
Activity > 90 = promotion to Second Promotion

Second Promotion:
Activity < 90 = promotion to First Promotion

/***** Examples *****\

*** Promoting a User if he donates ***
Beside a paid subscription you could establish a configuration where a user donates money and he is beeing promoted to a better group.
These steps are required for this:
1. Install vBExperience
2. Install VSa PayPal Donate
3. Install "vBExperience VSa - PayPal Donate v5.0 Integration" (ZIP\extras\Addons\vsa_paypal_donate.xml)
4. Create the promoted usergroup which will have extended permissions, larger allowances, etc...
5. Create a new promotion from the standard usergroup to the new created promoted usergroup
6. Set as a condition f.e. 50 PayPal Donations Points ( = 10 points * 5 EUR/Dollar/...)
7. Activate that promotion ("Sortorder" higher than 0)
8. Finished! Now when a user donates something, his points are growing

If required, repeat that with more groups and higher PayPal Donation Points.