/usr/share/doc/kildclient/html/ch13s03.xhtml is in kildclient-doc 3.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>13.3. Standard Plugins</title><link rel="stylesheet" type="text/css" href="docbook.css"/><link rel="stylesheet" type="text/css" href="kildclient.css"/><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/><link rel="prev" href="ch13s02.xhtml" title="13.2. Getting Information About Plugins"/><link rel="next" href="chap_logging.xhtml" title="Chapter 14. Logging the Output"/></head><body><header><div class="navheader"><table style="width: 100%; "><tr><th style="text-align: center; " colspan="3">13.3. Standard Plugins</th></tr><tr><td style="width: 20%; text-align: left; "><a accesskey="p" href="ch13s02.xhtml">Prev</a> </td><th style="width: 60%; text-align: center; ">Chapter 13. Plugins</th><td style="width: 20%; text-align: right; "> <a accesskey="n" href="chap_logging.xhtml">Next</a></td></tr></table><hr/></div></header><section class="sect1" id="idm2466"><div class="titlepage"><div><div><h2 class="title" style="clear: both">13.3. Standard Plugins</h2></div></div></div><p>KildClient comes with a few plugins as part of its distribution.
These plugins will be described here. You can load these plugins as
described above.</p><section class="sect2" id="sec_plugin_easypath"><div class="titlepage"><div><div><h3 class="title">13.3.1. easypath</h3></div></div></div><p>This plugin makes the use of paths (see <a class="xref" href="ch07s02.xhtml#sec_paths" title="7.2.1. Paths and Speed-Walking">Section 7.2.1, “Paths and Speed-Walking”</a>) easier. When this plugin is loaded, you can
type <strong class="userinput"><code>#2n3e{sw}</code></strong> instead of
<strong class="userinput"><code>/$world->path("2n3e{sw}")</code></strong>.</p></section><section class="sect2" id="sec_plugin_keypad"><div class="titlepage"><div><div><h3 class="title">13.3.2. keypad</h3></div></div></div><p>This plugin allows use of the keypad for movement. Pressing the
left arrow of the numeric keypad moves to the east, pressing the up
arrow moves to the north, and so on.</p><p>A few other keys of the keypad are also bound:
<span class="keysym">-</span> and <span class="keysym">+</span> represent down and up,
respectively. <span class="keysym">5</span> sends <code class="literal">who</code>,
<span class="keysym">0</span> sends <code class="literal">look</code>, <span class="keysym">/</span>
sends <code class="literal">inventory</code> and <span class="keysym">*</span> sends
<code class="literal">score</code>.</p><p>The <span class="keysym">Num Lock</span> key must be off for this plugin to
work.</p></section><section class="sect2" id="sec_plugin_notes"><div class="titlepage"><div><div><h3 class="title">13.3.3. notes</h3></div></div></div><p>This plugin allows you to assign notes to World. The notes are
saved with the World and are restored when it is opened again. You can
write anything you want, probably it will be something you want to
remember for that World.</p><p>This plugin requires the gtk3-perl bindings, because it has a
graphical user interface.</p><p>Type <strong class="userinput"><code>/notes::edit</code></strong> to open a window where
you can edit the notes. When you are finished, press the
<span class="guilabel">Close</span> button. The notes are saved
automatically.</p><p>Use the <code class="function">notes::clear</code> function to clear the
whole contents of the notes.</p><p>It is also possible to append something to the notes with
<code class="function">notes::append('text')</code>. This is probably more
useful in scripts.</p></section><section class="sect2" id="sec_plugin_kc256"><div class="titlepage"><div><div><h3 class="title">13.3.4. kc256</h3></div></div></div><p>This plugin demonstrates a useful extension to the 16 ansi
colors that KildClient supports. This is the same 256-color extension
supported by xterm (if it is complied with support for that).</p><p>With this extension, you can specify any color in a 6x6x6 RGB
color cube, that is, you have 216 rgb colors at your disposal, plus 24
shades of gray. (The remaining 16 colors are the standard ansi
colors.)</p><p>There are two functions in this sec_plugin_</p><p><code class="function">kc256::showcolors</code>: Displays all 216
available RGB colors and the 24 shades of grey in nice tables, with
the values that you can use in <a class="xref" href="func_colorize.xhtml" title="A.1. colorize"><code class="function">colorize</code></a> to access them.</p><p><code class="function">kc256::rainbowtext(<em class="parameter"><code>$string</code></em>)</code>:
Just a demonstration on how (not to) use the colors. Displays
<em class="parameter"><code>$string</code></em>, one character in a different
color.</p></section><section class="sect2" id="sec_plugin_channels"><div class="titlepage"><div><div><h3 class="title">13.3.5. channels</h3></div></div></div><p>Channels is a simple plugin to yank lines out of the world
window and put then in other windows. It's most obvious use is chat
channels, which usually have something
like <code class="literal">"[NAME]"</code> at the beginning.</p><p>Once the plugin is loaded, there is only one function to call:</p><p><code class="function">channels::new(<em class="parameter"><code>"name"</code></em>, <em class="parameter"><code>"regex"</code></em>);</code></p><p>where <em class="parameter"><code>"name"</code></em> is the name that should
appear in the title bar of the new window,
and <em class="parameter"><code>"regex"</code></em> is the pattern to match for text.
</p><p>Use <code class="function">channels::list()</code> for a list of
currently defined channels. To remove a channel, use
<code class="function">channel::del(<em class="parameter"><code>num</code></em>)</code>, where
num is the number of the channel.</p></section><section class="sect2" id="idm2536"><div class="titlepage"><div><div><h3 class="title">13.3.6. Other Plugins</h3></div></div></div><p>The <code class="literal">KCWin</code> plugin allows you to create general
purpose windows a terminal for output and an entry box for input.
These windows do nothing by themselves, but they can be used by other
plugins when they need a window for input and output.</p><p>Since this plugin is just a helper for other plugins, it is not
described here, but rather in <a class="xref" href="app_KCWin.xhtml" title="Appendix D. Using KCWin for Input/Output Windows">Appendix D, <em>Using KCWin for Input/Output
Windows</em></a>.</p><p>The <code class="literal">chat</code> plugin allows peer to peer chat with
other users of KildClient and of other clients that support the
MudMaster or zChat protocols. It is described in its own chapter,
<a class="xref" href="chap_chat.xhtml" title="Chapter 15. Using the Chat">Chapter 15, <em>Using the Chat</em></a>.</p><p>The <code class="literal">serverdatadumper</code> is a plugin to help
develop or debug plugins that use out-of-band server data. See
<a class="xref" href="chap_serverdata.xhtml" title="Chapter 16. Out-of-band server data">Chapter 16, <em>Out-of-band server data</em></a>.</p></section></section><footer><div class="navfooter"><hr/><table style="width: 100%; "><tr><td style="width: 40%; text-align: left; "><a accesskey="p" href="ch13s02.xhtml">Prev</a> </td><td style="width: 20%; text-align: center; "><a accesskey="u" href="chap_plugins.xhtml">Up</a></td><td style="width: 40%; text-align: right; "> <a accesskey="n" href="chap_logging.xhtml">Next</a></td></tr><tr><td style="width: 40%; text-align: left; vertical-align: top; ">13.2. Getting Information About Plugins </td><td style="width: 20%; text-align: center; "><a accesskey="h" href="index.xhtml">Home</a></td><td style="width: 40%; text-align: right; vertical-align: top; "> Chapter 14. Logging the Output</td></tr></table></div></footer></body></html>
|