Merge branch 'development' into MUSHclient

MUSHclient/AardwolfPackageChanges.txt

@@ -1,5 +1,9 @@
 Aardwolf Client Package Major Changes List
 
+r1940 snapshot
+- new feature: We're testing out a new second installer for VI players that bypasses purely visual plugins that might interfere with screen readers and also loads (hopefully) text to speech by default.
+- misc change: The inventory serials plugin will no longer be active by default. It will still be loaded and will inform the player of its existence until the player looks at it.
+
 r1938 snapshot
 - bug fix: Don't only lock miniwindow positions (when using aard layout lock) if they have a preprocessor function defined.
 

MUSHclient/worlds/Aardwolf_no_visuals.mcl

@@ -477,6 +477,7 @@ ColourNote ("white", "green", "Added trigger to match on '%1', sending '%2'")
 <include name="aard_text_substitution.xml" plugin="y" />
 <include name="aard_prompt_fixer.xml" plugin="y" />
 <include name="aard_chat_echo.xml" plugin="y" />
+<include name="aard_VI_command_output.xml" plugin="y" />
 <include name="aard_GMCP_handler.xml" plugin="y" />
 <include name="aard_miniwindow_z_order_monitor.xml" plugin="y" />
 <include name="aard_Copy_Colour_Codes.xml" plugin="y" />
@@ -486,4 +487,5 @@ ColourNote ("white", "green", "Added trigger to match on '%1', sending '%2'")
 <include name="aard_GMCP_mapper.xml" plugin="y" />
 <include name="aard_package_update_checker.xml" plugin="y" />
 <include name="universal_text_to_speech.xml" plugin="y" />
+<include name="aard_new_connection_no_UI.xml" plugin="y" />
 </muclient>

MUSHclient/worlds/plugins/aard_VI_command_output.xml

@@ -3,11 +3,11 @@
 
 <muclient>
 <plugin
-   name="Aardwolf_VI_Command_Output"
+   name="Aardwolf_Commands_To_Notepad"
    author="Fiendish"
    id="fefc7923b4db9e0ee3add286"
    language="Lua"
-   purpose="Captures output from game commands"
+   purpose="Captures output from game commands and sends it to a MUSHclient notepad."
    date_written="2016-02-14"
    requires="4.70"
    version="1.0"
@@ -29,25 +29,6 @@
    ignore_case="y"
 >
 </alias>
-
-<alias
-   match="^mc buffer capture$"
-   enabled="y"
-   regexp="y"
-   sequence="100"
-   ignore_case="y"
-   send_to="12"
->
-<send>
-Note("MC buffer capture command not yet ready to use.")
---  use_notepad = not use_notepad
---  SetVariable("use_notepad", use_notepad and "1" or "0")
---  if not use_notepad then
---     do_plugin_check_now("dd10517422bc35b5131a3a0", "VI_captures")
---  end
---  Note("MC command captures will be sent to a "..(use_notepad and "notepad tab" or "capture buffer")..".")
-</send>
-</alias>
 </aliases>
 
 <triggers>
@@ -132,7 +113,6 @@ end
 
 require "checkplugin"
 function OnPluginListChanged()
-   -- check we have necessary plugins
    -- do_plugin_check_now("dd10517422bc35b5131a3aa0", "VI_captures")
 end
 
@@ -195,7 +175,7 @@ function end_capture(name, line, wildcards, styles)
          table.insert(temp_buffer, {msg="Failed to capture any MUD output. Are you sure this command goes to the MUD?", date=nil})
       end
 
-      if use_notepad then
+      -- if use_notepad then
          local full_capture_string = ""
          for i,v in ipairs(temp_buffer) do
             full_capture_string = full_capture_string..v.msg.."\r\n"
@@ -205,20 +185,20 @@ function end_capture(name, line, wildcards, styles)
          NotepadSaveMethod(command_capture, 2)
          NotepadReadOnly(command_capture, true)
          ActivateNotepad(command_capture)
