Major Additions - vBExperience 4

vBExperience 4.1 for vBulletin 4

Tested with all Version of vBulletin Forum and Suite 4.0.4 -> 4.1.11

Created by Marius Czyz aka Phalynx.

Triple Winner of the "Mod of the Month"-Award (March 2008, September 2009, July 2010) on vBulletin.org.

What is vBExperience?
vBExperience is your free feature packaged solution for motivating your users. vBExperience is an advanced and highly customizable level/promotion and activity measure system with awards, achievements, promotions 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.

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? How can the user's activitiy be compared to others? All this can be answered with this mod. Additionally your users get awards and collect achievements for beeing active on your board.

vBExperience is fully translated to many languages. Beside english there are language files for german, french, italian, portuguese, spanish, swedish and chinese simplified. Polish, turkish, persian are not fully translated.

Comments, suggestions, translations, bugs, etc... are very welcome! Support is only given to people who have clicked "Mark as Installed":
https://vborg.vbsupport.ru/vborg_mis...hreadid=245023


/***** Demo *****\
No Demosite currently available.


/***** INSTALLATION *****\
Please read the file readme_install_uninstall_upgrade.txt for detailed instructions!


/***** Primary Support *****\
As vBulletin.org does not offer any help managing modifications, espacially the complex one like vBExperience, I have to decided to open a site together with TheMayhem that is dedicated just for this.
It features a forum not just a single thread, a bug and feature tracker. And you also test our modifications over there.



/***** Featurelist *****\

*** Plugins ***
vBExperience can be easily extended by using it's custom data provider interface (CDP). With the CDP everyone is able to create plugins that integrates into vBExperience calculation process. There are already several plugins like Post Thanks Integration.
The plugins data can also be used to create achievements, awards and also promotions.


*** Insight Experience ***
The insight into your personal experience and what's going on on the community. Currently support basic services like activity and some featured achievements, there are plans to extend this with helpful hints on how progress, depending on users points. Also a statistics module is in work.


*** Awards ***
Motivate your users to be the best in a defined category! With the Awards you are able to reward users who collect the most points, f.e. by making new friends and leading a social group.
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.

Currently there are six default awards: Most Popular, Activity Award, Posting Award, Community Award, Frequent Poster, Blog Award, Calendar Award, Discussion Ender, Master Tagger, User with most referrers, Downloads, Arm of Law, King of Publishing.
You can create as much awards as you like. Just select a title, choose from one of the 250 images and select the required points for it.


*** Achievements ***
Achievements are very similar to the awards a reward to the user. Unlike an award an achievement is not limited to a single user.
Similar to awards, you can create as much achievements as you like. Just select a title, choose from one of the over 500 images and create the required condition for it.


*** Promotion system ***
The promotion system enables you to move users to other usergroups, depending on their experience points. You can create conditions that have to be met to be promoted. Benefits and extended permissions will be shown automatically to the user. Promotions are showing also possible jumps from current to the next possible group with the required conditions.
Using this you can create multiple groups and assign additional features. Just an example: Usergroup 1 has no custom avatars and just a capacity of 20 private messages. With a condition of 1000 Experience points the user moves to Usergroup 2, where the user is able to upload his own avatar and store more private messages.


*** Rankings ***
Showing User, Level, Awards, Activity Points (experience, thread, post, user, misc) - sortable.


*** Social Groups Rankings ***
Starts the competition between social groups! This feature ranks the groups depending on their average user experience points.


*** Earn Points ***
This is an overview for the user on how points can be collected. It features also a possibility to compare own points to the community's average. All data is beeing pulled automatically from the database.


*** Give Away Points aka Point Donation ***
Users can donate their points to other community members. Choose the field which will be used for give away and select the amount that will be transferred. Admins can donate custom points to the user.


*** Statistics aka Leaderboards ***
The leaderboard 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.


*** Shop aka Market ***
vBExperience integrates easily with the Point Market System v3 by TheMayham (https://vborg.vbsupport.ru/showthread.php?t=232676).
It features a virtual item store, username items, bank, gifts, gambling, lottery, and a lot more!
As of vBExperience 4.0, the vBExperience 3.8 Shop has been discontinued.



/***** Collecting Points *****\
vBExperience is collecting points for a user counting his actions in the community. The collected points can be used to reward users with awards, achievements and promotions - even if the collected data comes from a plugin.

Beside the automatic collection, the admin can manually donate custom points to the user, for example for a special reward. Of course you can use this also for awards, achievements and promotions.


Taken into calculation are these things:
Threads
- Creating threads and gaining additional points from views, replies, votes and ratings to this thread
- Creating thread tags
- Making a thread sticky
- Socialgroup Discussions (Discussions, Posts)

Posts
- Creating posts
- Views on attachments (needs "Who Downloaded This Attachment?" installed)

User
- Days since registration
- Average posts per Day (for users who are registered for at least seven days)
- Referrals
- Received infractions
- Given infractions ("Arm of Law")
- Reputation / Use of reputation system
- Visitor messages on profiles
- Creating social groups and getting members
- Uploading pictures
- Making friends
- Completing profile

Misc
- Doing calendar entries
- Writing vBulletin Blogs (vBulletin 4 Suite required)
- Publishing content with vBulletin CMS (vBulletin 4 Suite required)
- Manually assigned points

Additionally there is support for 3rd party modifications:
- Point Market System / Items Shop (included)
- Project Tools (plugin)
- Who Downloaded This Attachment? (plugin)
- DownloadsII v6 (included)
- LDM Links and Downloads Manager (included)
- Abe1 Post Thank You (plugin)
- DBTech Advanced Post Thanks/Like (Lite) (plugin)
- DBTech Advanced @UserTag (plugin)
- Helpful Answers (plugin)
- iTrader (plugin)
- ibProArcade (plugin)
- v3arcade Champions and Submissions (plugin)
- vB Tournaments and Ladders (plugin)
- Advanced Forum Points - set points independent for every forum (plugin)
- Consuming points by downloading attachments ("pay" for attachments) (plugin)
- IWT Time Spent Online (plugin)
- PhotoPost Pro 7 (plugin)
- PhotoPost vBGallery 3 (plugin)
- 8WR Media Library (plugin)
- vBSoccer (plugin)
- vBookie (plugin)
- vBookie Cash (plugin)
- Farcaster's Event Attendance (plugin)
- PhotoPlug (plugin)
- EasyForms (plugin)
- Triple Triad (plugin)
- AWCoding Donation System LITE (shipped within that product)
- AWCoding Donation System PRO (shipped within that product)
- AWCoding Subscription System PRO (shipped within that product)
- AWCoding Credit Purchase System LITE (shipped within that product)
- AWCoding Credit Purchase System PRO (shipped within that product)
- AWCoding Pirate Poker PRO (shipped within that product)
- AWCoding Pirate Poker Platinum (shipped within that product)
- AWCoding Product System PRO (shipped within that product)



You have to install these modifications for your own, vBExperience doesn't install nor touches these.
More addons will be published as soon as they are finished.



/***** Calculation of the activity *****\
The system calculates the activity (week, month and also a custom defined datespan, 60) by counting the actions a user has done. An action can be a post, a new thread, rating, download, etc... The activity bars will be filled during the first weeks. This has changed from earlier versions where just postings, visitor- and group messages have been counted.



/***** 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.
Many settings regarding the behaviour of vBExperience are making it easy to adjust it to your needs. You can select from 10 colors for the progress bars and also choose from around 250 icons.
Additionally, you can set ignore users (f.e. for bot users), forums (f.e. offtopic forums) and usergroup id's. Please keep in mind that out of the box the usergroupid 6 (Administrators) is beeing ignored.



/***** Performance, especially on 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 the word "Experience".

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. If you used vBCredits, vBActivity, uCash and similar systems - there is no need to convert the points.

Q: My conditions don't work correctly on achievements and promotions.
A: Conditions in achievements and promotions are calculated in POINTS, not in count of items.
If you create an achievement for reaching the first 10 Days, you must enter the points needed for this. If you reward 2 points for every day, you have to set 2 points for every day since registering. Calculation: 10 days * 2 points = 20 as condition. So you will have to set 20 as the condition.

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



/***** History *****\

vBExperience 4.1.1

Please reinstall ALL plugins you are using from the ZIP\Plugins! Espacially if you get SQL Errors after reinstalling vBExperience.

- Fixed Plugin for 8WR_Media_Library
- Fixed Plugin for Advanced_Forum_Points
- Fixed Plugin for Attachment_Consumes_Points
- Fixed Plugin for EasyForms
- Fixed Plugin for Post_Thanks_Abe1
- Fixed border around boxes
- Fixed not correctly saving award images
- Extended character length for manual award assignment
- Several smaller fixes

vBExperience 4.1.0, 16th December 2011

- Introduced the feature to start the calculation by a defined date. By default all data will be considered for calculation. Please keep in mind that there are some data that cannot be filtered by date, like added friends. You need to re-install all plugins to have them obeying the new calculation limit. This feature has been sponsored by BryanB. Thanks!
- Fixed Discussion Ender, can be now disabled by setting value to 0
- Fixed Arm of Law, can be now disabled by setting value to 0
- Insight: Optimized layout
- Insight: Optimized colours for darker styles
- Achievement "Three Friends" renamed to "Social" (does not affect existing achievement)
- Renamed point descriptions so they can be identified better as point system (f.e. Days since registered -> Points for every day since registration)
- Added: Romanian Translation (thanks to Teascu Dorin)
- Custom Points can now have a category, can be used as entry point for other modifications using vBExperience points, eg. Market/Shop purchases
- Fixed several smaller issues

Changelog for other versions is in history.txt

[Phalynx]

Originally Posted by xXxpert

i1 problem
please see the image

Please click "Mark as Installed" to get further support.
Choose another location from the existing. Check settings for bars.

Originally Posted by Pro-eSports.com

1. What's up with the database error I always get when it comes to awards? Here the content of the e-mail.

You erased the field for the award limit. Please fill in a value.

Originally Posted by Pro-eSports.com

2. How to put a border around the Experience stuff in the postbit legacy?

That depends on your style. Take a look at the style in postbit. You need to edit the template xperience_gfx

Originally Posted by zonaenlinea

yes, but not display the image so the error is sebe image

I will implement a setting to do it without modifying templates.

Originally Posted by ChangeFive

After uninstalling on test machine, get following DB error:

Database error in vBulletin 4.0.6:

Invalid SQL:
UPDATE user SET xperience_done=0 WHERE userid='1';

MySQL Error   : Unknown column 'xperience_done' in 'field list'
Error Number  : 1054
Request Date  : Wednesday, October 13th 2010 @ 02:47:41 PM
Error Date    : Wednesday, October 13th 2010 @ 02:47:41 PM
Script        : http://www.*******.net/vbtest/login.php?do=login
Referrer      : http://www.******.net/vbtest/admincp/options.php?null=0
IP Address    : ******
Username      : ******
Classname     : vB_Database
MySQL Version : 5.1.48

Any suggestions? As it stands right now, I cannot even log back on to the forum.

How did you uninstalled it? It seems not all has been removed like it should.

To get back to your board you need to disable hooks via config.php

[ChangeFive]

Originally Posted by Phalynx

How did you uninstalled it? It seems not all has been removed like it should.

To get back to your board you need to disable hooks via config.php

When I uninstalled it, I uploaded the kill_xperience.php and ran it. After that I started removing all the files I uploaded via FTP. I don't think I got any further than that.

I was looking through my config.php and did not see any switches for disabling hooks.

[Pro-eSports.com]

Thanks for the help.

Is it possible to disable the 2 templates which display the level and points seperately in the postbit legacy?



This is my "Level" code:

<div class="pbit"><dt>{vb:rawphrase xperience_level}</dt> <dd>{vb:raw xperience.level}</dd></div>

I don't want to delete it, just disable it. Is there a command to disable this code/template?

[Phalynx]

Originally Posted by ChangeFive

When I uninstalled it, I uploaded the kill_xperience.php and ran it. After that I started removing all the files I uploaded via FTP. I don't think I got any further than that.

I was looking through my config.php and did not see any switches for disabling hooks.

Please copy all files from ZIP -> includes into your machine and uninstall the plugin/product first, after that you can run kill.

To disable plugins put this into your config.php:
define('DISABLE_HOOKS', true);

Remove it afterwards.

Originally Posted by Pro-eSports.com

Thanks for the help.

Is it possible to disable the 2 templates which display the level and points seperately in the postbit legacy?



This is my "Level" code:

<div class="pbit"><dt>{vb:rawphrase xperience_level}</dt> <dd>{vb:raw xperience.level}</dd></div>

I don't want to delete it, just disable it. Is there a command to disable this code/template?

I don't know what you mean by disable. You can disable the whole displaying of both by switching it off in settings.

[slinky]

Originally Posted by Phalynx

This should no happen. I know other boards running that count of users having no issues. Can I take a look at this? Please PM me.

I just sent you a PM with the site info. I am now running the recount again and you'll see the errors that will come up and double calculations when it rolls over in the activities panel. I never get past the "3 months registered" achievement. Never gets to the 1 year, etc. and then the rest of the achievements.

Originally Posted by slinky
I still haven't been able to do a recount. It gets stuck at "processing achievement 8" although I see a "processing complete" link at the bottom of the page. I click that and it just goes back into the loop, processing users twice in a row for 3 month awards and can't seem to get past that. I'm wondering if others are experiencing a similar bug. I have many users on my site (over 50,000) but this shouldn't present a problem as it finished the others.

Originally Posted by slinky
I deleted the "xperience_achievements_issues" table and ran the rebuild again. There must be some bug because it apparently completes everything up to the 8th award, which is 3 months of membership. Then it loops again into the that award and I can see in the "Activities" panel it showing that members are receiving the 3 month award twice in a row, then it goes to the next member and does the same thing. Hmmm.... disappointing. Hopefully this can be figured out.

[slinky]

I noticed there was also an error in the 1 year achievements - it says "719" in the "days since registering" part of the details of the achievement. I changed it to 365 and saved it. I can't imagine this happened random and I guess it's an error in the install data.

[slinky]

I also noticed that the "Overdrive" was set to 100 days. I fixed that and put in 3650 for 10 years. But I noticed that this last achievement will not allow me to have the system save "replace... Veteran." It defaults to a dash (no selection) after saving. I also can't change the names of these achievements either.

[slinky]

Got it - the source of the bug was the dates that were pre-entered into the vBexperience achievements above. It is now processing everythin correctly. The only item outstanding but right now is the Overdrive bug that doesn't allow replacement of the Veteran nor does it allow renaming the name of the achievements (won't save.)

[Phalynx]

Originally Posted by slinky

I just sent you a PM with the site info. I am now running the recount again and you'll see the errors that will come up and double calculations when it rolls over in the activities panel. I never get past the "3 months registered" achievement. Never gets to the 1 year, etc. and then the rest of the achievements.

Originally Posted by slinky
I still haven't been able to do a recount. It gets stuck at "processing achievement 8" although I see a "processing complete" link at the bottom of the page. I click that and it just goes back into the loop, processing users twice in a row for 3 month awards and can't seem to get past that. I'm wondering if others are experiencing a similar bug. I have many users on my site (over 50,000) but this shouldn't present a problem as it finished the others.

Originally Posted by slinky
I deleted the "xperience_achievements_issues" table and ran the rebuild again. There must be some bug because it apparently completes everything up to the 8th award, which is 3 months of membership. Then it loops again into the that award and I can see in the "Activities" panel it showing that members are receiving the 3 month award twice in a row, then it goes to the next member and does the same thing. Hmmm.... disappointing. Hopefully this can be figured out.

Still cannot confirm this. I will read your PM and take a closer look.

Originally Posted by slinky

I noticed there was also an error in the 1 year achievements - it says "719" in the "days since registering" part of the details of the achievement. I changed it to 365 and saved it. I can't imagine this happened random and I guess it's an error in the install data.

This is not an error. You should revert it. Please read readme.txt:
Q: My conditions don't work correctly on achievements and promotions.
A: Conditions in achievements and promotions are calculated in POINTS, not in count of items.
If you create an achievement for reaching the first 10 Days, you must enter the points needed for this. If you reward 2 points for every day, you have to set 2 points for every day since registering. Calculation: 10 days * 2 points = 20 as condition. So you will have to set 20 as the condition.

Originally Posted by slinky

I also noticed that the "Overdrive" was set to 100 days. I fixed that and put in 3650 for 10 years. But I noticed that this last achievement will not allow me to have the system save "replace... Veteran." It defaults to a dash (no selection) after saving. I also can't change the names of these achievements either.

Originally Posted by slinky

Got it - the source of the bug was the dates that were pre-entered into the vBexperience achievements above. It is now processing everythin correctly. The only item outstanding but right now is the Overdrive bug that doesn't allow replacement of the Veteran nor does it allow renaming the name of the achievements (won't save.)

"Overdrive" is an achievement for users if they reach 100% activity. It has nothing to to with days, years, etc.... Why can't you change the name? Please explain more, like error, etc...

[ChangeFive]

Originally Posted by Phalynx

Please copy all files from ZIP -> includes into your machine and uninstall the plugin/product first, after that you can run kill.

To disable plugins put this into your config.php:
define('DISABLE_HOOKS', true);

Remove it afterwards.

This worked. Thank you for your help.