Camfrog Bot User Guide

Camfrog Bot 6.0 for Windows User Guide

Revision 3.3: April 2012

Table

of

Contents

Table of Contents ................................................................................................................................................ 2 How to Use This Guide ........................................................................................................................................ 5 Getting started .................................................................................................................................................... 5 Installation ........................................................................................................................................................... 6 Camfrog Bot Registration .................................................................................................................................... 7 Camfrog Bot Main Window ................................................................................................................................. 8 Camfrog Bot Configurations File ......................................................................................................................... 9 Plug-In Descriptions .......................................................................................................................................... 10 Overview ....................................................................................................................................................... 10 8 Ball .............................................................................................................................................................. 11 Localization ................................................................................................................................................ 11 Bad Words Kicker .......................................................................................................................................... 11 Localization ................................................................................................................................................ 12 Ghost ............................................................................................................................................................. 13 Localization ................................................................................................................................................ 14 Greeter .......................................................................................................................................................... 16 Localization ................................................................................................................................................ 16 Heap .............................................................................................................................................................. 16 Localization ................................................................................................................................................ 16 HTML Log .................................. ................. ................................... ................................... ................................... ................................... ................................... ................................... ............................. ............ 18 IM Control ..................................................................................................................................................... 18 Full list of bot commands .......................................................................................................................... 19 Math Trivia .................................................................................................................................................... 22 Localization ................................................................................................................................................ 22 Messenger ..................................................................................................................................................... 24 Roulette ......................................................................................................................................................... 24 RSS Reader Plug-In ........................................................................................................................................ 24 Trivia .............................................................................................................................................................. 25

Table

of

Contents

Table of Contents ................................................................................................................................................ 2 How to Use This Guide ........................................................................................................................................ 5 Getting started .................................................................................................................................................... 5 Installation ........................................................................................................................................................... 6 Camfrog Bot Registration .................................................................................................................................... 7 Camfrog Bot Main Window ................................................................................................................................. 8 Camfrog Bot Configurations File ......................................................................................................................... 9 Plug-In Descriptions .......................................................................................................................................... 10 Overview ....................................................................................................................................................... 10 8 Ball .............................................................................................................................................................. 11 Localization ................................................................................................................................................ 11 Bad Words Kicker .......................................................................................................................................... 11 Localization ................................................................................................................................................ 12 Ghost ............................................................................................................................................................. 13 Localization ................................................................................................................................................ 14 Greeter .......................................................................................................................................................... 16 Localization ................................................................................................................................................ 16 Heap .............................................................................................................................................................. 16 Localization ................................................................................................................................................ 16 HTML Log .................................. ................. ................................... ................................... ................................... ................................... ................................... ................................... ............................. ............ 18 IM Control ..................................................................................................................................................... 18 Full list of bot commands .......................................................................................................................... 19 Math Trivia .................................................................................................................................................... 22 Localization ................................................................................................................................................ 22 Messenger ..................................................................................................................................................... 24 Roulette ......................................................................................................................................................... 24 RSS Reader Plug-In ........................................................................................................................................ 24 Trivia .............................................................................................................................................................. 25

Localization ................................................................................................................................................ 26 Who Banned Plug-In ...................................................................................................................................... 27 Word Trivia .................................................................................................................................................... 27 Localization ................................................................................................................................................ 28 Version (Sample Plug-In) ............................................................................................................................... 29 How To… To… ............................................................................................................................................................ 31 How to Write Custom Plug-Ins – Plug-Ins – Getting Getting Started ......................................................................................... 31 How to Change the Camfrog Bot Password .................................................................................................. 31 How to Register a New Bot ........................................................................................................................... 32 How to Run Camfrog Bot in Debug Mode ..................................................................................................... 32 How to Add or Remove a Plug-In Module ..................................................................................................... 32 How to Turn On and Off Plug-In Modules ..................................................................................................... 33 How to Connect a Bot to a Chat Room ......................................................................................................... 33 How to Kick Users from a Room for Bad Words ......................... .................................. .................. .................. .................. ................... ................... .................. ........... .. 34 How to Log Chat Room Events ...................................................................................................................... 34 How to Pause the Bot .................................................................................................................................... 35 How to Resume the Bot ................................................................................................................................ 35 How to Shut Down the Bot ........................................................................................................................... 36 How to Add Bot Owner ................................................................................................................................. 36 How to Remove A Bot Owner ....................................................................................................................... 37 How to Get The Bot Owner List..................................................................................................................... 38 How to Post a Message to the Chat C hat in the Name of the Bot Bo t .................. ........................... ................... ................... .................. .................. ................. ........38 How to Kick Users U sers from the Chat C hat in the Name of the Bot .................. ........................... .................. .................. .................. .................. .................. ............. ....39 How to Punish Users in the Name of the Bot ............................................................................................... 39 How to Unpunish Users in the Name of the Bot ........................................................................................... 40 How to Control the Trivia Game by Instant Messages to the Bot .................. ........................... .................. .................. .................. .................. ........... 40 How to Control the Messenger Plug-In by Instant I nstant Messages to the t he Bot .............. ....................... .................. .................. .................. ............. ....41 How to Control the Bad Words Kicker by Instant Messages to the Bot ..................... .............................. .................. .................. ................ .......41 How to Manage the RSS Reader by Instant Messages to the Bot .................. ........................... .................. .................. .................. .................. ........... 42 How to Request Bot Information I nformation for a User Who Banned another User U ser ................. .......................... ................... ................... ................. ........43

How to Set Up the t he Bot to Post a Messages to the t he Room Regularly ................. .......................... ................... ................... .................. ................. ........43 How to Start a Trivia Game in a Room .......................................................................................................... 44 How to Set Up a Bot to Log All the Administrative Actions in a Room .................... ............................. .................. .................. .................. ........... 44 How to post RSS feeds to a Room ................................................................................................................. 45 How to Get Your Bot Software Version......................................................................................................... 46


How to Use This Guide Welcome to the Camfrog Bot user guide. If you are a new Camfrog Bot user, please start by reading the Getting Started article. If you would like to perform a particular task, please refer to the How To section. If you want to develop a Camfrog Bot custom plug-in, refer to the Camfrog Bot Developer's Guide.

Getting started Camfrog Bot is created to help you operate your Camfrog Video Chat Room, log chat room events so that nothing important passes you by, entertain your chat visitors and more. You may also add custom functionality to Camfrog Bot by writing your plug-in modules. Camfrog Bot can do the following administrative actions for you. 1. Kick or punish users for bad words automatically. 2. Perform administrative actions on demand. 3. Help you to find out who banned a particular user. 4. Log all the administrative actions that happen in your chat room. 5. Send announcements to your room. You may also save your chat room log in the HTML format, post RSS feeds and run a Trivia game to entertain your visitors. Follow these steps to get started. 1. Download Camfrog Bot from http://download.camfrog.com and install it. 2. Run Camfrog Bot. 3. Create your bot profile. 4. Connect the bot to your room. 5. Set up Camfrog Bot to make it do what you want the way you want. Notes 1. See also Camfrog Bot modules overview. 2. See also how to install Camfrog Bot to your computer. 3. See also how to register a new bot.

© 2012 Camshare Inc.

Page 5


4. See also how to connect your bot to a room. 5. See also how to create custom plug-in modules.

