Add-On Releases - vBExperience

vBExperience 3.8 (aka xPerience)

Created by Marius Czyz aka Phalynx.

Winner of the "Mod of the Month"-Award (March 2008) on vBulletin.org.


Description
vBExperience is your feature packaged solution for motivation and satisfying your users. vBExperience is an advanced Level/Promotion and Activity System with Shop, Awards and Activities. It will calculate an activity and experience score for every user based on their activites on the forum. Now your users will see how their level is increasing by participating on your forum.

This mod was developed by me because I was never satisfied with the post count. Communities are not only defined by post count, they need much more parameters: Are the postings the user creates helpful? Are his threads frequently read? Does the user participate on the community by posting pictures, attachments, leaving visitor messages, tagging threads? All this can be answered with this mod.

Comments, suggestions, translations, bugs, etc... are very welcome! Support is only given to people who have clicked Mark as Installed.


Compatibility
This mod will work with vBulletin 3.7.x and 3.8.x. For vBulletin 3.6 you will need vBExperience 3.7



Demo:
http://www.insideearth.net/xperience.php?langid=5

Demo Profile:
http://www.insideearth.net/member.php?u=1&langid=5

Demo Rankings:
http://www.insideearth.net/xperience.php?langid=5

Demo Awards:
http://www.insidesupcom.de/xperience...wards&langid=1

Demo Promotions:
http://www.insidesupcom.de/xperience...=shop&langid=1

Demo Shop:
http://www.insideearth.net/xperience...=shop&langid=5

Demo Stats:
http://www.insideearth.net/xperience...stats&langid=5

Demo Earn Points:
http://www.insideearth.net/xperience...=earn&langid=5

Other Demo Site:
http://www.insidesupcom.de/xperience.php?langid=1


There are mainly four things visible for the users: The users score, his level, his next level up in %/points and his activity in %.


Calculation of the score
Taken into calculation are these things:
Threads
- Created threads
- Thread views of own threads
- Thread replies of own threads
- Thread votes of own threads
- Thread tags
- Replies to own threads
- Sticky threads
- Socialgroup Discussions (Discussions, Posts)

Posts
- Created posts
- Views on attachments

User
- Days since registration
- Average posts per Day (for users who are on forum for at least seven days)
- Referrals
- Received infractions
- Reputation / Use of reputation system
- Visitor messages on profiles
- Members of own social groups
- Albumpictures
- Friends
- Completing Profile

Misc
- Calendar entries


Additionally there is support for 3rd party addons (some are already installed):
- vB Tournaments and Ladders (via CDP Addon)
- Post Ranking System (via CDP Addon)
- Helpful Answers (via CDP Addon)
- AWCoding-Donation System LITE and PRO (via CDP Addon)
- Cyb Paypal Donate (included)
- DownloadsII (included)
- ibProArcade Highscorer Points (via CDP Addon)
- LDM Links and Downloads Manager (included)
- PhotoPlog 2.1 (via CDP Addon)
- PhotoPost vBGallery (via CDP Addon)
- PhotoPost Pro (via CDP Addon)
- Post Thank You / Use of Post Thank You (via CDP Addon)
- QuoteIt! 3.16 (via CDP Addon)
- SAPR: Advanced Post Rating system (via CDP Addon)
- thanks via vS-Hide Hack Resurrection (Expanded Edition) (included)
- v3arcade Highscorer Points (via CDP Addon)
- v3arcade Submissions Points (via CDP Addon)
- vBulletin Blog (included)
- Who Downloaded This Attachment? (included)
- Other Addons can be easily added via CDP - Custom Data Provider plugins.

Additionally you can install these modifications:
- Thread Necromancer: Gives (minus-) points when a user is posting in old threads.
- Scrupulous Poster: Gives points for editing posts. Award users that are editing own posts instead of doing double post.
- Deletion Addicted: Gives points when an user/nod soft-deletes post, thread, visitormessage, groupmessage or picturecomment.
- Arm of Law: Give points for moderators who are using the infraction system
- Discussion Ender: Give points for people who are the last on a discussion
- RadioActivity: Reduce points for every day the user is not online

Also, there are already addons available that are working as Custom Data Provider (CDP). A CDP can extend vBExperience by collecting data and adding it to the vBExperience datastore. All point providers can be used for Awards and Shop.

You have to install these hacks for your own, vBExperience doesn't install nor touches these.


vBAdvanced
There are three vBAdvanced 3.0 XML modules: Most Active Users, Most Experienced Users and Last 20 Activities. Import them via vBAdvanced AdminCP.


Awards
There are six default awards: Most Popular, Activity Award, Posting Award, Community Award, Frequent Poster, Blog Award, Calendar Award. The awards are shown in Rankings and Profile. You can set them also to display in postbit near the username. There is a scheduled job running once a day (02:30h) to calculate them.
Via AdminCP they are completely customizeable and can also be assigned manually.
Awards can be created for every data provider.


Rankings
Showing User, Level, Awards, Activity Points (experience, thread, post, user, misc) - sortable.
Since 3.8.3, there is a also a ranking for Social Groups

