Merge branch 'release/v1.1.0'

README.md

@@ -2,31 +2,61 @@
 
 This addon is meant to help hunters to setup tranqshot rotation and give them real time visual feedback about it.
 
-This first version is missing a lot of features I want to implement, and will only let you configure automatic success and miss tranqshot announces to a defined channel, hopefully you won't have to bother with that crappy macro anymore !
+**TranqRotate DOES NOT synchronize anything with other hunters (yet), even if they use the addon too. 
+Considering this fact and the Blizzard 45m combat log limit, I would advice to not have your hunters spread too much until sync is added.**
 
-## Roadmap
+This addon is still in a (stable) beta state, a stable release should come soon.
 
-Here is a list of feature I want to implement at some point, no specific order is decided yet.
+## Feedback
 
-- Display of hunter's tranqhot cooldowns
-- Transhot rotation configuration (raid assist required, order hunters, make groupe of multiple hunters, leave some hunt out of rotation as backup)
-- Transhot rotation display (Synchronized list will rotate as hunters tranq successfully or miss, showing at top the next hunter or hunter group that will have to tranq)
+I'm looking for feedback ! Feel free to contact me ingame (Slivo@Sulfuron).
+ 
+Please report any issue using github issues : https://github.com/Slivo-fr/TranqRotate/issues
 
-### Download
+## Features
 
-Do not use github download button on this page, get the latest release zip file from https://github.com/Slivo-fr/TranqRotate/releases
+- 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
+- Allow player to re-order players between two groups : main rotation and backup.
+- Whisper the next hunter on the rotation as well as all backup hunters if you miss your tranqshot
+- Provide a real time visual feedback about the rotation status, even if no one else use the addon in your raid
+- Allow player to broadcast the configured rotation and backup group to the raid
+- Display offline and dead status on hunters frames
 
-Also available here https://www.curseforge.com/wow/addons/tranqrotate and there https://wowclassicui.com/fr/addons/tranqrotate
+## Usage
+
+Use `/tranq` for options
 
-### Credits
+You must be in a raid for hunters to get registered and displayed by the addon.
 
-I've been learning and using some code of https://github.com/Aviana/YaHT to build this first codebase. It helped a lot !
+First step is to set your tranq order using drag & drop on hunters. 
+You may use the trumpet button to get it written in raid chat so others hunters can know what you planned (And set their TranqRotate order if they use it). 
+Please note the backup group is hidden if empty but you can still drag hunters into it.
 
-### About me
+You can now just pull the boss and start shooting your tranqshots, TranqRotate will track the rotation and use a purple tranq-like color on the next hunter that should tranq.
 
-I work as developer in a very different field, I have been wanting to make some addon for a long time but I'm a total newbie on this topic.
+Once boss has died (or you wiped), just use the reset button in the top bar to reset the rotation state
 
-Here is my first try, don't be too harsh but let me know if somethings looks wrong to you !
-Please report any issue using github issues : https://github.com/Slivo-fr/TranqRotate/issues
+## Roadmap
+
+Here is a list of feature I want to implement at some point, no specific order is decided yet.
+
+- Display of every hunter tranqhot cooldowns
+- Data sync between all users, allowing raid leader or raid assistant to setup the rotation for everyone
+- 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 or boss die
+- Encounter detection and frenzy cooldown progress bar
+- Handling of battleground raids
+
+## Download
+
+Do not use github download button on this page, get the latest release zip file from https://github.com/Slivo-fr/TranqRotate/releases
+
+Also available here https://www.curseforge.com/wow/addons/tranqrotate and there https://wowclassicui.com/fr/addons/tranqrotate
+
+## Credits
 
+I've been learning and using some code of https://github.com/Aviana/YaHT to build this first codebase. Thanks for his work.
 
+Many thanks to the wow addon discord members that helped me a lot too.

TranqRotate.toc

@@ -1,4 +1,4 @@
-## Interface: 11302
+## Interface: 11303
 ## Title: TranqRotate
 ## Notes: A tranqshot rotation assistant
 ## Author: Slivo
@@ -20,6 +20,13 @@ locales\frFR.lua
 locales\zhCN.lua
 locales\zhTW.lua
 
-TranqRotate.lua
-defaults.lua
-settings.lua
+src\tranqRotate.lua
+src\events.lua
+src\rotation.lua
+src\constants.lua
+src\frames.lua
+src\gui.lua
+src\dragdrop.lua
+src\defaults.lua
+src\settings.lua
+src\utils.lua

changelog.md