Installation Install Camfrog Bot to your computer. 1. Run the Camfrog Bot installation wizard. 2. The installation wizard window appears, click Next. 3. Read the Camfrog Bot License Agreement. Accept it if you agree with it. Click Cancel if you disagree. 4. If you agree, click Next. 5. Select the Camfrog Bot components you want to install and click Next. 6. Set the Camfrog Bot install location and click Next. 7. Choose the Start Menu folder and c lick Install. Wait until Camfrog Bot is installed. 8. Click Finish to complete the Camfrog Bot installation. Camfrog Bot is now installed to your computer. Notes 1. You may install Camfrog Bot 5.x over another Camfrog Bot 5.x installation. All the executables are rewritten and all the configuration files and bot profiles are saved for you. 2. If Camfrog Bot 5.x is installed over Camfrog Bot 3.94, you can migrate your previously created bot profiles (with their passwords and activation codes). After you accept the License Agreement, the “Migrate previous installations” window appears. By default it contains only the last bot you've created. If you have more than one bot you would like to migrate, click the “Add folder” button and select the installation folder of the bot you wish to add. When you have selected all of the bots you would like to migrate, click “Next”. To remove a single bot from the list of the bots to be migrated, select it and click the “Delete” button. To clear the whole list, click the “Clear” button.


Page 6


Camfrog Bot Registration How to register a new bot How to connect a bot to a chat room Fill in the form to register a new bot. All fields are mandatory. Camfrog

Bot

nicknames

must

contain from 1 to 39 numbers or letters. The “_” symbol is also acceptable. Nicknames are not case sensitive. Passwords must contain 6 to 19 symbols.

Passwords

are

case

sensitive. Use the password strength meter to determine how strong your password is. You must be at least 13 years old to register. You may have a number of bots configured for different uses. Each bot has its own independent settings, and you can run as many bots as you like from one Camfrog Bot application. Each bot must be activated. You cannot sign on with more than one bot registered with the same activation code simultaneously. Read Camfrog Bot Terms of Service for more information. If you have a previously registered bot, you may add it using the “Add Existing Bot” button. You will be prompted to activate it again. When you have activated your bot, a connection dialog will appear. To connect your bot to a chat room, enter the bot’s password, chat room name and password (if the room is password protected).

Camfrog

bot

cannot

connect to a room which is password protected and hosted by Camfrog Chat


Page 7


Room Server 4.2 or earlier.

Camfrog Bot Main Window How to Turn On and Off a Plug-In Module How to Connect a Bot to a Chat Room

In the upper left corner of the Camfrog Bot main window is the “Add\Register Bot” button. Click on it to register a new bot or add a previously registered one. Below is the list of currently registered bots. Icons of the bots that are currently online are shown as blue, and icons of those that are offline are gray. Click on the icon of a bot that is offline to connect it to a chat room. Click on the icon of a bot that is online to disconnect it or configure its settings. When an online bot is selected, the right part of the Camfrog Bot main window displays its name and the name of the chat room it is connected to (in square brackets), as well as the list of plug-in modules the bot © 2012 Camshare Inc.

Page 8


is using. Select a module from the list to configure it or read some brief information about it: its author, version and web-page. Click the author’s name to e mail him or her if necessary. Turn off the modules you are not using by clicking the “Turn Off Module” button or right-clicking the module name and selecting the “turn module off” item in the menu. Currently active modules are marked with a green circle, inactive modules are marked with an orange o ne. Click the Module Settings button to manage the selected module’s settings.

Camfrog Bot Configurations File Camfrog Bot configuration settings are located in the Camfrog Bot installation in the settings.xml file. Passwords and serial values are encrypted. Configurations file items: 

CSLLCHTM=on/off – turning on/off HTMLLog plug-in module (default is on);



CSLLCBWD=on/off – turning on/off Bad words kicker plug-in module (default is on);



CSLLCIMC=on/off – turning on/off IM control plug-in module (default is on);



CSLLCMGR=on/off – turning on/off Messenger plug-in module (default is on);



CSLLCWBN=on/off – turning on/off WhoBanned plug-in module (default is on);



CSLLCGHT=on/off – turning on/off Ghost game plug-in module (default is on);



CSLLCHAP=on/off – turning on/off Heap game plug-in module (default is on);



CSLLCRLT=on/off – turning on/off Roulette game plug-in module (default is on);



CSLLCTRV=on/off – turning on/off Trivia plug-in module (default is on);



CSLLCRSS=on/off – turning on/off RSS reader plug-in module (default is on);



CSLLC8BL=on/off – turning on/off 8 Ball plug-in module (default is on);



CSLLCGRT=on/off – turning on/off Greeter plug-in module (default is on);



CSLLCWTR=on/off – turning on/off the Word Trivia game plug-in module (default is on);



CSLLCMTR=on/off – turning on/off the Math Trivia game plug-in module (default is on).


Page 9


Every bot you have registered has its own configuration file called plugin.conf in its directory. In this file you can manually enable/disable plug-in modules for a given bot.

Plug-In Descriptions Overview Camfrog Bot extends its functionality with plug-in modules. There are several modules that come with the Camfrog Bot installation pack. The bad words kicker module allows you to kick users from a room for bad words automatically. The HTML log module writes a chat room log to an .html file. The IM control module allows you to control your bot via instant messages. The messenger module sends announcements to a room. The Trivia game module allows running a Trivia game in a room. The “Who banned” module helps you to operate your room. The RSS reader module allows you to post RSS feeds to a chat room. 

8 Ball



Bad Words Kicker



Ghost



Greeter



Heap



HTML Log



IM Control



Math Trivia



Messenger



Roulette



RSS Reader



Trivia



Who Banned Plug-In



Word Trivia



Version (Sample Plug-In)

Note. Camfrog Bot 3.94 or earlier plug-in modules are not compatible with Camfrog Bot 5.0 and higher. © 2012 Camshare Inc.

Page 10


8 Ball Full list of bot commands

8 Ball is an entertaining plug-in, which answers users’ Yes/No questions in the form of pseudo-random generation.

Localization The 8 Ball plug-in module can be localized. You may want to translate the warning messages to your native language. All warning messages are stored in 8ball_messages.txt. This file must be in the same directory as 8ball.conf. See also Camfrog Bot Configurations File. Here is an example of this file. # This is a localization sample file for the "8 ball" plug-in. # # Copy this file to %appdata%\Camfrog Bot\\ # and modify it as you need (in Windows OS) # # NOTE: #

1. '%' is a reserved symbol. Use it carefully

#

2. The file must be saved in the UTF-8 encoding

value1=Type %1% to ask 8 ball

Value1 message offers to play the 8 Ball game on plug-in startup or w hen a user connects to the chat room. %1% - 8 Ball name, which can be specified in the plug-in settings. The sample file badwords_message.txt is stored in \plugins\localization-sample\. Modify this file and copy it to %appdata%\Camfrog Bot\\.

Bad Words Kicker Full list of bot commands The Bad Words Kicker can kick or punish users for typing bad words. The bot sc ans users’ chat text in a room and finds matches with the rules you set. If the given quantity of matches is found, the bot performs the action you have set, for example, kicking the user from the room o r banning them. There are two ways you can set rules. If regular expressions are off, then the bot will try to find words that match the list of words you give it (case sensitive). © 2012 Camshare Inc.

