Merge pull request #43 from Slivo-fr/release/v1.5.0

Release/v1.5.0

.gitignore

@@ -1,2 +1,3 @@
 .idea
 libs
+copy.sh

README.md

@@ -1,8 +1,10 @@
 # TranqRotate
 
 This addon is meant to help hunters to setup tranqshot rotation and give them real time visual feedback about it.
+
 It also allow non-hunter raid leaders to easily manage, report and watch the tranq rotation live. 
-Even if none of your hunter use the addon! 
+
+This addon will work even if you are the only one using it in your raid. (With some combat log range limitation, see bellow)
 
 ![Screenshot](docs/screenshots/screenshot.png "ui") ![Screenshot](docs/screenshots/drag.gif "ui")  ![Screenshot](docs/screenshots/rotation.gif "ui")
 
@@ -16,17 +18,20 @@ Please report any issue using github issues : https://github.com/Slivo-fr/TranqR
 
 - Automatically send messages to notify others player about your tranq success or fail, hopefully you won't have to bother with that crappy macro anymore !
 - Display the list of raid hunters
+- Display offline and dead status on hunters frames
 - Allow player to re-order players between two groups : main rotation and backup
 - Synchronize rotation order between player using the addon
-- Whisper backup hunters (if there is backup) or next rotation hunter if you miss your tranqshot
+- Allow player to broadcast the configured rotation and backup group to the raid
 - Provide a real time visual feedback about the rotation status, even if no one else use the addon in your raid
 - Synchronize tranqshot casts to other player using the addon
-- Allow player to broadcast the configured rotation and backup group to the raid
-- Display offline and dead status on hunters frames
+- Whisper backup hunters (if there is backup) or next rotation hunter if you miss your tranqshot
 - Test mode out of raid using arcane shot
 - Play a sound when you are next on rotation
 - Show an alert and play a sound when you need to use your tranqshot
 - Display the tranq cooldown of each hunter
+- Display the frenzy cooldown of each boss
+- Optional automatic backup call when incapacitated
+- Optional automatic timed backup call 
 
 ## Usage
 
@@ -52,11 +57,9 @@ It will whisper all backup hunters the fail message.
 
 Here is a list of feature I want to implement at some point, no specific order is decided yet.
 
-- Adds RL/Raid assist handling to restrict rotation groups changes
 - Automatic handling of death and disconnection of hunters on the rotation group (swap with a backup, send an alert about it)
 - Use raid symbols to mark hunters that need to tranq, or that need to backup a failed tranqshot
 - Automatic reset of rotation when raid wipe
-- Frenzy cooldown/duration progress bar
 
 ## Download
 

TranqRotate.toc

@@ -1,8 +1,8 @@
 ## Interface: 11305
-## Title: TranqRotate |cff00aa001.4.0|r
+## Title: TranqRotate |cff00aa001.5.0|r
 ## Notes: A tranqshot rotation assistant
 ## Author: Slivo
-## Version: 1.4.0
+## Version: 1.5.0
 ## SavedVariables: TranqRotateDb
 ## OptionalDeps: Ace3
 
@@ -33,4 +33,5 @@ src\dragdrop.lua
 src\comms.lua
 src\defaults.lua
 src\settings.lua
-src\utils.lua
+src\utils.lua
+src\debuff.lua

changelog.md

@@ -1,6 +1,15 @@
 ## TranqRotate Changelog
 
-#### v1.3.0
+#### v1.5.0
+
+- Restricted ordering tranq rotation to raid leader, raid assists and hunters
+- Added a frenzy cooldown progress bar under the title bar
+- Added configurable optional timed backup alert
+- Added configurable optional incapacitated backup alert
+- Fix font for koKR player names
+- Fix main window showing up when login in while already in a raid with option to mask window enabled
+
+#### v1.4.0
 
 - TranqRotate now play a sound when you need to tranq (You can disable it in the options)
 - Added an option to not show up the window each time you join a raid

locales/enUS.lua