@@ -0,0 +1,40 @@
+## TranqRotate Changelog
+
+#### v1.1.0
+
+- Adds TranqRotate window
+- Adds raid hunters detection
+- Adds rotation handling
+- Adds main window position change using drag & drop
+- Adds main window position lock setting
+- Adds hunter death and disconnection display on hunter frames
+- Adds hunter group and order change using drag & drop
+- Adds lock/unlock slash command option
+- Adds toggle slash command option
+- Adds "broadcast rotation setup to raid chat"
+- Adds rotation reset button to re-initialize betweeen/after pulls
+- Adds whisper message to next hunter and all backup hunters when you miss
+- Adds close button to top bar
+- Adds option to hide main window when not in a raid
+
+- Change base slash command to display available options
+- Change slash command settings to `/tranq settings`
+
+- Splits code in multiple files
+- Moves all lua files to src/
+- Use first target change event to update raid status if player login while already in raid
+- Updates game interface version to 11303
+
+#### v1.0.1
+
+- Fix missing libs in toc file
+
+#### v1.0.0
+
+- Adds slash command
+- Adds settings
+- Adds base combat log handling
+- Adds automatic success and fail tranqshot messages
+- Adds frFR locale
+- Adds znTW locale
+- Adds znTW locale

locales/enUS.lua