Page 11


If regular expressions are turned on, the chat room text will be checked for matching by mask. An example of a mask is below. Example

Matching string

Wor.d

World, Worsd, Wor d, Wor.d

Wo*rd

Wrd, Word, Wooord

Wo+rd

Word, Wooord

Wo?rd

Word, Wrd

Word{2,4}

Wordd, Worddd, Wordddd

Wor(d|k)

Word, Work

Wor[a-z]

Wora, Worb, : , Worz

[cba] .*word.*

a, b, c All strings with substring 'word'

The bad Word Kicker can punish or kick users from a room. You may want to define a reason that is shown to the user when the bot is taking action. You can also define the number o f violations; it must be 1-10.

Localization The bad words kicker module can be localized. You may want to translate the warning messages to your native language. All warning messages are stored in badwords_message.txt. This file must be in the same directory as badwords.conf. See also Camfrog Bot Configurations File. Here is an example of this file. # #

Badwords plugin. Room message file

#

# These are the warning messages. You can translate them to your native language value1=%1% you are using a forbidden word %2% time(s), %3% time(s) left value2=%1% you are using a forbidden word '%2%' %3% time(s), %4% time(s) left Note. Value1 warning is shown to the user if regular expressions are on. %1% - user nickname; %2% - number of violations; %3% - violations left; Value2 warning is shown to the user if regular expressions are off. %1% - user nickname; © 2012 Camshare Inc.

Page 12


%2% - word; %3% - number of violations; %4% - violations left; The sample file badwords_message.txt is stored in \plugins\localization-sample\. Modify and copy this file to %appdata%\Camfrog Bot\\.

Ghost Full list of bot commands Ghost is a word guessing game. In the beginning of the game, the player is shown one letter or a fragment of a word (depending on the difficulty level), and should guess the next letter. If the hidden fragment of the word contains the letter entered by the player, an additional letter gets opened, and so on. The player is only allowed to make two mistakes, and if there is left just one unguessed letter in the word, the player has only one try. For each unguessed word the player gets one letter from the word «ghost». The player loses the game when he collects all letters composing the word «ghost». There are several difficulty levels which differ from e ach other by the way of displaying the hidden word: Easy – for example, the payer sees the hidden word «W----» (here it’s «WORLD»), and should consecutively guess the next letter after «W». If the player says that is’s «O», then «O» gets opened as well as the next letter «R». So, the word will look like «WOR—». Otherwise the game will offer to enter another letter. Normal – if the hidden word is «COMPUTER», the payer sees a 3-letter fragment of the word, « ---PUT—», and can try to guess any letter before or after the opened letters. For example, if the player chooses the letter «E», in the result he’ll get «--MPUTE-». Hard – this level is similar to the Normal level, the only difference being that each time three letters of the fragment will be randomly rearranged. Super – this level is similar to the Normal level, the only difference being that each time all letters of the fragment will be randomly rearranged. The rating table is stored in %appdata%\Camfrog Bot\\ghost\. The rating file name depends on the name of the chat room where the game was started. If you launch the game in the room “SomeRoom1”, the rating file name will be “SomeRoom1_records.dbu”. Please keep in mind that if the room name contains restricted characters (\, /, :, *, ?, “, <, >, |), the rating file name will contain some hash value, for example, B0B4DD05B629387BC3A005039EE27B8A_records.dbu. The default words pack is located in \plugins\ghost. When the plug-in is started up for the first time, the words pack is automatically copied to %appdata%\Camfrog Bot\\ghost\. © 2012 Camshare Inc.

Page 13


Any room visitor can execute Ghost commands. Here is the list of these public commands: !ghost help – sends a private help message; !ghost – starts the game; !ghost top – shows the top 10 game leaders.

Localization The Ghost plug-in module can be localized. You may want to translate the warning messages to your native language. All warning messages are stored in ghost_messages.txt. This file must be in the same directory as ghost.conf. See also Camfrog Bot Configurations File. Here is an example of this file. # # # # # # # #

This is a localization sample file for the "Ghost game" plug-in. Copy this file to %appdata%\Camfrog Bot\\ and modify it as you need (in Windows OS) NOTE: 1. '%' is a reserved symbol. Use it carefully 2. The file must be saved in the UTF-8 encoding

value1=Ghost game is not active. To start the game type !GHOST value2=Game started by %1%! Get ready! value3=Please

choose

a

level

of

the

game.\n1.EASY\n2.NORMAL\n3.HARD\n4.SUPER\nPlease send number of level to start playing. value4=Please choose a level of the game, %1% seconds remain. value5=You was removed from the game. value6=Round: %1%\n Word: %2% value7=Congratulation! You are winner, total %1% points. value8=You are lose. value9=You guessed the word %1% right, total %2% points!\n%3%: %4%\n%5%: %6% value10=The word I was thinking of was %1%\n %2%: %3%\n%4%:%5% value11=%1%: %2%\n%3%:%4% value12=Letter not found in the word? Please try again. value13=Word: %1% value14=Please send the next letter of the word, %1% seconds remain. value15=Ghost game is disabled. value16=Top 10 list: value17=Ghost Game help\n\n!GHOST HELP - this help screen\n!GHOST TOP - top scores\n!GHOST - start game value18=[List empty] © 2012 Camshare Inc.

Page 14


Notes Value2: %1% - user nickname; Value4: %1% -seconds;

Value6: %1% - number of round; %2% - hidden word;

Value7: %1% - number of points; Value9: %1% - number of points; %2% - a user nickname; %3% - the letters of "ghost" of user; %4% - the bot nickname; %5% - the letters of "ghost" of bot; Value10: %1% - the word; %2% - a user nickname; %3%- the letters of "ghost" of user; %4% - the bot nickname; %5%- the letters of "ghost" of bot; Value11: %1% - a user nickname; %2%- the letters of "ghost" of user; %3% - the bot nickname; %4%- the letters of "ghost" of bot; Value13: %1% - hidden word; Value14: © 2012 Camshare Inc.

Page 15


%1% - number of seconds;

Value18: This message stands for the private message when the top 10 leaders list is empty.

Greeter Full list of bot commands The Greeter module sends greeting messages when a user joins a chat room. All users are divided into several groups by sex and role. So the bot owner can create a list of greeting messages for each group of users or their combinations, for example, male o r female users, owner females, friend m ales and so on. Lists of greeting messages are stored in %appdata%\Camfrog Bot\\greeter\ as simple text files. Names of these files consist of two parts, which determine the role and sex of users to whom these messages are displayed. If for some reason these files do not exist, the plug-in will recreate them automatically.

Localization Greeting messages can be localized. All messages are in English by default, but you may want to translate them into your native language. Please keep in mind that these files should be saved in the UTF-8 encoding.

Heap Full list of bot commands In this game, the players in turns take the limited number of objects from the heap. The payer who takes the last object loses the game. Any room visitor can execute Heap commands. Here is the list of these public commands: !heap – start game. !heap help – sends a private help message.

Localization The Heap plug-in module can be localized. You may want to translate the warning messages to your native language. All warning messages are stored in heap_messages.txt. This file must be in the same directory as heap.conf. See also Camfrog Bot Configurations File. Here is an example of this file. # This is a localization sample file for the "Heap game" plug-in. # # Copy this file to %appdata%\Camfrog Bot\\ © 2012 Camshare Inc.

