Gammon Forum

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE muclient>

<muclient>
<plugin
   name="Sound_File_Redirector"
   author="Nick Gammon"
   id="2322e8bf7085dbeab87759b4"
   language="Lua"
   purpose="Plays sounds from &quot;sound&quot; directory"
   date_written="2014-07-31 07:09:23"
   requires="4.80"
   version="1.0"
   >

</plugin>

<!--  Script  -->

<script>
<![CDATA[
function OnPluginPlaySound (s)
  if string.match (s, "^%a:\\") then  -- see if s began with a drive letter
      Sound (s)                           -- so play s without prepending anything to it
    else
      Sound (GetInfo(66) .. "sound\\" .. s)
    end -- if
end -- OnPluginPlaySound 

]]>
</script>

</muclient>

!!SOUND(Off U=http://www.example.org:5000/sounds)

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE muclient>

<muclient>
<plugin
   name="MSP_Lua"
   author="Nick Gammon"
   id="7da63d78d9f91bebb5285127"
   language="Lua"
   purpose="Emulates MSP (MUD Sound Protocol)"
   save_state="y"
   date_written="2014-08-10 15:43"
   requires="4.54"
   version="1.0"
   >
<description trim="y">
<![CDATA[
Type: "msp:help" to see this help.

See: http://www.gammon.com.au/forum/bbshowpost.php?bbsubject_id=783 for a more complete description.

You will need to get the sound files manually (ie. from the MUD) and install them before using this. 
The plugin is configured to look for them in the "sounds" directory of the MUSHclient installation,
but you can change that by typing:

  set_msp_path new_path

eg.

  set_msp_path d:\muds\mushclient\msp

]]>

</description>

</plugin>


<!--  Triggers  -->

<triggers>
  <trigger
   enabled="y"
   match="!!SOUND\(([A-Za-z0-9./]+).*\)"
   name="sound"
   omit_from_output="y"
   regexp="y"
   script="OnSound"
   sequence="100"
  >
  </trigger>
</triggers>

<!--  Aliases  -->

<aliases>
  <alias
   script="On_set_MSP_path"
   match="set_msp_path *"
   enabled="y"
  >
  </alias>
  
  <alias
   script="OnHelp"
   match="msp:help"
   enabled="y"
  >
  </alias>

</aliases>

<!--  Script  -->

<script>
<![CDATA[

function fSound (filename)
  PlaySound (0, GetVariable ("msp_path") .. filename)
  return "" -- omit MSP stuff from output
end -- function fSound

-- handle a line with !!SOUND in it
function OnSound (name, line, wildcards, styles) 

	-- echo existing line with colours, sending !!SOUND part to a function
  for _, v in ipairs (styles) do
    local text = string.gsub (v.text, "!!SOUND%(([%a%d./]+).-%)", fSound)
    ColourTell (RGBColourToName (v.textcolour), 
                  RGBColourToName (v.backcolour), 
                  text)  
  end -- for each style run

  Note ("") -- finish the line
end -- function OnSound

-- change desired sound file path
function On_set_MSP_path (name, line, wildcards) 
  local path =  wildcards [1]
  
  --  ensure trailing backslash
  if string.sub (path, -1) ~= "\\" then
     path = path .. "\\"
  end -- if

  SetVariable ("msp_path", path) 
  print ("MSP sound files will be obtained from " .. path)
end -- function On_set_MSP_path

-- do telnet negotiation
function OnPluginTelnetRequest (type, data)
  if type == 90 and data == "WILL" then
    return true -- IAC DO MSP
  else
    return false
  end -- if
end -- function OnPluginTelnetRequest

-- show help
function OnHelp ()
  print (GetPluginInfo (GetPluginID (), 3))
end -- function OnHelp

-- use supplied path or default
msp_path = GetVariable ("msp_path") or GetInfo (74)

]]>
</script> 

</muclient>

set_msp_path c:\Program Files\MUSHclient\sound

C:\Program Files\MUSHclient\sound\Battle\backstab1.wav

PlaySound (0, "../sound/Battle/backstab1.wav")

Testing !!SOUND(Battle/backstab1.wav V=75 L=1 P=50 T=action U=http://whatever/Battle/backstab1.wav) Foo Bar

function fSound (filename)
  local result = PlaySound (0, GetVariable ("msp_path") .. filename)
  if result ~= error_code.eOK then
    ColourNote ("red", "", "ERROR: " .. error_desc [result] .. " playing " .. GetVariable ("msp_path") .. filename)
  end -- if
  return "" -- omit MSP stuff from output
end -- function fSound

ERROR: Cannot open the specified file playing c:\program files\mushclient\sound\sound/miss.wav

set_msp_path C:\MUSHclient

<install dir>/sounds/sound/miss.wav