From NoxBot the modular PHP IRC bot

Contents 1 About this documentation 2 Standard commands 2.1 login 2.2 register 2.3 logout 2.4 remove 2.5 changepw 2.6 grant 2.7 revoke 2.8 list 2.9 save 2.10 quit 2.11 settings 2.11.1 settings set 2.11.2 settings get 2.11.3 settings list 2.12 join 2.13 part 2.14 nick 2.15 raw 2.16 version 2.17 load 2.18 unload 2.19 addserver 2.20 removeserver (rmserver, delserver) 2.21 connect 2.22 reconnect 2.23 disconnect 3 Commands for the Standard Plugins 3.1 Talk 3.1.1 say 3.1.2 action 3.2 SvnHook 3.2.1 svnhook 3.2.2 svnhooktemplate 3.2.3 svnhooktest 3.3 StreamInfo 3.3.1 streaminfo 3.3.2 remstreaminfo 3.3.3 getstreaminfo 3.4 Rss 3.4.1 rss 3.5 Nstools 3.5.1 getip 3.5.2 gethost 3.5.3 dig 3.5.4 ping 3.5.5 traceroute 3.6 VersionChecker 3.6.1 checkplugin 3.7 Google 3.7.1 google (gg) 3.8 UrbanDict 3.8.1 urbandict (urban) 3.9 Invite 3.9.1 invite 3.9.2 allow 3.9.3 remove 3.9.4 allowadmin 3.9.5 removeadmin 3.10 ChannelCommands 3.10.1 mode 3.10.2 kick 3.10.3 ban 3.10.4 kickban (kb, kill) 3.10.5 invite 3.10.6 silence 3.10.7 op 3.10.8 deop 3.10.9 voice 3.10.10 devoice 3.11 Alias 3.11.1 alias (mkalias) 3.11.2 rmalias 3.12 Example1 3.12.1 example 4 Commands helpful in debugging 4.1 dumphandlers 4.2 dumpstate 4.3 dumpusers 4.4 dumpsettings

About this documentation

This documentation simply documents what standard commands their are available. The commands have been seperated into three sections. The section #Standard commands is about the commands that the bot has and cannot be disabled. The section #Commands for the Standard Plugins is about the standard plugins that can be disabled or enabled depending on what you want. Plugins created by 3rd parties and not included as a standard plugin are not listed here.

Version tracking has only been done since version 0.3. If you still use a prior version we urge you to upgrade to the latest one.

Note some commands may be from versions not yet released.

This documentation uses a standard structure for each command.

• Plugin: If this is specified it indicates from which plugin this command comes.
• Aliases: This describes what aliases there are for this command. if only a - is put there then there are no standard aliases.
• AuthType: If specified this command requires the authtype(s) listed here.
• Version: The version where this command is available.
• Arguments: A list of arguments. If an argument is enclosed with [ and ] then its optional.
• Description:

Here it describes what the command does and what you need to take in account.

• Example:

Examples are listed in these blocks.
Lines starting with a > are things we send to the bot.
Lines starting with a < are things the bot returns to us.

Standard commands

login

• Aliases: -
• AuthType: -
• Version: 0.3 - future
• Arguments: <password>
• Description:

This is used to login to the bot so it recognizes you.

• Example:

> login mypassword
< Login succesful.

register

• AuthType: -

@@@TODO@@@

logout

• AuthType: -
• Version: 0.3 - future

@@@TODO@@@

remove

• AuthType: -
• Version: 0.3 - future

@@@TODO@@@

changepw

• AuthType: -
• Version: 0.4 - future

@@@TODO@@@

grant

• AuthType: AUTH_USER_ADMIN
• Version: 0.3 - future

@@@TODO@@@

revoke

• AuthType: AUTH_USER_ADMIN
• Version: 0.3 - future

@@@TODO@@@

list

• AuthType: -
• Version: 0.4 - future

@@@TODO@@@

save

• Aliases: -
• AuthType: AUTH_BOT_ADMIN
• Version: 0.3 - future
• Arguments: -
• Description:

This function does exactly what it says ... it saves stuff ... mainly the settings of the bot though.

• Example:

> save
< Yes master.

quit

• Aliases: -
• AuthType: AUTH_BOT_ADMIN
• Version: 0.3 - future
• Arguments: <quit message>
• Description:

This function does exactly what it says ... it quits the bot. This is the only legal way to quit the bot atm. Other methods involve not saving the settings.

• Example:

> quit
< Yes master.

settings

• Aliases: -
• AuthType: AUTH_BOT_ADMIN
• Version: 0.3 - future
• Arguments: See subcommands
• Description:

This is one of the most dangarous commands in the bot. With this command (and its subcommands) you can edit the behavior or completely destroy all settings of the bot. But ofcourse if your smart enough that won't happen.

• Example: See subcommands

settings set

• Version: 0.3 - future

@@@TODO@@@

settings get

• Version: 0.3 - future

@@@TODO@@@

settings list

• Version: 0.3 - future

@@@TODO@@@

join

• Aliases: -
• AuthType: AUTH_BOT_ADMIN
• Version: 0.3 - future
• Arguments: <channel>
• Description:

Makes the bot join the channel specified with <channel>.

• Example:

> join #noxbot
< Joining channel #noxbot.

part

• Aliases: -
• AuthType: AUTH_BOT_ADMIN
• Version: 0.3 - future
• Arguments: <channel>
• Description:

Makes the bot part (leave) the channel specified with <channel>.

• Example:

> part #noxbot
< Parting channel #noxbot.

nick

• Aliases: -
• AuthType: AUTH_BOT_ADMIN
• Version: 0.3 - future
• Arguments: <channel>
• Description:

Attempts to change the nick of the bot. If it succeeds you will see him change his nick. Else something went wrong.

Note: If it failed to change its nick make sure you change the nick back so the configuration matches the bot again.

• Example:

> nick SuperBot
< Attempting to change nick to SuperBot.
NoxBot is now known as SuperBot

Here everything went fine ... but when it fails:

> nick !@#$^%^&*%*&
< Attempting to change nick to !@#$^%^&*%*&.
... nothing happens ... make sure you reset the nick by doing:
> nick NoxBot
< Attempting to change nick to NoxBot.

raw

• AuthType: AUTH_RAW
• Version: 0.3 - future

@@@TODO@@@

version

• Aliases: -
• AuthType: -
• Version: 0.3 - future
• Arguments: -
• Description:

Shows the bots version.

• Example:

> version
< NoxBot version 0.1.7-dev made by Mark Sanders (CyaNox) running with PHP 5.1.2 on Linux since Fri, 31 Mar 2006 22:37:49 +0200.

load

• Aliases: -
• AuthType: AUTH_PLUGIN_ADMIN
• Version: 0.3 - future
• Arguments: <plugin name>
• Description:

Loads a plugin by its name.

• Example:

> load VersionChecker
< Plugin loaded: VersionChecker.

unload

• Aliases: -
• AuthType: AUTH_PLUGIN_ADMIN
• Version: 0.3 - future
• Arguments: <plugin name>
• Description:

Unloads a plugin by its name.

• Example:

> unload VersionChecker
< Plugin unloaded: VersionChecker.

addserver

• Aliases: -
• AuthType: AUTH_SERVER_ADMIN
• Version: 0.3 - future
• Arguments: <server address> [<nickname>] [<primary channel>] [<command character>] [<port>] [<password>] [<email>]
• Description:

Adds a server to which the bot should connect. Only the first argument is required the rest is optional.

But it is most commen to specify the first 4 parameters so you know what its nick will be, to what channel it goes and what its command character is.

• Example:

> addserver irc.freenode.net noxbot-test #noxbot @
< Server "irc.freenode.net" added as "2".

removeserver (rmserver, delserver)

• Aliases: rmserver, delserver
• AuthType: AUTH_SERVER_ADMIN
• Version: 0.3 - future
• Arguments: <server number>
• Description:

This command removes a server from NoxBot's settings. Only takes the server number as argument.

• Example:

> removeserver 2
< Server "irc.freenode.net" with number "2" removed.

