Communication log window - fiendish/aardwolfclientpackage GitHub Wiki

This plugin captures channels and other bits of information to a floating miniwindow so that you can follow conversations more easily.

It should look something like this:

There are many different right-click options.

If any text inside the log window is selected, this text will be copied to the clipboard either with or without Aardwolf color codes inserted. More on selecting later.

Copies the entire capture buffer to the clipboard. This is like Copy Selected but grabs everything instead of just the selected text.

Changes the display font.

You'll notice in the above example image that captured messages are marked with the date and time. You can change the format of this timestamp, or disable it, by choosing one of the options in this sub-menu.

By default all channels are captured to the communication log window. You can use this option to change which channels get captured and which ones don't. In the following example, all channels except for auction and debate are being captured:

Some informational messages on Aardwolf do not present themselves in the form of channels with GMCP data. Other things may be annoying under certain circumstances. Control of those bits go here.

INFO:, Global Quest:, and Remort Auction: can be optionally captured by enabling or disabling the right options. If you are in a clan with members who all have gold donation triggers, you might also desire to specifically disable the capturing of clan donation messages.

By default, all lines that get captured to the communication log window also get shown in the main output. Use this submenu if you want to change that.

The channel capture plugin has the ability to record a log of all captured messages to a text file in the MUSHclient\logs folder.

If the Remove Timestamps option is not enabled, your chosen timestamp will be included in the log.

If the Remove Color Codes option is not enabled, the log will include Aardwolf color codes in colored text.

Aside from the standard resizing (drag the bottom-right corner) and moving (drag the title bar), there are a few other things you can do.

Right-clicking on a captured URL presents two new menu options, "Go to URL" or "Browse URL" depending on which version you have (which will launch your default web browser) and "Copy URL to Clipboard".

You can scroll up and down inside the channel capture window by any of the following methods:

• mouse-wheel scrolling with the cursor placed inside the miniwindow
• clicking on the up/down arrows at the top-right and bottom-right of the miniwindow
• dragging the miniwindow's scrollbar shuttle

The channel capture miniwindow, through the magic of awesomeness, supports selecting arbitrary bits of text with the mouse. Just select it as you would select text anywhere else. After you have text selected, you can copy the selection to the clipboard with or without Aardwolf color codes via the right-click menu.

There is a function in the plugin called storeFromOutside that makes it easy to log arbitrary lines of colored text in the communication log window. You use it via the CallPlugin() access function (examples below).

storeFromOutside takes four arguments:

1. the message you want to store in Aardwolf color code format
2. (optional) the tab name or number to store it in
3. (optional) true/false for controlling whether to timestamp the line (defaults to true if nil)
4. (optional) true/false for whether to omit the line from the log file (defaults to false if nil)

For documentation on CallPlugin(), see http://mushclient.com/scripts/doc.php?function=CallPlugin

Examples:

-- use tab 1, add a timestamp, and log the message to file
CallPlugin("b555825a4a5700c35fa80780","storeFromOutside","HELLO@RHello@Mhello@x215hello@x66HELLO")
-- use tab "My Echos", don't add a timestamp, and log the message to file
CallPlugin("b555825a4a5700c35fa80780","storeFromOutside","HELLO@RHello@Mhello@x215hello@x66HELLO", "My Echos", false)
-- use tab 3, add a timestamp, and do not log the message to file
CallPlugin("b555825a4a5700c35fa80780","storeFromOutside","HELLO@RHello@Mhello@x215hello@x66HELLO", 3, true, true)

To get Aardwolf color codes from a table of MUSHclient styles, see the function StylesToColours(styles_table) in aardwolf_colors.lua.

The log window supports multiple tabs, each with its own name and own set of captures. To create a new tab, right-click on the log window and choose "Add New Tab". That will create a new numbered tab. You can then set the tab's name and customize its captures in the right-click menu.

If you want to have multiple whole windows, you should take the following steps:

1. Go into your plugins folder and find aard_channels_fiendish.xml
2. Make a duplicate of that file (copy/paste) in the same folder. Give the duplicate any name you want, as long as the new file keeps the same .xml file type.
   
   
3. In MUSHclient, go to the Edit menu and select "Generate Unique ID..."
   
   
4. Copy the number in the small window that pops up and then click Close.
   
   
5. Open the duplicate file you just made in a text editor like Notepad and find the bit near the top of the file that says id="b555825a4a5700c35fa80780"
   
   
6. Replace the id string with the new one generated above.
   
   
7. Save and close the file.
8. Load your newly modified plugin into MUSHclient. If you don't know how, see FAQ#how-do-i-load-new-plugins.
9. You should now have another Communication Log window. Make sure to customize them (see the Customize Channels and Capture Other Info sections above) so that they don't capture the same channels.