Page 16


# and modify it as you need (in Windows OS) # # NOTE: # 1. '%' is a reserved symbol. Use it carefully # 2. The file must be saved in the UTF-8 encoding value1=Heap game is not active. To start the game type !HEAP value2=Heap game is disabled. value3=Heap game help\n\n!HEAP HELP - this help screen\n!HEAP - start game\n[number of objects] - get N objects from a heap value4=Each move allows you to take up to %1% obje cts from the heap.\nPlease try once again. value5=There should remain at least one object in the heap .\nPlease try once again. value6=Game is started! Get ready! value7=The turn goes to %1%. value8=You can't make your move now. It's %1% 's turn. value9=%1% joined the game 'HEAP'! Please wait until othe r players join the game. value10=%1% can't join the game 'HEAP', please w ait for the game to finish before joining! value11=Congratulations! %1% is the winner! value12=The game is over. No winner was determined. value13=%1% objects remain in the heap. value14=The turn goes to %1%, %2% se conds remain. value15=The game 'HEAP' will start in %1% seconds, the game is waiting for other players. value16=There are %1% objects in the heap. value17=Insufficient number of players! At least 2 players are required to start the game. value18=The player %1% leaves the game, the response time has expired. Notes: Value4: %1% - number of objects; Value7: %1% - an user nickname; Value8: %1% - an user nickname; Value9: %1% - an user nickname; Value10: %1% - an user nickname; Value11: %1% - an user nickname; Value13: © 2012 Camshare Inc.

Page 17


%1% - number of objects; Value14: %1% - an user nickname; %2% - number of seconds; Value15: %1% - number of seconds; Value16: %1% - number of objects; Value18: %1% - an user nickname;

HTML Log Full list of bot commands The HTML Log module writes down all room events such as user chat, log in and log out notifications, administrative actions, and more. The

log

file

name

is

composed

of

the

chat

room

name

and

current

date,

e.g.

“CamfrogHelp_chatlog_20090604.html”. In case the room name contains restricted characters (\, /, :, *, ?, “, <, >, |), a hash value will be used instead of the room name. Log file encoding is UTF-16. The module can gather room statistics every hour. In this case the bot must have the OWNER role in the room. The HTML Log module has an option "Auto stat every hour". When that is enabled, the bot sends "/stat" command in the room, and the server prints out the statistics, which get recorded in the HTML log. The HTML Log module requires the IM Control module to be enabled.

IM Control This module allows the user to control the bot and configure plug-in modules by instant messaging. You must be the bot owner for the bot to execute your commands. The bot owners list can be edited in imcontrol.conf, the module settings or by instant messages. How to Add Bot Owner How to Remove a Bot Owner How to Get the Bot Owner List © 2012 Camshare Inc.

Page 18


How to Post a Message to the Chat in the Name of the Bot How to Kick Users from the Chat in the Name of the Bot How to Punish Users in the Name of t he Bot How to Unpunish Users in the Name of the Bot How to Control the Trivia Game by Instant Messages to the Bot How to Control the Messenger Plug-In by Instant Messages to the Bot How to Control the Bad Words Kicker by Instant Messages to the Bot How to Manage the RSS reader by Instant Messages to the Bot How to Request Bot for a User Who Banned another User

Full list of bot commands Instant message control plug-in commands (imcontrol.dll/libimcontrol.so) - CSLLCIMC /pause - pause the bot (the bot disconnects from the room, but the bot is still online) /resume - resume the bot (connects to the last room) /shutdown - shut down the bot /imrefresh - reload the instant message control configuration file /help - show help /addowner - add a user to the owners list /delowner - remove an owner from the owners list /owners - show the bot owners list /postmsg - post a message to the chat /kickuser - kick a user from the chat room /punishuser - punish a user in the chat room /unpunishuser - unpunish a user /modules – list of currently active modules Trivia plug-in commands (trivia.dll/libtrivia.so) - CSLLCTRV /trvplay – turn the Trivia game on/off /trvstart – start a Trivia game /trvstop - stop a Trivia game /trvclear - clear the records /trvrefresh - reload the trivia configuration file Messenger plug-in commands (messenger.dll/libmessenger.so) - CSLLCMGR


Page 19


/msgrtime - set the interval of message posting /msgrclear - clear the message list /msgradd - add a message to the message list /msgrdisable - disable the messenger plug-in /msgrrefresh - reload the messenger configuration file

Bad words kicker plug-in commands (badwords.dll/libbadwords.so) - CSLLCBWD /bexpr - turn the bad expressions catcher on/off /bekick - select to kick for bad expressions /bepunish - select to punish for bad expressions /bereason - set the reason for kicking/punishment /becount - set the forbidden words counter /bewords – select the regular expressions/words mode /beclear - clear the bad expressions list /beadd - add an expression to the rule list /berefresh - reload the bad words module configuration file WhoBanned plugin commands (whobanned.dll/libwhobanned.so) - CSLLCWBN /whobanned - check who banned the given user /whounbanned – check who unbanned the given user /whokicked - check who kicked the given user /whopunished - check who punished the given user /whounpunished - check who unpunished the given user /whooped - check who oped nickname /whodeoped - check who deoped nickname

Heap plugin commands (heap.dll/libheap.so) - CSLLCHAP /hpplay – turn the Heap game on/off. /heap – start game. /hprefresh - reload the heap module configuration file HTMLLog plugin commands (htmllog.dll/libhtmllog.so) - CSLLCHTM


Page 20


/hlogdisable - disable the html log plug-in /hlogrefresh - reload the html log module configuration file Roulette plugin commands (roulette.dll/libroulette.so) - CSLLCRLT /rltplay – turn the Roulette on/off. /roulette [nickname] – send a random message to some user in the chat /rltrefresh – reload the roulette module configuration file

RSS reader plugin commands (rssreader.dll/librssreader.so) - CSLLCRSS /rsstimerfeed – change the feed update time interval /rsstimerpublish – change the news publishing time interval /rssrefresh – reload the rssreader configuration file

8 Ball plugin commands (8ball.dll/lib8ball.so) – CSLLC8BL /8disable - disable the 8 Ball plugin /8name - change the 8 Ball name /8refresh - reload the plugin configuration Ghost plugin commands (ghost.dll / libghost.so) – CSLLCGHT /ghtplay - turn the Ghost game o n/off /ghtclear - clear records /ghtrefresh - reload the Ghost configuration file Greeter plugin commands (greeter.dll/libgreeter.so) - CSLLCGRT /grtdisable - disable the Greeter plugin /grtnoroles - disable roles checking /grtnosexup - disable sex checking /grtrefresh - reload the Greeter configuration file Math Trivia plugin commands (math_trivia.dll/libmath_trivia.so) - CSLLCMTR /mtrplay - turn the Math Trivia game on/off /mtrstart - start a Math Trivia game © 2012 Camshare Inc.

Page 21


/mtrstop - stop a Math Trivia game /mtrclear - clear the records /mtrrefresh - reload the Math Trvia configuration file

Word Trivia plugin commands (word_trivia.dll/libword_trivia.so) - CSLLCWTR /wtrplay - turn the Word Trivia game on/off /wtrstart - start a Word Trivia game /wtrstop - stop a Word Trivia game /wtrclear - clear the records /wtrrefresh - reload the Word Trvia configuration file

