Top Level Category

Table of Contents

1. Contents of Top Level Category
   1. AddonChat
      1. Chat Client (Articles concerning the addonChat Java Chat...)
      2. Control Panel (Articles concerning the addonChat Admin Control...)
      3. Transcripts (Articles concerning addonChat transcripts / logs.)
      4. Custom Integration (Specifications and articles relating to...)
         1. Remote Authentication (Specifications for the Remote Authentication...)
         2. Code Parameters, Direct Settings, Remote Functions, Who's Chatting, etc.. (Articles and specifications relating to...)
         3. Advanced Integration (Topics including external functions and...)
      5. Integration Scripts & Howtos (Articles and resources concerning AddonChat...)
         1. vBulletin (Full featured vBulletin Product/Plugins...)
         2. Advanced Integration (Topics including remote authentication,...)
         3. Drupal (Full featured Drupal Modules including...)
         4. phpBB (phpBB Integration Scripts)
      6. Who's Chatting (Articles regarding the Who's Chatting system,...)
      7. International (Language support, character encoding, bilingual...)
      8. Emoticons (Articles regarding AddonChat emoticons, and...)
      9. Tutorials (Useful articles, tutorials, and user manuals...)
   2. Legacy Applications
      1. ICE Instant Messaging
      2. RaiderCSS
   3. My Account

Top Level Category

Problems? Try the TroubleShooter first!

1. Problems loading a chat room, or logging in
2. Lag issues
3. Control panel login issues, or lost passwords
4. Unanswered support or sales inquiries
5. Copy/paste issues within AddonChat
6. Transcript (Log) issues
7. Determining which edition of AddonChat is best for you
8. ... and much more!

AddonChat

Chat Client

"load: class Client not found" error

The load: class Client not found error can be caused by a number of different problems. Usually, this problem indicates that your web browser has downloaded/ cached an invalid copy of our chat software (cache instability or an error in download). Minor network glitches between your computer and our servers can also cause the problem. The problem can be resolved by emptying your browsers cache (or Temporary Internet Files), then shutting down all instances of your web browser, and trying again. In rare circumstances, a reboot may be required. Click the link below to learn how to clear your browser's cache.

In some cases, this problem can be caused because you have not copy and pasted your applet code correctly, or if you have entered your account number or server ID number incorrectly when integrating with applications such as Invision Power Board, vBulletin, ProBoards, phpBB, or SMF.

Clearing your browser's cache - http://support.addoninteractive.com/index.php?action=kb&article=2

Blank gray box when loading applet

"Bad Magic Number" error when loading Java applet

A message appears requiring a software install when I try to load the chat room.

I cannot connect when using a Macintosh computer using OS-9 or below.

Clearing your browser's cache

1. Click on Tools (or the Tools icon) from the Command Bar
2. Select Delete Browsing History...
3. Click the Delete files... button near Temporary Internet Files
4. Click Yes when prompted to delete temporary Internet Explorer files
5. Click the Close button
6. Shutdown all open instances of your web browser and restart

1. Click on Tools from your browser's main menu
2. Select Clear Private Data...
3. Ensure that Cache is checked
4. Click the Clear Private Data Now button
5. Shutdown all open instances of your web browser and restart

To empty your browser's cache using Microsoft Internet Explorer version 6

1. Click on Tools from your browser's main menu.
2. Select Internet Options
3. Under the General tab, click Delete Files... in the Temporary Internet files section.
4. Important: Shutdown all open instances of your web browser.

To empty your browser's cache using Firefox version 1.5

1. Click on Tools from your browser's main menu.
2. Select Options
3. Select the Privacy icon
   
4. Select  Cache tab.
5. Click the Clear Cache Now button
   
6. Important: Shutdown all open instances of your web browser.

To empty your browser's cache using Safari

1. Click on Safari from the main menu.
2. Click Empty Cache...
3. Important: Shutdown all open instances of your web browser.

To empty your browser's cache using Opera

1. Click on Tools from your browser's main menu.
2. Select Delete private data...
   
3. Click the Delete button
   
4. Important: Shutdown all open instances of your web browser.

To empty your browser's cache using Netscape

1. Click on Edit from your browser's main menu.
2. Select Preferences
3. Select and expand the Advanced category.
4. Click on Cache
5. Under Set Cache Options:
   1. Click Clear Memory Cache
   2. Click Clear Disk Cache
6. Click OK
7. Important: Shutdown all open instances of your web browser.

Unable to login using the AOL web browser

"applet client not inited" error when loading Java applet

"Applet requires a new version of Java" message

If this does not remedy your issue, please follow the troubleshooter here for further steps that you may take.

A Red X image is displayed where the applet should be, applets won't run

Resolving Firewall Issues

If you are having difficulty connecting from behind a firewall, you may wish to consider purchasing the Firewall Friendly module or upgrading to the Enterprise edition. If you do not have the Firewall Friendly module and wish to adjust your firewall settings to allow connections to our chat servers, please continue reading:

Before continuing, you will need the following information:

1. Login to your Account Control Panel from http://www.addonchat.com/.
2. Click the Settings tab
3. Select the Advanced Link in the submenu
4. Find the section labeled Tunnel (Proxy) Connections
5. Set Allow Tunnel Connections to Yes
6. Click the Click Here To Save Changes button

Kicking & Banning Users

• Kick User
• Ban User's IP Address
• Ban User's IP Address with Cookie Ban
• Ban User's IP Class C Subnet

Guest Speakers & Moderation

Copy & Paste Issues

Embedding Images in your Chat Room using HTML (Unsupported Feature)

Popup message appears whenever a message is entered in the chat room.

Resolving Windows Vista AddonChat Loading Issue

If, when loading the chat room, the blue loading bar appears for a very long time, and the chat room applet never comes up, the following may help you to immediately resolve the problem. This problem is also associated with very slow page loading using Firefox, and slow eMail sending/retrieval using Thunderbird.

The following solution applies to Windows Vista users only.

Important Update: Recent network modifications and upgrades have all but eliminated this issue. Most users should no longer experience this issue, nor should they have to disable TCP auto-tuning as instructed below. Should you continue to experience this issue using Windows Vista, we recommend ensuring that you've downloaded the latest patches and upgrades for Windows Vista, and ensure that any network hardware (modems, firewalls, etc..) are Windows Vista compatible.

The Windows Vista TCP Stack has been re-written. The following solution appears to correct many internet-related issues with Windows Vista, and seems to resolve the problem. There should be no negative effects from performing the following; but we have provided you with instructions for undoing this should you feel it necessary.

Part I: Disable TCP Autotuning

1. Click the Start (Windows Logo) icon
2. Select 'All Programs'
3. Select 'Accessories'
4. Right-Click on 'Command Prompt'
5. Click 'Run as Administrator'
6. A dialog box will ask you to confirm. Click the 'Continue' button to proceed.
7. Type: netsh interface tcp set global autotuning=disabled
8. Press 'Enter'
9. The message 'Ok.' should appear.
10. Type: exit

Part II: Empty your Java Cache

1. Visit http://www.addonchat.com/demo.html
2. The Java icon will appear in your task icon list in the lower-right hand corner of your screen
3. Right-click the Java (coffee-cup) icon and select 'Open Control Panel'
4. Under 'Temporary Internet Files', click 'Settings'
5. Click the 'Delete Files...' button
6. A window titled 'Delete Temporary Files' will appear. Make sure all options are checked and click 'OK'
7. Click 'OK' to exit the 'Temporary File Settings' window.
8. Click 'OK' to exit the Java Control Panel

Part III: Empty your browser's cache

1. Clear your browser's cache. Visit http://support.addoninteractive.com/index.php?action=kb&article=2 for complete instructions.
2. Shut down all instances of your web browser.

That's all. You may now try to load the chat applet. If you have any questions regarding this procedure, please let us know.

This issue is likely to work itself out in the near future as future updates of Windows Vista and Java are released to the public -- once these updates have been released, your users will not be required to go through the above procedure.

If, for any reason at all, you need to undo the above procedure, follow these steps:

1. Click the Start (Windows Logo) icon
2. Select 'All Programs'
3. Select 'Accessories'
4. Right-Click on 'Command Prompt'
5. Click 'Run as Administrator'
6. A dialog box will ask you to confirm. Click the 'Continue' button to proceed.
7. Type: netsh interface tcp set global autotuninglevel=normal
8. Press 'Enter'
9. The message 'Ok.' should appear.
10. Type: exit

Disabling DEP (Data Execution Protection) in MSIE 7 using Windows Vista to allow Java applets to run.

1. Launch Internet Explorer v7 in Windows Vista as an Administrator. (Right click on IE7 from Start Menu and select Run As Administrator)
   
2. Click the Tools menu or Command Bar pulldown
3. Select the Advanced tab
4. Scroll down towards the Security section
5. Uncheck the item called Enabled memory protection to help mitigate online attacks
6. Click the OK button
7. Close any open web browsers and restart

Offline Java Installation

1. First, un-install any version of Java you're currently using
2. Click on the following link: http://www.java.com/en/download/manual.jsp
3. Scroll down to find the operating system that you're using
4. Click the download link for the version recommended for your operating system. Be sure to select the Offline download. Download the file to your desktop.
5. Close all open browsers
6. Double-click the file you've just downloaded to begin installing Java

Windows Can't Verify Publisher

Control Panel

Direct Settings

color.applet.background = ffffaa
layout.applet.icon.help = 1
float.width = 700
campaign.engine.enable = 0
chatpane.border = 1
url.exit = http://www.addonChat.com/
url.exit.enable = true
text.applet.title = Title
macro.1 = "Direct Settings Macro", "A Sample Macro", "false"
text.applet.login.button.register = Register a Username
text.applet.display.msg.kicked = User <i>$username</i> has logged out.
text.applet.display.msg.banned = User <i>$username</i> has logged out.
text.applet.display.msg.help = This is my custom user help message.
text.applet.display.msg.help.admin = This is my custom admin help message.

text.applet.display.msg.help = This is my custom user help message.
text.applet.display.msg.help.mobile = This is my mobile custom user help message.
text.applet.display.msg.help.mobile.iphone = This is my iPhone custom user help message.

Transcripts

Custom Integration

Getting Started with Custom Integration

Using applet parameters, you may automatically log a user in using your own web site's user information, such as a username stored in a browser cookie or a database. The autologin, username, and password parameters allow you to easily (though some custom programming is generally required) allow a user entry into the chat room without requiring the user to re-enter his/her username and password. For detailed information, please consult Applet Parameters Knowledge Base Article

For enhanced security and seamless, live integration with your own user database, AddonChat has devised the Remote Authentication System (RA)S allowing you to authenticate access into the chat room from your own server. When used, our server will contact a simple script (again, custom programming required) on your server to determine if that user is allowed access, and what level of access that user should be given. RAS version 1.0 is very easy to implement, and is recommended for most Professional and Professional PLUS account owners. RAS v2.0 provides a great deal more flexibility, though is somewhat more complex and is recommended primarily for our Enterprise customers. You may learn more about remote authentication, including sample code in the Remote Authentication Knowledge Base Category