connect

• Aliases: -
• AuthType: AUTH_SERVER_ADMIN
• Version: 0.3 - future
• Arguments: <server number>
• Description:

This command make NoxBot connect to the server. Only takes the server number as argument.

• Example:

> connect 2
< Connecting to server "irc.freenode.net" with number "2".

reconnect

• Aliases: -
• AuthType: AUTH_SERVER_ADMIN
• Version: 0.3 - future
• Arguments: <server number>
• Description:

This command make NoxBot reconnect to the server. Only takes the server number as argument.

• Example:

> reconnect 2
< Connecting to server "irc.freenode.net" with number "2".

disconnect

• Aliases: -
• AuthType: AUTH_SERVER_ADMIN
• Version: 0.3 - future
• Arguments: <server number>
• Description:

This command make NoxBot disconnect from the server. Only takes the server number as argument.

• Example:

> disconnect 2
< Server "irc.freenode.net" with number "2" connection closed.

Commands for the Standard Plugins

Talk

say

• Plugin: Talk
• Aliases: -
• AuthType: -
• Version: 0.4 - future
• Arguments: [<channel>] <text>

@@todo@@

action

• Plugin: Talk
• Aliases: -
• AuthType: -
• Version: 0.4 - future
• Arguments: [<channel>] <text>

@@todo@@

SvnHook

svnhook

• Plugin: SvnHook
• Aliases: -
• AuthType: -
• Version: 0.4 - future
• Arguments: [<channel>] <on|off> <repository>

@@todo@@

svnhooktemplate

• Plugin: SvnHook
• Aliases: -
• AuthType: -
• Version: 0.4 - future
• Arguments: [<channel>] <repository> <template>

@@todo@@

svnhooktest

• Plugin: SvnHook
• Aliases: -
• AuthType: -
• Version: 0.4 - future
• Arguments: [<channel>] <repository>

@@todo@@

StreamInfo

streaminfo

• Plugin: StreamInfo
• Aliases: -
• AuthType: -
• Version: 0.4 - future
• Arguments: [<channel>] <streamurl>

@@todo@@

remstreaminfo

• Plugin: StreamInfo
• Aliases: -
• AuthType: -
• Version: 0.4 - future
• Arguments: [<channel>]

@@todo@@

getstreaminfo

• Plugin: StreamInfo
• Aliases: -
• AuthType: -
• Version: 0.4 - future
• Arguments: [<channel>]

@@todo@@

Rss

rss

• Plugin: Rss
• Aliases: -
• AuthType: -
• Version: 0.4 - future
• Arguments: [<channel>] <name> <on|off> <rss feed>

@@todo@@

Nstools

getip

• Plugin: Nstools
• Aliases: -
• AuthType: -
• Version: 0.4 - future
• Arguments: <hostname>

@@todo@@

gethost

• Plugin: Nstools
• Aliases: -
• AuthType: -
• Version: 0.4 - future
• Arguments: <ipaddress>

@@todo@@

dig

• Plugin: Nstools
• Aliases: -
• AuthType: -
• Version: 0.4 - future
• Arguments: <host>

@@todo@@

ping

• Plugin: Nstools
• Aliases: -
• AuthType: -
• Version: 0.4 - future
• Arguments: <host or ipaddress>

@@todo@@

traceroute

• Plugin: Nstools
• Aliases: -
• AuthType: -
• Version: 0.4 - future
• Arguments: <host or ipaddress>

@@todo@@

VersionChecker

checkplugin

• Plugin: VersionChecker
• Aliases: -
• AuthType: -
• Version: 0.3 (removed in 0.4 and later)
• Arguments: <plugin name>
• Description:

This is one of the simpler commands it takes one argument and that is the name of the plugin.

• Example:

> checkplugin versionchecker
< Plugin "versionchecker" was found to be "OK"

Google

google (gg)

• Plugin: Google
• Aliases: gg
• AuthType: -
• Version: 0.3 - future
• Arguments: <search query>
• Description:

This is one of the simpler commands it takes one argument and that is your search query.

• Example:

> google test
< http://www.test.com/ , http://www.ets.org/toefl/ , http://www.innergeek.us/geek.html ,
  http://www.bandwidthplace.com/speedtest/ , http://community.sparknotes.com/ , https://grc.com/x/ne.dll?bh0bkyd2 ,
  http://www.act.org/ , http://www.tickle.com/ , http://www.iqtest.com/ , http://www.testprepreview.com/
  http://google.com/search?q=test

UrbanDict

urbandict (urban)

• Plugin: Urbandict
• Aliases: urban
• AuthType: -
• Version: 0.3 - future
• Arguments: <query>
• Description:

This is one of the simpler commands it takes one argument and that is word (or words) you want to query from urbandictionary.com.

• Example:

> urban bot
< blackmage53: "Things on instant messanger programs that try to act like stupid girls who give you links to pay
  porn sites. Usually are hella annoying and repeat everything over and over again"
  http://www.urbandictionary.com/define.php?term=bot

Invite

invite

• Plugin: Invite
• Aliases: -
• AuthType: AUTH_MEMBER
• Version: 0.3 - future

@@@TODO@@@

allow

• Plugin: Invite
• Aliases: -
• AuthType: AUTH_MEMBER_ALLOW
• Version: 0.3 - future

@@@TODO@@@

remove

• Plugin: Invite
• Aliases: -
• AuthType: AUTH_MEMBER_ALLOW
• Version: 0.3 - future

@@@TODO@@@

allowadmin

• Plugin: Invite
• Aliases: -
• AuthType: AUTH_MEMBER_ADMIN
• Version: 0.3 - future

@@@TODO@@@

removeadmin

• Plugin: Invite
• Aliases: -
• AuthType: AUTH_MEMBER_ADMIN
• Version: 0.3 - future

@@@TODO@@@

ChannelCommands

mode

• Plugin: ChannelCommands
• Aliases: -
• AuthType: AUTH_CHANNEL_ADMIN
• Version: 0.3 - future
• Arguments: [<channel>] <mode>
• Description:

The sets the channel modes. It does not do any checking on the mode therefor only AUTH_ADMIN users can use it.

the <channel> parameter is only needed in a private message to the bot.

• Example:

> mode #channel +s
< Attempting to set mode to "+s".

kick

• Plugin: ChannelCommands
• Aliases: -
• AuthType: AUTH_CHANNEL_MODERATOR
• Version: 0.3 - future
• Arguments: [<channel>] <nickname> [<reason>]
• Description:

Kick <nickname> from the channel.

the <channel> parameter is only needed in a private message to the bot.

• Example:

> kick #channel bloooop
< Attempting to kick "blooop".

ban

• Plugin: ChannelCommands
• Aliases: -
• AuthType: AUTH_CHANNEL_MODERATOR
• Version: 0.3 - future
• Arguments: [<channel>] <nickname>
• Description:

Ban <nickname> from the channel.

the <channel> parameter is only needed in a private message to the bot.

• Example:

> ban #channel bloooop
< Attempting to ban "blooop".

kickban (kb, kill)

• Plugin: ChannelCommands
• Aliases: -
• AuthType: AUTH_CHANNEL_MODERATOR
• Version: 0.3 - future
• Arguments: [<channel>] <nickname> [<reason>]
• Description:

Kick and ban <nickname> from the channel.

the <channel> parameter is only needed in a private message to the bot.

• Example:

> kickban #channel bloooop
< Attempting to kick ban "blooop".

invite

• Plugin: ChannelCommands
• Aliases: -
• AuthType: AUTH_CHANNEL_MODERATOR
• Version: 0.3 - future
• Arguments: [<channel>] <nickname>
• Description:

Kick and ban <nickname> from the channel.

the <channel> parameter is only needed in a private message to the bot.

• Example:

> invite #channel bloooop
< Attempting to invite "blooop".

silence

• Plugin: ChannelCommands
• Aliases: -
• AuthType: AUTH_CHANNEL_MODERATOR
• Version: 0.3 - future
• Arguments: [<channel>] <nickname>
• Description:

This effectivly silences a person by deopping, devoicing and banning <nickname> from the channel.

the <channel> parameter is only needed in a private message to the bot.

• Example:

> silence #channel bloooop
< Attempting to silence "blooop".

op

• Plugin: ChannelCommands
• Aliases: -
• AuthType: AUTH_CHANNEL_ADMIN
• Version: 0.3 - future
• Arguments: [<channel>] <nickname>
• Description:

Op <nickname> in the channel.

the <channel> parameter is only needed in a private message to the bot.

• Example:

> op #channel bloooop
< Attempting to op "blooop".

deop

• Plugin: ChannelCommands
• Aliases: -
• AuthType: AUTH_CHANNEL_ADMIN
• Version: 0.3 - future
• Arguments: [<channel>] <nickname>
• Description:

Deop <nickname> in the channel.

the <channel> parameter is only needed in a private message to the bot.

• Example:

> deop #channel bloooop
< Attempting to deop "blooop".

voice

• Plugin: ChannelCommands
• Aliases: -
• AuthType: AUTH_CHANNEL_MODERATOR
• Version: 0.3 - future
• Arguments: [<channel>] <nickname>
• Description:

Voice <nickname> in the channel.

the <channel> parameter is only needed in a private message to the bot.

• Example:

> vioce #channel bloooop
< Attempting to vioce "blooop".

devoice

• Plugin: ChannelCommands
• Aliases: -
• AuthType: AUTH_CHANNEL_MODERATOR
• Version: 0.3 - future
• Arguments: [<channel>] <nickname>
• Description:

Devoice <nickname> in the channel.

the <channel> parameter is only needed in a private message to the bot.

• Example:

> devoice #channel bloooop
< Attempting to devoice "blooop".

Alias

alias (mkalias)

• Plugin: Alias
• Aliases: mkalias
• AuthType: -
• Version: 0.3 - future
• Arguments: <alias> <command>
• Description:

Thas commands makes and alias from <alias> to the command <command>.

• Example:

> alias v version
< The command "v" is now alias to "version".
> v
< NoxBot version 0.1.7-dev made by Mark Sanders (CyaNox) running with PHP 5.1.2 on Linux since Fri, 31 Mar 2006 22:37:49 +0200.

in other words v now acts the same as version.

rmalias

• Plugin: Alias
• Aliases: -
• AuthType: -
• Version: 0.3 - future
• Arguments: <alias>
• Description:

Thas commands removes an alias previously set with #alias.

• Example:

> rmalias v
< Alias "v" removed.
> v
< Unknown command "v".

Example1

example

• Plugin: Example1
• Aliases: -
• AuthType: -
• Version: 0.3 - future
• Arguments: <anything>
• Description:

This is an example command used also in the tutorial Howto Make Plugins.

• Example:

> example testing
< You used the "example" command with the following text: "testing".

Commands helpful in debugging

dumphandlers

• Aliases: -
• AuthType: -
• Version: 0.3 - future
• Arguments: -
• Description:

Used for debugging. It writes a file with readable data based on the structure in NoxBots memory.

it writes the file in the directory data/system/ with the filename handlers.dump.

• Example:

> dumphandlers
< Yes master.

dumpstate

• Aliases: -
• AuthType: -
• Version: 0.3 - future
• Arguments: -
• Description:

Used for debugging. It writes a file with readable data based on the structure in NoxBots memory.

it writes the file in the directory data/system/ with the filename state.dump.

• Example:

> dumpstate
< Yes master.

dumpusers

• Aliases: -
• AuthType: -
• Version: 0.3 - future
• Arguments: -
• Description:

Used for debugging. It writes a file with readable data based on the structure in NoxBots memory.

it writes the file in the directory data/system/ with the filename users.dump.

• Example:

> dumpusers
< Yes master.

dumpsettings

• Aliases: -
• AuthType: -
• Version: 0.3 - future
• Arguments: -
• Description:

Used for debugging. It writes a file with readable data based on the structure in NoxBots memory.

it writes the file in the directory data/system/ with the filename settings.dump.

• Example:

> dumpsettings
< Yes master.