Math Trivia Full list of bot commands Math Trivia is an entertaining module, which generates simple math equations and posts them over a userdefined time interval. If a user solves t he equation correctly, he or she will gain a point. The rating table is stored in %appdata%\Camfrog Bot\\math\. The rating file name depends on the name of the chat room where the game was started. If you launch the game in the room “SomeRoom1”, the rating file name will be “SomeRoom1_records.dbu”. Please keep in mind that if the room name contains restricted characters (\, /, :, *, ?, “, <, >, |), the rating file name will contain some hash value, for example, B0B4DD05B629387BC3A005039EE27B8A_records.dbu. Any room visitor can execute Math Trivia commands. Here is the list of these public commands: !math help – sends a private help message; !math – starts the game; !mq – repeats the current question; !math top – shows the top 10 game leaders.

Localization The math trivia game module can be localized into any language. You may want to translate the notification messages into your native language. All the notification messages are stored in math_trivia_message.txt. This file must be in the same directory as math_trivia.conf. See also Camfrog Bot Configurations File. Here is an example of this file. # This is a localization sample file for the "Math trivia game" plug-in. # # Copy this file to %appdata%\Camfrog Bot\\ © 2012 Camshare Inc.

Page 22


# and modify it as you need (in Windows OS) # # NOTE: #


#

2. The file must be saved in the UTF-8 encoding

value1=Math Trivia game is not active. To start the game type !MATH value2=Math Trivia Game help\n\n!MATH HELP - this help screen\n!MATH TOP top scores\n!MQ - current question value3=Game started by %1%! Get ready! value4=Top 10 list: value5=Correct answer is %1%, answered by %2%, total %3% points value6=%1% seconds remaining... value7=Not answered! value8=Not answered! Correct answer was %1% value9=Math Trivia game is disabled. value10=[list empty]

Notes Value3: %1% - user nickname; Value5: %1% -correct answer; %2% - user nickname; %3% - user points; Value6: %1% - time left;

Value8: %1% - correct answer;

Value10: This message stands for the private message whe n the top 10 leaders list is empty. © 2012 Camshare Inc.

Page 23


Messenger Full list of bot commands This module posts messages in the chat room after every fixed time interval. You can change the time interval from 30 to 30000 seconds. It is possible to add, remove, or modify messages by editing the messenger.conf file, messenger module settings or by instant messages. The module chooses a message to post from the message list randomly.

Roulette Full list of bot commands This plug-in sends a random message to the chat. If the user isn’t specified, it chooses any user nickname from the list. Edit the messages.du file to fill it with your own messages. An example question template is below: %1% pulled the trigger of his Magnum and CamfrogBot fell dead %1% wears square pants! Notes: %1% - an user nickname; Please note: The default messages pack is located in \plugins\roulette. You must put your own messages pack to a separate location in %appdata%\Camfog Bot\\roulette\.

RSS Reader Plug-In How to post RSS feeds to a chat room This module allows you to post RSS feeds of your choice to your chat room. To add a feed to the list, enter its URL in the “Feeds” field and click the “Add” button. To edit a previously added feed URL , double-click the feed in the feeds list. To remove a feed from the list, select the feed and press the “delete” button on your keyboard. You can also define how often the module will update t he news and post them to the chat room. Click the “Apply” button for the changes to take effect or “Cancel” to discard them. Any room visitor can execute RSS reader commands. Here is the list of all public commands. © 2012 Camshare Inc.

Page 24


!news – sends all news heads and their URLs; !feeds – sends the list of feeds and its ID; !feednews – sends the list of news of the chosen feed.

The information is then sent as a private message.

Trivia Full list of bot commands This module runs a Trivia game in the chat room. The bot asks questions and users who answer get positive ratings points that are reported by t he bot. The question database is stored in the %appdata%\Camfrog Bot\\trivia\questions.du file. The rating table is stored in the same directory. The rating file name depends on the name of the chat room where Trivia is launched. If you launch Trivia in the room with the name “SomeRoom1” and after that launch Trivia in the room with the name “SomeRoom2”, then the rating file names will be “SomeRoom1_records.dbu” and “SomeRoom2_records.dbu”. Please keep in mind that if the room name contains restricted characters (\, /, :, *, ?, “, <, >, |), the rating file name will contain some hash value, for example, B0B4DD05B629387BC3A005039EE27B8A_records.dbu. Edit the questions.du file to fill it with your own questions. Preserve the file format for the bot to understand it. An example question template is below: Q:What is the name of our planet? A:Earth Please note: The default question pack is located in \plugins\trivia. You must put your own questions pack to a se parate location in %appdata%\Camfog Bot\\trivia\. You can also enable hints, correct answer alerts, and notify room visitors how to start the game. Any room visitor can execute the Trivia commands. Here is the list of these public Trivia commands. !stat – get a private message with the game stats; !help – get a private message with a trivia help message; !play – starts the game; !q – repeats the current question; !top – shows the top 10 game leaders.


Page 25


Localization The trivia game module can be localized into any language. You may want to translate the notification messages to your native language. All notification messages are stored in the trivia_message.txt file. This file must be in the same directory as trivia.conf. See also Camfrog Bot Configurations File. Here is an example of this file. # #

Trivia plugin messages

# You can translate these messages to your native language value1=Trivia game is not active. To start the game type !PLAY value2=Trivia

Game

stat\n\n%1%

question(s)

loaded\n%2%

question(s)

displayed\n%3%

question(s) answered\n%4% question(s) cached in buffer value3=Trivia

Game

help\n\n!HELP

-

this

help

screen\n!TOP

-

top

scores\n!Q - current question\n!STAT - game stats value4=Game started by %1%! Get ready! value5=Top 10 list: value6=Correct answer is %1%, answered by %2%, total %3% points value7=%1% seconds remaining... First letter is %2% value8=%1% seconds remaining... value9=%1% seconds remaining... Last letter is %2% value10=Not answered! value11=Not answered! Correct answer was %1% value12=Trivia game is disabled. value13=[list empty] Notes. Value2: %1% - number of questions; %2% - displayed questions; %3% - answered questions; %4% - questions left. Value4: %1% - user nickname; Value6: %1% -correct answer; © 2012 Camshare Inc.

Page 26


%2% - user nickname; %3% - user points; Value7: %1% - time left; %2% - first letter (if hints turned on); Value9: %1% - time left; %2% - last letter (if hints turned on); Value13: This message stands for the private message whe n the top 10 leaders list is empty.

Who Banned Plug-In Full list of bot commands How to Request Bot Information for a User Who Banned another User How to Set Up the Bot to Log All the Administrative Actions in a Room This module is compatible with Camfrog Chat Room Server 5 .0 and higher. This module gathers statistics about any chat r oom server options changes, user kicking, punishing, banning, microphone blocking and unblocking, status changing events. The module writes logs in UTF-16. The default log directory is %appdata%\Camfrog Bot\\whobanned\. The log file name depends on the room name. You can also receive administrative action statistics by instant messages. Statistics will be lost if the bot is restarted or the module is turned off. Statistics records are also removed after the given time interval which can be defined in the settings or in the configuration file. If you request the latest ban statistics and nothing is found, the module returns only the last 20 records. This feature may be turned off in t he settings.

