Difference between revisions of "Channel Comsys"

From Fate's Harvest
Jump to: navigation, search
(Created page with "__NOTOC__ __NOEDITSECTION__ =Channel Cheat Sheet= For those players, new and old, who are unfamiliar with all of the many and varied commands and capabilities of channels in T...")
 
Line 17: Line 17:
  
 
''<span style="color:gray">(Reminder: the 'help' command covers TinyMUX defaults. The '+help' command covers code staff has written.)</span>''
 
''<span style="color:gray">(Reminder: the 'help' command covers TinyMUX defaults. The '+help' command covers code staff has written.)</span>''
 +
 +
==How to Use Channels==
 +
Every channel has a name assigned by its creator.
 +
 +
<u>This name is case sensitive.</u>  If the channel is named 'Public', none of the commands will work if you type 'public' instead.
 +
 +
 +
===Aliases===
 +
An alias is what you use to tell the system you are speaking on a particular channel.  An alias should be short and easy to type, generally between 2-4 letters.
 +
 +
<u>Aliases are also case sensitive!</u>
 +
 +
Until you assign an alias, you can't see/speak on a channel.  You may, however, have multiple aliases for the same channel.  For example, if you constantly typo your 'cha' alias for the Changeling channel, you could use the addcom command again to make a 'ch' alias.  You will see both aliases listed when you type comlist.
 +
 +
When you join a channel, you create an alias for it (e.g. addcom pub=Public, where 'pub' is your new alias to speak on Public).
 +
 +
:Typing 'pub Hello!' would post '<Public> YourName says, "Hello!"' on the Public channel, and anyone who had the channel turned on would see it.
 +
 +
 +
===User Commands===
 +
Each of the commands listed below has a separate helpfile. See the 'help' file for them in game for more details, including command syntax.
 +
 +
{| width=100%; style="border:1px solid whitesmoke; background:white; margin-left:20px; margin-top:20px; margin-right:20px; margin-bottom:20px;"
 +
|-
 +
| width=10%; style="font-family:open sans; padding-left:15px; vertical-align:top;" | '''@clist'''
 +
| width=85%; style="font-family:open sans; font-size: 95%; vertical-align:top;" | Displays a summary list of all channels you have access to.
 +
|-
 +
| width=10%; style="font-family:open sans; padding-left:15px; vertical-align:top;" | '''comlist'''
 +
| width=85%; style="font-family:open sans; font-size: 95%; vertical-align:top;" | Lists all aliases/comtitles you have set up.<br>Also lists which channels you are currently on/off of.
 +
|-
 +
| width=10%; style="font-family:open sans; padding-left:15px; vertical-align:top;" | '''comtitle'''
 +
| width=85%; style="font-family:open sans; font-size: 95%; vertical-align:top;" | Creates a title for you on the channel. On most channels, this is just for fun.  If you 'comtitle cha=Grand Poobah' for the Changeling channel, any time you speak, it will show up as, <Changeling> Grand Poobah YourName says, "Something!"<br>Some channels are anonymous, so your name never shows up when you speak.  Just your comtitle (if you have one).  In that case, it would show up like: <Channel Header> Grand Poobah says, "Blorp!"
 +
|-
 +
| width=10%; style="font-family:open sans; padding-left:15px; vertical-align:top;" | '''addcom'''
 +
| width=85%; style="font-family:open sans; font-size: 95%; vertical-align:top;" | Adds a new alias for a channel and joins it.
 +
|-
 +
| width=10%; style="font-family:open sans; padding-left:15px; vertical-align:top;" | '''delcom'''
 +
| width=85%; style="font-family:open sans; font-size: 95%; vertical-align:top;" | Deletes an alias. If this was the only alias you had, this also effectively deletes the channel from your list, and removes any comtitle you had on that channel.
 +
|-
 +
| width=10%; style="font-family:open sans; padding-left:15px; vertical-align:top;" | '''clearcom'''
 +
| width=85%; style="font-family:open sans; font-size: 95%; vertical-align:top;" | Deletes ALL aliases on ALL channels and ALL comtitles.  Poof!
 +
|-
 +
| width=10%; style="font-family:open sans; padding-left:15px; vertical-align:top;" | '''alias'''
 +
| width=85%; style="font-family:open sans; font-size: 95%; vertical-align:top;" | 'Alias' is not a command.  It is a placeholder for your own alias for a channel.  If you have 'cha' as your Changeling channel alias, you can do the following with it:
 +
{| width=100%
 +
|-
 +
| width=10%; style="font-family:open sans; font-size: 95%; vertical-align:top; color:darkgreen;" | cha on
 +
| style="font-family:open sans; font-size: 95%; vertical-align:top;" | ''Turns on the channel so you see its chatter.
 +
|-
 +
| width=10%; style="font-family:open sans; font-size: 95%; vertical-align:top; color:darkgreen;" | cha off
 +
| style="font-family:open sans; font-size: 95%; vertical-align:top;" | ''You stop seeing Changeling channel-spam.
 +
|-
 +
| width=10%; style="font-family:open sans; font-size: 95%; vertical-align:top; color:darkgreen;" | cha who
 +
| style="font-family:open sans; font-size: 95%; vertical-align:top;" | ''Lists who is on the channel, with comtitles.
 +
|-
 +
| width=10%; style="font-family:open sans; font-size: 95%; vertical-align:top; color:darkgreen;" | cha Hello!
 +
| style="font-family:open sans; font-size: 95%; vertical-align:top;" | ''Says "Hello!" on the channel.
 +
|-
 +
| width=10%; style="font-family:open sans; font-size: 95%; vertical-align:top; color:darkgreen;" | cha :smiles.
 +
| style="font-family:open sans; font-size: 95%; vertical-align:top;" | ''Emits "YourName smiles." on the channel.
 +
|-
 +
| width=10%; style="font-family:open sans; font-size: 95%; vertical-align:top; color:darkgreen;" | cha ;'s nose.
 +
| style="font-family:open sans; font-size: 95%; vertical-align:top;" | ''Emits "YourName's nose." on the channel.
 +
|-
 +
| width=10%; style="font-family:open sans; font-size: 95%; vertical-align:top; color:darkgreen;" | cha last
 +
| style="font-family:open sans; font-size: 95%; vertical-align:top;" | ''Displays the last 10 comments on the channel.
 +
|-
 +
| width=10%; style="font-family:open sans; font-size: 95%; vertical-align:top; color:darkgreen;" | cha last <#>
 +
| style="font-family:open sans; font-size: 95%; vertical-align:top;" | ''Displays the last <#> comments.
 +
|-
 +
|}
 +
If a channel has no object/isn't set to log, you cannot use the 'last' command options on it.  The owner may @cset it to log up to 200 comments. TinyMUX hard caps it there.
 +
|-
 +
| width=10%; style="font-family:open sans; padding-left:15px; vertical-align:top;" | '''allcom'''
 +
| width=85%; style="font-family:open sans; font-size: 95%; vertical-align:top;" | The same as the commands above, except it allows you to use ON, OFF, or WHO on all channels you are watching.  This one is useful if you want to leave all channels at once during a scene to cut down on spam.
 +
|-
 +
|}
 +
 +
