Merge branch 'tts'

Author: quisquous

CactbotOverlay/CactbotOverlay.cs

@@ -47,6 +47,7 @@ public class CactbotOverlay : OverlayBase<CactbotOverlayConfig>, ILogger {
     private StringBuilder dispatch_string_builder_ = new StringBuilder(1000);
     JsonTextWriter dispatch_json_writer_;
     JsonSerializer dispatch_serializer_;
+    JsonSerializer message_serializer_;
 
     private System.Timers.Timer fast_update_timer_;
     // Held while the |fast_update_timer_| is running.
@@ -107,6 +108,7 @@ public CactbotOverlay(CactbotOverlayConfig config)
       wipe_detector_ = new WipeDetector(this);
       dispatch_json_writer_ = new JsonTextWriter(new System.IO.StringWriter(dispatch_string_builder_));
       dispatch_serializer_ = JsonSerializer.CreateDefault();
+      message_serializer_ = JsonSerializer.CreateDefault();
 
 
       // Our own timer with a higher frequency than OverlayPlugin since we want to see
@@ -639,6 +641,16 @@ public void LogInfo(string format, params object[] args) {
         null);
     }
 
+    // This is an overlayMessage() function call from javascript. We accept a json object of
+    // (command, argument) pairs. Commands are:
+    // - say: The argument is a string which is read as text-to-speech.
+    public override void OverlayMessage(string message) {
+      var reader = new JsonTextReader(new StringReader(message));
+      var obj = message_serializer_.Deserialize<Dictionary<string, string>>(reader);
+      if (obj.ContainsKey("say"))
+        Advanced_Combat_Tracker.ActGlobals.oFormActMain.TTS(obj["say"]);
+    }
+
     // State that is tracked and sent to JS when it changes.
     private class NotifyState {
       public bool sent_data_dir = false;

README.md

@@ -170,6 +170,22 @@ Options.DisabledTriggers = {
 }
 ```
 
+If you dislike the built-in sound info, alert, and alarm noises that cactbot uses and would
+prefer to use text to speech (tts), you can set a global option by including this line
+in your **user/raidboss.js** file:
+
+```
+// Including this line will make any trigger with text to speech use that instead of other
+// noises.
+Options.SpokenAlertsEnabled = true;
+
+// If you don't like the on screen text, you can turn that off with this line too:
+Options.TextAlertsEnabled = false;
+```
+
+See [this options documentation](ui/raidboss/raidboss.js) for a full list of options and
+how to configure text, sound, and tts options on a per trigger basis.
+
 To add a sound alert that can be activated in any zone, for example, add the following to **user/raidboss.js**:
 
 ```

ui/raidboss/data/triggers/README.txt

@@ -71,4 +71,5 @@ The full order of evaluation of functions in a trigger is:
 4. infoText
 5. alertText
 6. alarmText
-7. run
+7. tts
+8. run

ui/raidboss/data/triggers/test.js

@@ -56,5 +56,12 @@
       },
       tts: 'hahahahaha',
     },
+    {
+      id: 'Test Clap',
+      regex: /:You clap for the striking dummy/,
+      sound: '../../resources/sounds/WeakAuras/Applause.ogg',
+      soundVolume: 0.3,
+      tts: 'clapity clap',
+    },
   ],
 }]

ui/raidboss/popup-text.js

