Getting Started with StormBot

From BotHouse MediaWiki

This page is not finished. You can help the StormBot Wiki Team by adding to it.

The purpose of this guide is to help users become familiar with some of the basic StormBot commands in order to effectively use the script.

This guide assumes the reader has finished the installation guide and has owner level access on the bot. It also assumes reader’s nickname is part of the owner flag in eggdrop’s configuration file. It also assumes that the bot is in at least one channel. If the bot is not in at least one channel (i.e: it is a clean installation of eggdrop and has not been run for the first time), please read First Time StormBot as it will provide instructions to get the bot into its first channel.

Contents 1 Guide Information 2 LOGIN 3 The Basics 3.1 Listing Available Commands 3.2 Access Levels

[edit] Guide Information

This guide is going to use a fictitious bot with the following settings:

• Nickname: LamestBot
• Alternate Nickname: LlamaBob
• Owner's Nickname: LamestOwner
• Owner's Handle: OwnerHandle
• Owner's Password: abc123
• Channel: #fictitious

[edit] LOGIN

This is crucial as StormBot will afford users virtually zero access unless they login to identify themselves with the bot. If the bot asks Who are you? Did you login?, the reason is because the login command was never issued.

/MSG LamestBot LOGIN <MY_PASSWORD> <MY_HANDLE>

[edit] The Basics

The bot should respond to commands stated in the channel by chatters. By default, the bot will have three names by which it will respond: its full nickname, its alternate nickname and the first letter and last letter of its regular nickname. The example bot noted at the beginning of this guide would respond to the following three commands (case insensitive):

• LamestBot
• LlamaBob
• Lt

The bot will also respond to commands issued via /MSG, though commands relating to channels must also state a #channelname for which the command is being issued. Some commands do not require a #channelname but those are far and few between. Example:

/MSG LamestBot SAY #fictitious Hi!  I'm LamestBot, I'm a StormBot

If you have a question on whether or not the command needs #channelname specified, review the help topic for the command in question. This can be done by sending a help request to the bot by doing this:

/MSG LamestBot HELP <COMMAND_NAME>

Example:

/MSG LamestBot HELP ADDUSER

[edit] Listing Available Commands

Owners of bots will have access to all commands, but non-owner users will not have access to all commands. To list available commands:

/MSG LamestBot HELP #fictitious *

The command list generated in the output from the above command are the commands which the requesting user can execute. If the user does not have access to execute a command, the command will not show up in this list.

[edit] Access Levels

Before reading about StormBot's access levels, users should already be familiar with eggdrop's access flags. This will help understand which privileges users will have with the default access levels. NOTE: The commands and privileges provided by access levels can be changed with every installation. Though it is not detailed in this guide, be aware that not all StormBot configurations are the same. The information provided here is the default StormBot configuration.

• Bot Owner: Owns the bot and is specified as such in the eggdrop configuration. Users specified under these conditions have complete unadulterated access to the bot its settings and configurations. Some of the commands afforded to bot owner provide internal access to the machine running the bot as general owner access does not need access to this information nor these commands.
• Owner: Less access than bot owner, but still has access to change most vital settings. Owners can still change the bot's nickname as well as the timezone in which the bot resides. Owners also have access to debugging information which is required to acquire the required information to submit bugs.
• Master: Less access to vital settings than bot owners or even owners. However this level does afford access to kill the bot in times of malfunctioning or even malfeasance. It also allows the user to block channels, suspend channels as well as move channels. This level also provides access to the admin command which allows global users to be added to the bot's user file.
• Tech: This level allows most operations regarding bot administration to happen. It provides the user with the access to suspend users, change user attributes, reset user passwords, part channels, restore information among a whole slew of other options. Please see your help command for more information.
• Operator (OP): This level allows users to lock channels, unlock channels, transfer bans between bots, check user passwords, ignore hostmasks, unignore hostmasks and a few other things.
• Trainee: This user has access to the abuse command (which notifies of abuse of the bot such as kicking, deoping, etc. Other commands afforded to users of this level are channels command, lastlogin, check command which tells the user where the bot is not opped.
• ChanOwner: This level allows the user to set channel specific settings such as chanset which sets flood protections. The say and action commands are also provided at this level, which make the bot speak and do things.