Sounds are defined in config/sounds.js file.
Example of a sound definition:
bcsound = new Object(); bcsound.id = 1; bcsound.name = "Smile"; bcsound.alt1 = ":-)"; bcsound.alt2 = ":)"; bcsound.alt3 = "";
bcsound.iconClass = "bcSoundMessage";
bcsound.ogg = "";
bcsound.mp3 = "/components/com_blastchatconfig/config/sounds/msg.mp3";
bcsound.wav = "/components/com_blastchatconfig/config/sounds/msg.wav";
bcDataConfig.sounds.sounds.push(bcsound);
You should copy this code for each sound you would like to create. There are 3 alternatives "ogg", "mp3" and "wav" for the file type because different browsers support different sound file types. You can read more about it at HTML5 Audio.
Parameter name
|
Default value
|
Type
|
| bcsound.id (mandatory) | Number | |
| Identification number of the sound (must be unique value in your system) |
||
| bcsound.name | "" | String |
| Sound name (presented as a tooltip) |
||
| bcsound.alt1 | "" | String |
| First string alternative to look for in the message, that should be mapped to this sound |
||
| bcsound.alt2 | "" | Boolean |
| Second string alternative to look for in the message, that should be mapped to this sound |
||
| bcsound.alt3 | "" | String |
| Third string alternative to look for in the message, that should be mapped to this sound |
||
| bcsound.iconClass | "" | String |
| icon class |
||
| bcsound.ogg | "" | String |
| File location of the "ogg" file type alternative for this sound definition |
||
| bcsound.mp3 | "" | String |
| File location of the "mp3" file type alternative for this sound definition |
||
| bcsound.wav | "" | String |
| File location of the "wav" file type alternative for this sound definition |
||
Sound groups are defined in config/emoticons.js file.
Example of a sound group definition:
bcsoundgroup = new Object(); bcsoundgroup.id = 1; bcsoundgroup.sounds = [1,2]; bcDataConfig.sounds.groups.push(bcsoundgroup);
You should copy this code for each emoticon group you would like to create.
Parameter name
|
Default value
|
Type
|
| bcsoundgroup.id (mandatory) | Number | |
| Identification number of the sound group (must be unique value in your system) |
||
| bcsoundgroup.sounds | "" | Array |
| Array of comma separated sound identification numbers that belong to this sound group |
||
Emoticons are defined in config/emoticons.js file.
Example of an emoticon definition:
bcemoticon = new Object(); bcemoticon.id = 1; bcemoticon.name = "Smile"; bcemoticon.alt1 = ":-)"; bcemoticon.alt2 = ":)"; bcemoticon.alt3 = ""; bcemoticon.iconClass = "bcEmoticonSmile"; bcDataConfig.emoticons.emoticons.push(bcemoticon);
You should copy this code for each emoticon you would like to create.
Parameter name
|
Default value
|
Type
|
| bcemoticon.id (mandatory) | Number | |
| Identification number of the emoticon (must be unique value in your system) |
||
| bcemoticon.name | "" | String |
| Emoticon name (presented as a tooltip). |
||
| bcemoticon.alt1 | "" | String |
| First string alternative to look for in the message, that should be mapped to this emoticon |
||
| bcemoticon.alt2 | "" | Boolean |
| Second string alternative to look for in the message, that should be mapped to this emoticon |
||
| bcemoticon.alt3 | "" | String |
| Third string alternative to look for in the message, that should be mapped to this emoticon |
||
| bcemoticon.iconClass | "" | String |
| icon class |
||
Emoticon groups are defined in config/emoticons.js file.
Example of a emoticon group definition:
bcsoundgroup = new Object(); bcsoundgroup.id = 1; bcsoundgroup.sounds = [1,2]; bcDataConfig.sounds.groups.push(bcsoundgroup);
You should copy this code for each emoticon group you would like to create.
Parameter name
|
Default value
|
Type
|
| bcemoticongroup.id (mandatory) | Number | |
| Identification number of the emoticon group (must be unique value in your system) |
||
| bcemoticongroup.emoticons | "" | Array |
| Array of comma separated emoticon identification numbers that belong to this emoticon group |
||
You can place any of the following parameters into your config/groups.js file to overwrite default values for each room that you need to.
Example of a group definition:
bcgroup = new Object(); bcgroup.id = 1; bcgroup.name = "Guest"; bcgroup.iconClass = "bcUserGroupIconGuest"; //additional parameters here bcDataConfig.groups.push(bcgroup);
You should copy this code for each group you would like to create.
Parameter name
|
Default value
|
Type
|
| bcgroup.id (mandatory) | Number | |
| Identification number of the group (must be unique value in your system) |
||
| bcgroup.name | "Guest" | String |
| bcgroup.weight | 0 | Integer |
| higher the weight value, stronger the user type |
||
| bcgroup.instantMessagingShowUserList | true | Boolean |
| show bar userlist |
||
| bcgroup.instantMessagingFriends | Boolean | false |
| show friends of this user in bar userlist |
||
| bcgroup.instantMessagingGroups | "all" | String/Array |
| show only users belonging to these groups in bar userlist, possible values: - "all" will show all groups, - [] will show no groups, - [0,1] will show users belonging to group id 0 and 1 |
||
| bcgroup.baseClass | "bcUserGroupIcon" | String |
| icon base class |
||
| bcgroup.iconClass | "bcUserGroupIconGuest" | String |
| icon class |
||
| bcgroup.access | true | Boolean |
| bcgroup.adminAccess | false | Boolean |
| access to admin features |
||
| bcgroup.adminKick | false | Boolean |
| can user kick other users who belong to less 'weight' group from whole system? |
||
| bcgroup.adminBan | false | Boolean |
| can user ban other users who belong to less 'weight' group for whole system? |
||
You can place any of the following parameters into your config/roomsgroups.js file to overwrite default value for any group/room that you need to.
Example of a room definition looks like this:
bcroomgroup = new Object(); bcroomgroup.roomid = 1; bcroomgroup.groupid = 1; //additional parameters here bcDataConfig.groupsrooms.push(bcroomgroup);
You should copy this code for each group/room combination that you would like to adjust.
Parameter name
|
Default value
|
Type
|
| bcroomgroup.roomid (mandatory) | Integer | |
| Room id you wish to overwrite parameters for |
||
| bcroomgroup.groupid (mandatory) | Integer | |
| Group id you wish to overwrite parameters for |
||
| bcroomgroup.maxChatters | 100 | Integer |
| max chatters in the room |
||
| bcroomgroup.bannerHeight | 0 | Integer |
| bcroomgroup.bannerUrl | String | |
| bcroomgroup.visible | true | Boolean |
| bcroomgroup.avatarsChat | true | Boolean |
| bcroomgroup.avatarsShout | true | Boolean |
| bcroomgroup.avatarsBar | true | Boolean |
| bcroomgroup.access | true | Boolean |
| bcroomgroup.write | true | Boolean |
| bcroomgroup.showUserlistChat | true | Boolean |
| bcroomgroup.showUserlistShout | true | Boolean |
| bcroomgroup.showUserlistBar | true | Boolean |
| bcroomgroup.showWeblinksChat | true | Boolean |
| bcroomgroup.showWeblinksShout | true | Boolean |
| bcroomgroup.showWeblinksBar | true | Boolean |
| bcroomgroup.historyCount | 10 | Integer |
| count of old messages loaded on room entry (max value is 25, 0 - no history) |
||
| bcroomgroup.historyMaxAge | 60 | Integer |
| minutes, max age of old messages that are loaded on room entry |
||
| bcroomgroup.emoticons | true | Boolean |
| bcroomgroup.sounds | true | Boolean |
| bcroomgroup.colors | true | Boolean |
| bcroomgroup.detectUrl | true | Boolean |
| bcroomgroup.flood | true | Boolean |
| does flood apply? |
||
| bcroomgroup.autoKickBan | true | Boolean |
| bcroomgroup.messageDeleteOwn | true | Boolean |
| bcroomgroup.messageMaxLength | 250 | Integer |
| 0 - unlimited |
||
| bcroomgroup.messageMaxLines | 3 | Integer |
| 0 - unlimited |
||
| bcroomgroup.messageSingleModeChat | false | Boolean |
| maximum messages to show (0 - unlimited) |
||
| bcroomgroup.messageSingleModeShout | false | Boolean |
| maximum messages to show (0 - unlimited) |
||
| bcroomgroup.messageSingleModeBar | false | Boolean |
| maximum messages to show (0 - unlimited) |
||
| bcroomgroup.maxMessagesChat | 0 | Integer |
| maximum messages to show (0 - unlimited) |
||
| bcroomgroup.maxMessagesShout | 0 | Integer |
| maximum messages to show (0 - unlimited) |
||
| bcroomgroup.maxMessagesBar | 0 | Integer |
| maximum messages to show (0 - unlimited) |
||
| bcroomgroup.instantMessaging | true | Boolean |
| Allow instant messaging between people from different groups that meet in room (if "Bar" is present) |
||
| bcroomgroup.adminMessageDeleteAny | false | Boolean |
| (Admin feature, group must have "adminAccess" set to true to access this feature) |
||
| bcroomgroup.adminApprove | false | Boolean |
| can approve messages in strict moderation room (Admin feature, group must have "adminAccess" set to true to access this feature) |
||
| bcroomgroup.adminAssign | false | Boolean |
| can assign write privileges to users who belong to less 'weight' group for this room? (Admin feature, group must have "adminAccess" set to true to access this feature) |
||
| bcroomgroup.adminRevoke | false | Boolean |
| can revoke write privileges to users who belong to less 'weight' group for this room? (Admin feature, group must have "adminAccess" set to true to access this feature) |
||
| bcroomgroup.adminKick | false | Boolean |
| can user kick other users who belong to less 'weight' group from this room? (Admin feature, group must have "adminAccess" set to true to access this feature) |
||
| bcroomgroup.adminBan | false | Boolean |
| can user ban other users who belong to less 'weight' group for this room? (Admin feature, group must have "adminAccess" set to true to access this feature) |
||
You can place any of the following parameters into your config/rooms.js file to overwrite default value for each room that you need to.
Example of a room definition:
bcroom = new Object();
bcroom.id = 1;
bcroom.name = "Room";
bcroom.topic = "RoomTopic";
//additional parameters here
bcDataConfig.rooms.push(bcroom);
You should copy this code for each room you would like to create.
Parameter name
|
Default value
|
Type
|
| bcroom.id (mandatory) | Number | |
| Identification number of the room (must be unique value in your system) |
||
| bcroom.name | "Room" | String |
| Name of the room |
||
| bcroom.topic | "RoomTopic" | String |
| Topic of the room (short description) |
||
| bcroom.showButtonSendChat | true | Boolean |
| Should the "Send" clickable button be visible in the Chat? |
||
| bcroom.showButtonSendShout | false | Boolean |
| Should the "Send" clickable button be visible in the Shout? |
||
| bcroom.showButtonSendBar | false | Boolean |
| Should the "Send" clickable button be visible in the Bar? |
||
| bcroom.emoticonsGroupId | 0 | Integer |
| Emoticons group id is to use in this room (defined in config/emoticons.js |
||
| bcroom.emoticonsGroupBaseClass | "bcEmoticon" | String |
| Emoticons base CSS class (defined in config/css/emoticons.css file) |
||
| bcroom.emoticonsGroupColsChat | 6 | Integer |
| chat |
||
| bcroom.emoticonsGroupColsShout | 6 | Integer |
| chat |
||
| bcroom.emoticonsGroupColsBar | 6 | Integer |
| bar |
||
| bcroom.soundsGroupId | 0 | Integer |
| |
||
| bcroom.soundsGroupBaseClass | "bcSound" | String |
| bcroom.soundsGroupColsChat | 6 | Integer |
| chat |
||
| bcroom.soundsGroupColsShout | 6 | Integer |
| shout |
||
| bcroom.soundsGroupColsBar | 6 | Integer |
| bar |
||
| bcroom.soundsRoomMessage | 0 | Integer |
| bcroom.soundsPrivateMessage | 0 | Integer |
| bcroom.baseClass | "bcIcon" | String |
| icon base class |
||
| bcroom.iconClass | "bcIconRooms" | String |
| icon class |
||
| bcroom.baseClassBar | "bcIconBar" | String |
| |
||
| bcroom.iconClassBar | "bcIconRoomsBar" | String |
| bcroom.password | false | Boolean |
| if true, you must create this room in your blastchat.com account Administration |
||
| bcroom.moderated | false | Boolean |
| strict moderation, message must be approved by user with moderator privileges |
||
Following parameters can be overwritten in config/roomsgroups.js file per group.
Parameter Name
|
Default value
|
Type
|
| bcroom.maxChatters | 100 | Integer |
| max chatters in the room |
||
| bcroom.bannerHeight | 0 | Integer |
| bcroom.bannerUrl | String | |
| bcroom.visible | true | Boolean |
| bcroom.avatarsChat | true | Boolean |
| bcroom.avatarsShout | true | Boolean |
| bcroom.avatarsBar | true | Boolean |
| bcroom.access | true | Boolean |
| bcroom.write | true | Boolean |
| bcroom.copypaste | false | Boolean |
| Set value to true to allow copy/paste and save history to text file functionality | ||
| bcroom.showGuestList | true | Boolean |
| Show guest list in the userlist area inside this room. |
||
| bcroom.showUserlistChat | true | Boolean |
| bcroom.showUserlistShout | true | Boolean |
| bcroom.showUserlistBar | true | Boolean |
| bcroom.showWeblinksChat | true | Boolean |
| bcroom.showWeblinksShout | true | Boolean |
| bcroom.showWeblinksBar | true | Boolean |
| bcroom.historyCount | 10 | Integer |
|
count of old messages loaded on room entry (max value is 25, 0 - no history) |
||
| bcroom.historyMaxAge | 60 | Integer |
| minutes, max age of old messages that are loaded on room entry |
||
| bcroom.emoticons | true | Boolean |
| bcroom.sounds | true | Boolean |
| bcroom.colors | true | Boolean |
| Colors usage allowed |
||
| bcroom.fontstyle | true | Boolean |
| Font Style usage allowed |
||
| bcroom.fontsize | true | Boolean |
| Font Size usage allowed |
||
| bcroom.detectUrl | true | Boolean |
| bcDataConfig.system.badWords | null | Array |
| badWords filter, array of strings, example ['a','b'] |
||
| bcDataConfig.system.badWordsReplacement | *** | String |
| badWords replacement string |
||
| bcroom.flood | true | Boolean |
| does flood apply? |
||
| bcroom.autoKickBan | true | Boolean |
| bcroom.messageDeleteOwn | true | Boolean |
| bcroom.messageMaxLength | 250 | Integer |
| 0 - unlimited |
||
| bcroom.messageMaxLines | 3 | Integer |
| 0 - unlimited |
||
| bcroom.messageSingleModeChat | false | Boolean |
| maximum messages to show (0 - unlimited) |
||
| bcroom.messageSingleModeShout | false | Boolean |
| maximum messages to show (0 - unlimited) |
||
| bcroom.messageSingleModeBar | false | Boolean |
| maximum messages to show (0 - unlimited) |
||
| bcroom.maxMessagesChat | 0 | Integer |
| maximum messages to show (0 - unlimited) |
||
| bcroom.maxMessagesShout | 0 | Integer |
| maximum messages to show (0 - unlimited) |
||
| bcroom.maxMessagesBar | 0 | Integer |
| maximum messages to show (0 - unlimited) |
||
| bcroom.instantMessaging | true | Boolean |
| Allow instant messaging between people from different groups that meet in room (if "Bar" is present) |
||
| bcroom.adminMessageDeleteAny | false | Boolean |
| (Admin feature, group must have "adminAccess" set to true to access this feature) |
||
| bcroom.adminApprove | false | Boolean |
| can approve messages in strict moderation room (Admin feature, group must have "adminAccess" set to true to access this feature) |
||
| bcroom.adminAssign | false | Boolean |
| can assign write privileges to users who belong to less 'weight' group for this room? (Admin feature, group must have "adminAccess" set to true to access this feature) |
||
| bcroom.adminRevoke | false | Boolean |
| can revoke write privileges to users who belong to less 'weight' group for this room? (Admin feature, group must have "adminAccess" set to true to access this feature) |
||
| bcroom.adminKick | false | Boolean |
| can user kick other users who belong to less 'weight' group from this room? (Admin feature, group must have "adminAccess" set to true to access this feature) |
||
| bcroom.adminBan | false | Boolean |
| can user ban other users who belong to less 'weight' group for this room? (Admin feature, group must have "adminAccess" set to true to access this feature) |
||