Word Trivia Full list of bot commands Word Trivia game asks users to guess the encrypted word whose letters are rearranged. The module also offers a short tip specifying the area the word is related to. A user can gain a point by giving a correct answer. The top rated user list is saved to a file located in %appdata%\Camfrog Bot\\words\. The name of the rating file depends on the room name, where the game was launched and basically has the following view: “SomeRoom_records.dbu” if the room © 2012 Camshare Inc.

Page 27


name is “SomeRoom”, but if the room name contains some restricted characters (\, /, :, *, ?, “, <, >, |), the rating

file

name

will

contain

a

hash

value,

for

example,

B0B4DD05B629387BC3A005039EE27B8A_records.dbu. The default question pack is located in \plugins\words. When the plug-in is started up for the first time, the question pack is automatically copied to %appdata%\Camfrog Bot\\words\. Any room visitor can execute Word Trivia commands. Here is the list of these public commands: !words help – sends a private help message; !words – starts the game; !wq – repeats the current question; !words top – shows the top 10 game leaders; !words stat – sends a private message with the game stats.

Localization The word trivia game module can be localized into any language. You may want to translate the notification messages into your native language. All notification messages are stored in word_trivia_message.txt. This file must be in the same directory as word_trivia.conf. See also Camfrog Bot Configurations File. Here is an example of this file. # This is a localization sample file for the "Word Trivia game" plugin. # # Copy this file to %appdata%\Camfrog Bot\\ # and modify it as you need (in Windows OS) # # NOTE: #


#

2. File must be saved in the UTF-8 encoding

value1=Words Trivia game is not active. To start the game type !WORDS value2=Words Trivia Game stat\n\n%1% question(s) loaded\n%2% question(s) displayed\n%3% question(s) answered\n%4% question(s) cached in buffer value3=Words Trivia Game help\n\n!WORDS HELP - this help screen\n!WORDS TOP - top scores\n!WQ - current question\n!WORDS STAT - game stats value4=Game started by %1%! Get ready! value5=Top 10 list: value6=Correct answer is %1%, answered by %2%, total %3% points © 2012 Camshare Inc.

Page 28


value7=%1% seconds remaining... First letter is %2% value8=%1% seconds remaining... value9=%1% seconds remaining... Last letter is %2% value10=Not answered! value11=Not answered! Correct answer was %1% value12=Words Trivia game is disabled. value13=[list empty] Notes. Value2: %1% - number of questions; %2% - displayed questions; %3% - answered questions; %4% - questions left. Value4: %1% - user nickname; Value6: %1% -correct answer; %2% - user nickname; %3% - user points; Value7: %1% - time left; %2% - first letter (if hints turned on); Value9: %1% - time left; %2% - last letter (if hints turned on); Value13: This message stands for the private message whe n the top 10 leaders list is empty.

Version (Sample Plug-In) Custom Plug-In Modules This module is distributed with open source code to help developers understand the plug-in architecture. Its reaction to an instant message /ver command to the bot is “Camfrog Bot 5.1 version plug-in”. The module's © 2012 Camshare Inc.

Page 29


settings tab contains a field where you can type additional text to be displayed after the version message (the text will be displayed in brackets). For more information look at the sample plug-in sources which are located in < Camfrog Bot installation folder>\dev\samples\sample-src\. To build the sample project we used Micr osoft Visual Studio 2008.


Page 30


How To…

How to Write Custom Plug-Ins – Getting Started Write your Camfrog Bot plug-in to add custom functionality to Camfrog Bot. 1. Study the reference materials to understand the Camfrog Bot plug-in architecture and workflow. 2. Adjust your plug-in concepts to work with the tools suggested by Camfrog Bot. 3. Use our sample plug-in project to get started. The sample project default location is C:\Program Files\Camfrog\Camfrog Bot\dev\samples\sample-src\. The location may differ from the default one depending on where Camfrog Bot is installed. 4. Build your project and add it to Camfrog Bot. Copy your plug-in to the Camfrog Bot plug-ins folder to add it to Camfrog Bot. The default location is C:\Program Files\Camfrog\Camfrog Bot\plugins\. The location may differ from the default one depending on where Camfrog Bot is installed. You must restart Camfrog Bot to see your plug-in in the Camfrog Bot module list. 5. Test the new functionality while using Camfrog Bot. Notes 1. See also the Camfrog Bot Developer's Guide. 2.

See also how to turn on or off a plug-in module.

How to Change the Camfrog Bot Password Follow the steps below to change yo ur Camfrog Bot account password. 1. Run Camfrog Bot. 2. Choose the bot nickname that has the password you want to change. 3. Connect to a room. 4. Click the “Change Password” button in the top right corner of the Camfrog Bot main window. 5. Fill in the form with the old password, new password and password confirmation. 6. Click “Change Password”. The message “Your profile was successfully updated” should appear. Notes 1. You must connect Camfrog Bot to a room to make the Change Password function available. © 2012 Camshare Inc.

Page 31


2. See also how to set up bot connection to a room.

How to Register a New Bot Follow these steps to create a new Camfrog Bot account. 1. Run Camfrog Bot. 2. The Camfrog Bot main window appears. Push the Add/Register Bot button. 3. Fill in the form and push Register button. 4. Enter the activation code when prompted. The bot you registered should appear in the list. See also Camfrog Bot registration dialog description.

How to Run Camfrog Bot in Debug Mode Run Camfrog Bot in debug mode to get debug logs. 1. Right-click the Camfrog Bot icon on t he desktop and select properties. 2. Type -debug in the end of the “Target” field (after the closing quotation mark). 3. Run Camfrog Bot. The log file will be saved to your desktop in the camfrogbot_5033_dbg_logs folder. Notes 1. See also Camfrog Bot configuration files description. 2. See also how to set up bot connection to a room.

How to Add or Remove a Plug-In Module Remove plug-in modules you are not going to use. Add custom plug-in modules for extra functionality. 1. Run Camfrog Bot. 2. Choose a bot from the list. 3. Connect to a chat room. 4. Right-click on the plug-in module you want to remove and se lect the “Remove” menu item. 5. Click on the “Add Module” button to add a new plug-in module.


Page 32


Notes 1. See also Camfrog Bot modules description.

How to Turn On and Off Plug-In Modules Turn off a plug-in module you are not using. Turn on a plug-in module yo u wish to use. 1. Run Camfrog Bot. 2. Choose a bot from the list. 3. Connect to a chat room. 4. Choose the plug-in module you want to enable or disable. 5. Click the Turn On or Turn Off button correspondingly to the action you want to perform or right click on the module in the list and choose the turn off/turn on menu item. The plug-in module state should be updated now. Active modules become inactive and vice ver sa. Notes 1. See also Camfrog Bot modules description. 2. Any plug-in module can have an active state in the list but be disabled in its settings. While troubleshooting, make sure the plug-in module is enabled.

How to Connect a Bot to a Chat Room Connect Camfrog Bot to your chat room to use it. 1. Run Camfrog Bot. 2. Choose a bot from the list. 3. Fill in the form with your bot password, chat room name and password (if required). 4. Click Connect. Camfrog Bot is now connecting. When the connection process finishes, the bot’s icon in the list becomes blue and the bot appears in your chat room user list. Notes 1. Chat Room Server may prevent Camfrog Bot from connection to a room. Configure the room so that it allows bots. Bots are allowed into rooms by default. Take into account that your bot profile may be registered as a teen (13 to 17 years old inclusively) and an 18+ room may not allow it due to this reason or the opposite if a room allows teens only. © 2012 Camshare Inc.

