view release on metacpan or  search on metacpan

share/docs/guide/ch11.html  view on Meta::CPAN

<li>This page lists sentient beings. Non-sentient creatures are added in <strong>Page 2</strong></li>
</ul>
</li>
<li>In the box labelled <strong>Word</strong>, add <strong>Slartibartfast</strong></li>
<li>Click the <strong>Add</strong> button, then the <strong>OK</strong> button at the bottom of the window</li>
</ul>
<h2><a name="11.6">11.6 The Channels and Divert tasks</a></h2>
<p>The Channels and Divert tasks intercept text that would normally be displayed in the main window, and redirect that text into the task's own windows.</p>
<p>To use either task, you must tell Axmud what text you want to intercept.</p>
<p>If you're using a pre-configured world, Axmud already knows how to intercept some common messages.  Axmud also knows how to separate those messages into channels - one channel for chat messages, another channel for tell messages, and so on.</p>
<h3><a name="11.6.1">11.6.1 Adding channel patterns</a></h3>
<p>Patterns can be added using a client command (see the help for <strong>;addchannelpattern</strong>) but in general it's easier to add patterns in the world's edit window.</p>
<p>Suppose we want to intercept all shout messages like this:</p>
<pre><code>   Bilbo shouts, 'I'm the greatest!'
</code></pre>
<p>...and to redirect the text into a channel called <strong>boasting</strong>. This is how to do it.</p>
<ul>
<li>Open the edit window with the <strong>;editworld</strong> command</li>
<li>Click on <strong>Channels &gt; Page 1</strong> tab</li>
<li>Enter a pattern like <strong>shouts</strong><ul>
<li>A better pattern would be <strong>^\w+ shouts,</strong></li>
</ul>
</li>
<li>Enter the channel name <strong>boasting</strong></li>
<li>If you want the message to appear only in the task window, and not the main window too, check the box</li>
<li>Click the <strong>Add</strong> button</li>
<li>The change is applied to any Channels/Divert tasks as soon as you click the <strong>Save</strong> or <strong>OK</strong> buttons</li>
</ul>
<p>You might want to see messages like <strong>Gandalf tells you...</strong> and <strong>Bilbo tells you...</strong>, but not <strong>The shopkeeper tells you...</strong></p>
<p>For this, you can specify <em>ignore patterns</em>. When some text is received from the world, if it matches a channel pattern AND an ignore pattern, it isn't redirected to the task window.</p>
<ul>
<li>Open the edit window with the <strong>;editworld</strong> command</li>
<li>Click on the <strong>Channels &gt; Page 1</strong> tab</li>
<li>Add the channel pattern <strong>tells you</strong>, as described above</li>
<li>Now click on <strong>Page 2</strong></li>
<li>Add the ignore pattern <strong>shopkeeper tells you</strong></li>
<li>The changes are applied to any Channels/Divert tasks as soon as you click the <strong>Save</strong> or <strong>OK</strong> buttons</li>
</ul>
<h3><a name="11.6.2">11.6.2 The Channels task</a></h3>
<p><img alt="Channels task window" src="img/ch11/channels_task.png"></p>
<p>The Channels task is fairly self-explanatory.  When it first starts, tabs for three channels are created.  If you've specified any more channels, extra tabs are added as soon as they are needed.</p>
<p>You can modify some aspects of the task's behaviour.</p>
<ul>
<li>Open the task's edit window with the <strong>;edittask channels</strong> command</li>
<li>Click on the <strong>Parameters - Page 1</strong> tab</li>
<li>In the <strong>Summary tab</strong> section, click the 'multi' button</li>
<li>In the <strong>Display options</strong> section, click the button <strong>Tabs in the task window have a close button</strong></li>
<li>Now click on <strong>Page 2</strong></li>
<li>Modify the initial channel list</li>
<li>When you're ready, click the <strong>Save</strong> or <strong>OK</strong> buttons</li>
<li>Reset the task to apply your changes, using <strong>;resettask channels</strong></li>
</ul>
<p>That will modify the current task; in <a href="ch12.html">Section 12</a>, we'll discuss how to make those changes permanent.</p>
<p><img alt="Channels task window" src="img/ch11/channels_task_2.png"></p>
<h3><a name="11.6.3">11.6.3 The Divert task</a></h3>
<p>The Divert task is the (much) older brother of the Channels task.</p>
<p>Divert task windows doesn't have multiple tabs; instead, when some text is intercepted, the background colour changes temporarily.  In this case, it has turned yellow signifying that the text is in the <strong>tell</strong> channel.</p>
<p><img alt="Divert task window" src="img/ch11/divert_task.png"></p>
<p>Traditionally, the Divert task used just four channels - one for <strong>social</strong> messages, one for <strong>tell</strong> messages, a <strong>warning</strong> channel and a <strong>custom</strong> channel for everything else.</p>
<p>The task can now use any channel.  The four channels above each have their own colour; any other channel you might create is displayed using a fifth colour (magenta by default).</p>
<p>For your convenience, the window provides a command entry box. Any type of instruction, including client commands and speedwalk commands, can be typed in this box. This is useful if you're connected to a world, but busy doing something else; as lo...
<p>If you're connected to several worlds at the same time, you might also find the Watch task useful. Everything displayed in Channels, Chat and Divert task windows, in any session, is copied into any Watch task window that's open.</p>
<h2><a name="11.7">11.7 The Chat task</a></h2>
<p>The Chat task is an instant messenger service. It is an almost complete implementation of the MudMaster and zChat protocols (only encryption has not yet been implemented).</p>
<p>Several popular MUD clients implement these protocols, so your friends don't need to be using Axmud; they only need to be using a compatible MUD client.</p>
<p>There are some issues of security to consider, so we recommend you read the whole of this Section before using the task.</p>
<p>You can get started by listening out for incoming calls.</p>
<pre><code>    ;chatlisten
    ;listen
