Aardwolf Look and scan to miniwindows. (OLD)

This plugin has been replaced with http://www.gammon.com.au/forum/?id=9783






Look_Scan Plugin for Aardwolf
This plugin puts the Scan and Look command output from Aardwolf into miniwindows.

Features:
-Puts scan and look commands into miniwindows.
-Does a scan after each look command.
-Sets highlights for campaign mobs.
-Custom keywords highlight stored in SQLite database.
-Right click menu on characters and mobs in scan window.
-Copy character and mob keyword to clipboard (the keywords aren't always the right ones).

Command line:
scan - update scan window.
look - update look window.
sl <add / rem> <keywords> c:<colour> g:<group> - add keywords with colour and group
rlscan - reload plugin, use when you change the script file or it screws up
sl ? - show this help.

Macro keys:
ALT+s Show / Hide scan window.
ALT+l Show / Hide look window.

Install instructions:

If your using Inventory_window2.xml (http://www.gammon.com.au/forum/?id=9574) then you will need
upgrade this plugin following the instructions for upgrading.

1.
Download these from http://code.google.com/p/aardinvwin/:
Look_Scan.xml save to MUSH plugin directory (default: C:\Program Files\MUSHclient\worlds\plugins\)
aardsql.lua save to MUSH lua directory (default: C:\Program Files\MUSHclient\lua\)

2.
Then install Look_Scan.xml into MUSHclient using the File menu -> Plugins.
No windows will appear until you do look or scan command or just move you character however you will
see "Look_Scan.xml loaded" in the output.
http://www.gammon.com.au/forum/?id=9617

A database is created in the plugin directory (default) this can be changed by editing the aardsql.lua file.
change:
db_path = GetPluginInfo (GetPluginID(), 20) .. "\Aardwolfdb.db"

to:
db_path = [[c:\your directory]]


These options are required to be set with the MUD.
Commands:
tags EXITS on
tags ROOMDESCS on
tags ROOMNAMES on
tags ROOMCHARS on
tags ROOMOBJS on
The plugin has an option to switch these on and off when the script starts and stops (set SetTags = true below).
If you plan to enable and disable this plugin as needed and don't want to see the tags when this plugin in disabled
SetTags = true would be best, however if you plan to have this plugin running all the time SetTags = false. You can
switch off scanning after each look temporialy by clicking the minimize button or "ALT+s".


I recommend creating an alias to reload the script from the command line. This is useful if you are editing the settings
in the script file or if the script screws up. Reloading the script won't change setting unless you have edited the script.
I plan to add this alias via the script but for now you'll need to do it manually.
1.
Select and copy between the lines below.
2.
Open "Game -> Configure -> Aliases" or "CTRL+SHIFT+9" menu.
3.
Click the paste button.

--cut--
<aliases>
<alias
match="rlscan"
enabled="y"
send_to="12"
sequence="100"
>
<send>
if ReloadPlugin ("73766b7b4dfab1cd1ce9494d") == error_code.eNoSuchPlugin then
check (LoadPlugin ("/program files/mushclient/worlds/plugins/Look_Scan.xml"))
end
</send>
</alias>
</aliases>
--cut--

Full cut and paste aliases, triggers and timers instructions can be found here:
http://www.gammon.com.au/forum/?id=4777


To change the look and behaviour of the plugin open the Look_Scan.xml file
and edit the options below. An editor like Crimson Editor can be configured to display MUSH xml
files with colours making editing MUCH easier.
http://www.gammon.com.au/forum/bbshowpost.php?bbsubject_id=8692

You can find the options below starting at line 269 of Look_Scan.xml, make a backup of
these settings because tests are not done for unreasonable values.

FontName = GetInfo(20) -- Font for window, i.e. "Times New Roman", GetInfo(20) is current window font.
BackgroundColour = GetInfo (271) -- Background colour for window. Supports Lua codes and MUSH colour names
-- i.e. "2432272" or "black" or GetInfo(271) can be used, last one is your current window colour.
TitleColour = "lime" -- Colour of title text. Supports Lua codes and MUSH colour names
BannerColour = "925008" -- Title Banner colour. Supports Lua codes and MUSH colour names.
ButtonColour = "white" -- Button body colour. Supports Lua codes and MUSH colour names.
ButtonBorderColour = "black" -- Button border colour. Supports Lua codes and MUSH colour names.
BorderColour = "white" -- Window border colour. Supports Lua codes and MUSH colour names.
CampaignColour = "lime" -- Colour for campaign mob highlights. Supports Lua codes and MUSH colour names.
LFontSize = 8 -- Window font size.
FontName = GetInfo(20) -- Font for window, i.e. "Times New Roman", GetInfo(20) is current window font.
BorderWidth = 1 -- Line thickness borders.
ButtonGap = 5 -- Space between buttons.
LineSpace = 3 -- Space in points between lines of text.
OffSet = BorderWidth + 4 -- Objects offset from window edge.
ShowBorders = true -- "true" = Draw borders, "false" = Don't draw borders
ShowWelcome = true -- Show "plugin installed" msg when plugin enabled.
ScanAfterCombat = true -- Will send scan to MUD after you recieve experience
EchoCharObjs = true -- "true" = show objects and characters in display
-- "false" = only display objects and characters in miniwindow
EchoDesc = true -- "true" = show room descriptions in display
-- "false" = only display room descriptions in miniwindow
EchoName = true -- "true" = show room names in display
-- "false" = only display room names in miniwindow
ShowRoomSep = true -- "true" = will print "[-]" after look output is finished
-- "false = won't print anything
LookSpace = true -- "true" = print a blank line after look
-- "false" = no line printed after look
dbmsgs = false -- Toggle SQL msgs from db, can be toggled from cmd line. Used for testing.
SetTags = false -- "true" = will turn tags for look command on and off
-- "false" = won't set the tags, once tags are set at the MUD false is faster
-- if false is used ensure these commands are run once "tags" command will show their state:
-- tags EXITS on
-- tags ROOMDESCS on
-- tags ROOMNAMES on
-- tags ROOMCHARS on
-- tags ROOMOBJS on

Bump.

Added whois to database and made a popup showing the whois from the db
on the scan window.

This is a nice plugin. I turned off the whois function mainly because I didn't use it much, but is there a way to do a left click, customizable action (like in your consider mini window)? I wanted it to default to backstab.

Yeah the whois display never really had a use and is *really* badly written, but I thought it was cool.

I added a couple of options to the script to do what you needed.


I posted it here:
http://code.google.com/p/aardinvwin/

I also added an OnPluginBroadcast to this plugin because I found the command line I did very clumsy.

What it does is enable other plugins to to turn look and scan on and off.
After installing the plugin below:

"town" is off and "explore" is on.

To get another plugin to turn it on use:

To turn it off from with in a plugin use:

To make a macro to enable it use (the "/" is the script prefix set on the script dialog):

To make an alias use it just set the the alias to execute and use:



The reason for the separate plugin is this will be used to turn on and off all my plugins as I update them.

I have a macro to turn it on and off and I turn it off at the beginning of my speedwalk alias.

Hey, I love this plugin, but trying to figure out a few things:

1. How do i get this to work with quests and gquests? I tried adding additional triggers off of the quest and gquest match strings still referencing the original alias for adding mobs to cp list, but it doesn't seem to do anything. Do i need to change anything else?

2. How do i build in a way to see which keywords belong in certain lists in order to remove them? for example, if one of my characters is in a campaign but the other is not, there's currently no way for me to remove all cp keywords, mobs still come up randomly in red

Thanks much in advance, Great job on this plugin by the way!!

I'm so confused... How does the script below know which is the correct mob to remove from the database...??? if you look at the database portion of the code all it does is remove all entries with Cgr = "campaign" if you kill ANY campaign mobs... yet somehow it works. Am i missing something here?

--adds the campaign mobs to the keywords table
function campaignTrigger (name, line, wildcards)

if wildcards[1] == "false" or wildcards[1] == nil then
return
end

if wildcards[1] == "Congratulations" then
KeywordColour ("rem", "", "", "campaign")
end

sAct = "add"
sKey = wildcards[1]:lower():match("^(.*) %(.+%)$")
sCol = CampaignColour
sCgr = "campaign"
KeywordColour (sAct, sKey, sCol, sCgr)

end --campaignTigger

I've never been happy with this script it does too many things and all of them poorly.

Having read your post I think a script to handle the scan window with keywords is probably the way to go. I'll post a link to it here when it's done.

Ok, I've re-written it. I removed all the look and whois stuff and made an easier command line for adding and removing keywords. All the database functions are in the plugin so it's stand alone.

You'll have to make your own triggers for global quests but hopefully it'll be simple now.

Post any questions or suggestions on the new plugins thread.