Shop
A virtual Shop will motivate your users to earn more points. You can define categories and put virtual items with pictures in it. A currency can be defined seperatly for every item, e.g. 20 points from threads or 100 points from gallery. Users can purchase the items, they appear in their profile. The costs of the item are substracted from their xperience points. Additionally you can set quantity of the items.
The Shop will motivate your users to collect specific points to buy an item. Optionally you can show the last purchased items on postbit.
You can put virtual items in it, like WoW addons: Sell WoW Items in exchange of f.e. thread points. Great for RPG forums.
Non-Virtual Items like bold Usernames or Downloads for Points are already on my todo list.

Earn Points
There is an overview for the user on how points can be collected, with a list of users own points. All data is beeing pulled from the database (settings, phrases)

Statistics
The statistics is showing a Top-X list of the leading users. Usefull for optimizing points of the point provider. Only enabled point providers with results will be displayed.


Promotion system
To motivate users to do more on your forum I created the promotion system. By reaching defined xperience points the user will be moved to another usergroup - where you can set graphics, shadows, highlighting, etc... What is interesting in combination with this: you can give the user more possibilities f.e. larger avatars or bigger PM box. A log of the promotions is available.


Calculation of the activity
The system calculates the activity by taking the average post count/visitormessages/group discussion/Blog entries of the ten most active user and comparing it to own post count. This can be set to count only the last X days, f.e. 21 days.


Settings
You can control how many points are given to every calculation. For example you can give many points for creating new threads but only a few for views of that thread. Setting a value to 0 will disable a setting.
Additionally, you can set ignore users (f.e. for bot users), forums (f.e. offtopic forums) and usergroup id's.


Performance, Big Boards
vBExperience has been tested on smaller and also on some bigger sites. I know from boards with around 120k users running this mod smoothly. More about this topic can be read in the file readme_optimization.txt


Frequently asked questions
Q: How do I change the name Experience to something new?
A: You can change the name via phrases. Just search and replace all phrases that contains vBExperience.

Q: When installing vBExperience, does everyone start from scratch, or will it automatically configure everyone's points based on actions before the install?
A: If you recount, vBExperience will calculate ALL existing data since the beginning of the board.

Known Issues:
- Awards: On "Currently Active Users Viewing This Thread" awards are only shown for the user who is viewing this.
- Awards: If activated in with rich username, they are attached to the username. If the username is linked, the awards are also linked. If a link is underlined, the awards are also underlined. This behaviour is hardcoded in vBulletin and cannot be fixed.
- Settings are showing only a blank page, read here: http://www.vbulletin.com/forum/proje...6979#note74140
- If you completely remove vBExperience, you need also to uninstall the product XML manually from the pluginssystem

Credits for icons
- FAMFAMFAM, http://www.famfamfam.com/lab/icons/silk/
- IconExperience


History
3.8.5 Beta 3, 18th September 2009
- Fixed Promotions
- Fixed Notifications
- Added Activities to Promotions
- All Activities are not obeying limit
- AdminCP/Experience has a recount for Promotions and Achievements
- Fixed listing of Achievements with Firefox
- Several Beta 2 fixes

3.8.5 Beta 2, 02nd September 2009
- Just a short note: 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.
- New tabbed interface. If you want to change the style, edit the template xperience_navbar_css
- Promotions now showing usergroups and conditions for a promotion to the next group
- You can import old vBExperience Legacy promotions (that were created within level.xml)
- Achievements in Profile
- Achievements below Avatar
- Several Beta 1 fixes

3.8.5 Beta 1, 28th August 2009
- Achievements!
- Promotions!
- Notification on Awards, Promotions and Achievements
- GAP: Empty pointfields will not be displayed anymore
- Activity: Showing percent values with a decimal
- Activities now also for users
- Awards below Avatar
- Default Awards are now also creating new category
- Shop: Fixed issue in not returning cash on sells
- Reworked Edit Shop Items


Todo for Beta 3:
- Download files with vBExperience as a credit system ("LDM Links and Downloads Manager", "DownloadsII")
- Activity eraser
- AdminCP Permissions
- Advanced User Permissions


For more see history.txt

[Morrus]

Question: (trying to decide whether to downlaod this or vBCredits) - is there a "per forum" setting? For example, can I allow users to earn points by creating a thread in my review forums (which power GARS), or news forums (which power VBA CMS), but not elsewhere?

In addition, when defining levels and experience points, can I define level titles also?

[Thijmen1992]

I can't manage my settings in the AdminCP.
Like:
vBExperience

Settings: General
Settings: Bars
Settings: Points
Settings: Awards
Settings: Shop
Settings: Stats
Statistics: Level

When I click one, I only see:
vBulletin Options

vBulletin® v3.7.3 Patch Level 1, Copyright ©2000-2008, Jelsoft Enterprises Ltd.

Strange enough:
Statistics: Level
Delete Statistics
Recount
Manage Awards
Manage Shop
Manage Custom Points
Import another level product
Those are working correctly.
Anyone a solution?