[[Category:System]]

Revision as of 04:57, 29 June 2020

Channel Cheat Sheet

For those players, new and old, who are unfamiliar with all of the many and varied commands and capabilities of channels in TinyMUX, this cheat sheet is designed to help.

What is a Channel?

Channels are a way for a group of people to chat together, without the chat being visible to anyone outside of that group. Channels can be customized in many ways, though as a general rule, the staff on most games don't allow players to do this.

In TinyMUX, channels are the "comsys", and are a default system included with the codebase.


To see the full explanation, type:

help comsys


To see a full list of commands for the comsys, you can type:

help comsys commands

(Reminder: the 'help' command covers TinyMUX defaults. The '+help' command covers code staff has written.)

How to Use Channels

Every channel has a name assigned by its creator.

This name is case sensitive. If the channel is named 'Public', none of the commands will work if you type 'public' instead.


Aliases

An alias is what you use to tell the system you are speaking on a particular channel. An alias should be short and easy to type, generally between 2-4 letters.

Aliases are also case sensitive!

Until you assign an alias, you can't see/speak on a channel. You may, however, have multiple aliases for the same channel. For example, if you constantly typo your 'cha' alias for the Changeling channel, you could use the addcom command again to make a 'ch' alias. You will see both aliases listed when you type comlist.

When you join a channel, you create an alias for it (e.g. addcom pub=Public, where 'pub' is your new alias to speak on Public).

Typing 'pub Hello!' would post '<Public> YourName says, "Hello!"' on the Public channel, and anyone who had the channel turned on would see it.


User Commands

Each of the commands listed below has a separate helpfile. See the 'help' file for them in game for more details, including command syntax.

@clist Displays a summary list of all channels you have access to.
comlist Lists all aliases/comtitles you have set up.
Also lists which channels you are currently on/off of.
comtitle Creates a title for you on the channel. On most channels, this is just for fun. If you 'comtitle cha=Grand Poobah' for the Changeling channel, any time you speak, it will show up as, <Changeling> Grand Poobah YourName says, "Something!"
Some channels are anonymous, so your name never shows up when you speak. Just your comtitle (if you have one). In that case, it would show up like: <Channel Header> Grand Poobah says, "Blorp!"
addcom Adds a new alias for a channel and joins it.
delcom Deletes an alias. If this was the only alias you had, this also effectively deletes the channel from your list, and removes any comtitle you had on that channel.
clearcom Deletes ALL aliases on ALL channels and ALL comtitles. Poof!
alias 'Alias' is not a command. It is a placeholder for your own alias for a channel. If you have 'cha' as your Changeling channel alias, you can do the following with it:
cha on Turns on the channel so you see its chatter.
cha off You stop seeing Changeling channel-spam.
cha who Lists who is on the channel, with comtitles.
cha Hello! Says "Hello!" on the channel.
cha :smiles. Emits "YourName smiles." on the channel.
cha ;'s nose. Emits "YourName's nose." on the channel.
cha last Displays the last 10 comments on the channel.
cha last <#> Displays the last <#> comments.

If a channel has no object/isn't set to log, you cannot use the 'last' command options on it. The owner may @cset it to log up to 200 comments. TinyMUX hard caps it there.

allcom The same as the commands above, except it allows you to use ON, OFF, or WHO on all channels you are watching. This one is useful if you want to leave all channels at once during a scene to cut down on spam.