-      else
-         CallPlugin("dd10517422bc35b5131a3aa0", "remove_capture_internal", command_capture, true)
-         CallPlugin("dd10517422bc35b5131a3aa0", "add_capture_if_new", command_capture, false, true, nil, false)
-         CallPlugin("dd10517422bc35b5131a3aa0", "switch_to_capture", command_capture, true)
-         CallPlugin("dd10517422bc35b5131a3aa0", "clear_capture", true)
-         CallPlugin("dd10517422bc35b5131a3aa0", "stamp_and_store", command_capture, "Captured output for command ["..last_command.."].")
-
-         for i,v in ipairs(temp_buffer) do
-            CallPlugin("dd10517422bc35b5131a3aa0", "stamp_and_store", command_capture, v.msg, v.date and aardwolf_channel_datestring_to_timestamp(v.date) or nil)
-         end
-
-         CallPlugin("dd10517422bc35b5131a3aa0", "show", "Captured output from command ["..last_command.."] to ["..command_capture.."] capture.")
-         CallPlugin("dd10517422bc35b5131a3aa0", "switch_to_capture", command_capture)
-      end
+      -- else
+      --    CallPlugin("dd10517422bc35b5131a3aa0", "remove_capture_internal", command_capture, true)
+      --    CallPlugin("dd10517422bc35b5131a3aa0", "add_capture_if_new", command_capture, false, true, nil, false)
+      --    CallPlugin("dd10517422bc35b5131a3aa0", "switch_to_capture", command_capture, true)
+      --    CallPlugin("dd10517422bc35b5131a3aa0", "clear_capture", true)
+      --    CallPlugin("dd10517422bc35b5131a3aa0", "stamp_and_store", command_capture, "Captured output for command ["..last_command.."].")
+
+      --    for i,v in ipairs(temp_buffer) do
+      --       CallPlugin("dd10517422bc35b5131a3aa0", "stamp_and_store", command_capture, v.msg, v.date and aardwolf_channel_datestring_to_timestamp(v.date) or nil)
+      --    end
+
+      --    CallPlugin("dd10517422bc35b5131a3aa0", "show", "Captured output from command ["..last_command.."] to ["..command_capture.."] capture.")
+      --    CallPlugin("dd10517422bc35b5131a3aa0", "switch_to_capture", command_capture)
+      -- end
 
       temp_buffer = {}
       last_command = ""

MUSHclient/worlds/plugins/aard_inventory_serials.xml

@@ -198,14 +198,18 @@ Makes inventory command slightly more useful by displaying item serial numbers
    group="commands"
 >
 <send>
-   inv_sent_count = inv_sent_count + 1
-   key_sent_count = key_sent_count + 1
-   EnableTrigger("start_key", true)
-   EnableTrigger("start_inv", true)
-   SendNoEcho("keyring data")
-   SendNoEcho("invdata")
-   if manually_requested then
-      EnableAliasGroup("commands", false)
+   if not manually_requested and not visible_always then
+      SendNoEcho("%0")
+      if show_hint then
+         hint_message()
+      end
+   else
+      inv_sent_count = inv_sent_count + 1
+      key_sent_count = key_sent_count + 1
+      EnableTrigger("start_key", true)
+      EnableTrigger("start_inv", true)
+      SendNoEcho("keyring data")
+      SendNoEcho("invdata")
    end
 </send>
 </alias>
@@ -220,11 +224,15 @@ Makes inventory command slightly more useful by displaying item serial numbers
    group="commands"
 >
 <send>
-   key_sent_count = key_sent_count + 1
-   EnableTrigger("start_key", true)
-   SendNoEcho("keyring data")
-   if manually_requested then
-      EnableAliasGroup("commands", false)
+   if not manually_requested and not visible_always then
+      SendNoEcho("%0")
+      if show_hint then
+         hint_message()
+      end
+   else
+      key_sent_count = key_sent_count + 1
+      EnableTrigger("start_key", true)
+      SendNoEcho("keyring data")
    end
 </send>
 </alias>