Page 33


2. See also how to connect your bot to a chat room on a local host.

How to Kick Users from a Room for Bad Words You may set up your Camfrog Bot so that it kicks users from a room for bad words. This feature is useful for keeping users from typing foul language, spam, repetitive language, or rude comments in your chat room . 1. Run Camfrog Bot. 2. Choose a bot from the list. 3. Connect to a room. 4. Choose badwords.dll in the list of modules. 5. Type a rule in the “Rules” field and c lick Add to add it to the list. 6. Select the action you want your bot to take against violators, number of violations required for the bot to take action and type a message that the punished users see. 7. Click Apply for the changes to take effect. Now the bot will kick users from your room for bad words. Notes 1. See also the Camfrog Bot modules description. 2. See also the bad words kicker plug-in description. 3. Bad words kicker plug-in must be turned on. See also how to turn on or off plug-in modules. 4. Use regular expressions to set rules for the bad words kicker. 5. The bot must have at least OPERATOR privileges in a room to kick or punish users for bad words. 6. If you choose to punish users for bad words, the bot will use the default punishment parameters set for the given room. Please refer to the Camfrog Chat Room Server documentation for more information.

How to Log Chat Room Events You may want to log chat room e vents such as user messages, user logging in and out and more. 1. Run Camfrog Bot. 2. Choose a bot from the list. 3. Connect to a room. © 2012 Camshare Inc.

Page 34


4. Choose htmllog.dll in the list of modules. 5. Set a path where you want the logs to be saved. 6. Click Apply for the changes to take effect. Now the logs are being saved to the folder of your choice. Notes 1. See also how to set up bot connection to a room. 2. See also Camfrog Bot modules description. 3. See also HTML log plug-in description. 4. HTML log plug-in must be turned on. See also how to turn on or off plug-in module.

How to Pause the Bot Pause the bot to disconnect it from a room temporarily. 1. Start an instant message conversation with the bot in Camfrog Video Chat. 2. Send a /pause message to the bot. If you receive an “OK” message from the bot then the bot has been successfully paused. Notes 1. See also Camfrog Bot modules description. 2. See also instant message control plug-in description. 3. See also Camfrog Bot commands description. 4. You must be a bot owner to control the bot by instant messages. See also how to become the bot owner. 5. The Instant message control plug-in must be turned on. See also how to turn on or off plug-in module.

How to Resume the Bot Resume the bot to reconnect it to a chat room. 1. Start an instant message conversation with the bot in Camfrog Video Chat.


Page 35


2. Send /resume to the bot. If you receive an “OK” message from the bot then the bot has resumed working. Notes 1. See also Camfrog Bot modules description. 2. See also instant message control plug-in description. 3. See also Camfrog Bot commands description. 4. You must be a bot owner to control the bot by instant messages. See also how to become the bot owner. 5. The Instant message control plug-in must be turned on. See also how to turn on or off plug-in module.

How to Shut Down the Bot Shut down the bot to stop it. 1. Start an instant message conversation with the bot in Camfrog Video Chat. 2. Send /shutdown to the bot. If you receive an “OK” message from the bot then the bot has shut down. Notes 1. See also Camfrog Bot modules description. 2. See also instant message control plug-in description. 3. See also Camfrog Bot commands description. 4. You must be a bot owner to control the bot by instant messages. See also how to become the bot owner. 5. The Instant message control plug-in must be turned on. See also how to turn on or off plug-in modules.

How to Add Bot Owner Add a Camfrog account as a bot owner to control the bot by instant messages. 1. Run Camfrog Bot. 2. Choose a bot from the list. © 2012 Camshare Inc.

Page 36


3. Connect to a room. 4. Choose imcontrol.dll in the list of modules. 5. Type a Camfrog account name in the “Owners” field and click Add. 6. Click Apply for the changes to take effect. The bot now accepts commands from this Camfrog acc ount via instant messages. Notes 1. See also Camfrog Bot modules description. 2. See also instant message control plug-in description. 3. See also Camfrog Bot commands description. 4. See also how to set up bot connection to a room. 5. Instant message control plug-in must be turned on for the bot to accept commands from the bot owner. See also how to turn on or off plug-in module.

How to Remove A Bot Owner Remove a Camfrog account from the bot owner list to stop controlling the bot from this Camfrog account. 1. Run Camfrog Bot. 2. Choose a bot from the list. 3. Connect to a room 4. Choose imcontrol.dll in the list of modules. 5. Choose Camfrog account from the owner s list. 6. Push Delete button on the keyboard to remove this account from the list. 7. Click Apply for the changes to take effect. It is no longer possible to control t he bot from the removed Camfrog account. Notes 1. See also Camfrog Bot modules description. 2. See also instant message control plug-in description. 3. The Instant message control plug-in must be turned on. See also how to turn on or off plug-in © 2012 Camshare Inc.

Page 37


module. 4. See also how to set up bot connection to a room.

How to Get The Bot Owner List You can see the bot owner list. 1. Start instant message conversation with the bot in Camfrog Video Chat. 2. Send /owners to the bot. You received the bot owners list. Notes 1. See also Camfrog Bot modules description. 2. See also instant message control plug-in description. 3. See also Camfrog Bot commands description. 4. You must be a bot owner to control the bot by instant messages. See also how to become the bot owner. 5. The Instant message control plug-in must be turned on. See also how to turn on or off plug-in module.

How to Post a Message to the Chat in the Name of the Bot Post announcements to your room in the name o f the bot. 1. Start an instant message conversation with the bot in Camfrog Video Chat. 2. Send /postmsg to the bot. The message appears in a room in the name of bot. Notes 1. See also Camfrog Bot modules description. 2. See also instant message control plug-in description. 3. See also Camfrog Bot commands description. 4. You must be a bot owner to control the bot by instant messages. See also how to become the bot owner. 5. The Instant message control plug-in must be turned on. See also how to turn on or off plug-in © 2012 Camshare Inc.

Page 38


module.

How to Kick Users from the Chat in the Name of the Bot Kick a user from a chat room in the name of bot to do it anonymously. 1. Start an instant message conversation with the bot in Camfrog Video Chat. 2. Send /kickuser [reason] to the bot. The bot kicks the user with the given reason. Notes 1. Reason is optional. 2. See also Camfrog Bot modules description. 3. See also instant message control plug-in description. 4. See also Camfrog Bot commands description. 5. You must be a bot owner to control the bot by instant messages. See also how to become the bot owner. 6. The Instant message control plug-in must be turned on. See also how to turn on or off plug-in module. 7. The bot must have at least OPERATOR privileges in a room to kick users.

How to Punish Users in the Name of the Bot Punish a user from chat in the name of the bot. 1. Start an instant message conversation with the bot in Camfrog Video Chat. 2. Send /punishuser [reason] to the bot. The bot punishes the user with the given r eason. Notes 1. Reason is optional. 2. See also Camfrog Bot modules description. 3. See also instant message control plug-in description. 4. See also Camfrog Bot commands description.