[biocyberman]

Originally Posted by Phalynx

I would suggest to change hooks/templates to post instead misc. See for example addon_scrupulous_poster.xml.

I fixed it and save as addon_for_3.7.17_postrate.xml

Originally Posted by Phalynx

Thanks for sharing. You will need to add the new Earn Points functionality introduced with 3.7.18 - the CDP has been extended with this.
Also, change the dependancy to 3.7.18 and lift the version to 1.1.0 to show that your hack is supporting Earn Points.

Just for confirmatiion, that change would be for 3.7.18 release. File has been updated and saved as addon_for 3.7.18_postrate.xml
-----------
POSSIBLE PROBLEMS:
There is might be a small problem if somebody installed my previous release of this hack:
This code doesn't seem to work:

if (field_exists('xperience_stats', 'points_misc_postrate')) $vbulletin->db->query_write("ALTER TABLE " . TABLE_PREFIX . "xperience_stats CHANGE points_misc_postrate points_post_postrate BIGINT");

So one may need to execute MySQL command to change "points_misc_postrate" to "points_post_postrate" by oneself.

AND THIS MAY BE A BUG FOR vBExperience:

awardfields for Awards are stored in table: <TABLE_PREFIX>xperience_awards

For Awards that take points_misc_postrate into account, it will store this fieldname in this awardfields. After I change the field to points_misc_postrate, the awardfields is not updated. So SQL query error is triggered say field points_misc_postrate doesn't exist (of course). This is true for any addon that update/upgrade containing changing of field names.

[jerx]

Will this mod be updated for vb 3.8 beta (maybe RC) or will you wait until vb 3.8 becomes final? Or is it possible for non coders to adjust vbExperience? Eg the security token has been changed during one of the last vbulletin updates and it is pretty easy to solve this problem.

I am asking, because the new vbulletin version has social group improvements which are badly needed. I know that you have released a very fine mod called social forums, which is even better in terms of social group messages, but it probably won' t get updated to vb 3.8.

Thank you!

[Phalynx]

Originally Posted by Morrus

Question: (trying to decide whether to downlaod this or vBCredits) - is there a "per forum" setting? For example, can I allow users to earn points by creating a thread in my review forums (which power GARS), or news forums (which power VBA CMS), but not elsewhere?

You can use the CDP Interface to collect data on your own, f.e. just for some forums.

Originally Posted by Morrus

In addition, when defining levels and experience points, can I define level titles also?

Yes, in conjunction with usergroups.

Originally Posted by Thijmen1992

I can't manage my settings in the AdminCP.

Use the default way for settings (AdminCP/Settings)

Originally Posted by biocyberman

I fixed it and save as addon_for_3.7.18_postrate.xml

Thanks. I changed xperience_earn_postrate to xperience_earn_post to create a valid hook. 3.7.18 will include this addon.

Originally Posted by biocyberman

There is might be a small problem if somebody installed my previous release of this hack:
This code doesn't seem to work:

if (field_exists('xperience_stats', 'points_misc_postrate')) $vbulletin->db->query_write("ALTER TABLE " . TABLE_PREFIX . "xperience_stats CHANGE points_misc_postrate points_post_postrate BIGINT");

You will have to increase the version of the code
<code version="1.0.0"> -> <code version="1.0.1">, or just simply do a <code version="*"> to execute it on every install.

Originally Posted by biocyberman

awardfields for Awards are stored in table: <TABLE_PREFIX>xperience_awards. For Awards that take points_misc_postrate into account, it will store this fieldname in this awardfields. After I change the field to points_misc_postrate, the awardfields is not updated. So SQL query error is triggered say field points_misc_postrate doesn't exist (of course). This is true for any addon that update/upgrade containing changing of field names.

It should be avoided to change the fieldname. But if you change it, you will have to change possibly created awards on your own. Just go to awards, select new field and save.

Originally Posted by jerx

Will this mod be updated for vb 3.8 beta (maybe RC) or will you wait until vb 3.8 becomes final? Or is it possible for non coders to adjust vbExperience? Eg the security token has been changed during one of the last vbulletin updates and it is pretty easy to solve this problem.

Beta 3 will already be adapted to 3.8 Beta 1.

[gorentals]

Anyone know if you can just remove the Activity bar in the postbit?

[Phalynx]

Originally Posted by gorentals

Anyone know if you can just remove the Activity bar in the postbit?

You will need to remove it from the template "xperience_gfx".

[gorentals]

Thank you Phalynx

[Thijmen1992]

Originally Posted by Phalynx

Use the default way for settings (AdminCP/Settings)

Perhaps you have a solution?

[WNxWakko]

Love the mod. I have one request. I don't like having the mini award show up next to the username in the postbit. I attempted to grab the code that goes there from the templates and insert it into my postbit directly at my preferred location however it doesn't work. It gives me a dead image. I viewed the image path and its not including the end of the image name.gif

What is the bit i can put in my postbit to have the award appear other than using the settings? I need to actually code if that is possible.

Thanks,