@@ -29,6 +29,18 @@ local L = {
     ["ARCANE_SHOT_TESTING_ENABLED"] = "Arcane shot testing mode enabled for 10 minutes",
     ["ARCANE_SHOT_TESTING_DISABLED"] = "Arcane shot testing mode disabled",
 
+    ["FEATURES_HEADER"] = "Optionals features",
+    ["DISPLAY_BOSS_FRENZY_COOLDOWN"] = "Display frenzy cooldown progress bar",
+    ["DISPLAY_BOSS_FRENZY_COOLDOWN_DESC"] = "A thin progress bar just under the title bar will show the progress",
+    ["ENABLE_AUTOMATIC_BACKUP_ALERT_WHEN_INCAPACITATED"] = "Enable automatic backup alert when incapacitated",
+    ["ENABLE_AUTOMATIC_BACKUP_ALERT_WHEN_INCAPACITATED_DESC"] = "TranqRotate will check for your debuffs when you should actually tranq and will call for backup if you are incapacitated for longer than the defined delay",
+    ["INCAPACITATED_DELAY_THRESHOLD"] = "Incapacitated alert threshold",
+    ["INCAPACITATED_DELAY_THRESHOLD_DESC"] = "If you are incapacitated for longer than the configured delay, TranqRotate will automatically call for backup",
+    ["ENABLE_AUTOMATIC_TIMED_BACKUP_ALERT"] = "Enable timed automatic backup alert",
+    ["ENABLE_AUTOMATIC_TIMED_BACKUP_ALERT_DESC"] = "TranqRotate will call for backup if the boss is on frenzy for a defined delay and you should have been tranqing it",
+    ["TIMED_DELAY_THRESHOLD"] = "Timed alert threshold",
+    ["TIMED_DELAY_THRESHOLD_DESC"] = "TranqRotate will automatically call for backup if you do not tranq within the configured threshold",
+
     --- Announces
     ["SETTING_ANNOUNCES"] = "Announces",
     ["ENABLE_ANNOUNCES"] = "Enable announces",
@@ -54,10 +66,12 @@ local L = {
     ["SUCCESS_MESSAGE_LABEL"] = "Successful announce message",
     ["FAIL_MESSAGE_LABEL"] = "Fail announce message",
     ["FAIL_WHISPER_LABEL"] = "Fail whisper message",
+    ["UNABLE_TO_TRANQ_MESSAGE_LABEL"] = "Message whispered when you cannot tranq or call for backup",
 
     ['DEFAULT_SUCCESS_ANNOUNCE_MESSAGE'] = "Tranqshot done on %s",
     ['DEFAULT_FAIL_ANNOUNCE_MESSAGE'] = "!!! TRANQSHOT FAILED ON %s !!!",
-    ['DEFAULT_FAIL_WHISPER_MESSAGE'] = "TRANQSHOT FAILED ! TRANQ NOW !",
+    ['DEFAULT_FAIL_WHISPER_MESSAGE'] = "TRANQSHOT MISSED ! TRANQ NOW !",
+    ['DEFAULT_UNABLE_TO_TRANQ_MESSAGE'] = "I'M UNABLE TO TRANQ ! TRANQ NOW !",
 
     ['TRANQ_NOW_LOCAL_ALERT_MESSAGE'] = "USE TRANQSHOT NOW !",
 

locales/frFR.lua

@@ -31,6 +31,18 @@ local L = {
     ["ARCANE_SHOT_TESTING_ENABLED"] = "Test mode activé pour 10 minutes",
     ["ARCANE_SHOT_TESTING_DISABLED"] = "Test mode désactivé",
 
+    ["FEATURES_HEADER"] = "Fonctionnalités optionnelles",
+    ["DISPLAY_BOSS_FRENZY_COOLDOWN"] = "Afficher le cooldown de frénésie des boss",
+    ["DISPLAY_BOSS_FRENZY_COOLDOWN_DESC"] = "Une fine barre de progression, juste sous la barre de titre, indiquera le cooldown de la frénésie",
+    ["ENABLE_AUTOMATIC_BACKUP_ALERT_WHEN_INCAPACITATED"] = "Activer l'alerte automatique en cas d'incapacité",
+    ["ENABLE_AUTOMATIC_BACKUP_ALERT_WHEN_INCAPACITATED_DESC"] = "TranqRotate alertera automatiquement le backup si un debuff vous empeche de tranq pendant un temps supérieur au délai configuré",
+    ["INCAPACITATED_DELAY_THRESHOLD"] = "Délai pour l'alerte d'incapacité",
+    ["INCAPACITATED_DELAY_THRESHOLD_DESC"] = "Si un débuff vous empêche de tranq pour un temps supérieur à celui configuré au moment ou vous devez tranq, une alerte est envoyée au backup",
+    ["ENABLE_AUTOMATIC_TIMED_BACKUP_ALERT"] = "Activer l'alerte automatique chronométrée ",
+    ["ENABLE_AUTOMATIC_TIMED_BACKUP_ALERT_DESC"] = "TranqRotate enverra automatiquement une alerte au backup si vous ne tirez pas votre tir tranquilisant avant le délai configuré",
+    ["TIMED_DELAY_THRESHOLD"] = "Délai pour l'alerte chronométrée",
+    ["TIMED_DELAY_THRESHOLD_DESC"] = "Si vous ne tirez pas votre tir tranquilisant avant ce délai, une alerte sera envoyée au backup",
+
     --- Announces
     ["SETTING_ANNOUNCES"] = "Annonces",
     ["ENABLE_ANNOUNCES"] = "Activer les annonces",
@@ -56,10 +68,12 @@ local L = {
     ["SUCCESS_MESSAGE_LABEL"] = "Message de réussite",
     ["FAIL_MESSAGE_LABEL"] = "Message d'échec",
     ["FAIL_WHISPER_LABEL"] = "Message d'échec chuchoté",
+    ["UNABLE_TO_TRANQ_MESSAGE_LABEL"] = "Message chuchoté quand vous ne pouvez pas tranq ou que vous demandez un backup",
 
     ['DEFAULT_SUCCESS_ANNOUNCE_MESSAGE'] = "Tir tranquillisant fait sur %s",
     ['DEFAULT_FAIL_ANNOUNCE_MESSAGE'] = "!!! TIR TRANQUILLISANT RATE SUR %s !!!",
     ['DEFAULT_FAIL_WHISPER_MESSAGE'] = "TIR TRANQUILISANT RATE ! TRANQ MAINTENANT !",
+    ['DEFAULT_UNABLE_TO_TRANQ_MESSAGE'] = "JE NE PEUX PAS TRANQ ! TRANQ MAINTENANT !",
 
     ['TRANQ_NOW_LOCAL_ALERT_MESSAGE'] = "TRANQ MAINTENANT !",
 

locales/ruRU.lua

@@ -31,6 +31,18 @@ local L = {
     ["ARCANE_SHOT_TESTING_ENABLED"] = "Тестовый режим включен на 10 минут",
     ["ARCANE_SHOT_TESTING_DISABLED"] = "Тестовый режим выключен",
 
+    ["FEATURES_HEADER"] = "Optionals features",
+    ["DISPLAY_BOSS_FRENZY_COOLDOWN"] = "Display frenzy cooldown progress bar",
+    ["DISPLAY_BOSS_FRENZY_COOLDOWN_DESC"] = "A thin progress bar just under the title bar will show the progress",
+    ["ENABLE_AUTOMATIC_BACKUP_ALERT_WHEN_INCAPACITATED"] = "Enable automatic backup alert when incapacitated",
+    ["ENABLE_AUTOMATIC_BACKUP_ALERT_WHEN_INCAPACITATED_DESC"] = "TranqRotate will check for your debuffs when you should actually tranq and will call for backup if you are incapacitated for longer than the defined delay",
+    ["INCAPACITATED_DELAY_THRESHOLD"] = "Incapacitated alert threshold",
+    ["INCAPACITATED_DELAY_THRESHOLD_DESC"] = "If you are incapacitated for longer than the configured delay, TranqRotate will automatically call for backup",
+    ["ENABLE_AUTOMATIC_TIMED_BACKUP_ALERT"] = "Enable timed automatic backup alert",
+    ["ENABLE_AUTOMATIC_TIMED_BACKUP_ALERT_DESC"] = "TranqRotate will call for backup if the boss is on frenzy for a defined delay and you should have been tranqing it",
+    ["TIMED_DELAY_THRESHOLD"] = "Timed alert threshold",
+    ["TIMED_DELAY_THRESHOLD_DESC"] = "TranqRotate will automatically call for backup if you do not tranq within the configured threshold",
+
     --- Announces
     ["SETTING_ANNOUNCES"] = "Оповещения",
     ["ENABLE_ANNOUNCES"] = "Включить оповещения",
@@ -56,10 +68,12 @@ local L = {
     ["SUCCESS_MESSAGE_LABEL"] = "При успехе сообщить",
     ["FAIL_MESSAGE_LABEL"] = "При промахе сообщить",
     ["FAIL_WHISPER_LABEL"] = "При промахе шепнуть запасным",
+    ["UNABLE_TO_TRANQ_MESSAGE_LABEL"] = "Message whispered when you cannot tranq or call for backup",
 
     ['DEFAULT_SUCCESS_ANNOUNCE_MESSAGE'] = "Усмиряющий выстрел в %s",
     ['DEFAULT_FAIL_ANNOUNCE_MESSAGE'] = "!!! Усмиряющий выстрел промах в %s !!!",
     ['DEFAULT_FAIL_WHISPER_MESSAGE'] = "!!! Усмиряющий выстрел промах !!! ! СТРЕЛЯЙ СЕЙЧАС !",
+    ['DEFAULT_UNABLE_TO_TRANQ_MESSAGE'] = "I'M UNABLE TO TRANQ ! TRANQ NOW !",
 
     ['TRANQ_NOW_LOCAL_ALERT_MESSAGE'] = "СТРЕЛЯЙ СЕЙЧАС !",
 

locales/zhCN.lua

@@ -31,6 +31,18 @@ local L = {
     ["ARCANE_SHOT_TESTING_ENABLED"] = "奥术射击测试模式已启用, 持续10分钟",
     ["ARCANE_SHOT_TESTING_DISABLED"] = "奥术射击测试模式已禁用",
 
+    ["FEATURES_HEADER"] = "可选功能",
+    ["DISPLAY_BOSS_FRENZY_COOLDOWN"] = "显示激怒冷却进度条",
+    ["DISPLAY_BOSS_FRENZY_COOLDOWN_DESC"] = "标题栏下方显示一个细进度条",
+    ["ENABLE_AUTOMATIC_BACKUP_ALERT_WHEN_INCAPACITATED"] = "当无法工作时，启用自动替补通告",
+    ["ENABLE_AUTOMATIC_BACKUP_ALERT_WHEN_INCAPACITATED_DESC"] = "TranqRotate会检查你的Debuff，如果轮到你宁神时，你瘫痪时间超过定义的延迟时间，则会要求替补",
+    ["INCAPACITATED_DELAY_THRESHOLD"] = "瘫痪通告阀值",
+    ["INCAPACITATED_DELAY_THRESHOLD_DESC"] = "如果您瘫痪时间超过配置的延迟时间，TranqRotate将自动调用替补",
+    ["ENABLE_AUTOMATIC_TIMED_BACKUP_ALERT"] = "启用定时自动替补通告",
+    ["ENABLE_AUTOMATIC_TIMED_BACKUP_ALERT_DESC"] = "如果BOSS在规定的延迟时间内激怒，而你已经宁神了，那么TranqRotate会要求替补",
+    ["TIMED_DELAY_THRESHOLD"] = "定时通告阈值",
+    ["TIMED_DELAY_THRESHOLD_DESC"] = "如果你没有在配置的阈值内进行宁神, TranqRotate将自动调用替补",
+
     --- Announces
     ["SETTING_ANNOUNCES"] = "通告",
     ["ENABLE_ANNOUNCES"] = "启用通告",
@@ -56,10 +68,12 @@ local L = {
     ["SUCCESS_MESSAGE_LABEL"] = "施放成功通告信息",
     ["FAIL_MESSAGE_LABEL"] = "施放失败通告信息",
     ["FAIL_WHISPER_LABEL"] = "施放失败私聊信息",
+    ["UNABLE_TO_TRANQ_MESSAGE_LABEL"] = "Message whispered when you cannot tranq or call for backup",
 
     ['DEFAULT_SUCCESS_ANNOUNCE_MESSAGE'] = "已对 %s 施放了宁神射击!",
     ['DEFAULT_FAIL_ANNOUNCE_MESSAGE'] = "!!! 对 %s 宁神失败!!!",
     ['DEFAULT_FAIL_WHISPER_MESSAGE'] = "宁神失败 !! 赶紧补宁神!!",
+    ['DEFAULT_UNABLE_TO_TRANQ_MESSAGE'] = "I'M UNABLE TO TRANQ ! TRANQ NOW !",
 
     ['TRANQ_NOW_LOCAL_ALERT_MESSAGE'] = "立即使用宁神 !!",
 

locales/zhTW.lua

@@ -31,6 +31,18 @@ local L = {
     ["ARCANE_SHOT_TESTING_ENABLED"] = "奧術射擊測試模式已啟用, 持續10分鐘",
     ["ARCANE_SHOT_TESTING_DISABLED"] = "奧術射擊測試模式已禁用",
 
+    ["FEATURES_HEADER"] = "Optionals features",
+    ["DISPLAY_BOSS_FRENZY_COOLDOWN"] = "Display frenzy cooldown progress bar",
+    ["DISPLAY_BOSS_FRENZY_COOLDOWN_DESC"] = "A thin progress bar just under the title bar will show the progress",
+    ["ENABLE_AUTOMATIC_BACKUP_ALERT_WHEN_INCAPACITATED"] = "Enable automatic backup alert when incapacitated",
+    ["ENABLE_AUTOMATIC_BACKUP_ALERT_WHEN_INCAPACITATED_DESC"] = "TranqRotate will check for your debuffs when you should actually tranq and will call for backup if you are incapacitated for longer than the defined delay",
+    ["INCAPACITATED_DELAY_THRESHOLD"] = "Incapacitated alert threshold",
+    ["INCAPACITATED_DELAY_THRESHOLD_DESC"] = "If you are incapacitated for longer than the configured delay, TranqRotate will automatically call for backup",
+    ["ENABLE_AUTOMATIC_TIMED_BACKUP_ALERT"] = "Enable timed automatic backup alert",
+    ["ENABLE_AUTOMATIC_TIMED_BACKUP_ALERT_DESC"] = "TranqRotate will call for backup if the boss is on frenzy for a defined delay and you should have been tranqing it",
+    ["TIMED_DELAY_THRESHOLD"] = "Timed alert threshold",
+    ["TIMED_DELAY_THRESHOLD_DESC"] = "TranqRotate will automatically call for backup if you do not tranq within the configured threshold",
+
     --- Announces
     ["SETTING_ANNOUNCES"] = "通告",
     ["ENABLE_ANNOUNCES"] = "啟用通告",
@@ -56,10 +68,12 @@ local L = {
     ["SUCCESS_MESSAGE_LABEL"] = "施放成功通告資訊",
     ["FAIL_MESSAGE_LABEL"] = "施放失敗通告資訊",
     ["FAIL_WHISPER_LABEL"] = "施放失敗私聊資訊",
+    ["UNABLE_TO_TRANQ_MESSAGE_LABEL"] = "Message whispered when you cannot tranq or call for backup",
 
     ['DEFAULT_SUCCESS_ANNOUNCE_MESSAGE'] = "已對 %s 施放了寧神射擊!",
     ['DEFAULT_FAIL_ANNOUNCE_MESSAGE'] = "!!! 對 %s 寧神失敗!!!",
     ['DEFAULT_FAIL_WHISPER_MESSAGE'] = "寧神失敗 !! 趕緊補寧神!!",
+    ['DEFAULT_UNABLE_TO_TRANQ_MESSAGE'] = "I'M UNABLE TO TRANQ ! TRANQ NOW !",
 
     ['TRANQ_NOW_LOCAL_ALERT_MESSAGE'] = "立即使用寧神 !!",
 

src/comms.lua

@@ -26,6 +26,8 @@ function TranqRotate.OnCommReceived(prefix, data, channel, sender)
                 TranqRotate:receiveSyncOrder(prefix, message, channel, sender)
             elseif (message.type == TranqRotate.constants.commsTypes.syncRequest) then
                 TranqRotate:receiveSyncRequest(prefix, message, channel, sender)
+            elseif (message.type == TranqRotate.constants.commsTypes.backupRequest) then
+                TranqRotate:receiveBackupRequest(prefix, message, channel, sender)
             end
         end
     end
@@ -105,6 +107,18 @@ function TranqRotate:sendSyncOrderRequest()
     TranqRotate:sendRaidAddonMessage(message)
 end
 
+-- Broadcast a request for the current rotation configuration
+function TranqRotate:sendBackupRequest(name)
+
+    TranqRotate:printPrefixedMessage('Sending backup request to ' .. name)
+
+    local message = {
+        ['type'] = TranqRotate.constants.commsTypes.backupRequest,
+    }
+
+    TranqRotate:sendWhisperAddonMessage(message, name)
+end
+
 -----------------------------------------------------------------------------------------------------------------------
 -- INPUT
 -----------------------------------------------------------------------------------------------------------------------
@@ -138,3 +152,9 @@ end
 function TranqRotate:receiveSyncRequest(prefix, data, channel, sender)
     TranqRotate:sendSyncOrder(true, sender)
 end
+
+-- Received a backup request
+function TranqRotate:receiveBackupRequest(prefix, message, channel, sender)
+    TranqRotate:printPrefixedMessage(sender .. ' asked for backup !')
+    TranqRotate:throwTranqAlert()
+end

src/constants.lua

@@ -24,6 +24,7 @@ TranqRotate.constants = {
         ['tranqshotDone'] = 'tranqshot-done',
         ['syncOrder'] = 'sync-order',
         ['syncRequest'] = 'sync-request',
+        ['backupRequest'] = 'backup-request',
     },
 
     ['printPrefix'] = 'TranqRotate - ',
@@ -51,10 +52,31 @@ TranqRotate.constants = {
     },
 
     ['bosses'] = {
-        [11982] = 19451, -- magmadar
-        [11981] = 23342, -- flamegor
-        [14020] = 23342, -- chromaggus
-        [15509] = 19451, -- huhuran
---        [15932] = 19451, -- gluth
-    }
+        [11982] = { -- magmadar
+            ['frenzy'] = 19451,
+            ['cooldown'] = 18,
+        },
+        [11981] = { -- flamegor
+            ['frenzy'] = 23342,
+            ['cooldown'] = 9,
+        },
+        [14020] = { -- chromaggus
+            ['frenzy'] = 23342,
+            ['cooldown'] = 16,
+        },
+        [15509] = { -- huhuran
+            ['frenzy'] = 19451,
+            ['cooldown'] = 13,
+        },
+        [15932] = { -- gluth
+            ['frenzy'] = 19451,
+            ['cooldown'] = 10,
+        },
+    },
+
+    ["incapacitatingDebuffs"] = {
+        19408, -- Magmadar fear
+        23171, -- Chromaggus Bronze affliction stun
+        23311, -- Chromaggus Time lapse
+    },
 }

src/debuff.lua

@@ -0,0 +1,21 @@
+local TranqRotate = select(2, ...)
+
+-- Checks if player is incapacitated by a debuff for too long
+function TranqRotate:isPlayedIncapacitatedByDebuff()
+
+    for i, debuffId in ipairs(TranqRotate.constants.incapacitatingDebuffs) do
+
+        local name, _, _, _, _, expirationTime, _, _, _, spellId, _, isBossDebuff
+            = AuraUtil.FindAuraByName(GetSpellInfo(debuffId), "player")
+
+        if (name) then
+            print(name, expirationTime - GetTime(), spellId, isBossDebuff)
+
+            if (expirationTime - GetTime() > TranqRotate.constants.incapacitatedDelay) then
+                return true
+            end
+        end
+    end
+
+    return false
+end

src/defaults.lua

@@ -10,13 +10,19 @@ function TranqRotate:LoadDefaults()
 	        announceSuccessMessage = L["DEFAULT_SUCCESS_ANNOUNCE_MESSAGE"],
 	        announceFailMessage = L["DEFAULT_FAIL_ANNOUNCE_MESSAGE"],
 			whisperFailMessage = L["DEFAULT_FAIL_WHISPER_MESSAGE"],
+			unableToTranqMessage = L["DEFAULT_UNABLE_TO_TRANQ_MESSAGE"],
 			lock = false,
 			hideNotInRaid = false,
 			enableNextToTranqSound = true,
 			enableTranqNowSound = true,
 			tranqNowSound = 'alarm1',
 			doNotShowWindowOnRaidJoin = false,
 			showWindowWhenTargetingBoss = false,
+			showFrenzyCooldownProgress = true,
+			enableIncapacitatedBackupAlert = true,
+			incapacitatedDelay = 1.5,
+			enableTimedBackupAlertValue = true,
+			timedBackupAlertValueDelay = 1.5,
 	    },
 	}
 end