Page 39


5. You must be a bot owner to control the bot by instant messages. See also how to become the bot owner. 6. The Instant message control plug-in must be turned on. See also how to turn on or off plug-in module. 7. The bot must have at least OPERATOR privileges in a room to punish users. 8. Camfrog bot uses default punishment parameters set for the given room. Please refer to the Camfrog Chat Room Server documentation for mor e information.

How to Unpunish Users in the Name of the Bot Unpunish a user from the chat in the name of the bot. 1. Start an instant message conversation with the bot in Camfrog Video Chat. 2. Send /unpunishuser to the bot. The user is unpunished. Notes 1. See also Camfrog Bot modules description. 2. See also instant message control plug-in description. 3. See also Camfrog Bot commands description. 4. You must be a bot owner to control the bot by instant messages. See also how to become the bot owner. 5. The Instant message control plug-in must be turned on. See also how to turn on or off plug-in module. 6. The bot must have at least OPERATOR privileges in a room to unpunish users.

How to Control the Trivia Game by Instant Messages to the Bot You can control the Trivia game by sending instant messages to the bot. 1. Start an instant message conversation with the bot in Camfrog Video Chat. 2. Send a Trivia game control command to the bot. The bot acts according to your command. Notes


Page 40


1. See also Camfrog Bot modules description. 2. See also instant message control plug-in description. 3. See also Trivia game plug-in description. 4. See also Camfrog Bot commands description. 5. You must be a bot owner to control the bot by instant messages. See also how to become the bot owner. 6. The Instant message control plug-in must be turned on. See also how to turn on or off plug-in module. 7. The Trivia game plug-in must be turned on.

How to Control the Messenger Plug-In by Instant Messages to the Bot You can control the messenger plug-in by sending instant messages to a bot. 1. Start an instant message conversation with the bot in Camfrog Video Chat. 2. Send a messenger plug-in control command to the bot. The bot acts according to your command. Notes 1. See also Camfrog Bot modules description. 2. See also instant message control plug-in description. 3. See also messenger plug-in description. 4. See also Camfrog Bot commands description. 5. You must be a bot owner to control the bot by instant messages. See also how to become the bot owner. 6. The Instant message control plug-in must be turned on. See also how to turn on or off plug-in module. 7. The Messenger plug-in must be turned on.

How to Control the Bad Words Kicker by Instant Messages to the Bot You can control the bad words kicker by sending instant messages to a bot. 1. Start an instant message conversation with the bot in Camfrog Video Chat. © 2012 Camshare Inc.

Page 41


2. Send a bad word kicker control command to the bot. The bot acts according to your command. Notes 1. See also Camfrog Bot modules description. 2. See also instant message control plug-in description. 3. See also bad words kicker plug-in description. 4. See also Camfrog Bot commands description. 5. You must be a bot owner to control the bot by instant messages. See also how to become the bot owner. 6. The Instant message control plug-in must be turned on. See also how to turn on or off plug-in module. 7. The Bad words kicker plug-in must be tur ned on.

How to Manage the RSS Reader by Instant Messages to the Bot You can control the RSS reader module by sending instant messages to the bot. 1. Start an instant message conversation with the bot in Camfrog Video Chat. 2. Send an RSS reader control command to the bot. The bot acts according to your command. Notes 1. See also Camfrog Bot modules description. 2. See also instant message control plug-in description. 3. See also RSS reader plug-in description. 4. See also Camfrog Bot commands description. 5. You must be a bot owner to control the bot by instant messages. See also how to become the bot owner. 6. The Instant message control plug-in must be turned on. See also how to turn on or off plug-in module. 7. The RSS reader plug-in must be turned on. © 2012 Camshare Inc.

Page 42


How to Request Bot Information for a User Who Banned another User You may want to find out who banned a particular Camfrog user from the room. 1. Start an instant message conversation with the bot in Camfrog Video Chat. 2. Send a /whobanned command to the bot. The bot responds with the nickname of the user who banned the given one. Notes 1. See also Camfrog Bot modules description. 2. See also instant message control plug-in description. 3. See also who banned plug-in description. 4. See also Camfrog Bot commands description. 5. You must be a bot owner to control the bot by instant messages. See also how to become the bot owner. 6. The Instant message control plug-in must be turned on. See also how to turn on or off plug-in module. 7. The Who banned plug-in must be turned on. 8. The bot must be in the room from the moment of the ban in question till the moment of your request to respond with the correct answer. 9. The room must be run on Camfrog Chat Room Server 5.0 or later.

How to Set Up the Bot to Post a Messages to the Room Regularly Follow the steps to make the bot send your message(s) to a room re gularly. 1. Run Camfrog Bot. 2. Choose a bot from the list. 3. Connect to a room 4. Choose messenger.dll in the list of modules. 5. Enter your message in the “Messages” field and click Add. 6. Set the Time parameter. 7. Click Apply for the changes to take effect. © 2012 Camshare Inc.

Page 43


The bot will now post a random message from the list to the room regularly. Notes 1. See also Camfrog Bot modules description. 2. See also Camshare messenger plug-in description. 3. The Messenger plug-in must be turned on. See also how to turn on or off plug-in module. 4. See also how to set up the bot connection to a room.

How to Start a Trivia Game in a Room Start a Trivia game in your ro om for your visitors to have fun. 1. Run Camfrog Bot. 2. Choose a bot from the list. 3. Connect to a room 4. Choose trivia.dll in the list of modules. 5. Enable the Trivia game. 6. Set the timers to fit your taste. 7. Click Apply for the changes to take effect. 8. Type !PLAY in the room for the bot to start the game. The bot shows who started the game in the chat room log. Notes 1. See also Camfrog Bot modules description. 2. See also Trivia game plug-in description. 3. The Trivia game plug-in must be turned on. See also how to turn on or off plug-in module. 4. See also how to set up the bot connection to a room.

How to Set Up a Bot to Log All the Administrative Actions in a Room Log all the administrative actions of your room operators to monitor them. 1. Run Camfrog Bot. 2. Choose a bot from the list. © 2012 Camshare Inc.

Page 44


3. Connect to a room 4. Choose whobanned.dll in the list of modules. 5. Set the path where the logs will be saved. 6. Set for how many days you want to store the logs. 7. Click Apply for the changes to take effect. Logs are being saved to the given folder now. Notes 1. See also Camfrog Bot modules description. 2. See also who banned plug-in description. 3. See also how to set up the bot connection to a room. 4. The Who banned plug-in must be turned on. See also how to turn on or off plug-in module. 5. The room must be run on Camfrog Chat Room Server 5.0 or later.

How to post RSS feeds to a Room Post RSS feeds of your choice to your room. 1. Run Camfrog Bot. 2. Choose a bot from the list. 3. Connect to a room 4. Choose rssreader.dll in the list of modules. 5. Enter the feed you would like to publish in the “Feeds” field. 6. Set how often the Camfrog Bot will update the news and post them to a room. 7. To remove a feed you no longer want to post select it in the list and push Delete button on the keyboard. 8. Click Apply for the changes to take effect. The bot now posts news from the selecte d RSS feeds to your room. Notes 1. See also Camfrog Bot modules description. © 2012 Camshare Inc.

Page 45

Camfrog Bot User Guide

Recommend Documents