Added Lua_Sapi plugin to distribution

Author: nickgammon

install/mushclient.nsi

@@ -421,6 +421,8 @@ Section "Plugins"
   File "..\plugins\ATCP_Mapper.xml"
   File "..\plugins\Messages_Window.xml"
   File "..\plugins\Calculator.xml"
+  File "..\plugins\Lua_Sapi.xml"
+
 
 SectionEnd
 
@@ -610,6 +612,7 @@ Section Uninstall
   Delete "$INSTDIR\worlds\plugins\ATCP_Mapper.xml"  
   Delete "$INSTDIR\worlds\plugins\Messages_Window.xml"
   Delete "$INSTDIR\worlds\plugins\Calculator.xml"
+  Delete "$INSTDIR\worlds\plugins\Lua_Sapi.xml"
 
   ; locale stuff
 

plugins/Lua_Sapi.xml

@@ -0,0 +1,144 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE muclient>
+
+<muclient>
+<plugin
+   name="Sapi_speaker"
+   author="Nick Gammon"
+   id="463242566069ebfd1b379ec1"
+   language="Lua"
+   purpose="Speaks incoming text using SAPI."
+   date_written="2010-09-01"
+   requires="3.45"
+   version="1.0"
+   >
+   
+<description trim="y">
+Type:
+
+ sapi on    --> turn on speaking (the default)
+ sapi off   --> turn off speaking of MUD output
+ sapi skip  --> skips one sentence in output stream
+
+Other scripts can speak stuff by doing:
+
+  CallPlugin ("463242566069ebfd1b379ec1", "say", "What to say")
+
+</description>
+</plugin>
+
+<!--  Triggers  -->
+<aliases>
+  <alias
+   match="sapi on"
+   enabled="n"
+   omit_from_command_history="y"
+   omit_from_log="y"
+   omit_from_output="y"
+   script="speak_on"
+   sequence="100"
+   group="speech"
+  >
+  </alias>
+
+  <alias
+   match="sapi off"
+   enabled="n"
+   omit_from_command_history="y"
+   omit_from_log="y"
+   omit_from_output="y"
+   script="speak_off"
+   sequence="100"
+   group="speech"
+  >
+  </alias>
+    
+ <alias
+   match="sapi skip"
+   enabled="n"
+   omit_from_log="y"
+   omit_from_output="y"
+   script="speak_skip"
+   sequence="100"
+   group="speech"
+  >
+  </alias>
+    
+</aliases>
+
+<triggers>
+</triggers>
+
+<!--  Script  -->
+
+
+<script>
+<![CDATA[
+
+-- turn on speaking
+function speak_on (name, line, wildcards)
+  speak = true
+  talk:Speak ("Sapi auto speak now on.", 1)
+end -- function speak_on
+
+-- turn off speaking
+function speak_off (name, line, wildcards)
+  speak = false
+  talk:Speak ("Sapi auto speak now off.",1)
+end -- function speak_off
+
+-- skip a sentence
+function speak_skip (name, line, wildcards)
+  talk:Skip ("Sentence", 1)
+end -- function speak_skip
+
+-- installation
+function OnPluginInstall ()
+
+  -- load Lua COM
+  assert (package.loadlib ("luacom.dll", "luacom_open")) ()
+  
+  -- Instantiate a SAPI voice obejct
+  talk = assert (luacom.CreateObject ("SAPI.SpVoice"), "cannot open SAPI")
+  
+  -- Method call
+  talk:Speak ("SAPI Plugin installed and is ready.", 1)
+
+  speak = true
+  EnableGroup ("speech", true)
+  
+end -- function OnPluginInstall
+
+-- here to draw the screen
+function OnPluginScreendraw (t, log, line)
+
+  -- check loaded
+  if not talk then
+    return
+  end -- if not installed
+
+  if (t == 0 or t == 1) and speak then
+     talk:Speak (line, 1)
+  end -- if
+  
+end -- function
+  
+-- Speak from other scripts
+-- eg. CallPlugin ("463242566069ebfd1b379ec1", "say", "What to say")
+
+function say (what)
+
+  -- check loaded
+  if not talk then
+    return false  -- failure
+  end -- if not installed
+
+  talk:Speak (what, 1)
+  
+  return true  -- OK
+end -- function say
+
+]]>
+</script>
+
+</muclient>