Setup Guide

Welcome to the ClanBots Setup Guide! This guide was made to create a quick look 

into how to setup your new or old ClanBot.



Notes before beginning:



1. All bots have the default trigger of '.' when you first get your new ClanBot,

   any command you want to send the bot will require this trigger in front of the

   command.

2. If you replace your trigger, all commands will be changed to use that 

   trigger instead of the '.' - This tutorial is setup using . as the default 

   trigger. 

3. You may configure your bot by logging into our online control panel found at 

   www.clanbots.org/cpanel.php.



Setting up your new ClanBot:



1. Decide whether you want to keep the default trigger of '.' or to change it. If you 

   want to change the trigger follow the command below:

      a. To change the trigger of your ClanBot, type: .set trigger trigger



2. All of the following commands are set in your channel by typing the commands given:

      a. Roster - .set roster roster - Applys the roster for your clan 

         to be displayed when .roster is typed.

      b. Practices - .set practices practices - Applys a list of 

         practices for your clan  to be displayed when .practices is typed.

      c. Servers - .set servers servers - Applys a list of servers for 

         your clan to be displayed when .servers is typed.

      d. Website - .set website website - Applys your clans website to 

         be displayed when .website is typed.

      e. Rules - .set rules rules - Applys a list of rules for your 

         channel and/or clan to be displayed when .rules is typed.

      f. Sponsors - .set sponsors sponsors - Applys a list of sponsors 

         of your clan to be displayed when .sponsors is typed.

      g. ClanStats - .set clanstats clanstats - Applys any statistics 

         about your clan you wish to be displayed when .clanstats is typed.

      h. News - .set news news - Applys any news or upcoming events your 

         clan may have coming up to be seen when .news is typed.

      i. Record - .set record record - Applys your clans current record 

         to be seen when .record is typed.

      j. Matches - .set matches matches - Applys a list of upcoming 

         matches to be viewed when .matches is typed.

      k. Flood - .set flood on or .set flood off - On enables kicking people 

         who flood the channel, off allows the channel to be flooded with no 

         discipline.

      l. Floodrate - .set floodrate X:Y - Where X is the number of lines and Y 

         is the number of seconds.

      m. Swear - .set swear on or .set swear off - On enables people who swear 

         to be kicked Off allows swearing in the channel.

      n. VoiceAll - .set voiceall on or .set voiceall off - On voices everyone 

         who joins the channel, Off does not.

      o. OpAll - .set opall on , .set opall off - On ops everyone who joins the 

         channel, Off does not.

      p. KickOps - .set kickops on or .set kickops off - On allows ops to be 

         kicked by flood, swear, and noads. Off disables this.

      q. NotifyType 

         - .set notifytype channel - All commands will be displayed 

           with a message to the channel.

         - .set notifytype query - All commands will be displayed through a 

           private message to the typer.

         - .set notifytype notice - All commands will be displayed through a 

           notice to the typer.

      r. TopicLock - .set tlock on or .set tlock off - On locks the channel 

         topic,  Off leaves the topic unlocked.

      s. ModeLock - .set mlock channel modes - Locks all channel modes 

         to be reset if they are removed. 

      t. Greeting- .set greeting message - Sets the message to be 

         displayed whenever someone joins the channel.

         Greeting2 - .set greeting2 message -  Sets the second message

         to be displayed whenever someone joins the channel.

         .set greeting off - Turns off the greeting.

         .set greeting notice - Makes the greeting shown in notice.

         .set greeting query - Makes the greeting shown in query.

         .set greeting channel - Makes the greeting shown in channel.

      u. NoAds - .set noads on , .set noads off - Allows or disallows 

         advertising in your channel without punishment.

      v. NoURLs - .set nourls on , .set nourls off - Allows or disallows URLs 

         to be displayed in the channel without punishment.

      w. Punishtype - .set punishtype 0,1,2,3, or 4 - Please type .set 

         punishtype for a complete list.

      x. ShoutCast - .set shoutcast IP PORT PASSWORD - This allows your clanbot

         to relay infomation from your server to your channel. Once this is set

         the DJ must use the following commands: .onair - to sign on, and .offair

         to sign off. Additional commands: .stream .dj .listeners .bitrate .song 

         .request .shoutout



4. For a list of all other commands your ClanBot can perform, please visit the commands page.