</code></pre>
<p>When you receive an incoming call, you can either accept or decline it.</p>
<p><img alt="Incoming chat popup" src="img/ch11/incoming_chat.png"></p>
<p>For outgoing calls you'll need to know your friend's IP address and the port they're using for chat sessions.</p>
<p>Calls can be made with either protocol. The zChat protocol is slightly more powerful, so let's use that.</p>
<pre><code>    ;chatzcall 159.200.36.251 4050
    ;zcall 159.200.36.251 4050
</code></pre>
<p>Most MUD clients use the port 4050, so it's normally safe to omit it.</p>
<pre><code>    ;chatzcall 159.200.36.251
    ;zcall 159.200.36.251
</code></pre>
<p>You can also call someone using the main window menu.</p>
<ul>
<li>To listen for incoming calls, click on <strong>Tasks &gt; Chat task &gt; Listen for incoming calls</strong></li>
<li>To make an outgoing call, click on <strong>Tasks &gt; Chat task &gt; Chat using zChat...</strong></li>
</ul>
<h3><a name="11.7.1">11.7.1 Chat task commands</a></h3>
<p>Once a connection is established, a task window will appear.</p>
<p><img alt="Chat task window" src="img/ch11/chat_task.png"></p>
<p>There are about thirty client commands used with the Chat task, all of which are typed in the main window. For a list of them, type:</p>
<pre><code>    ;taskhelp chat
    ;th chat
</code></pre>
<p>There is a <em>separate</em> list of commands used in the task's own window. All of these commands begin with the usual semicolon ( ; ) character. To see this list, type <strong>;help</strong> in the task window.</p>
<h3><a name="11.7.2">11.7.2 Chatting and emoting</a></h3>
<p>To chat with someone, just type into the window.</p>
<p><img alt="Chat task window" src="img/ch11/chat_task_2.png"></p>
<p>You can also send emotes. In the main window, you would type:</p>
<pre><code>    ;emote grins
</code></pre>
<p>In the task window, any command that starts with a colon ( : ) is also treated as an emote:</p>
<pre><code>    :grins
</code></pre>
<p>In either case, if Bob grinned at you, you would see something like this:</p>
<p><img alt="Chat task window" src="img/ch11/chat_task_3.png"></p>
<p>To hang up, just close the window. Alternatively, use the following command in the main window, which will hang up on everyone:</p>
<pre><code>    ;chathangup
    ;chu
</code></pre>
<h3><a name="11.7.3">11.7.3 Chat contacts</a></h3>
<p>It would be rather inconvenient to type an IP address like <strong>159.200.36.251</strong> every time you wanted to chat with a friend.  Luckily, Axmud allows you to save your chat contacts so they're available at a click of a button.</p>
<ul>
<li>In the main window menu, click <strong>Edit &gt; Axmud preferences</strong></li>
<li>When the preference window opens, click <strong>Chat &gt; Page 4</strong></li>
<li>Add your friend's name, IP address and port, and click the <strong>Add</strong> button</li>
</ul>
<p>On <strong>Page 3</strong> of the same edit window you can choose the name, email address and icon which are sent to your friends, whenever you open a chat session with them.</p>
<ul>
<li>If you don't specify a name here, the current character's name is used</li>
<li>Axmud provides several hundred icons to choose from.<ul>
<li>Cycle through them with the <strong>&lt;&lt;</strong> and <strong>&gt;&gt;</strong> buttons</li>