AddonChat provides the ability to to tie into other features and services you may provide at your own web site through the use of Remote (or External) functions. Remote functions allow you to specify additional options in the user and room right-click menus from within the chat applet. These options, when clicked, can launch a web page of your choosing. We add additional (HTTP CGI) content to these web addresses for programmers to reference source and target users, check IP addresses, and more. For detailed information, please read the External (Remote) Functions & Parameters Knowledge Base Article

The Who's Chatting System allows you to display a live, customizable listing of users (or simply a user count if you prefer) currently logged in to your chat room. For more information, please read the Who's Chatting System Knowlege Base Article

Third party vendors seeking advanced integration, including the ability to allow their own clients to remotely register for and access an AddonChat chat room, we offer many advanced features. Most of these systems must be used with prior permission from AddonInteractive, and are often used in conjunction with the AddonInteractive customer affiliate program. You can learn more about Advanced Integration for third party vendors in the Advanced Integrated Knowledge Base Category

Remote Authentication

Remote Authentication System v1.0

Remote Authentication System (RAS) v1.0 is a simple, easy to implement protocol allowing you to perform username/password authentication from your own web site. This is performed by hosting a script on your own website (using PHP, ASP, Perl, JSP, etc..) that accepts two parameters; a username, and a password; and prints a single digit value as a result to indicate the privilege level of the user requesting access to the chat room.

SCRIPT INPUT PARAMETERS

The following parameters are passed to your script http-encoded as CGI get variables.

• username : Requesting username
• password : Requesting user's password
• ip       : Requesting user's ip address
  

For example. If the user "JavaMan" logged in using the password "FoxTROT" with IP address 192.168.2.1, and your RAS script is http://www.mywebsite/verify.pl, your script would be invoked as:

Your script should return (print to screen) a single 0 (zero), 1 (one), or 2 (two), or 3 (three) dependant upon whether or not you wish to allow this user access to your chat room. We recommend using the text/plain content-type header in your script:

• A value of Zero (0) indicates the user will be denied access
• A value of One (1) indicates that access is granted
• A value of Two (2) indicates that access is granted, and that the user has administrative privileges.
• A value of Three (3) indicates that access is granted, the user has administrative privileges and the user has grant privileges (the ability to grant other users administrative privileges).
• A value of Four (4) indicates that access is granted with all of the permissions of level Three (3) and additionally has full access to the Remote Administrators Console which provides access to monitor your chat room without being logged in.

EXAMPLE CODE (PERL)

The following is an example script written in perl that will only allow a user named JAVAMAN access. This script requires the CGI perl module available from cpan.org.

#!/usr/bin/perl

use CGI qw(:param);

$ip = param("ip");
$username = param("username");
$password = param("password");

print "Content-type: text/plain\n\n";
if($username eq "JAVAMAN")
{
   print "1";
}
else
{
   print "0";
}

EXAMPLE CODE (PHP)

The following is an example script written in PHP that will only permit a user with the name 'admin' using password '12345' super administrator access, and all other users regular access with the exception of the user named 'invalid' who is not permitted access.

<?php

   $user_name     = $_REQUEST['username'];
   $user_ip       = $_REQUEST['ip'];
   $user_password = $_REQUEST['password'];

   header("Content-type: text/plain");

   /* User's with the name 'invalid' are not allowed into the chat room */
   if($username == 'invalid')
   {
      print "0";
      exit(0);
   }
 
   /*
      Username admin is allowed in with super-admin
      access if the password is 12345
   */
   if( ($username == 'admin') && ($password == '12345') )
   {
      print "3";
      exit(0);
   }

   /* All other users are given standard user access */
   print "1";
   exit(0);
?>

Remote Authentication System v2.0

• A server side scripting language such as PHP, Perl, ASP, Python, Ruby, etc..
• Very basic knowledge of HTTP
  

url.remote.user.0 = "Function Descriptor 0", "http://www.mysite.com/mylink.php", "_blank", "false"
url.remote.user.1 = "Function Descriptor 1", "http://www.mysite.com/admin_function.cgi", "_blank", "true"