@@ -239,17 +247,21 @@ Makes inventory command slightly more useful by displaying item serial numbers
    group="commands"
 >
 <send>
-   vault_sent_count = vault_sent_count + 1
-   EnableTrigger("start_vault", true)
-   SendNoEcho("vault data")
-   if manually_requested then
-      EnableAliasGroup("commands", false)
+   if not manually_requested and not visible_always then
+      SendNoEcho("%0")
+      if show_hint then
+         hint_message()
+      end
+   else
+      vault_sent_count = vault_sent_count + 1
+      EnableTrigger("start_vault", true)
+      SendNoEcho("vault data")
    end
 </send>
 </alias>
 
 <alias
-   match="^((i|in|inv|inve|inven|invent|invento|inventor|inventory)|(keyr(i|in|ing)? l(i|is|ist)?)|(vau(l|lt)? l(i|is|ist)?)) serials( help| off| on)?$"
+   match="^((i|in|inv|inve|inven|invent|invento|inventor|inventory)|(keyr(i|in|ing)? l(i|is|ist)?)|(vau(l|lt)? l(i|is|ist)?)) serials( help| off| on| hint clear)?$"
    regexp="y"
    enabled="y"
    sequence="100"
@@ -261,7 +273,8 @@ Makes inventory command slightly more useful by displaying item serial numbers
 <script>
 <![CDATA[
 
-visible_always = tonumber(GetVariable("visible_always")) ~= 0  -- default true
+visible_always = tonumber(GetVariable("visible_always")) ~= 1  -- default false
+show_hint = tonumber(GetVariable("show_hint")) ~= 0 -- default true
 manually_requested = false
 
 function OnPluginListChanged()
@@ -272,28 +285,44 @@ function OnPluginInstall()
    if IsConnected() then
       OnPluginConnect()
    end
-   EnableAliasGroup("commands", visible_always)
+end
+
+function hint_message()
+   Note("")
+   Note("The Aardwolf MUSHclient Package includes a plugin for displaying object serial numbers in your inventory.")
+   Note("The information can give you more precise control over which items you give/drop/wear/etc.")
+   ColourNote("", "", "To learn more about object serial numbers, type '", "yellow", "", "help ObjectId", "", "", "'.")
+   Note("")
+   ColourNote("", "", "To review the commands for this plugin and stop seeing this informational message, type '", "yellow", "", "inventory serials help", "", "", "'.")
 end
 
 function show_help()
-   Note("--------------------------------------")
+   Note("")
    Note("Aardwolf Inventory Serials Plugin Help")
    Note("--------------------------------------")
    Note("")
    Note("Command syntax:")
-   ColourNote("yellow", "", ">", "", "","  inventory serials <on/off>")
-   Note("      - Show or don't show item serial numbers by default when viewing inventory")
-   ColourNote("yellow", "", ">", "", "","  (inventory|keyring list|vault list) serials")
-   Note("      - Request the display of item serial numbers once")
-
+   Note("")
+   ColourNote("yellow", "", "   inventory serials <on/off>")
+   Note("        Whether to always automatically include item serial numbers when listing inventory.")
+   Note("")
+   ColourNote("yellow", "", "   inventory serials")
+   ColourNote("yellow", "", "   keyring list serials")
+   ColourNote("yellow", "", "   vault list serials")
+   Note("        Request the display of item serial numbers once.")
+   Note("")
+   ColourNote("yellow", "", "   inventory serials help")
+   Note("        Print this help.")
    Note("")
    Note("Current status:")
-   Tell("Item serial numbers always shown by default? ")
-   ColourNote(visible_always and "lime" or "red", "", visible_always and "[YES]" or "[NO]")
+   Tell("Always include item serial numbers when listing inventory? ")
+   ColourNote(visible_always and "lime" or "red", "", visible_always and "Yes" or "No")
+   Note("--------------------------------------")
    Note("")
 end
 
 function serials_command(name, line, wildcards)
+   -- wildcard indices:
    -- 1 is full command minus the serials bit
    -- 2 is inv
    -- 3 is keyring
@@ -306,21 +335,23 @@ function serials_command(name, line, wildcards)
       else
          manually_requested = true
       end
-      EnableAliasGroup("commands", true)
       Execute(wildcards[1])
       manually_requested = false
    elseif cmd == "off" and wildcards[2] ~= "" then
-      ColourNote("","","Inventory, vault list, and keyring list ","red","","[will not]","",""," display item serial numbers unless specifically requested (For help, type 'inventory serials help').")
+      ColourNote("","","Inventory, vault list, and keyring list ","red","","[will not]","",""," display item serial numbers now unless specifically requested. (For help, type ","yellow", "", "'inventory serials help'","","",")")
       visible_always = false
       SetVariable("visible_always", 0)
-      EnableAliasGroup("commands", false)
    elseif cmd == "on" and wildcards[2] ~= "" then
-      ColourNote("","","Inventory, vault list, and keyring list ","lime","","[will]","",""," always display item serial numbers.")
+      ColourNote("","","Inventory, vault list, and keyring list ","lime","","[will]","",""," now always display item serial numbers. (For help, type ","yellow", "", "'inventory serials help'","","",")")
       visible_always = true
       SetVariable("visible_always", 1)
-      EnableAliasGroup("commands", true)
    elseif cmd == "help" then
       show_help()
+      show_hint = false
+      SetVariable("show_hint", 0)
+   elseif cmd == "hint clear" then
+      show_hint = false
+      SetVariable("show_hint", 0)
    end
 end
 

MUSHclient/worlds/plugins/aard_new_connection_no_UI.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE muclient>
+
+<muclient>
+<plugin
+   name="Aardwolf_New_Connection_No_UI"
+   author="Fiendish"
+   id="9f796334ab9ed476ef44f1dc"
+   language="Lua"
+   purpose="Welcome players to the new client package"
+   date_written="2010-11-22 18:32:06"
+   requires="4.73"
+   version="1.0"
+   save_state="y"
+>
+</plugin>
+<script>
+<![CDATA[
+
+function OnPluginInstall()
+   Note("Welcome to the Aardwolf MUSHclient Package.")
+   Note("Please send all client feedback to Fiendish in the game.")
+end
+
+loaded = false
+function OnPluginListChanged()
+   dofile "lua/aard_requirements.lua"
+   if not loaded then
+      Connect()
+   end
+   loaded = true
+end
+
+]]>
+</script>
+</muclient>

MUSHclient/worlds/plugins/universal_text_to_speech.xml

@@ -238,7 +238,7 @@ AcceleratorTo("Ctrl+6", "CallPlugin('"..GetPluginID().."', 'playback', 6)", send
 AcceleratorTo("Ctrl+7", "CallPlugin('"..GetPluginID().."', 'playback', 7)", sendto.script)
 AcceleratorTo("Ctrl+8", "CallPlugin('"..GetPluginID().."', 'playback', 8)", sendto.script)
 AcceleratorTo("Ctrl+9", "CallPlugin('"..GetPluginID().."', 'playback', 9)", sendto.script)
-AcceleratorTo("Ctrl+0", "CallPlugin('"..GetPluginID().."', 'playback', 0)", sendto.script)
+AcceleratorTo("Ctrl+0", "CallPlugin('"..GetPluginID().."', 'playback', 10)", sendto.script)
 
 
 function do_filtering(msg)
@@ -387,7 +387,7 @@ function OnPluginInstall()
       sapi_fallback()
    else
       local reader = widestr_to_luastr(tolk_api.Tolk_DetectScreenReader())
-      say("You are using "..reader.." text to speech.", true)
+      say("The universal T T S plug-in is now using "..reader.." speech.", true)
    end
 end