@@ -179,7 +179,7 @@ class PopupText {
   }
 
   OnTrigger(trigger, matches) {
-    if (!this.options.PopupTextEnabled)
+    if (!this.options.AlertsEnabled)
       return;
     if ('disabled' in trigger && trigger.disabled)
       return;
@@ -193,13 +193,27 @@ class PopupText {
       return (typeof(f) == "function") ? f(that.data, matches) : f;
     }
 
+    var showText = this.options.TextAlertsEnabled;
+    var playSounds = this.options.SoundAlertsEnabled;
+    var playSpeech = this.options.SpokenAlertsEnabled;
     var userDisabled = trigger.id && this.options.DisabledTriggers[trigger.id];
     var delay = 'delaySeconds' in trigger ? ValueOrFunction(trigger.delaySeconds) : 0;
     var duration = 'durationSeconds' in trigger ? ValueOrFunction(trigger.durationSeconds) : 3;
 
+    var triggerOptions = trigger.id && this.options.PerTriggerOptions[trigger.id];
+    if (triggerOptions) {
+      if ('SpeechAlert' in triggerOptions)
+        playSpeech = triggerOptions.SpeechAlert;
+      if ('SoundAlert' in triggerOptions)
+        playSounds = triggerOptions.SoundAlert;
+      if ('TextAlert' in triggerOptions)
+        showText = triggerOptions.TextAlert;
+    }
+
     var f = function() {
-      var textSound = '';
-      var textVol = 1;
+      var soundUrl = '';
+      var soundVol = 1;
+      var ttsText = '';
 
       var addText = function(container, e) {
         container.appendChild(e);
@@ -224,72 +238,87 @@ class PopupText {
 
       if ('infoText' in trigger) {
         var text = ValueOrFunction(trigger.infoText);
-        if (text && !userDisabled) {
+        if (text && !userDisabled && showText) {
           var holder = that.infoText.getElementsByClassName('holder')[0];
           var div = makeTextElement(text, 'info-text');
           addText.bind(that)(holder, div);
           window.setTimeout(removeText.bind(that, holder, div), duration * 1000);
 
           if (!('sound' in trigger)) {
-            textSound = that.options.InfoSound;
-            textVol = that.options.InfoSoundVolume;
+            soundUrl = that.options.InfoSound;
+            soundVol = that.options.InfoSoundVolume;
           }
         }
       }
       if ('alertText' in trigger) {
         var text = ValueOrFunction(trigger.alertText);
-        if (text && !userDisabled) {
+        if (text && !userDisabled && showText) {
           var holder = that.alertText.getElementsByClassName('holder')[0];
           var div = makeTextElement(text, 'alert-text');
           addText.bind(that)(holder, div);
           window.setTimeout(removeText.bind(that, holder, div), duration * 1000);
 
           if (!('sound' in trigger)) {
-            textSound = that.options.AlertSound;
-            textVol = that.options.AlertSoundVolume;
+            soundUrl = that.options.AlertSound;
+            soundVol = that.options.AlertSoundVolume;
           }
         }
       }
       if ('alarmText' in trigger) {
         var text = ValueOrFunction(trigger.alarmText);
-        if (text && !userDisabled) {
+        if (text && !userDisabled && showText) {
           var holder = that.alarmText.getElementsByClassName('holder')[0];
           var div = makeTextElement(text, 'alarm-text');
           addText.bind(that)(holder, div);
           window.setTimeout(removeText.bind(that, holder, div), duration * 1000);
 
           if (!('sound' in trigger)) {
-            textSound = that.options.AlarmSound;
-            textVol = that.options.AlarmSoundVolume;
+            soundUrl = that.options.AlarmSound;
+            soundVol = that.options.AlarmSoundVolume;
           }
         }
       }
-
-      if (textSound) {
-        var audio = new Audio(textSound);
-        audio.volume = textVol;
-        audio.play();
+      if ('tts' in trigger && playSpeech) {
+        var text = ValueOrFunction(trigger.tts);
+        if (text && !userDisabled)
+          ttsText = text;
       }
 
-      if (trigger.sound && !userDisabled) {
-        var url = trigger.sound;
-        var volume = 1;
+      if (trigger.sound) {
+        soundUrl = trigger.sound;
 
         var namedSound = trigger.sound + 'Sound';
         var namedSoundVolume = trigger.sound + 'SoundVolume';
         if (namedSound in that.options) {
-          url = that.options[namedSound];
+          soundUrl = that.options[namedSound];
           if (namedSoundVolume in that.options)
-            volume = that.options[namedSoundVolume];
+            soundVol = that.options[namedSoundVolume];
         }
         if ('soundVolume' in trigger)
-          volume = trigger.soundVolume;
+          soundVol = trigger.soundVolume;
+      }
 
-        var audio = new Audio(url);
-        audio.volume = volume;
+      if (triggerOptions) {
+        soundUrl = triggerOptions.SoundOverride || soundUrl;
+        soundVol = triggerOptions.VolumeOverride || soundVol;
+      }
+
+      // Text to speech overrides all other sounds.  This is so
+      // that a user who prefers tts can still get the benefit
+      // of infoText triggers without tts entries by turning
+      // on (speech=true, text=true, sound=true) but this will
+      // not cause tts to play over top of sounds or noises.
+      if (soundUrl && playSounds && !userDisabled && !ttsText) {
+        var audio = new Audio(soundUrl);
+        audio.volume = soundVol;
         audio.play();
       }
 
+      if (ttsText && !userDisabled) {
+        var cmd = { 'say': ttsText };
+        OverlayPluginApi.overlayMessage(OverlayPluginApi.overlayName, JSON.stringify(cmd));
+      }
+
       if ('run' in trigger)
         trigger.run(that.data, matches);
     };

ui/raidboss/raidboss.js

@@ -7,7 +7,10 @@
 // See user/raidboss-example.js for documentation.
 var Options = {
   TimelineEnabled: true,
-  PopupTextEnabled: true,
+  AlertsEnabled: true,
+  TextAlertsEnabled: true,
+  SoundAlertsEnabled: true,
+  SpokenAlertsEnabled: false,
 
   ShowTimerBarsAtSeconds: 30,
   KeepExpiredTimerBarsForSeconds: 0.7,
@@ -25,6 +28,9 @@ var Options = {
   LongSoundVolume: 1,
 
   DisabledTriggers: {},
+
+  PerTriggerOptions: {},
+
   Triggers: [],
 };
 

ui/test/cactbot_test.html

@@ -115,6 +115,14 @@
     document.addEventListener("onBossFightEnd", function(e) {
       document.getElementById('event').innerText = "BossFight End";
     });
+    document.addEventListener("onLogEvent", function(e) {
+      for (var i = 0; i < e.detail.logs.length; i++) {
+        // Match "/echo tts:<stuff>"
+        var r = e.detail.logs[i].match('00:0038:tts:(.*)');
+        if (r)
+          OverlayPluginApi.overlayMessage(OverlayPluginApi.overlayName, JSON.stringify({ 'say': r[1] }));
+      }
+    });
   </script>
 </head>
 <body>

user/raidboss-example.js

@@ -9,8 +9,21 @@
 // If false, no timeline of upcoming events will be displayed during fights.
 Options.TimelineEnabled = true
 
-// If false, no text will be shown or spoken, or sounds played, for triggers and timeline events.
-Options.PopupTextEnabled = true
+// If false, triggers and timelines will not show or speak text, nor play
+// sounds.
+Options.AlertsEnabled = true
+
+// If false, then visual text alerts are not shown for triggers.
+Options.TextAlertsEnabled = true
+
+// If false, then sound alerts are not played.
+Options.SoundAlertsEnabled = true,
+
+// If true, then text-to-speech alerts are read aloud.  Text-to-speech takes
+// priority over custom sounds and text noises.  If a trigger does not have
+// a tts entry then it will fall back on text and sound (if turned on).
+Options.SpokenAlertsEnabled = false
+
 
 // Show timer bars for events that will happen in this many seconds or less.
 Options.ShowTimerBarsAtSeconds = 30
@@ -153,3 +166,46 @@ Options.Triggers = [
   },
 
 ]
+
+// Per trigger options.  By default, each trigger uses the global options
+// of TextAlertsEnabled, SoundAlertsEnabled, and SpokenAlertsEnabled.
+// These global options are set up top in this file.
+//
+// If a per trigger entry is present (regardless if true/false), it will
+// override whatever the global option is set to.
+//
+// SoundOverride (if present) behaves like 'sound' on an individual trigger, in
+// that it will take the place of the info/alert/alarm noise if no sound has
+// been specified.  SoundAlert (or SoundAlertsEnabled) must still be true for
+// that override to be played.
+//
+// Here's some example per trigger options that modify the test triggers
+// in Summerford Farms:
+// https://github.com/quisquous/cactbot/blob/master/ui/raidboss/data/triggers/test.js
+
+Options.PerTriggerOptions = {
+  // Just like Options.DisabledTriggers, this is the trigger id to apply to.
+  // This overrides the settings for the "/laugh" trigger from the test
+  // triggers.  You can try this out by teleporting to Summerford Farms
+  // and /laugh at a striking dummy.  It will use these settings and moo.
+  'Test Laugh': {
+    // Play the text to speech.
+    SpeechAlert: false,
+    // Play the sound alert.
+    SoundAlert: true,
+    // Show the info/alert/alarm text on screen.
+    TextAlert: false,
+    // Play this sound (replacing any sound from the original).
+    SoundOverride: '../../resources/sounds/WeakAuras/CowMooing.ogg',
+    // Play the sound (if any) at this volume.
+    VolumeOverride: 0.3,
+  },
+
+  // This makes /poke-ing a striking dummy in Summerford Farms only
+  // use text to speech with no visual text indicator or other sound.
+  'Test Poke': {
+    SpeechAlert: true,
+    SoundAlert: false,
+    TextAlert: false,
+  },
+}