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]

This has been already addressed in 4.1.0
However, vBExperience was never vulnerable to SQL, just remote cross-site scripting (XSS). Thats a big difference.

[Vowgaming]

Hi was wondering if I could get a hand on modding the code slightly.

My users Love the Mod but have raised a concern with activity showing up as negative points when a few things get changed or deleted

Was hopping for some pointers on what file or where I need to edit to modify this.

I also have coded up a ventrilo add on if someone would like a look at the raw basic code im happy to post.

[Phalynx]

There is no real possibility to disallow negative points, as vBExperience always recalculates all points from beginning. But you could do something with the hooks to save the points before they are wiped and only save if its get higher...

Would be great to see what you have done with Ventrilo.

[Vowgaming]

Warning This code is very poor in some ways. I'm not a professional coder at all just hack and play till i get it working.

firstly you need to use this in conjunction with http://www.ventrilo.com/dlprod.php?id=201

PHP Code:

<?php

include "ventrilostatus.php";

include "ventriloinfo_ex1.php";
include "ventrilodisplay_ex1.php";
include "ventrilodisplay_ex2.php";

$filename = '/home/vowgamin/public_html/vent/ventrilo_status';

$current_timestamp=mktime(date("H"), date("i"), 0, date("m"), date("d"), date("Y"));


function toArray($data) {
    if (is_object($data)) $data = get_object_vars($data);
    return is_array($data) ? array_map(__FUNCTION__, $data) : $data;
}

function myTruncate($string, $limit, $break=".", $pad="...")
{
// return with no change if string is shorter than $limit
    if(strlen($string) <= $limit) return $string;
// is $break present between $limit and the end of the string?
    if(false !== ($breakpoint = strpos($string, $break, $limit))) {
        if($breakpoint < strlen($string) - 1) {
$string = substr($string, 0, $breakpoint);
        }
    }
return $string;
}

$stat = new CVentriloStatus;
$stat->m_cmdprog    = "/home/vowgamin/public_html/vent/ventrilo_status";    // Adjust accordingly.
$stat->m_cmdcode    = "2";                    // Detail mode.
$stat->m_cmdhost    = "Vent server address";            // Assume ventrilo server on same machine.
$stat->m_cmdport    = "port";                // Port to be statused.
$stat->m_cmdpass    = "";                    // Status password if necessary.

$rc = $stat->Request();


$data = toArray($stat);

// This code truncates the user names removing anything after the _ key
$i=0;
while (list($key, $val) = each($data[m_clientlist]))
  {
  $users[$i][name]=myTruncate($val[m_name],1, "_");
  $users[$i][chan]=myTruncate($val[m_cid],1, "_");
  $i=$i+1;
  }

$i=0;
foreach ($users as $value) {

// the following checks ventrilo channel name if it is not the parent channel get the parent channel name
foreach ($data[m_channellist] as $k => $v)
{
    if ($users[$i][chan] == $v[m_cid])
    {
        if ($v[m_pid] == 0)
        {
            $users[$i][chananme]=$v[m_name];
        }
        else
        {
            $chan2=$v[m_pid];
            foreach ($data[m_channellist] as $j => $b)
            {
            if ($chan2 == $b[m_cid]) $users[$i][chananme]=$b[m_name];
            }
        }
    }
}
    $i=$i+1;
  }

// connect to the database and pull out all the data assigning it to the forum array for searching latter
$link = mysql_connect('localhost', '********', '**********');
if (!$link) {
    die('Could not connect: ' . mysql_error());
}
mysql_select_db("vowgamin_Vbulletin", $link);
$query = "SELECT * FROM user";
$result = mysql_query($query) or die(mysql_error());
$i=0;
while($row = mysql_fetch_array($result)){
$forum[$i]['username']=$row['username'];
$forum[$i]['xperience']=$row['xperience'];
$forum[$i]['userid']=$row['userid'];
$forum[$i]['usergroupid']=$row['usergroupid'];
    
    $i=$i+1;
    }

$size= 0;
$size2= 0;
$size = sizeof($users); // set the size of the upcoming for loops
$size2 = sizeof($forum);

// go through all users on the vent server looking for a case insensitive match
for ($h = 0; $h <= $size; $h++)
{
  for ($i = 0; $i <= $size2; $i++)
    {
    if (strcasecmp($users[$h]['name'], $forum[$i]['username']) == 0)
    {
      $m[$h]['username'] =$forum[$i]['username'];
      $m[$h]['xperience'] =$forum[$i]['xperience'];
      $m[$h]['channame'] =$users[$h]['chananme'];
      $m[$h]['userid'] =$forum[$i]['userid'];
      $m[$h]['usergroupid'] =$forum[$i]['usergroupid'];
    }

    if ($users[$h]['name']=="Match")
    {
        $match=4; // the multiplier for clan matches
        $chan=$users[$h][chananme]; // record the channel name down where match bot is located
    }
    }
}

