Differences

This shows you the differences between two versions of the page.

--- sense [2016/10/11 15:20] – [Timeline API] ace
+++ sense [2020/05/22 17:29] (current) – [Addon Layout] ace
@@ Line 14: / Line 14: @@
   * **''bin''**
     * Holds executable files that <color red>MUST BE DOWNLOADED AND INSTALLED BY THE USER</color>.
-    * [[https://www.dropbox.com/s/5pvqxa7c8nr4pin/imagecreator.exe?dl=0|imagecreator.exe]] - this app turns text into images for use in the addon.
+    * Both files are now in one zip file, working around dropbox limitations.
-    * [[https://www.dropbox.com/s/ceon26uzld89tv5/soundengine.exe?dl=0|soundengine.exe]] - this app handles the playing of mp3/wav/text-to-speech.
+    * [[https://www.dropbox.com/s/ljjt0jlmpxbq95f/binaries.zip?dl=0|imagecreator.exe]] - this app turns text into images for use in the addon.
+    * [[https://www.dropbox.com/s/ljjt0jlmpxbq95f/binaries.zip?dl=0|soundengine.exe]] - this app handles the playing of mp3/wav/text-to-speech.
   * **''images''**
     * Holds automatic and user-created images for use in the addon.
@@ Line 25: / Line 26: @@
     * Holds universal/general triggers.
-===== Timeline Sample =====
+===== Timeline Sample & API =====
 <code lua>
 local profile = {
-	name = "A5S",
+	name = "A5S", -- Friendly name, used only internally, for now.
-	reset = "Advanced Clevering is no longer sealed",
+	reset = "Advanced Clevering is no longer sealed", -- Reset accepts a string or table full of strings.  If detected, it will reset the encounter.
-	start = "Advanced Clevering will be sealed off in 15",
+	start = "Advanced Clevering will be sealed off in 15", -- Start accepts a string or table full of strings.  If detected, it will start the encounter. Triggers in the profile become active once the profile is started.
-	started = 0,
+	timeline = { -- Timeline is a table full of all events that the profile walk through.
-	timeline = {
 		{ post = 5, sound = "Goes Big", main_image = "GOES BIG", helper_image = "", setvar = { name = "SENSE_TEST", value = 44, duration = 20, reset = 0} },
+                -- "post" - Time in seconds after the profile has started.
+                -- "sound" - Accepts a file name (file must be inside the "sounds" folder and be mp3/wav format), or text that will be played via text-to-speech.
+                -- "main_image" - Top level image. Can be a file name (file must be in the images folder), or text that will be auto-converted into an image.
+                -- "helper_image" - Second level image. Can be a file name (file must be in the images folder), or text that will be auto-converted into an image.
+                -- "jump" - Accepts a number.  Once this
+                -- "setvar" - Accepts a lua table.  setvar is used to expose/alter a variable in the global lua scope, so that other addons/code sections not local to Sense can read/react to it, such as setting a var that a skill profile may react to.
+                --       { name = Name of the variable to be altered/set. , value = Value to set the variable to, duration = Length in time (seconds) that this variable will remain in that state, reset = Value that the var will be reset back to upon duration limit }
 		{ post = 8, sound = "Gob jab", main_image = "GOBJAB", helper_image = "1ST HEADACHE STACK", runcode = "SendTextCommand('/echo GOBJAB')" },
+                -- "runcode" - Accepts a string or lua function.  Will run the code block upon reaching this time point.
 		{ post = 12, sound = "Gob jab", main_image = "GOBJAB", helper_image = "2ND HEADACHE STACK" },
 		{ post = 16, sound = "Gob jab", main_image = "GOBJAB", helper_image = "3RD HEADACHE STACK" },
@@ Line 43: / Line 51: @@
 		{ post = 41, sound = "Charge", main_image = "CHARGE", helper_image = "" },
-		{ post = 50, sound = "Goes Small", sync = "loses the effect of Bigbulge Biggerbrain", windowopen = 0, windowclose = 50, main_image = "GOES SMALL", helper_image = "" },
+		{ post = 50, sound = "Goes Small", sync = "loses the effect of Bigbulge Biggerbrain",jump = 51, windowopen = 0, windowclose = 50, main_image = "GOES SMALL", helper_image = "" },
+                -- "sync" - Turns this timepoint into a 'watcher'.  Watchers will be executed when the "sync" field is found in the chat log.
+                -- "windowopen" - Allows the watcher to find logs x amount of seconds backwards in time.
+                -- "windowclose" - Allows the watcher to continue checking logs for x amount of seconds forward in time.
+                -- "jump" - If the watcher is found, the profile will jump itself to this value since the profile was started, by default the timeline will set itself back to the value in the "post".  Can be useful if a timeline needs to be 'rewinded' or 'fast-forwarded'.
 		{ post = 50, sound = "Glupgloop Mark 1", main_image = "GLUPGLOOP MARK", helper_image = "AOE LANDING IN 7 SECONDS" },
 		{ post = 60, sound = "Glupgloop Mark 2", main_image = "GLUPGLOOP MARK", helper_image = "AOE LANDING IN 7 SECONDS" },
@@ Line 69: / Line 81: @@
 return profile
 </code>
-===== Trigger API =====
+===== Trigger Sample & API =====
+<code lua>
+local profile = {
+	name = "Ace Triggers",
+	triggers = {
+		{ detect_chat = "readies Petrification",
+			sound = "Petrification", main_image = "PETRIFICATION", helper_image = "TURN AWAY"
+		},
+		{ detect_chat = "readies Cure",
+			sound = "CURE", main_image = "CURE", helper_image = "BE HEALED NOOB",
+			runcode = "SendTextCommand('/echo LET THAIR BE LIGHT')",
+		},
+		{ detect_action = "Cure", detect_action_user = "3660;3661";
+			sound = "CURE", main_image = "CURE", helper_image = "BE HEALED NOOB",
+			runcode = "SendTextCommand('/echo LET THAIR BE LIGHT2')",
+		},
+		{ detect_action = "Cure", detect_action_user = "", detect_action_self = true, detect_delay = 1,
+			sound = "CURE", main_image = "CURE", helper_image = "BE HEALED NOOB",
+			runcode = "ActionList:StopCasting()",
+		},
+		{ detect_function = "ScanForCaster(3660,50,120)",
+			sound = "CURE", main_image = "CURE", helper_image = "BE HEALED NOOB",
+			runcode = "SendTextCommand('/echo LET THAIR BE LIGHT2')",
+		},
+	}
+}
+return profile
+</code>
+Tags:\\
+  * **''detect_chat''** (//string// SearchText)
+    * Detects a partial chat-line from the chat log.
+  * **''detect_action''** (//string// Action Name), (//string//, semi-colon separated list of IDs, "145;154") or (//number// Action ID)
+    * Detects an action being cast by self or other entities, via the minion API.
+  * **''detect_action_user''** (//string// semi-colon separated list of entity content IDs, "3660;3661")
+    * Modifies a detect_action statement to activate only if the caster is one of the listed content IDs.
+  * **''detect_action_self''** (//boolean// true/false)
+    * Modifies a detect_action statement to also activate if the caster is the Player.
+  * **''detect_function''** (//string// or //function// or //table//)
+    * Detects based on the return value of a single function string or a normal lua function statement, or a lua table filled with multiple function strings or statements.  Value must be true to activate the trigger. For a table, only one value must be true to activate.
+===== User Made Profiles =====
+All existing profile can be found on [[http://www.mmominion.com/forum-182.html]]\\
+These profiles are to be installed into C:\MINIONAPP\Bots\FFXIVMinion64\LuaMods\Sense\profiles\\\

User Tools

Site Tools

Differences

Page Tools