How-To..

This page explains how to use some of the features that ClanBots has to offer. Please look below for the feature you would like to learn to use.

SHOUTcast Bot

   In order to use your SHOUTcast bot you first need to set ClanBot with your server
information. It is recommended to do this by typing: /msg ClanBot-XX set #channel
shoutcast address port password. You will receive a message
confirming that you have set it if sucessful otherwise it will tell you the error.
Note: Anyone who is opped in the channel will have access to be a DJ using the
ClanBots SHOUTcast feature.
   By default the bot is set to change your topic using the following topicmask:
"Server: %title%  Listen: %listen%  DJ: %dj%". There are four
variables that you can use in the topicmask for the bot to change when going onair and
offair, they are: %title% %listen% %dj% and %status%. You can arrange and add colors
to your topic using those to be replaced by the information any way you like. To do
this type: (trigger)set sctopic shoutcast topicmask. If you do not want the bot
to change your topic when going onair or offair, type: (trigger)set sctopic off.
   Now, for a DJ to get onair to use the SHOUTcast bot, they must type (trigger)onair,
by typing this command it now enables the following commands for users to use:
(trigger)stream, (trigger)song, (trigger)dj, (trigger)listeners, (trigger)bitrate,
(trigger)shoutout, and (trigger)request. Once the DJ goes onair their nickname is
recorded to be used to allow people to use the SHOUTOUT and REQUEST commands. If you
change nicknames the bot should update its records.
   Once you are done with being onair using the SHOUTcast bot, type: (trigger)offair.
If you have sctopic set to a topicmask it will update the title and status to Offair.
The SHOUTcast commands like stream, dj, listeners, bitrate, song, shoutout, and request
will now be disabled. After that you are now done using the SHOUTcast bot.

Giving ClanBot access to users

   If you want to give access to other people to use your ClanBot they must have
a ClanBots account. If they do not already have a ClanBots account they must type:
/msg ClanBots register handle password email address.
This will send an activation email to the address and make them confirm the email.
Once activated, they will be able to login to the ClanBots system by typing:
/msg ClanBots ident handle password.
   After they have logged into the ClanBots system you may add them to your channel
by typing: (trigger)adduser nickname level. Nickname would be
the nickname they are currently using on IRC. And level depends on how much access
you want to give them, level 10 is basic commands such as voice/devoice, act/say.
Level 20 gives them operator power such as kick, ban, op, deop, topic, etc. Level 30
gives them access to set information on the ClanBot such as the roster or website,
the ability to change the skin, or to make a timed message. Level 40 is the highest
access to can give and allows them to make custom commands, custom actions, or adding
and removing users.

Using custom commands

   To add a custom command such as Prices. You must type the command:
(trigger)custom add command information.
Example: .custom add Prices 1 Server/$50. This will add a custom command named "Prices"
with the information "1 Server/$50". 
   After you have made the custom command you may want to have it listed under the 
commands list, to update the list you may type: (trigger)set commands commands listed here.
Example: .set commands .Prices .Website .About. That will set the .commands to say 
".Prices .Website .About" when ever you type the command.
   Once you have set a custom command you do not need to add it again, if you want to
change the information of a custom command you may type: (trigger)set command
information. This will change the information to whatever you specify.
   Removing a custom command is just as easy as making one, to remove a custom command
you must type: (trigger)custom del command.
Example: .custom del Prices. This will delete the custom command named .Prices from the
bot. Depending on whether you updated the commands list you may need to set it again
to remove it from the list.