$array=array_filter($m);

$size3= sizeof($array);
for ($j = 0; $j <= $size3; $j++)
{
$points=3; // default points per cron job
$message= "Ventrilo Participation";
$experience = $array[$j]['xperience'];
$userid = $array[$j]['userid'];

// Check to see if the match bot is in the chanel and change message plus points
if ($array[$j][channame] == $chan)
{
   $message="Ventrilo Clan Match Participation";
    $points=5*$match;
}
// adjust points to 1 for users sitting in afk channel
if ($array[$j][channame] == "AFK")
{
    $points=1;
    $message="AFK user";
}
if ($array[$j][channame] == "Members Lounge")
{
    $points=2;
    $message="Members Lounge Ventrilo";
}
if ($array[$j][channame] == "Sulk Room")
{
    $points=-20;
    $message="Members Lounge Ventrilo";
}
// adjust points for boot camp users to stop them ranking up to quick
if ($array[$j]['usergroupid'] == "55")
{
    $points=1;
    $message="Boot Camp User";
}

// check to make sure a user exists then enter data into the database
if ($userid)
{
$query2 = "INSERT INTO xperience_custompoints (userid, points_misc_custom, adminid, comment, dateline) VALUES ( $userid, $points , 1, '$message', $current_timestamp)";
//echo $query2."<br />";

mysql_query($query2);
}
}
mysql_close($link);

You will need to add your own server and port for ventrilo setup and change the ***** to your details for the database.

I have also hard coded this for the names of our vent channels and have included a check to see if a user match bot is part of the channel if it is increase the points

This script is run by a cron job every 15 mins and it adds points to the custom point table. (This is becoming an issue as the table is getting quite large)

[Vowgaming]

Originally Posted by Phalynx

There is no real possibility to disallow negative points, as vBExperience always recalculates all points from beginning. But you could do something with the hooks to save the points before they are wiped and only save if its get higher...

Would be great to see what you have done with Ventrilo.

As you can see from the Ventrillo post above I'm ok a getting things modded can you give me a tip on where to start with this. I have looked through most of the php scripts and hooks. was hopping to find a place just before it wrote the info into the database and check if <0 skip the sql write

[Iron Star]

Hi,

I installed it and GG! Very good script.

I got bugs on xperience.php page:

- link to member profiles aren't correct in "recent activity"
- the template doesn't close correctly and footer is broken

How can I correct that?

Thank a lot.

[Vowgaming]

Originally Posted by Vowgaming

Hi was wondering if I could get a hand on modding the code slightly.

My users Love the Mod but have raised a concern with activity showing up as negative points when a few things get changed or deleted

Was hopping for some pointers on what file or where I need to edit to modify this.

Found it in class_xperience.php

find this code

PHP Code:

($hook = vBulletinHook::fetch_hook('xperience_calcdata_stats')) ? eval($hook) : false;
    
        if (count($xperience_old) > 0 AND count($xperience_new) > 0)
        {
            foreach($xperience_old AS $fieldk => $fielde)
            {
                if (!in_array($fieldk, $fields_notallowed))
                {
                    if ($xperience_new[$fieldk] > $fielde OR $xperience_new[$fieldk] < $fielde)
                    {
                        $difference = $xperience_new[$fieldk] - $fielde; 


and add this line at the end

PHP Code:

if ($difference < "0") $difference ="0"; 


That way if some one receives experience less then 0 it will be recorded as 0

I hope this is correct please tell me if i need to change anything else

[Iron Star]

Originally Posted by Iron Star

Hi,


- link to member profiles aren't correct in "recent activity"


Thank a lot.

I found the pb in xperience_activity_x_earn template:

replace "<a href="{1}">{2}</a> earns {3}" with "<a href="member.php?u={1}">{2}</a> earns {3}"

[JonUrban]

I installed this and it seems to be working fine. It took about a week to get everyone's "Experience" level icons up to speed. It was interesting to see it happen over the week.

One thing that would be nice is if it could somehow subtract points for those who don't login anymore or have left the forum. I noticed that some members who have not logged in for years have large experience scores because they used to post a lot. Removing points for inactivity would be something that I would think would be a good feature.

Other than that, this is a great mod.

[bposner]

Seems achievement icons are not displaying, everything else seem fine. Seen screen shot:

http://screencast.com/t/t1pBz5bm