The list must begin with url.remote.user.0, and count upwards with no ID exclusions. The first parameter is the function descriptor (as it is displayed in the userlist right-click menu. The second paramater is the full URL to the link. See the External (Remote) Functions knowledge base article for more details regarding this. The third paramter specifies the browser frame or window name that the link should be launched in. The fourth parameter specifies whether or not the function should only be available to administrators.

This system also applies to Room functions. E.g.

url.remote.room.0 = "Room Function 0", "http://www.mysite.com/room_function.pl", "_blank", "false"

1. Login to your AddonChat Customer Account at http://www.addonchat.com/
2. Enter the AddonChat Account Control Panel for the account you wish to enable remote authentication for
3. Select the Settings tab from within the AdodnChat Account Control Panel
4. Select the Site Integration link in the Settings submenu
5. Select the Remote Authentication link in the Site Integration submenu
6. Set Enable Remote Authentication to Yes
7. Enter the full URL (beginning with http://) to your authentication script next to Authentication URL
8. Click the Click Here to Save Changes button

1. Your account ID
2. Indicate that you have read this knowledge base document (RAS v2.0 specification)
3. Provide a full URL to your working (though possibly buggy) authentication script
4. Indicate the exact nature of the problem
5. Provide a valid username and password that we may test with

Remote Authentication System v2.1

username   : Requesting user's name
password   : Requesting user's password
transname  : (Deprecated)
ip         : Requesting user's IP address
rasver     : Most recent supported RAS version by server (for use during AddonChat Beta testing)

scras.version = 2.1
user.usergroup.id = {numeric, required; internal user group id, or 0 (zero) to auto-generate.}

Recommended Parameters for All Users:
user.uid                             = {numeric; user ID as passed back through external functions}
user.usergroup.can_login             = {boolean; Permit log in?}
user.usergroup.icon                  = {numeric; specify a custom icon; see below for details.}
user.usergroup.can_msg               = {boolean; permit user to send messages?}
user.usergroup.idle_kick             = {boolean; Kick user if he/she remains idle in chat room?}

Recommended Parameters for Non-Administrative Users:
user.usergroup.can_action            = {boolean; permit user to send action messages?}
user.usergroup.post_delay            = {numeric; time delay before user may enter another message}
user.usergroup.allow_pm              = {boolean; Permit private messages?}
user.usergroup.allow_room_create     = {boolean; Permit user to create new rooms?}
user.usergroup.allow_avatars         = {boolean; permit user to select an avatar?}
user.usergroup.can_random            = {boolean; permit use of /roll command?}
user.usergroup.allow_bbcode          = {boolean; allow BBCode in messages?}
user.usergroup.allow_color           = {boolean; allow user to set message color?}
user.usergroup.msg_scroll            = {boolean; enable message scroll-back feature?}
user.usergroup.max_msg_length        = {numeric; maximum message length in characters}
user.usergroup.filter_shout          = {boolean; apply shout filter to this user?}
user.usergroup.filter_profanity      = {boolean; apply word filters to this user?}
user.usergroup.filter_word_replace   = {boolean; apply text replacement filters to this user?}
user.usergroup.can_nick              = {boolean; permit user to change his/her name using /nick command}
user.usergroup.level                 = {numeric; specify user rank/level used in room access control.}
user.usergroup.title                 = {string; optionally used to specify a user group title.}

Recommended Parameters for Administrators, Moderators & Guest Speakers:
user.usergroup.is_admin              = {boolean; Define this user as an Administrator?}
user.usergroup.allow_html            = {boolean; allow HTML content in messages?}
user.usergroup.can_kick              = {boolean; Permit user to kick other users?}
user.usergroup.can_affect_admin      = {boolean; Permit user to affect administrators?}
user.usergroup.can_grant             = {boolean; can this user grant administrative privileges?}
user.usergroup.can_cloak             = {boolean; can this user cloak?}
user.usergroup.can_see_cloak         = {boolean; can this user see cloaked users?}
user.usergroup.login_cloaked         = {boolean; forces user to be logged in cloaked.}
user.usergroup.can_ban               = {boolean; can this user ban IP addresses?}
user.usergroup.can_ban_subnet        = {boolean; can this user ban Class C subnets?}
user.usergroup.can_system_speak      = {boolean; can this user speak as the system user?}
user.usergroup.can_silence           = {boolean; can this user silence others?}
user.usergroup.can_fnick             = {boolean; permit user use of /fnick command?}
user.usergroup.can_launch_website    = {boolean; permit user to launch websites for other users?}
user.usergroup.can_transfer          = {boolean; permit user to transfer users to another room?}
user.usergroup.can_join_nopw         = {boolean; permit user to join password protected rooms freely?}
user.usergroup.can_topic             = {boolean; permit user to set room topics?}
user.usergroup.can_close             = {boolean; permit user to close rooms?}
user.usergroup.can_ipquery           = {boolean; permit user to query IP addresses of other users?}
user.usergroup.can_geo_locate        = {boolean; permit user to query geographic location of other users?}
user.usergroup.can_query_ether       = {boolean; permit user to query ether?}
user.usergroup.can_clear_screen      = {boolean; permit user to clear screens of other users?}
user.usergroup.can_clear_history     = {boolean; permit user to clear recent room history?}
user.usergroup.allow_img_tag         = {boolean; permit use of IMG BBCode tag?}

Parameters Specific to Moderated Events: (Enterprise Editions)
user.usergroup.is_speaker            = {boolean; Define this user as a Guest Speaker?}
user.usergroup.is_super_moderator    = {boolean; permit this user to Moderate events?}
user.usergroup.can_enable_moderation = {boolean; permit user to enable room moderation?}
user.usergroup.is_unmoderated        = {boolean; permit user to send un-moderated messages?}

Remote Administrator Console Parameters:
user.usergroup.allow_admin_console   = {boolean; permit use of Remote Administrator Console (RAC)?}
user.usergroup.can_view_transcripts  = {boolean; permit user to view transcripts within RAC?}

Daisy Chain Parameters: (Advanced Use Only)
auth.daisy                           = {url; RAS script to process before current script.}
auth.daisy.retreat                     {none; Retreat to previous script in daisy chain.}

numeric          : A signed 32 bit integer
boolean          : A single 0 (zero) or 1 (one) to indicate false or true respectively.
string           : An unquoted string of ASCII or UTF-8 characters
url              : A fully qualified web address, beginning with http://
none             : A parameter which requires no value

• user.usergroup.id

Starting with RAS v2.1, we recommend setting the user.usergroup.id parameter to 0 (zero) for complicated scripts. Scripts that consult a database with a single, signed integer user group should use their system's user group ID number instead. By setting the user.usergroup.id parameter to 0, the AddonChat server will automatically match the provided user group privileges with other user groups in use; if no match is found a unique user group ID will be automatically assigned.

• user.usergroup.icon

This parameter allows you to specify the icon to be used for the user group privilege set provided. The following built-in icons are provided for your use:

• 0: Blue Pawn Icon (Typically used for regular, non-administrative users)
• 1: Green Pawn Icon (Typically used for Guest Speakers in moderated Enterprise events)
• 2: Red Pawn Icon (Typically used for Administrators)
• 3: Yellow Pawn Icon (Typically used for Moderators in moderated Enterprise events)
• 4: White Pawn Icon (Typically reserved to indicate VIP status of user)

Custom user group icons (See Icons & Avatars: Emoticons: Advanced Help: Custom Icons: Custom User Group Icons) may also be used. To use a custom user group icon, simple add 100 to the ID number of your custom user group icon. E.g., if you have created an icon called icon.usergroup.custom.2, your script should output the following:

user.usergroup.icon = 102

• user.usergroup.level

A user group level should be provided if you're restricting room access based on Rank Access Permissions (Rooms tab in your control panel) The value specified must be between 1 and 20. Level 1 is typically reserved for no-access privileges. If you are not using rank access room permissions, your default (Guest) user group setting should suffice.

• user.usergroup.can_nick

This parameter was provided in RAS v2.1 by popular request. It is important to note that when providing users with the ability to change their names using this parameter, that your authentication script will not be consulted again when a user performs a /nick (user name change) command. I.e., they could easily change their name to that of an administrator or a guest speaker if that user is not currently logged in. It is recommended that this privilege only be given to trusted users. If you intend to restrict use of this feature to trusted administrators only, the user.usergroup.can_fnick parameter should be used in preference to user.usergroup.can_nick.

• user.usergroup.allow_img_tag

The user.usergroup.allow_img_tag privilege should only be given to trusted users. The IMG BBCode tag permits the user to display an image from any location on the web to all users within the current room. Dial-up users may not appreciate having to wait for very large images to download, and there exist no means to easily moderate image content.

• user.usergroup.is_admin, user.usergroup.can_affect_admin
  

The user.usergroup.is_admin parameter is only a privilege in the sense that it prevents users who do not have the user.usergroup.can_affect_admin privilege from taking certain actions (e.g., silencing, kicking, banning, etc..) against them. In RAS v2.0 (the previous version) this parameter was a prerequisite to other administrative functions; this is no longer the case. Users without the user.usergroup.is_admin privilege may still be given any other privilege/parameter defined in RAS v2.1.

• auth.daisy, auth.daisy.retreat
  

Beginning with AddonChat v8.5, RAS v2.0 and RAS v2.1 now support daisy chaining up to three remote authentication scripts. Enterprise level chat rooms which are used on multiple systems (for example, two separate bulletin board systems) can use daisy chaining to permit authentication from multiple sources using a single Enterprise account. For security purposes, the auth.daisy parameter should be output before any other content; including the scras.version parameter. When the AddonChat RAS processor detects a valid auth.daisy parameter value, it will immediately proceed to process the specified script. The auth.daisy.retreat parameter (which requires no value be specified) will cause the RAS processor to immediately cease processing the current authentication script and fall back to the previous script in the chain. Careful thought and caution should be taken when implementing a RAS daisy chain; including consideration for the possibility that identical user names may be in use on multiple systems. The auth.daisy parameter may be used to daisy chain to an older (1.x) RAS version; however RAS v1.x scripts may not include the auth.daisy or auth.daisy.retreat parameters.

url.remote.user.0 = "Function Descriptor 0", "http://www.mysite.com/mylink.php", "_blank", "false"
url.remote.user.1 = "Function Descriptor 1", "http://www.mysite.com/admin_function.cgi", "_blank", "true"

The list must begin with url.remote.user.0, and count upwards with no ID exclusions. The first parameter is the function descriptor (as it is displayed in the userlist right-click menu. The second paramater is the full URL to the web site. See the External (Remote) Functions knowledge base article for more details regarding this. The third parameter specifies the browser frame or window name that the link should open in. The fourth parameter specifies whether or not the function should only be available to administrators.

This system also applies to Room functions. E.g.

url.remote.room.0 = "Room Function 0", "http://www.mysite.com/room_function.pl", "_blank", "false"

1. Login to your AddonChat Customer Account at http://www.addonchat.com/
2. Enter the AddonChat Account Control Panel for the account that you wish to enable remote authentication
3. Select the Settings tab from within the AdodnChat Account Control Panel
4. Select the Site Integration link in the Settings submenu
5. Select the Remote Authentication link in the Site Integration sub-menu
6. Set Enable Remote Authentication to Yes
7. Enter the full URL (beginning with http://) to your authentication script next to Authentication URL
8. Click the Click Here to Save Changes button

Migrating from RAS v1.x to RAS v2.1

• 1: Standard User Access

user.usergroup.id = 1
user.usergroup.can_login = 1
user.usergroup.can_msg = 1
user.usergroup.can_action = 1
user.usergroup.icon = 1
user.usergroup.level = 2

• 2: Basic Administrative Access

The following settings are set (or modified) in addition to all other settings listed above.

user.usergroup.id = 2
user.usergroup.post_delay = 0
user.usergroup.allow_pm = 1
user.usergroup.allow_room_create = 1
user.usergroup.idle_kick = 0
user.usergroup.is_admin = 1        
user.usergroup.is_super_moderator = 0        
user.usergroup.can_kick = 1
user.usergroup.can_affect_admin = 0
user.usergroup.can_grant = 0
user.usergroup.can_cloak = 0
user.usergroup.can_see_cloak = 0
user.usergroup.can_ban = 1        
user.usergroup.can_system_speak = 1
user.usergroup.can_enable_moderation = 1
user.usergroup.can_silence = 1
user.usergroup.allow_bbcode = 1
user.usergroup.allow_color = 1        
user.usergroup.msg_scroll = 1
user.usergroup.max_msg_length = 2048
user.usergroup.filter_shout = 0
user.usergroup.filter_profanity = 0
user.usergroup.filter_word_replace = 0
user.usergroup.can_launch_website =  1
user.usergroup.can_join_nopw = 1
user.usergroup.can_topic = 1
user.usergroup.is_unmoderated = 1
user.usergroup.can_ipquery = 1
user.usergroup.can_geo_locate = 1
user.usergroup.can_query_ether = 1
user.usergroup.allow_img_tag = 1  
user.usergroup.level = 3     
user.usergroup.icon = 2
user.usergroup.allow_avatars = 1
user.usergroup.can_give_timeout = 1
user.usergroup.can_random = 1

• 3: Super Administrator Access, including RAC privilege

The following settings are set (or modified) in addition to all other settings listed above.

user.usergroup.id = 3
user.usergroup.can_ban_subnet = 1   
user.usergroup.can_see_cloak = 1    
user.usergroup.can_grant = 1
user.usergroup.can_affect_admin = 1
user.usergroup.can_cloak = 1
user.usergroup.can_fnick = 1
user.usergroup.allow_admin_console = 1
user.usergroup.can_close = 1        
user.usergroup.can_transfer = 1
user.usergroup.can_clear_screen = 1
user.usergroup.can_clear_history = 1
user.usergroup.level = 4

• 4: Super Administrator Access with RAC+Log View Privilege

The following settings are set (or modified) in addition to all other settings listed above.

user.usergroup.id = 4
user.usergroup.allow_admin_console = 1
user.usergroup.can_view_transcripts = 1
user.usergroup.level = 5

• 0: Access Denied
  

user.usergroup.id = 0
user.usergroup.can_login = 0
user.usergroup.level = 1

Migrating from RAS v2.0 to RAS v2.1

user.usergroup.can_login

The user.usergroup.can_login parameter remains the same in v2.1; however two additional v2.1 parameters are automatically set when using RAS v2.0 by the new RAS processor. These were previously implied features of v2.0.

user.usergroup.can_msg = 1
user.usergroup.can_action = 1

user.usergroup.mark_as_guest

The user.usergroup.mark_as_guest parameter no longer exists in v2.1. This parameter is now translated as an icon setting; specifically to the default white pawn icon typically reserved for VIP/Special/Guest users.

user.usergroup.icon = 4

user.usergroup.is_admin

Fine privilege control in RAS v2.1 spells a lot of changes for the RAS v2.0 user.usergroup.is_admin parameter. While the user.usergroup.is_admin still remains in v2.1, it's meaning has changed dramatically. user.usergroup.is_admin is no longer a prerequisite for other administrative functions, and it serves solely to "define" that a user is an administrator so they can be protected from users who do not have the new user.usergroup.can_affect_admin privilege. Since user.usergroup.is_admin previously implied many default administrative privileges, the new RAS processor automatically sets the following RAS v2.1 parameters when defined in a v2.0 script:

user.usergroup.can_transfer = 1
user.usergroup.can_join_nopw = 1
user.usergroup.can_topic = 1
user.usergroup.can_close = 1
user.usergroup.is_unmoderated = 1
user.usergroup.can_ipquery = 1
user.usergroup.can_geo_locate = 1
user.usergroup.can_query_ether = 1
user.usergroup.can_clear_screen = 1
user.usergroup.can_give_timeout = 1
user.usergroup.can_random = 1

user.usergroup.can_kick_admin

user.usergroup.can_kick_admin is no longer a valid parameter in RAS v2.1. It is translated directly to user.usergroup.can_affect_admin by the current RAS processor.

user.usergroup.can_affect_admin = 1

user.usergroup.is_admin AND user.usergroup.can_kick_admin

When both user.usergroup.is_admin and user.usergroup.can_kick_admin (now translated as user.usergroup.can_affect_admin) are enabled in a RAS v2.1 script, the following additional RAS v2.1 parameters are enabled:

user.usergroup.can_clear_history = 1
user.usergroup.allow_img_tag = 1

user.usergroup.is_speaker

The user.usergroup.is_speaker remains unchanged in RAS v2.1; however the new RAS processor adds the following parameters during up-conversion:

user.usergroup.is_unmoderated = 1
user.usergroup.can_topic = 1

user.usergroup.is_super_moderator

The user.usergroup.is_super_moderator remains unchanged in RAS v2.1; however the new RAS processor adds the following parameters during up-conversion:

user.usergroup.is_unmoderated = 1
user.usergroup.can_topic = 1

• Level 2

Set when: user.usergroup.can_login = 1

• Level 3

Set when: user.usergroup.is_speaker = 1

• Level 4

Set when: user.usergroup.is_super_moderator = 1

• Level 5

Set when: user.usergroup.is_admin = 1

• Level 6

Set when both: user.usergroup.is_admin = 1 and user.usergroup.can_kick_admin = 1

• Level 1

Set by default, when none of the above parameters are set in your RAS v2.0 script. Level 1 is typically reserved as a no-access rank starting with AddonChat v8.5.

Code Parameters, Direct Settings, Remote Functions, Who's Chatting, etc..

Who's Chatting System v1.1

The AddonChat Who's Chatting System (previously Who's Online Module) v1.1 allows you to easily fetch a list of users, with additional data, that are currently in your chat room. v1.1 no longer requires HTML stripping, as output is produced in plain text tabular format.

The Who's Chatting System may be accessed from:

The following parameters should be passed to this script:

Example:

Output:

WCS v1.1, when used with the plain=1 option will display it's output in columnar (tab delimited) format, with one user per each line delimited by a \r\n. The following table describes the columns:

Example:

Related PHP/Perl Resources:

• PHP file function
• PHP fopen function
• PHP allow_url_fopen configuration option
• Perl LWP module

Direct Settings

color.applet.background = ffffaa
layout.applet.icon.help = 1
float.width = 700
campaign.engine.enable = 0
chatpane.border = 1
url.exit = http://www.addonChat.com/
url.exit.enable = true
text.applet.title = Title
macro.1 = "Direct Settings Macro", "A Sample Macro", "false"
text.applet.login.button.register = Register a Username
text.applet.display.msg.kicked = User <i>$username</i> has logged out.
text.applet.display.msg.banned = User <i>$username</i> has logged out.
text.applet.display.msg.help = This is my custom user help message.
text.applet.display.msg.help.admin = This is my custom admin help message.

text.applet.display.msg.help = This is my custom user help message.
text.applet.display.msg.help.mobile = This is my mobile custom user help message.
text.applet.display.msg.help.mobile.iphone = This is my iPhone custom user help message.

External (Remote) Functions & Parameters

1. Descriptor: This is the designator displayed in the user (or room) right-click menu when a user right-clicks on a user or a room.
2. Function: Type: Specify whether this function should apply to rooms or to users
3. Availability: Specify whether or not this function should only be available to users with administrative privileges
4. Web Site: Fully qualified URL to your web site (link) to be launched when a user selects this function descriptor.

User Function Variables

• $username : Target user name of function
• $srcusername : Source User Name (Name of user who initiated call to user function)
• $uid : Target User ID
• $srcuid : Source User ID (ID of user who initiated call to user function)
• $roomname : Name of room that the source (initiating) user is currently in

Room Function Variables

• $srcuid : Source User ID (ID of user who initiated the call to the room function)
• $srcusername : Source User Name (Name of user who initiated call to the room function)
• $roomname : Name of room whose function has been queried

• roomname: Name of the room that the user function was selected from.
  
• srcuid: User ID (internal database ID, or user ID as passed through using RAS v2.0)
  
• srcusername: Name of user that has selected the link
  

• username: Target username (The username that the source user has clicked on)
  
• roomname: Name of the room that the target user is currently in
  
• uid: Target User ID (internal database ID, or user ID as passed through using RAS v2.0)
• srcuid: Source User ID (internal database ID, or user ID as passed through using RAS v2.0)
• srcusername: Name of user (source user) that has selected the link
  

Applet Parameters

Code Parameters

Advanced users and web developers may use code parameters to pass additional instructions to AddonChat chat clients.

This page has been converted from its original HTML format. You may view the original here.

Advanced Integration

Server Lookup Query Script

http://clientx.addonchat.com/queryserver.php

id: Numeric portion of AddonChat account number.

queryserver.php will return the message 'Invalid Account Number' if the account specified is invalid, or will return the full domain to the server that this chat room has been assigned.

http://clientx.addonchat.com/queryserver.php?id=12345

You can safely assume that a chat room's assigned server will not change; thus only lookup should be neccesary to determine a chat room's assigned server based on it's account ID number.

This script makes no guarantee as to what Content-Type the output will be delivered in; however the only content of the returned page will be the server name or error message.

This service is now considered deprecated; and has been replaced by the General Account Query Script. This script should only be used when an AddonChat customer's password is not available to the vendor.

General Account Query Script

http://clientx.addonchat.com/queryaccount.php

id: Numeric portion of AddonChat account number.
md5pw: MD5 Hashed Password.

On success, the following 13 lines (separated by a carriage return and linefeed '\r\n') will be returned. On failure, only four lines will be returned, the first line being a -1 error code.

1. INTEGER: Numeric Edition Code, or -1 for failure. At the time of this writing the following edition codes exist: 0: Free; 10: Personal; 20: Professional; 30: Professional PLUS; 40-130: Enterprise Editions.
2. Numeric list of modules installed; which each number indicating a specific module. The list is enclosed in parenthesis, and numeric codes for modules are not presently documented. If line 1 is an error (-1) this line will merely be 0.
   
3. BOOLEAN: 0, or 1; specifying whether or not this chat room is capable of enabling the Remote Authentication System. If line 1 is an error, this line will contain a description of the error.
   
4. Full Service Edition Name (e.g., Enterprise-200), or 0 (zero) on error.
   
5. Account Expiration Date.
6. BOOLEAN: 0, or 1; specifying whether or not remote authentication is currently enabled for this account
7. Current Remote Authentication URL (fully qualified if valid)
8. Assigned server name (e.g., client8.addonchat.com)
9. Assigned TCP connection port
10. Direct, fully qualified URL to control panel login
11. Title of chat room as specified by customer
12. Account ID, preceded with 'SC-' product code.
13. Customer ID, preceded with 'RC-' customer code.

http://clientx.addonchat.com/queryaccount.php?id=12345&md5pw=293890908237789sdfhsd8923

30
(3,5,7,14,23)
1
Professional PLUS
2011-08-23
0
http://
client23.addonchat.com
8009
http://cpanel23.addonchat.com/this?is=just+to+give&you=an+example
My Very Own Chat Room
SC-9384949
RC-0010293948

-1
0
Incorrect Password
0

You can safely assume that a chat room's assigned server will not change; thus only lookup should be neccesary to determine a chat room's assigned server based on it's account ID number.

This script guarantees the Content-type output will be in plain text format, UTF-8 encoded.

AddonInteractive does not recommend storing our customer's passwords in plain text.

Set, Unset Remote Authentication Script

http://clientx.addonchat.com/setras.php

id: Numeric portion of AddonChat account number.

rasurl: Fully qualified URL to remote authentication script (must be URL Encoded) that you wish to set

md5pw: MD5 encoded password for customer account

unset: Boolean (0 or 1). Set to 1 to disable remote authentication for this account. Note: rasurl need not be supplied when set to 1.

setras.php will return two lines of data, in UTF-8 encoded plain text:

1. BOOLEAN: 0 (failure) or 1 (success)
2. TEXT message indicating either 'Success' or a specified failure reason.

Get Client Settings Script

http://clientN.addonchat.com/settings.php

aid: Numeric portion of AddonChat account number.

settings.php will return a lengthy, UTF-8 Plain Text encoded file in parameter = value style format. Its output will correlate with settings specified by the user in the AddonChat control panel.

http://client0.addonchat.com/settings.php?aid=8847

See also: Direct Settings

The settings.php protocol may change, parameters may be added, removed, or renamed from version to version with no warning.

clientN.addonchat.com  (as specified above) should be replaced by the assigned server for this account. You may use the Server Lookup Query Script to determine this server, or your chat room link code (available in your AddonChat control panel) will indicate this value.

Remote Account Sign-Up

http://www.addonchat.com/rsignup.php

email: Customer eMail Address
password: Customer Password
password_verify: Customer Password (Verify, must match password)
firstname: Customer's First Name (Recommended, but not required)
lastname: Customer's Last Name (Recommended, but not required)
website: Customer's Web Site
terms: Set to 'yes' to inidcate that customer agrees to terms of use
age: Set to 'yes' to indicate that customer is 13 years of age or older
informed: Set to 'yes' to add customer to AddonInteractive mailing list
chat_title: Title customer wishes to use for chat room
referred_by: Affiliate ID or Referral Code

This script will return two or three lines depending upon successful account creation:

1. 0 for Failure, 1 for Success.
2. Assigned customer account number (Integer only) or Error Code
   
3. Assigned AddonChat account number (Integer only

1
128483
3947839

0
102

• 100: Customer is not 13 years of age or older
• 101: Customer does not agree with Terms & Conditions
• 102: Invalid eMail Address
• 103: Invalid Web Site
• 104: Weak Password Specified
• 105: Customer already has an account listed with this eMail address. Please direct them to addonchat.com
• 106: Password verification does not match
• 110: General (Unknown) Error
• 200: Internal Error
  
• 201: Internal Error
• 202: Internal Error

This script guarantees the Content-type output will be in plain text format, UTF-8 encoded. Data passed to this script should also be UTF-8 encoded.

AddonInteractive does not recommend storing our customer's passwords in plain text.

You must provide forms for the user to consent to our terms of service, age requirements, and mailing list opt-in.

Integration Scripts & Howtos

aMember Pro Integration

FusionBB Integration

Invision Power Board Integration

You will need to know the integer portion of your account ID number. You may look up your account number by logging in to your AddonChat or IPChat Legacy control panel at http://www.addonchat.com/login.html Your account will begin with two letters, followed by a hyphen, followed by four or more numbers. You need to know the numbers only. I.e., if your account ID is SC-12345, the number you'll use is 12345. If your account is IC-54321, the number you'll be using is 54321, etc..

Login to your IPB ACP (Admin Control Panel) at your forum.

IPB v1.x: Click to expand the IPB Enhancements menu. Click on IPChat (or Invision Power Chat)

IPB v2.x: For more recent versions, you will find this option (labeled AddonChat) in the IP.Board Components section of the ACP. The available components are managed from the Admin tab of the admin control panel.

If you have an old IPChat, SigmaChat, AddonChat, or ParaChat chat room that you will be replacing, then follow this step. Otherwise, skip to step 3. A previous chat room installed will be indicated by many options presented in the IPChat pane. The first option will show you your account ID number. To remove this installation, simply clear the account number field, then scroll to the bottom of the page and click the button to save your changes.

In the IPChat pane, enter the integer portion of your account ID number (the account number beginning with SC-) as described in the "Before you begin" section of this howto. Click the button presented to save changes.

You will also need to enter your chat room server. You can lookup your chat room server from the Home > Chat Room Link Code section of your AddonChat control panel. The linkcode will contain a line such as codebase="http://client3.addonchat.com" (or similar). Enter only the server name, without the "http://". E.g., if your server is http://client1.addonchat.com, enter simply client1.addonchat.com.

Again, although it is listed as a requirement for integration, we must stress that IP.Board integration requires a Professional PLUS or Enterprise edition AddonChat account. You may request a free trial upgrade by eMailing your account number and request to support@addonchat.com.

Your chat room is now integrated.

After this, you will be taken to the configuration page where you may set the dimensions of the applet, as well as many other features.

If you would like access to your chat room to be controlled by your IPB user database, then you need to perform one last step.
First, login to your AddonChat/SigmaChat/IPChat(Legacy) control panel at http://www.addonchat.com/login.html

Click to expand the "Site Integration" menu.

Click on "Site Authentication"

In the "Authentication URL" section, type in the full web address to you forum, beginning with 'http://' and add '/ipchat.php' to the end. I.e., if your forums are located at www.myforumsite.org/forums/ , you would type http://www.myforumsite.org/forums/ipchat.php

Set "Enable Authentication URL" to Yes.

Click Save Changes

Special Note for IPB v2.1, 2.2: The ipchat.php file is located in the Tools folder of your IPB distribution archive (ZIP or TGZ file). In order to complete this step, you'll need to copy or FTP this file to the root folder of your forum directory for remote authentication to function properly. For IP.Board 2.1.x, and 2.2.x customers, this script (ipchat.php) may also be downloaded directly from our file library at http://support.addoninteractive.com/download.php?FLIB=1&id=38

Login to your forums, and click on "Live Chat" or "Chat" in the menubar. Your AddonChat chat room will appear. Type in an invalid forum username/password combination to ensure the chat room does not let you in. Next, try a user with chat room administrative privileges (this is set in the IPChat configuration section in your IPB ACP control panel) Last, try a regular non-admin user to make sure everything works ok.

MSN Groups Integration

1. Save each chat room script separately using NotePad (or a similar plain text editor) with the room size in the title, i.e., "Chat600", "Chat700" and "Chat800".  Specify the file type as "html" instead of "txt"
2. Open your MSN Groups Documents folder and click on Add file which will open a diagram of your computer. Find the folder you saved them in and click on the box of each one.
3. Click on Add file in the tool bar header.
4. Right click on Manager Tools and select Open in new window.
5. Create a new webpage by first clicking on "Add a page" and choose the "Custom web page".  Give it a page name such as "Chat Room" and a basic description.
6. Enter your three chat rooms by the names and sizes, i.e., "Chat Room 600x400", "Chat Room 700x500" and  "Chat Room 800x600"
7. Return to the Documents folder and right click on the first one and select "Copy shortcut"
8. Return to your web page and highlight the first one and click on the toolbar hyperlink symbol and enter that link but..... delete the "http://" as it is already provided.
9. Do the other two links in the same manner.
10. Save your new web page and test the links.  Each one should open a separate size chat room.

MySpace Integration

1. Login to your Account Control Panel
2. Select Chat Room Link Code in the Home Tab

1. Login to your MySpace page
2. Click Edit Profile
3. In Your About Me, I'd Like to Meet, or Interests text field, paste (type CTRL-V) the code you copied from Step 1
4. Click the Save All Changes button at the bottom of the page

1. Login to your MySpace page
2. Click Edit Profile
3. Find the code you added in Step 2
4. Add the following code just before the final right bracket (>) -- make sure to place a space after the preceding quotation mark: target="addonchat" 
   
5. Click the Save All Changes button at the bottom of the page

ProBoards Integration

1. Login to your ProBoards Administration Area by clicking the admin link in your ProBoards forum.
2. Click the Live Chat Settings Link in the Live Chat folder menu.
3. Scroll down to Existing Live Chat Account
   
4. Enter the numeric portion of your AddonChat Account ID (the number that begins with SC-)
5. Enter your AddonChat Account Password. This is the password you use to login to your customer control panel with.
6. Click the Save Settings button.
7. If you have the Remote Authentication Module, or a Professional PLUS or Enterprise account, your Remote Authentication URL will be automatically updated such that user access will be authenticated using your ProBoards forum usernames and passwords.
8. To show a chat icon in your ProBoards main menu, set Display in menu to Yes and click Save Settings.
   

ProBoards also allows you to quickly upgrade your account and access your Account Control Panel (Administrative Panel)  directly from the Live Chat Settings link in your Administration Area.

If you've recently upgraded your AddonChat account, you may update your settings automatically by clicking the I Have Upgraded button in the Live Chat Settings section of your Administration Area. Clicking this button will update your ProBoards settings to reflect your new AddonChat account level, and will also automatically update your Remote Authentication URL (if available) within your AddonChat Account Control Panel.

You may also modify the Headers and Footers of your AddonChat page by clicking Chat Headers and Footers from your ProBoards Administration Area.

Profile Manager Premium by Interlogy

1. Download: addonchat_pmp_auth.php
   
2. Edit the file using a plain text editor such as Notepad. Instructions and examples are provided within the file. You will need to know your database host name, username, and password.
3. Upload addonchat_pmp_auth.php to your root web folder, usually public_html/ or www/

1. Log in to your Profile Manager Premium Administrator control panel
2. Click over to Templates -> Add New to create a new template
3. Enter a name (e.g., AddonChat) and location (e.g., Member) 

WordPress 2.5.x Integration

WowBB Integration

• Login to your AddonChat control panel
• In Settings -> Site Integration > Site Authentication -> Remote Authentication -> Authentication URL , type
  http://yourdomain.com/your_forums/sigmachat.php
  where yourdomain.com is the address of your web site, and your_forums is the directory where WowBB is installed.
• Set Enable Authentication URL to Yes.
• Click Click Here to Save Changes.

vBulletin

vBulletin v3.0.x Integration/Authentication Script

vBulletin v3.5.x Integration/Authentication Script

• vBulletin 3.5.x
• SigmaChat Platinum, or Enterprise. Please note that SigmaChat Basic and SigmaChat Professional are no longer supported. You may register for a SigmaChat account at www.addonchat.com.
• PHP with allow_url_fopen directive enabled in your php.ini file. This is required to download the Who's Chatting list from SigmaChat servers.

• Seamless integration between your vBulletin forum and SigmaChat
• Popup and Embedded Chat room link options
• Automatic (one minute interval) User's Chatting count updates
• Real-Time Who's Chatting list
• Display the amount of users within your chat room on your main navbar shown throughout your entire forum
• Remote authentication allows you to authenticate access into your chat room based on your vBulletin user database
• Automatic user login option
• Remote authentication allows you to choose which vBulletin user groups are allowed chat room administrative privileges
• Remote functions system allows you to tie in vBulletin forum functions into the SigmaChat user menu
• Uses the new vBulletin 3.5 XML product import architecture, making installation/uninstallation easier, requiring no modifications to the codebase.
• Improves over previous versions by storing Who's Chatting list within it's own MySQL database table

vBulletin v3.6.x Integration/Authentication Script

vBulletin 3.6.x, 3.5.x Official Integration & Authentication Extension

Product Info
Name: AddonChat Official Integration Extension
Product ID: sc7400
Version: 1.1.0
Author: AddonInteractive (http://www.addoninteractive.com/)
Last Modified: 29 Oct. 2006
Compatibility: vBulletin 3.6.x, 3.5.x
Mirror: www.vBulletin.org

Overview
This extension allows you to fully integrate a AddonChat Professional PLUS or Enterprise Java™ Chat Room with your vBulletin 3.5.x forum system. AddonChat Professional accounts may also be integrated provided they have purchased the Remote (HTTP Authentication module. Included is the ability to authenticate access via your vBulletin forum system, and provide a "Who's Chatting" page list showing who is currently logged into your chat room.

Requirements

• vBulletin 3.6.x or 3.5.x
  
• AddonChat Professional PLUS, or Enterprise, or AddonChat Professional with the Remote (HTTP) Authentication System. Please note that AddonChat Free is no longer supported. You may register for a AddonChat account at www.addonchat.com.
• PHP with allow_url_fopen directive enabled in your php.ini file. This is required to download the Who's Chatting list from AddonChat servers.

What's new?
This extension dramatically improves upon the previous release by making use of the vBulletin Database to store Who's Chatting list updates. Additionally, the Who's Chatting box at the bottom of the main forum page has been removed in favor of showing a (nearly) real-time count of users in your chat room directly from the main navbar. Both embedded and popup chat room options are provided to your user. The Who's Chatting list has been cleaned up. Two additional remote functions (Add Buddy and Forum Ignore) have been added as well.

Features

• Seamless integration between your vBulletin forum and AddonChat
• Popup and Embedded Chat room link options
• Automatic (one minute interval) User's Chatting count updates
• Real-Time Who's Chatting list
• Display the amount of users within your chat room on your main navbar shown throughout your entire forum
• Remote authentication allows you to authenticate access into your chat room based on your vBulletin user database
• Automatic user login option
• Remote authentication allows you to choose which vBulletin user groups are allowed chat room administrative privileges
• Remote functions system allows you to tie in vBulletin forum functions into the AddonChat user menu
• Uses the new vBulletin 3.5+ XML product import architecture, making installation/uninstallation easier, requiring no modifications to the codebase.
• Improves over previous versions by storing Who's Chatting list within it's own MySQL database table

Installation
Installaion will require between 10 and 15 minutes of your time. Download the supplied ZIP file, and extract it on your personal computer. Open the README.html in your web browser file for full installation instructions. No PHP code modifications are required as this script makes use of the new vBulletin XML Product system.

Support
Support is provided by AddonInteractive for this script provided you have a Professional, Professional PLUS or Enterprise AddonChat account. Read the included instructions for details. Please let us know if you have any problems installing this extension.

Download

vBulletin v3.7.x Integration/Authentication Script

vBulletin 3.7.x Official Integration & Authentication Extension

Product Info
Name: AddonChat Official Integration Product
Product ID: ac80_37
Version: 3.7.0
Author: AddonInteractive (http://www.addoninteractive.com/)
Last Modified: 15 May. 2008
Compatibility: vBulletin 3.7.x

Overview
This extension allows you to fully integrate a AddonChat Free, Professional, Professional PLUS or Enterprise Java™ Chat Room with your vBulletin 3.7 forum system. This script provides basic integration for AddonChat Free and Professional customers. Remote authentication (the ability to secure access to your chat room using your vBulletin username/passwords) is available for Pro+/Enterprise customers, as well as a Who's Chatting feature.

Requirements

• vBulletin 3.7 or higher
  
• AddonChat Free, Professional PLUS, or Enterprise, or AddonChat Professional with the Remote (HTTP) Authentication System. You may register for a AddonChat account at www.addonchat.com. A Professional PLUS or Enterprise account is recommended to take advantage of advanced features.
  
• (optional, but recommended) PHP with allow_url_fopen directive enabled in your php.ini file. This is required to download the Who's Chatting list from AddonChat servers.

What's new?
This script is a completely revamped edition of our previous integration script. Installation no longer requires any template or code modifications. Additionally, there are no PHP files to edit when setting up your chat room. We have added an "AddonChat" menu item in the vBulletin AdminCP that allows you to setup and configure your chat room with ease. Most users will simply need to enter their account number and password (as used at addonchat.com) and your chat room settings will be retrieved automatically, with your remote authentication system updated automatically as well. We have also improved character code support through better UTF-8 conversion allowing non-English speakers to use a vBulletin+AddonChat without issue. Issues relating to the Who's Chatting system causing problems have also been addresses; a scheduled task has been added to automatically optimize and repair AddonChat related tables daily in addition to improvements to the re-written Who's Chatting system.

Features

• Seamless integration between your vBulletin forum and AddonChat
• After installation, setup and configure your chat room from the AddonChat menu in your vBulletin Admin Control Panel
• Popup and Embedded Chat room link options
• Automatic (ten minute interval) User's Chatting count updates
• Real-Time Who's Chatting list
• Display the amount of users within your chat room on your main navbar shown throughout your entire forum
• Remote authentication allows you to authenticate access into your chat room based on your vBulletin user database
• Automatic user login option
• Seamless integration with vBulletin Usergroup permissions (remote authentication)
  
• Remote functions system allows you to tie in vBulletin forum functions into the AddonChat user menu
• Uses the vBulletin XML product import architecture, making installation/uninstallation simple.
  
• No code or template modifications required
• Automated account lookup - just enter your account number and password, and your information will be automatically retrieved. (allow_url_fopen must be enabled in PHP)
• Multi-lingual (UTF-8) support

Installation
Installaion takes less than five minutes. Download the supplied ZIP file, and extract it on your personal computer. Open the readme.txt file for full installation instructions. No PHP code modifications or template modifications are required. This script makes use of the vBulletin XML Product system for a fast and painless installation.

Support
Support is provided by AddonInteractive for this script provided you have a Professional, Professional PLUS or Enterprise AddonChat account. Read the included instructions for details. Please let us know if you have any problems installing this extension.

Download

vBulletin v3.8.x Integration/Authentication Script

vBulletin 3.8.x Official Integration & Authentication Extension

Product Info
Name: AddonChat Official Integration Product
Product ID: ac80_37
Version: 3.8.x, 3.7.x
Author: AddonInteractive (http://www.addoninteractive.com/)
Last Modified: 15 May. 2008
Compatibility: vBulletin 3.8.x

Overview
This extension allows you to fully integrate a AddonChat Free, Professional, Professional PLUS or Enterprise Java™ Chat Room with your vBulletin 3.8 forum system. This script provides basic integration for AddonChat Free and Professional customers. Remote authentication (the ability to secure access to your chat room using your vBulletin username/passwords) is available for Pro+/Enterprise customers, as well as a Who's Chatting feature.

Requirements

• vBulletin 3.8 or 3.7 (or higher 3.x version)
  
• AddonChat Free, Professional PLUS, or Enterprise, or AddonChat Professional with the Remote (HTTP) Authentication System. You may register for a AddonChat account at www.addonchat.com. A Professional PLUS or Enterprise account is recommended to take advantage of advanced features.
  
• (optional, but recommended) PHP with allow_url_fopen directive enabled in your php.ini file. This is required to download the Who's Chatting list from AddonChat servers.

What's new?
This script is a completely revamped edition of our previous integration script. Installation no longer requires any template or code modifications. Additionally, there are no PHP files to edit when setting up your chat room. We have added an "AddonChat" menu item in the vBulletin AdminCP that allows you to setup and configure your chat room with ease. Most users will simply need to enter their account number and password (as used at addonchat.com) and your chat room settings will be retrieved automatically, with your remote authentication system updated automatically as well. We have also improved character code support through better UTF-8 conversion allowing non-English speakers to use a vBulletin+AddonChat without issue. Issues relating to the Who's Chatting system causing problems have also been addresses; a scheduled task has been added to automatically optimize and repair AddonChat related tables daily in addition to improvements to the re-written Who's Chatting system.

Features

• Seamless integration between your vBulletin forum and AddonChat
• After installation, setup and configure your chat room from the AddonChat menu in your vBulletin Admin Control Panel
• Popup and Embedded Chat room link options
• Automatic (ten minute interval) User's Chatting count updates
• Real-Time Who's Chatting list
• Display the amount of users within your chat room on your main navbar shown throughout your entire forum
• Remote authentication allows you to authenticate access into your chat room based on your vBulletin user database
• Automatic user login option
• Seamless integration with vBulletin Usergroup permissions (remote authentication)
  
• Remote functions system allows you to tie in vBulletin forum functions into the AddonChat user menu
• Uses the vBulletin XML product import architecture, making installation/uninstallation simple.
  
• No code or template modifications required
• Automated account lookup - just enter your account number and password, and your information will be automatically retrieved. (allow_url_fopen must be enabled in PHP)
• Multi-lingual (UTF-8) support

Installation
Installaion takes less than five minutes. Download the supplied ZIP file, and extract it on your personal computer. Open the readme.txt file for full installation instructions. No PHP code modifications or template modifications are required. This script makes use of the vBulletin XML Product system for a fast and painless installation.

Support
Support is provided by AddonInteractive for this script provided you have a Professional, Professional PLUS or Enterprise AddonChat account. Read the included instructions for details. Please let us know if you have any problems installing this extension.

Download

vBulletin v4.0.x Integration/Authentication Script

• vBulletin 4 or higher
• AddonChat Free, Professional PLUS, or Enterprise, or AddonChat Professional with the Remote (HTTP) Authentication System. You may register for a AddonChat account at www.addonchat.com. A Professional PLUS or Enterprise account is recommended to take advantage of advanced features.
• (optional, but recommended) PHP with allow_url_fopen directive enabled in your php.ini file or the PHP CURL extension. This is required to download the Who's Chatting list from AddonChat servers.

• Completely re-written for vBulletin 4
• New Integration Options for vBulletin Social Networking Features (Blog, Albums, etc..)
• Updated to support RAS (Remote Authentication System) v2.1 providing extremely fine grain control over user privileges.
• New 'User is Banned' option in usergroup manager to easily prevent users belonging to specified usergroups from entering your chat room.
• Who's Chatting list is now (optionally) displayed on main forum page in the What's Going On box.
• Embedded Width may now be specified in percentage values (defaults to 100%)
• Option to display Chat Room Link in main navigation tab, community menu, and/or quick links menu.
• Various Performance Improvements

• Seamless integration between your vBulletin Forum/CMS and AddonChat
• After installation, set up and configure your chat room from the AddonChat menu in your vBulletin Admin Control Panel
• Popup and Embedded Chat room link options
• Automatic (ten minute interval) User's Chatting updates
• Optionally display the amount of users within your chat room on your chat navigation tab shown throughout your entire forum/CMS.
• Remote authentication allows you to authenticate access into your chat room based on your vBulletin user database
• Automatic user login option
• Seamless integration with vBulletin Usergroup permissions (remote authentication)
• Remote functions system allows you to tie in vBulletin forum functions into the AddonChat user menu
• Uses the vBulletin XML product import architecture, making installation simple.
• No code or template modifications required
• Automated account lookup - just enter your account number and password, and your information will be automatically retrieved. (allow_url_fopen must be enabled in PHP)
• Multi-lingual (UTF-8) support

Advanced Integration

Server Lookup Query Script

http://clientx.addonchat.com/queryserver.php

id: Numeric portion of AddonChat account number.

queryserver.php will return the message 'Invalid Account Number' if the account specified is invalid, or will return the full domain to the server that this chat room has been assigned.

http://clientx.addonchat.com/queryserver.php?id=12345

You can safely assume that a chat room's assigned server will not change; thus only lookup should be neccesary to determine a chat room's assigned server based on it's account ID number.

This script makes no guarantee as to what Content-Type the output will be delivered in; however the only content of the returned page will be the server name or error message.

This service is now considered deprecated; and has been replaced by the General Account Query Script. This script should only be used when an AddonChat customer's password is not available to the vendor.

General Account Query Script

http://clientx.addonchat.com/queryaccount.php

id: Numeric portion of AddonChat account number.
md5pw: MD5 Hashed Password.

On success, the following 13 lines (separated by a carriage return and linefeed '\r\n') will be returned. On failure, only four lines will be returned, the first line being a -1 error code.

1. INTEGER: Numeric Edition Code, or -1 for failure. At the time of this writing the following edition codes exist: 0: Free; 10: Personal; 20: Professional; 30: Professional PLUS; 40-130: Enterprise Editions.
2. Numeric list of modules installed; which each number indicating a specific module. The list is enclosed in parenthesis, and numeric codes for modules are not presently documented. If line 1 is an error (-1) this line will merely be 0.
   
3. BOOLEAN: 0, or 1; specifying whether or not this chat room is capable of enabling the Remote Authentication System. If line 1 is an error, this line will contain a description of the error.
   
4. Full Service Edition Name (e.g., Enterprise-200), or 0 (zero) on error.
   
5. Account Expiration Date.
6. BOOLEAN: 0, or 1; specifying whether or not remote authentication is currently enabled for this account
7. Current Remote Authentication URL (fully qualified if valid)
8. Assigned server name (e.g., client8.addonchat.com)
9. Assigned TCP connection port
10. Direct, fully qualified URL to control panel login
11. Title of chat room as specified by customer
12. Account ID, preceded with 'SC-' product code.
13. Customer ID, preceded with 'RC-' customer code.

http://clientx.addonchat.com/queryaccount.php?id=12345&md5pw=293890908237789sdfhsd8923

30
(3,5,7,14,23)
1
Professional PLUS
2011-08-23
0
http://
client23.addonchat.com
8009
http://cpanel23.addonchat.com/this?is=just+to+give&you=an+example
My Very Own Chat Room
SC-9384949
RC-0010293948

-1
0
Incorrect Password
0

You can safely assume that a chat room's assigned server will not change; thus only lookup should be neccesary to determine a chat room's assigned server based on it's account ID number.

This script guarantees the Content-type output will be in plain text format, UTF-8 encoded.

AddonInteractive does not recommend storing our customer's passwords in plain text.

Set, Unset Remote Authentication Script

http://clientx.addonchat.com/setras.php

id: Numeric portion of AddonChat account number.

rasurl: Fully qualified URL to remote authentication script (must be URL Encoded) that you wish to set

md5pw: MD5 encoded password for customer account

unset: Boolean (0 or 1). Set to 1 to disable remote authentication for this account. Note: rasurl need not be supplied when set to 1.

setras.php will return two lines of data, in UTF-8 encoded plain text:

1. BOOLEAN: 0 (failure) or 1 (success)
2. TEXT message indicating either 'Success' or a specified failure reason.

Get Client Settings Script

http://clientN.addonchat.com/settings.php

aid: Numeric portion of AddonChat account number.

settings.php will return a lengthy, UTF-8 Plain Text encoded file in parameter = value style format. Its output will correlate with settings specified by the user in the AddonChat control panel.

http://client0.addonchat.com/settings.php?aid=8847

See also: Direct Settings

The settings.php protocol may change, parameters may be added, removed, or renamed from version to version with no warning.

clientN.addonchat.com  (as specified above) should be replaced by the assigned server for this account. You may use the Server Lookup Query Script to determine this server, or your chat room link code (available in your AddonChat control panel) will indicate this value.

Remote Account Sign-Up

http://www.addonchat.com/rsignup.php

email: Customer eMail Address
password: Customer Password
password_verify: Customer Password (Verify, must match password)
firstname: Customer's First Name (Recommended, but not required)
lastname: Customer's Last Name (Recommended, but not required)
website: Customer's Web Site
terms: Set to 'yes' to inidcate that customer agrees to terms of use
age: Set to 'yes' to indicate that customer is 13 years of age or older
informed: Set to 'yes' to add customer to AddonInteractive mailing list
chat_title: Title customer wishes to use for chat room
referred_by: Affiliate ID or Referral Code

This script will return two or three lines depending upon successful account creation:

1. 0 for Failure, 1 for Success.
2. Assigned customer account number (Integer only) or Error Code
   
3. Assigned AddonChat account number (Integer only

1
128483
3947839

0
102

• 100: Customer is not 13 years of age or older
• 101: Customer does not agree with Terms & Conditions
• 102: Invalid eMail Address
• 103: Invalid Web Site
• 104: Weak Password Specified
• 105: Customer already has an account listed with this eMail address. Please direct them to addonchat.com
• 106: Password verification does not match
• 110: General (Unknown) Error
• 200: Internal Error
  
• 201: Internal Error
• 202: Internal Error

This script guarantees the Content-type output will be in plain text format, UTF-8 encoded. Data passed to this script should also be UTF-8 encoded.

AddonInteractive does not recommend storing our customer's passwords in plain text.

You must provide forms for the user to consent to our terms of service, age requirements, and mailing list opt-in.

Drupal

Drupal 6 Integration

phpBB

phpBB v2.x Integration

AddonChat integration with phpBB

These instructions assist you with the integration of the AddonChat software into the polular phpBB forum software.

phpBB can be obtained from www.phpbb.com/downloads.php
AddonChat can be obtained from www.addonchat.com/products.html

The following instructions apply to the Professional / Professional Plus or Enterprise editions

You can view a flash demonstration of this knowledge base article at http://support.addoninteractive.com/phpbb/

1. Open up Notepad or a similar text editing piece of software

2. Copy and paste the following code into Notepad or similar ensuring that XXXXX is replaced  with your room number (the numeric portion of your account number beginning with SC-) and the blue servername is identical with that of your own which you may lookup from the Home -> Chat Room Link Code section of your AddonChat control panel.  E.g., a typical server name might be "client4.addonchat.com" or "client1.addonchat.com" or similar.

<?php

// standard hack prevent
define('IN_PHPBB', true);
$phpbb_root_path = './';
include($phpbb_root_path . 'extension.inc');
include($phpbb_root_path . 'common.'.$phpEx);

// standard session management
$userdata = session_pagestart($user_ip, PAGE_INDEX );
init_userprefs($userdata);

// set page title
$page_title = 'AddOnChat';

// redirect to login if not logged in
if ( empty($userdata['user_id']) || $userdata['user_id'] == ANONYMOUS )
{
       redirect(append_sid("login.$phpEx?redirect=chat.$phpEx", true));
}

// standard page header
include($phpbb_root_path . 'includes/page_header.'.$phpEx);

$naam = $userdata['username'];

?>
<applet code="Client.class"
   codebase="http://clientX.addonchat.com/current/" 
   archive="scclient_en_uk.zip" width="600" height="425"
   alt="Java Chat Software - AddonChat" MAYSCRIPT>
   <param name="room" value="XXXXX">   
   <a href="http://www.addonchat.com/">Java Chat Software</a>
<param name="username" value="<?php echo $naam?>" />
<param name="autologin" value="yes">
</applet>

<?php
// standard page footer
include($phpbb_root_path . 'includes/page_tail.'.$phpEx);

?>

3. Save the file as chat.txt

4. Change the extension of the file to chat.php

5. Upload the file to your server ensuring that it is placed in the same directory where the phpBB index.php file is located

6. Grab a copy of index_body.tpl in the templates/subSilver folder from your server and open it with Wordpad or similar

7. Find the following set of lines:

<table width="100%" cellpadding="1" cellspacing="1" border="0">
<tr>
       <td align="left" valign="top"><span class="gensmall">{L_ONLINE_EXPLAIN}</span></td>
</tr>
</table>

8. After these lines add the following code ensuring that XXXXX is your room number, the green URL matches that in your Admin Control Panel and if the blue value is set to 1 for the rooms the users are in to be shown:

<table BORDER=0 CELLSPACING=0 CELLPADDING=0 WIDTH=100%>
<tr>
<td HEIGHT="10" BGCOLOR="#FFF5C2" align=center><b><font color="#3333FF" font size="1"><i><a href="chat.php" target="_blank">The Following Users Are In The Chat Room.</a></i></font></b></td>
</tr>
<tr>
<td><iframe
name="scwho"
src="http://clientX.addonchat.com/scwho.pl?id=XXXXX&subroom=0&boldadmin=0&comma=1&countonly=0&chatbg=FFF5C2&chatusr=3333FF&subroomcolor=000000&chatadmusr=3333FF&nousermsg=There are currently no users in the Chat Room"
width=100%
height=50
frameborder=0
scrolling="auto"></iframe></td>
</tr>
</table></center>
</td></tr>

9. Save the file and upload it to your server ensuring it is placed in the templates/subSilver directory

** Important:  Room Security **
These final steps ensure that your chat room is secure. It disallows the room to be accessed from other websites.

10. Login to your AddonChat Admin Control Panel and select -> settings -> Site integration -> Securtiy URL, then set the 'enable security url' option to yes. and the 'secure by url domain only' option to yes. Then enter the full url of the domain on which the AddonChat will be running from and finally click save

11. Finally ensure that your username and password to the AddonChat Admin Control Panel is different to your phpBB administrator username and password. This adds additional security to both your phpBB and AddonChat installations and is good practice in any case.

phpBB v3.x Integration

Who's Chatting

Who's Chatting System v1.1

The AddonChat Who's Chatting System (previously Who's Online Module) v1.1 allows you to easily fetch a list of users, with additional data, that are currently in your chat room. v1.1 no longer requires HTML stripping, as output is produced in plain text tabular format.

The Who's Chatting System may be accessed from:

The following parameters should be passed to this script:

Example:

Output:

WCS v1.1, when used with the plain=1 option will display it's output in columnar (tab delimited) format, with one user per each line delimited by a \r\n. The following table describes the columns:

Example:

Related PHP/Perl Resources:

• PHP file function
• PHP fopen function
• PHP allow_url_fopen configuration option
• Perl LWP module

International

Enabling Supplemental Language Support in Windows XP

Step 1 [Enable Supplemental Language Support]

1. Open your Windows XP Control Panel. This can be found in your Start Menu.
2. Click "Date, Time, Language and Regional Options"
3. Click "Regional and Language Options". A new window will appear.
4. From the Regional and Language Options Window, click on the "Languages Tab"
5. Ensure that the "Install files for complex script and right-to-left" option and the "Install files for Easy Asian languages" checkboxes are checked.
6. Click OK
7. You may be prompted to insert your Windows XP CD-ROM. Follow any remaining instructions provided.
8. Restart your computer if instructed to do so.

Add Input Language Service/Keyboard in Windows XP

Please consult knowledge base article #13, Enabling Supplemental Language Support in Windows XP ,before proceeding with the steps below.

Step 1 [Add Input Language Service/Keyboard]

1. Open your Windows XP Control Panel. This can be found in your Start Menu.
2. Click "Date, Time, Language and Regional Options"
3. Click "Regional and Language Options". A new window will appear.
4. From the Regional and Language Options Window, click on the "Languages Tab"
5.   Click the "Details..." button under "Text services and input languages". A new window will appear.
6.   Under the "Settings" tab in the "Text Services and Input Languages" window that just popped up, you will see a region titled "Installed services" indicating the keyboards / language input services installed on your system. Click the "Add..." button to add a new keyboard/language service. A new window will appear.
7.   Under the "Add Input Language" window that just appeared, select the input language you wish to use, and the keyboard layout style. Click the "OK" button. The window will disappear.
8. Click the "OK" button in the "Text Services and Input Languages" window.
9. Click the "OK" button in the "Regional and Language Options" window.

Step 2 [Select Language]

1. The language bar should now be accessible from your Windows Task Bar.
2. Select the language that you would like to input text with, or use the Left-Alt+Shift keyboard combination to switch between input languages.

Displaying Arabic Characters

• Enabling Supplemental Language Support in Windows XP
• Add Input Language Service/Keyboard in Windows XP

Displaying Hebrew Characters

• Enabling Supplemental Language Support in Windows XP
• Add Input Language Service/Keyboard in Windows XP

Displaying Japanese Characters

• Enabling Supplemental Language Support in Windows XP
• Add Input Language Service/Keyboard in Windows XP

Emoticons

Recovering Lost Emoticons

Converting Audio Emoticons

Emoticon Resources

The following links may be helpful in finding additional emoticons to add to your chat room. Please note that some sites may contain copyrighted material. Before using copyrighted material, please ensure that you have permission to do so.

• Nomicons: The Full Monty
  Credits: Oscar Gruno, Andy Fedosjeenko (Nightwolf).
  Copyright ©2001-Infinity, Oscar Gruno & Andy Fedosjeenko
  RaiderSoft (now AddonInteractive) has received permission from Oscar Gruno to use Nomicons as part of our SigmaChat (now AddonChat) Java Chat Service.
• WenPigsFly Smilies
• Emoticons used at The Buffy Site
• FindSounds: Search the Web for Sounds
• Google Image Search
• Mysmilies.com

Tutorials

Quick Set Up Guide

With this easy to follow Quick Setup Guide, your chat room should be online within minutes.

We have tried to keep the instructions below as easy to follow as possible, and there is no major technical expertise needed to get up and running. You can opt to use our Simple Link code which you can start using immediately, or choose to integrate the chat room to an existing website.

First Things First: Getting your Free AddonChat Account

If you have not done so already, you will need to set up a chat account by clicking the ‘Get It Now’ link from the main AddonChat website. When registering for an account, we recommend choosing an account password which includes a mixture of both letters and numbers; this will make sure your account is as secure as possible.

Once registered, a confirmation notice will be sent to your registered e-mail address. This confirmation will also include these basic instructions for getting started quickly with your new AddonChat chat room account. If you do not receive the confirmation e-mail within a few moments, please check that it has not been picked up by any spam filtering software you may have.

Your AddonChat Control Panel

To access your AddonChat control panel, you will first need to login to your Customer account by clicking on the ‘My Account’ link on the main AddonChat website using the email address and password you registered with.

Once logged in you can view all of your AddonInteractive services in the My Services area.

The option to access the control panel for your AddonChat product will be displayed here also. Click the gear icon link next to your account to open the AddonChat account control panel.

Accessing Your Chat Room

No Website: If you do not have a website, don’t worry! You can still use and access your chat room using the direct link in your control panel marked "No Website? No Problem". This is the direct link to your chat room located on our servers. Just give this link to anyone you want to use your chat room.

You can find this code in your AddonChat control panel under: Home -> Chat Room Link Code -> Simple Link

Uploading Chat To Your Website: If you have a website and would like your chat room to load into an existing web page (in the same way ours does on our demo page) the embedded chat code is required. You will require some basic knowledge on adding HTML code to your site, and creating web pages.

You can embed your chat room to your site in a few easy steps:

Step One: Copy the code shown on your AddonChat control panel under the Home -> Chat Room Link Code -> Embedded section – to copy the code take your mouse and place your cursor at the beginning of the text. Click and hold the left mouse button while pulling your mouse over the text, this will highlight the test for you. Release the left mouse button and right click on the highlighted text and select copy from the options.

Step Two: Using the web building software you are normally used too (e.g. Frontpage, Dreamweaver etc) paste the chat code into your webpage in the same way you would when adding any other code to your website or when writing your web page. If you are unsure how to do this, check the help files in your web building software and search for help on ‘adding html code to my site’ – this should point you in the right direction.

Step Three: Once you have successfully added the chat code to your web page, upload your saved page to your website following the usual steps you would follow when updating your website. This varies depending on the software you are using but usually involves uploaded your website using FTP if you are using software on your computer – or different if you are using an online web building system, in this case consult your software provider.

Your chat room will now be up and running on your website.

3^rd Party Integration

The AddonChat software can be easily integrated with many 3^rd party applications and forum software. If you have a forum or 3^rd party application, please check out our comprehensive integration list to see if we have an integration script for your particular software.

For step by step instructions, and integration scripts please visit: http://support.addoninteractive.com/index.php?action=kb&category=8

Need Help?

Questions? Comments? Suggestions? Feel free to e-mail our support team at support@addonchat.com and one of our technicians will be happy to assist you.

Legacy Applications

Quick Set Up Guide

With this easy to follow Quick Setup Guide, your chat room should be online within minutes.

We have tried to keep the instructions below as easy to follow as possible, and there is no major technical expertise needed to get up and running. You can opt to use our Simple Link code which you can start using immediately, or choose to integrate the chat room to an existing website.

First Things First: Getting your Free AddonChat Account

If you have not done so already, you will need to set up a chat account by clicking the ‘Get It Now’ link from the main AddonChat website. When registering for an account, we recommend choosing an account password which includes a mixture of both letters and numbers; this will make sure your account is as secure as possible.

Once registered, a confirmation notice will be sent to your registered e-mail address. This confirmation will also include these basic instructions for getting started quickly with your new AddonChat chat room account. If you do not receive the confirmation e-mail within a few moments, please check that it has not been picked up by any spam filtering software you may have.

Your AddonChat Control Panel

To access your AddonChat control panel, you will first need to login to your Customer account by clicking on the ‘My Account’ link on the main AddonChat website using the email address and password you registered with.

Once logged in you can view all of your AddonInteractive services in the My Services area.

The option to access the control panel for your AddonChat product will be displayed here also. Click the gear icon link next to your account to open the AddonChat account control panel.

Accessing Your Chat Room

No Website: If you do not have a website, don’t worry! You can still use and access your chat room using the direct link in your control panel marked "No Website? No Problem". This is the direct link to your chat room located on our servers. Just give this link to anyone you want to use your chat room.

You can find this code in your AddonChat control panel under: Home -> Chat Room Link Code -> Simple Link

Uploading Chat To Your Website: If you have a website and would like your chat room to load into an existing web page (in the same way ours does on our demo page) the embedded chat code is required. You will require some basic knowledge on adding HTML code to your site, and creating web pages.

You can embed your chat room to your site in a few easy steps:

Step One: Copy the code shown on your AddonChat control panel under the Home -> Chat Room Link Code -> Embedded section – to copy the code take your mouse and place your cursor at the beginning of the text. Click and hold the left mouse button while pulling your mouse over the text, this will highlight the test for you. Release the left mouse button and right click on the highlighted text and select copy from the options.

Step Two: Using the web building software you are normally used too (e.g. Frontpage, Dreamweaver etc) paste the chat code into your webpage in the same way you would when adding any other code to your website or when writing your web page. If you are unsure how to do this, check the help files in your web building software and search for help on ‘adding html code to my site’ – this should point you in the right direction.

Step Three: Once you have successfully added the chat code to your web page, upload your saved page to your website following the usual steps you would follow when updating your website. This varies depending on the software you are using but usually involves uploaded your website using FTP if you are using software on your computer – or different if you are using an online web building system, in this case consult your software provider.

Your chat room will now be up and running on your website.

3^rd Party Integration

The AddonChat software can be easily integrated with many 3^rd party applications and forum software. If you have a forum or 3^rd party application, please check out our comprehensive integration list to see if we have an integration script for your particular software.

For step by step instructions, and integration scripts please visit: http://support.addoninteractive.com/index.php?action=kb&category=8

Need Help?

Questions? Comments? Suggestions? Feel free to e-mail our support team at support@addonchat.com and one of our technicians will be happy to assist you.

ICE Instant Messaging

"load: class Client not found" error

The load: class Client not found error can be caused by a number of different problems. Usually, this problem indicates that your web browser has downloaded/ cached an invalid copy of our chat software (cache instability or an error in download). Minor network glitches between your computer and our servers can also cause the problem. The problem can be resolved by emptying your browsers cache (or Temporary Internet Files), then shutting down all instances of your web browser, and trying again. In rare circumstances, a reboot may be required. Click the link below to learn how to clear your browser's cache.

In some cases, this problem can be caused because you have not copy and pasted your applet code correctly, or if you have entered your account number or server ID number incorrectly when integrating with applications such as Invision Power Board, vBulletin, ProBoards, phpBB, or SMF.

Clearing your browser's cache - http://support.addoninteractive.com/index.php?action=kb&article=2

Blank gray box when loading applet

"Bad Magic Number" error when loading Java applet

A message appears requiring a software install when I try to load the chat room.

Clearing your browser's cache

1. Click on Tools (or the Tools icon) from the Command Bar
2. Select Delete Browsing History...
3. Click the Delete files... button near Temporary Internet Files
4. Click Yes when prompted to delete temporary Internet Explorer files
5. Click the Close button
6. Shutdown all open instances of your web browser and restart

1. Click on Tools from your browser's main menu
2. Select Clear Private Data...
3. Ensure that Cache is checked
4. Click the Clear Private Data Now button
5. Shutdown all open instances of your web browser and restart

To empty your browser's cache using Microsoft Internet Explorer version 6

1. Click on Tools from your browser's main menu.
2. Select Internet Options
3. Under the General tab, click Delete Files... in the Temporary Internet files section.
4. Important: Shutdown all open instances of your web browser.

To empty your browser's cache using Firefox version 1.5

1. Click on Tools from your browser's main menu.
2. Select Options
3. Select the Privacy icon
   
4. Select  Cache tab.
5. Click the Clear Cache Now button
   
6. Important: Shutdown all open instances of your web browser.

To empty your browser's cache using Safari

1. Click on Safari from the main menu.
2. Click Empty Cache...
3. Important: Shutdown all open instances of your web browser.

To empty your browser's cache using Opera

1. Click on Tools from your browser's main menu.
2. Select Delete private data...
   
3. Click the Delete button
   
4. Important: Shutdown all open instances of your web browser.

To empty your browser's cache using Netscape

1. Click on Edit from your browser's main menu.
2. Select Preferences
3. Select and expand the Advanced category.
4. Click on Cache
5. Under Set Cache Options:
   1. Click Clear Memory Cache
   2. Click Clear Disk Cache
6. Click OK
7. Important: Shutdown all open instances of your web browser.

Unable to login using the AOL web browser

Unable to create or renew account

ICE End-user Help Guide

A Red X image is displayed where the applet should be, applets won't run

RaiderCSS

"load: class Client not found" error

The load: class Client not found error can be caused by a number of different problems. Usually, this problem indicates that your web browser has downloaded/ cached an invalid copy of our chat software (cache instability or an error in download). Minor network glitches between your computer and our servers can also cause the problem. The problem can be resolved by emptying your browsers cache (or Temporary Internet Files), then shutting down all instances of your web browser, and trying again. In rare circumstances, a reboot may be required. Click the link below to learn how to clear your browser's cache.

In some cases, this problem can be caused because you have not copy and pasted your applet code correctly, or if you have entered your account number or server ID number incorrectly when integrating with applications such as Invision Power Board, vBulletin, ProBoards, phpBB, or SMF.

Clearing your browser's cache - http://support.addoninteractive.com/index.php?action=kb&article=2

Blank gray box when loading applet

"Bad Magic Number" error when loading Java applet

A message appears requiring a software install when I try to load the chat room.

Clearing your browser's cache

1. Click on Tools (or the Tools icon) from the Command Bar
2. Select Delete Browsing History...
3. Click the Delete files... button near Temporary Internet Files
4. Click Yes when prompted to delete temporary Internet Explorer files
5. Click the Close button
6. Shutdown all open instances of your web browser and restart

1. Click on Tools from your browser's main menu
2. Select Clear Private Data...
3. Ensure that Cache is checked
4. Click the Clear Private Data Now button
5. Shutdown all open instances of your web browser and restart

To empty your browser's cache using Microsoft Internet Explorer version 6

1. Click on Tools from your browser's main menu.
2. Select Internet Options
3. Under the General tab, click Delete Files... in the Temporary Internet files section.
4. Important: Shutdown all open instances of your web browser.

To empty your browser's cache using Firefox version 1.5

1. Click on Tools from your browser's main menu.
2. Select Options
3. Select the Privacy icon
   
4. Select  Cache tab.
5. Click the Clear Cache Now button
   
6. Important: Shutdown all open instances of your web browser.

To empty your browser's cache using Safari

1. Click on Safari from the main menu.
2. Click Empty Cache...
3. Important: Shutdown all open instances of your web browser.

To empty your browser's cache using Opera

1. Click on Tools from your browser's main menu.
2. Select Delete private data...
   
3. Click the Delete button
   
4. Important: Shutdown all open instances of your web browser.

To empty your browser's cache using Netscape

1. Click on Edit from your browser's main menu.
2. Select Preferences
3. Select and expand the Advanced category.
4. Click on Cache
5. Under Set Cache Options:
   1. Click Clear Memory Cache
   2. Click Clear Disk Cache
6. Click OK
7. Important: Shutdown all open instances of your web browser.

Unable to login using the AOL web browser

Unable to create or renew account

RaiderCSS v2.0 Operator Help Guide

A Red X image is displayed where the applet should be, applets won't run

My Account

Customer ID vs. Account ID Numbers

What is the difference between my Customer ID and my Account ID(s)?

All AddonInteractive customers are assigned a unique Customer ID. This Customer ID begins with 'RC' and is indicated in your control panel, and on all invoices and receipts.

For each AddonInteractive service you sign up for (i.e., a new AddonChat chat room) you are assigned an account ID unique to that new account. An AddonChat account ID, for example, begins with 'SC'. Each of your AddonInteractive service Account ID's are bound to your unique Customer ID number.

When contacting technical support, we can use any of your account numbers or invoice numbers to reference your customer data.

If you have multiple Customer ID's and would like them merged into a single Customer ID's, please contact technical support by submitting a support ticket or through eMail at support@addonInteractive.com

Become an Affiliate

1. Login to your AddonInteractive Customer Control Panel at http://www.addoninteractive.com/login.html. If you do not already have a Customer account, you may create a free customer account at http://www.addonchat.com/signup.html
   
2. After logging in, select the menu item on the right titled Affiliate Program
3. Complete the form provided, and select the affiliate program (cash commission or account commission) that you'd like to use and click the Sign Up button at the bottom of the page. You will be automatically approved as an affiliate. The starting commission rate is 5%, and we offer incentive commission rate upgrades based on commissions paid and other factors.
4. You are now an AddonInteractive affiliate! Click the Getting Started link to get your affiliate link and learn more about the program.

• Account Overview: Use the account overview to view your current commission settings and rate, as well as to view vital statistics including click-throughs and sign up conversions.
• Update Settings: Use this link to update your affiliate account settings and/or modify your affiliate account type.
• View Statements: Here, you may view your settled transaction statements. Commissions are paid once a month for conversions that are 32 days or older.
  
• Recent Transactions: Here, you may view your recent sales conversion transactions that have not yet been settled. These transactions are subject to a 32 day hold before being paid. Settlements are updates once per month for all affiliates, so some transactions may be listed as unsettled for up to 64 days.