@channel

Use and manage in-game channels.

Usage:
channel channelname <msg>
channel channel name = <msg>
channel (show all subscription)
channel/all (show available channels)
channel/alias channelname = alias[;alias...]
channel/unalias alias
channel/who channelname
channel/history channelname [= index]
channel/sub channelname [= alias[;alias...]]
channel/unsub channelname[,channelname, ...]
channel/mute channelname[,channelname,...]
channel/unmute channelname[,channelname,...]

channel/create channelname[;alias;alias[:typeclass]] [= description]
channel/destroy channelname [= reason]
channel/desc channelname = description
channel/lock channelname = lockstring
channel/unlock channelname = lockstring
channel/ban channelname (list bans)
channel/ban[/quiet] channelname[, channelname, ...] = subscribername [: reason]
channel/unban[/quiet] channelname[, channelname, ...] = subscribername
channel/boot[/quiet] channelname[,channelname,...] = subscribername [: reason]

# subtopics

## sending

Usage: channel channelname msg
channel channel name = msg (with space in channel name)

This sends a message to the channel. Note that you will rarely use this
command like this; instead you can use the alias

channelname <msg>
channelalias <msg>

For example

public Hello World
pub Hello World

(this shortcut doesn't work for aliases containing spaces)

See channel/alias for help on setting channel aliases.

## alias and unalias

Usage: channel/alias channel = alias[;alias[;alias...]]
channel/unalias alias
channel - this will list your subs and aliases to each channel

Set one or more personal aliases for referencing a channel. For example:

channel/alias warrior's guild = warrior;wguild;warchannel;warrior guild

You can now send to the channel using all of these:

warrior's guild Hello
warrior Hello
wguild Hello
warchannel Hello

Note that this will not work if the alias has a space in it. So the
'warrior guild' alias must be used with the `channel` command:

channel warrior guild = Hello

Channel-aliases can be removed one at a time, using the '/unalias' switch.

## who

Usage: channel/who channelname

List the channel's subscribers. Shows who are currently offline or are
muting the channel. Subscribers who are 'muting' will not see messages sent
to the channel (use channel/mute to mute a channel).

## history

Usage: channel/history channel [= index]

This will display the last |c20|n lines of channel history. By supplying an
index number, you will step that many lines back before viewing those 20 lines.

For example:

channel/history public = 35

will go back 35 lines and show the previous 20 lines from that point (so
lines -35 to -55).

## sub and unsub

Usage: channel/sub channel [=alias[;alias;...]]
channel/unsub channel

This subscribes you to a channel and optionally assigns personal shortcuts
for you to use to send to that channel (see aliases). When you unsub, all
your personal aliases will also be removed.

## mute and unmute

Usage: channel/mute channelname
channel/unmute channelname

Muting silences all output from the channel without actually
un-subscribing. Other channel members will see that you are muted in the /who
list. Sending a message to the channel will automatically unmute you.

## create and destroy

Usage: channel/create channelname[;alias;alias[:typeclass]] [= description]
channel/destroy channelname [= reason]

Creates a new channel (or destroys one you control). You will automatically
join the channel you create and everyone will be kicked and loose all aliases
to a destroyed channel.

## lock and unlock

Usage: channel/lock channelname = lockstring
channel/unlock channelname = lockstring

Note: this is an admin command.

A lockstring is on the form locktype:lockfunc(). Channels understand three
locktypes:
listen - who may listen or join the channel.
send - who may send messages to the channel
control - who controls the channel. This is usually the one creating
the channel.

Common lockfuncs are all() and perm(). To make a channel everyone can
listen to but only builders can talk on, use this:

listen:all()
send: perm(Builders)

## boot and ban

Usage:
channel/boot[/quiet] channelname[,channelname,...] = subscribername [: reason]
channel/ban channelname[, channelname, ...] = subscribername [: reason]
channel/unban channelname[, channelname, ...] = subscribername
channel/unban channelname
channel/ban channelname (list bans)

Booting will kick a named subscriber from channel(s) temporarily. The
'reason' will be passed to the booted user. Unless the /quiet switch is
used, the channel will also be informed of the action. A booted user is
still able to re-connect, but they'll have to set up their aliases again.

Banning will blacklist a user from (re)joining the provided channels. It
will then proceed to boot them from those channels if they were connected.
The 'reason' and `/quiet` works the same as for booting.

Example:
boot mychannel1 = EvilUser : Kicking you to cool down a bit.
ban mychannel1,mychannel2= EvilUser : Was banned for spamming.