shroudIRC commands

     
 
This manual gives a brief overview of most available commands. You can get a more detailed description of most commands by typing the command itself without parameters.

If you have questions, please come to #shroud (QuakeNet) and ask someone, who has experience with shroudIRC. But remember: #shroud is NOT an official help-channel, but a lot of people use shroudIRC there.

Credits

(c) 2004 BlackShroud
vote script (c) 2003 F-L-O

constructive criticism and helpful suggestions by: MAp, Deeage, F-L-O, schocK and numerous others

Setup

/setup - shows the shroudIRC setup dialog
/checkip - updates your ip-settings (Alt-O -> Connect -> Local Info)

Clonescanner / Address scanner

By default the clonescanner shows you the clones of someone, when he/she joins a channel. You can also perform a scan manually:
/clonescan - performs a clonescan (uses active channel window)

Blowfish

The Blowfish-algorithm allows you to encrypt your chat (both channel-conversation and queries). Everyone needs the same (channel-specific) keys to be able to decrypt the conversation:

/blowfish -a #chan Key - sets the key for a channel
/blowfish -r #chan - removes a channel
/blowfish -l - reloads settings from disk
/blowfish -e key text - encrypts 'text' using 'key'
/blowfish -d key encrypted text - decrypts 'encrypted text' using 'key'
/blowfish -x #chan - toggles autoencryption for a channel
/blowfish -f #chan - enables autoencryption for a channel
/blowfish -c #chan - disabled autoencryption for a channel

There's a tab for setting up keys in the shroudIRC setup dialog (/setup)

Note: You may also speficy nicks instead of channel names, if you want to encrypt queries. If you want to encrypt dcc chats, you have to specify the nick like =BlackShroud

Age

The age-script allows you to show how old you are:

/setbd - sets your birthday
/age - shows your birthday (example: 1605:30 <@BlackShroud> [My age: 17.555147] [Lifetime: 915wks 2days 15hrs 5mins 30secs] [553619130 secs])

Stats

The stats-scripts allow you to show several stats about your computer and your current DCCs:

/stat - show general stats about your computer (OS, CPU, update, RAM)
/nistat - show stats about your network interfaces (e.g. brandname and transfered amounts of data)
/screenstat - show stats about your graphics adapter (graphics card name and resolution; won't work with Windows 9x/ME)
/getstats - show stats about current downloads (DCCs)
/sendstats - show stats about current uploads (DCCs)
/lag - show how long it takes to send a ctcp message to yourself
/lag -s - show the current server lag

L/Q-flag recovery

The L/Q-flag recovery-script automatically tries to recover voice and op on channels where you are deopped/devoice. You can disable the recovery-script for certain channels.

/lqflags - updates the internal information about your L/Q-flags (using Q/L whoami)
/setup -> L/Q-Flags - allows you to setup channels, where flag-recovery should be disabled.

Away script

Allows you to easily switch between away/not-away status. The options can also be changed using the shroudIRC setup (/setup):

/awset - setup the script
/aw - set away-status using the default away-reason
/back - unset away-status

MP3 script

Using the mp3-script you can easily control WinAMP (only version 2.x and 5.x, 3.x is NOT supported) and show, which song you're currently listening to. Furthermore it allows other irc-users to download your songs (you need to be able to DCC send files in order for this to work):

/smp3 - spams the active channel/query window with MP3-status messages :)
/smp3set - set options of the mp3-script
/smp3color - add/delete custom color-sets (you can specify colors for specific interprets)
/smp3skin - change/load/save custom skins (for /smp3)
/skined - open the SkinED (mp3 skin editor)
/skinview - open the SkinViewer (allows you to select a new skin)
/scripted - open the ScriptEditor (allows you to add scripts to your mp3-skin)
/smp3lock - disables the trigger of the mp3-script
/smp3unlock - (re-)enables the trigger of the mp3-script
/wa_pause - pause WinAMP
/wa_prev - play previous song
/wa_next - play next song

F-Keys

By default, the following f-keys are defined:

F2 -> /smp3 (shows MP3-status)
F3 -> /setup (shows the setup dialog)
F5 -> /wa_pause (pauses WinAMP)
F6 -> /wa_prev (switches to the previous song (WinAMP))
F7 -> /wa_next (switches to the next song (WinAMP))
F10 -> /blowfish -x $active (toggles auto-encryption for the active channel/query)
F11 -> /hop $active (rejoins the active channel)
F12 -> /rqop $active (requests ops using QuakeNet's Operserv)

Hide channels

Using shroudIRC you can hide some of the channels, you've joined. This can be quite handy, if you have to "idle" in channels. (Usually this just sucks, but some people requested this feature.)

You can setup this feature using /setup (Hidden channels).

Vote

This script should be quite self-explanatory.

The vote-script was kindly donated by F-L-O.

Misc

/comchan - show common channels of the specified nick and you
/encode - encode text using $encode(text,m)
/decode - decode text using $decode(text,m)
/slap - slap someone (using random slaps)

In the beginning shroudIRC was based on the FCN-script. But nearly all references to FCN-code were removed, when the first public release (5.7) was published. In the case, that there is still FCN-code left over, which I haven't noticed so far, you could drop me a line and I will replace it with own code.
Thanks.

Blacklist

The blacklist allows you to set "global" bans. If someone, whose nick!ident@host mask matches a ban on your blacklist, joins a channel where you have op, shroudIRC will automagically kickban this person from the channel.

/blacklist - setup your blacklist
/blacklist.show - lists all your blacklist bans
/blacklist.add *!?ident@*host - adds a ban to your blacklist
/blacklist.remove *!?ident@*host - removes a ban from your blacklist

Filter

Being on IRC for a long time, you have certainly noticed, that a lot of people excessivly post away-messages or URLs to their SoGamed-user-profile and various other similar sites. Using the filter, you can hide all these messages. All you have to do, is adding phrases to your word-filter, which are common to these messages:

/wordfilter - shows current filters
/wordfilter -a phrase - adds the phrase 'phrase'
/wordfilter -r phrase - removes 'phrase'
/wordfilter -l - reloads the database from disk

You can also use wildcards, however, when you don't use wildcards, your phrase is internally converted to *phrase*. Color codes, bold, underline and reverse tags are removed before text-matching occurs.

You can also configure your word-filter using shroudIRC setup dialog

Here are some phrases, which should give you an idea of how to use this feature:

psyBNC: is away (
ist away (
Gamers.IRC: is AWAY ? (Reason:
is BACK ? (
shroudIRC: is away:
is back after

BotCentral

Using the bot-central you can easily manage your channels on QuakeNet:

/sichanlev - shows the chanlev-dialog

Frequently Asked Questions (FAQ)

Q: Why doesn't shroudIRC have an integrated mail/icq/web/game server browser/<insert some protocol>-client
A: Maybe you haven't noticed yet, but mIRC is an IRC-client and not some general purpose frontend for other programs. Use Mozilla Mail for your mails or any other real mail client you can dream of. shroudIRC is meant to be really lightweight, therefore there'll never be support for anything you can do with other programs within shroudIRC:

Q: Hm, if it was a lightweight script, why are there features like the vote- or mp3-script?
A: Because they were requested/required by many shroudIRC users/myself.

Q: Hey, there's a bug, shouldn't the timestamps be like 21:11:09 instead of 2111:09?
A: No, this is on purpose. You can change it, by selecting a different theme here.