@@ -2,13 +2,15 @@ local TranqRotate = select(2, ...)
 
 local L = {
 
-    ["LOADED_MESSAGE"] = "TranqRotate loaded, type /tranq for settings",
+    ["LOADED_MESSAGE"] = "TranqRotate loaded, type /tranq for options",
+    ["TRANQ_WINDOW_HIDDEN"] = "Tranqrotate window hidden. Use /tranq toggle to get it back",
 
     -- Settings
     ["SETTING_GENERAL"] = "General",
     ["SETTING_GENERAL_REPORT"] = "Please report any issue at",
-    ["SETTING_GENERAL_DESC"] = "This first version will only allow you to get automatic tranq annouce messages\n"..
-        "I'm planning to add more features giving visual feedback about tranqshot rotation",
+    ["SETTING_GENERAL_DESC"] = "New : TranqRotate now has a window allowing hunters to track rotation status\n"..
+        "It still automatically announce tranq or miss and now whispers next and backup when you miss\n"..
+        "It doesn't sync rotation order between hunters yet, you have to manually set the correct groups and order.",
 
     --- Announces
     ["SETTING_ANNOUNCES"] = "Announces",
@@ -35,12 +37,27 @@ local L = {
     ["ANNOUNCES_MESSAGE_HEADER"] = "Announce messages",
     ["SUCCESS_MESSAGE_LABEL"] = "Successful announce message",
     ["FAIL_MESSAGE_LABEL"] = "Fail announce message",
+    ["FAIL_WHISPER_LABEL"] = "Fail whisper message",
 
     ['DEFAULT_SUCCESS_ANNOUNCE_MESSAGE'] = "Tranqshot done on %s",
     ['DEFAULT_FAIL_ANNOUNCE_MESSAGE'] = "!!! TRANQSHOT FAILED ON %s !!!",
+    ['DEFAULT_FAIL_WHISPER_MESSAGE'] = "TRANQSHOT FAILED ! TRANQ NOW !",
+
+    --- Rotation
+    ["LOCK_WINDOW"] = "Lock window",
+    ["LOCK_WINDOW_DESC"] = "Lock window",
+    ["HIDE_WINDOW_NOT_IN_RAID"] = "Hide the window when not in a raid",
+    ["HIDE_WINDOW_NOT_IN_RAID_DESC"] = "Hide the window when not in a raid",
+    ["WINDOW_LOCKED"] = "TranqRotate: Window locked",
+    ["WINDOW_UNLOCKED"] = "TranqRotate: Window unlocked",
 
     --- Profiles
-    ["SETTING_PROFILES"] = "Profiles"
+    ["SETTING_PROFILES"] = "Profiles",
+
+    --- Raid broadcast messages
+    ["BROADCAST_HEADER_TEXT"] = "Hunter tranqshot setup",
+    ["BROADCAST_ROTATION_PREFIX"] = "Rotation",
+    ["BROADCAST_BACKUP_PREFIX"] = "Backup",
 }
 
 TranqRotate.L = L

locales/frFR.lua

@@ -5,12 +5,14 @@ local TranqRotate = select(2, ...)
 local L = {
 
     ["LOADED_MESSAGE"] = "TranqRotate chargé, utilisez /tranq pour les options",
+    ["TRANQ_WINDOW_HIDDEN"] = "Tranqrotate window hidden. Use /tranq toggle to get it back",
 
     -- Settings
     ["SETTING_GENERAL"] = "Général",
     ["SETTING_GENERAL_REPORT"] = "Merci de signaler tout bug rencontré sur",
-    ["SETTING_GENERAL_DESC"] = "Cette première version permet uniquement des annonces automatique pour le tir tranquillisant\n"..
-        "D'autres fonctionnalités sont prévues, permettant entre autre un affichage temps réel de la rotation et des cooldowns",
+    ["SETTING_GENERAL_DESC"] = "Nouveau : Une fenetre permet maintenant de régler et suivre la rotation\n"..
+        "TranqRotate va également et automatiquement chuchoter le chasseur suivant et le backup en cas de raté !\n"..
+        "Aucune synchronisation n'est encore en place, chaque chasseur dois régler l'ordre de son coté.",
 
     --- Announces
     ["SETTING_ANNOUNCES"] = "Annonces",
@@ -37,12 +39,27 @@ local L = {
     ["ANNOUNCES_MESSAGE_HEADER"] = "Messages",
     ["SUCCESS_MESSAGE_LABEL"] = "Message de réussite",
     ["FAIL_MESSAGE_LABEL"] = "Message d'échec",
+    ["FAIL_WHISPER_LABEL"] = "Message d'échec cdhuchoté",
 
     ['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 !",
+
+    --- Rotation
+    ["LOCK_WINDOW"] = "Verrouiller la position de la fênetre",
+    ["LOCK_WINDOW_DESC"] = "Verrouiller la position de la fênetre",
+    ["HIDE_WINDOW_NOT_IN_RAID"] = "Masquer la fenêtre principale hors raid",
+    ["HIDE_WINDOW_NOT_IN_RAID_DESC"] = "Masquer la fenêtre principale hors raid",
+    ["WINDOW_LOCKED"] = "TranqRotate: Fenêtre verrouillée",
+    ["WINDOW_UNLOCKED"] = "TranqRotate: Fenêtre déverrouillée",
 
     --- Profiles
-    ["SETTING_PROFILES"] = "Profils"
+    ["SETTING_PROFILES"] = "Profils",
+
+    --- Raid broadcast messages
+    ["BROADCAST_HEADER_TEXT"] = "Hunter tranqshot setup",
+    ["BROADCAST_ROTATION_PREFIX"] = "Rotation",
+    ["BROADCAST_BACKUP_PREFIX"] = "Backup",
 }
 
 TranqRotate.L = L

locales/zhCN.lua

@@ -4,13 +4,15 @@ local TranqRotate = select(2, ...)
 
 local L = {
 
-    ["LOADED_MESSAGE"] = "TranqRotate 已加载, 输入 /tranq 进入设置",
+    ["LOADED_MESSAGE"] = "TranqRotate loaded, type /tranq for options",
+    ["TRANQ_WINDOW_HIDDEN"] = "Tranqrotate window hidden. Use /tranq toggle to get it back",
 
     -- Settings
     ["SETTING_GENERAL"] = "General",
     ["SETTING_GENERAL_REPORT"] = "Please report any issue at",
-    ["SETTING_GENERAL_DESC"] = "This first version will only allow you to get automatic tranq annouce messages\n"..
-        "I'm planning to add more features giving visual feedback about tranqshot rotation",
+    ["SETTING_GENERAL_DESC"] = "New : TranqRotate now has a window allowing hunters to track rotation status\n"..
+        "It still automatically announce tranq or miss and now whispers next and backup when you miss\n"..
+        "It doesn't sync rotation order between hunters yet, you have to manually set the correct groups and order.",
 
     --- Announces
     ["SETTING_ANNOUNCES"] = "通告",
@@ -37,12 +39,27 @@ local L = {
     ["ANNOUNCES_MESSAGE_HEADER"] = "通告信息",
     ["SUCCESS_MESSAGE_LABEL"] = "施放成功通告信息",
     ["FAIL_MESSAGE_LABEL"] = "施放失败通告信息",
+    ["FAIL_WHISPER_LABEL"] = "Fail whisper message",
 
     ['DEFAULT_SUCCESS_ANNOUNCE_MESSAGE'] = "已对 %s 施放了宁神射击!",
     ['DEFAULT_FAIL_ANNOUNCE_MESSAGE'] = "!!! 对 %s 宁神失败!!!",
+    ['DEFAULT_FAIL_WHISPER_MESSAGE'] = "TRANQSHOT FAILED ! TRANQ NOW !",
+
+    --- Rotation
+    ["LOCK_WINDOW"] = "Lock window",
+    ["LOCK_WINDOW_DESC"] = "Lock window",
+    ["HIDE_WINDOW_NOT_IN_RAID"] = "Hide the window when not in a raid",
+    ["HIDE_WINDOW_NOT_IN_RAID_DESC"] = "Hide the window when not in a raid",
+    ["WINDOW_LOCKED"] = "TranqRotate: Window locked",
+    ["WINDOW_UNLOCKED"] = "TranqRotate: Window unlocked",
 
     --- Profiles
-    ["SETTING_PROFILES"] = "配置"
+    ["SETTING_PROFILES"] = "配置",
+
+    --- Raid broadcast messages
+    ["BROADCAST_HEADER_TEXT"] = "Hunter tranqshot setup",
+    ["BROADCAST_ROTATION_PREFIX"] = "Rotation",
+    ["BROADCAST_BACKUP_PREFIX"] = "Backup",
 }
 
 TranqRotate.L = L