Buff Monitor System

Discussion in 'Player Created Lua Script Repository' started by Tirrag, Jun 26, 2020.

  1. Tirrag

    Tirrag Avatar

    Messages:
    467
    Likes Received:
    1,024
    Trophy Points:
    43
    Location:
    Iowa, USA / Maiden's Blush, SotA
    Greetings and welcome to the buff monitor system for SotA! It is very difficult to see the active buffs on your character when they are active and presents a problem when they unknowingly expire. This is a lua mod that allows special indicators to be placed for active buffs on your character to provide better visibility to their status as you are playing.

    Buffs Currently Monitored - updated 2021-08-26
    Air's Embrace
    Aetheric Feedback
    Anthem of Alacrity
    Atonal Aria
    Berserk
    Berserkers Stance
    Bolster Balance
    Celestial Blessing
    Chaotic Feedback
    Dash
    Death Shield
    Defensive Stance
    Deflect
    Dodge
    Douse
    Enlightenment
    Evasion
    Flurry
    Knights Grace
    Earths Embrace
    Elysian Illumination
    Fortify Defenses
    Glancing Blow
    Healing Grace
    Ice Field
    Immolation
    Inner Strength
    Ignite Weapon
    Melody of Mending
    Mesmerizing Melody
    Meteor Shower
    Night Vision
    Parry
    Poison Weapon
    Provoking Shout
    Psalm of Stagnation
    Purify
    Purify Burst
    Refrain of Resistance
    Rhapsody of Recovery
    Ring of Fire
    Spellbinder Stance
    Savage Sonata
    Shield of Air
    Shield of Crystal
    Shield of Ice
    Soothing Rain
    Sprint
    Torpor

    Pet Buffs Currently Monitored - updated 2021-08-26

    Health
    Frenzy
    Strength of Earth
    Air's Embrace
    Enlightenment
    Bear Bites
    Dragon Kibbles
    Venison Jerky
    Rabbit Pate'

    What does it do? - updated 2021-09-30
    This addon will create indicators on your UI that will show when a buff is activated, when there is 1/2 of the buff time remaining the indicator will turn yellow, when 1/3 of the buff time remaining the indicator will turn yellow with red corners, when the buff expires the indicator will turn red, and then 20 seconds after that the buff indicator will disappear (unless the buff is reactivated). Buff indicators can be positioned individually so you may place them where you see fit.

    Examples of the Defensive Stance indicator:

    [​IMG] [​IMG] [​IMG]

    Getting Started
    To get started you will need to download the Buff Monitor System addon at:

    Compatible with R94+, released on 2021/09/30
    https://shroudoftheavatar.tools/buff_monitor_system_v3.08.zip

    Please extract the files and directories from the zip download into your Lua SotA folder. If you are prompted to overwrite libsota.lua and libsota.util.lua and have not previously installed this mod, I would recommend skipping those two files. When installed properly you should see files called:

    buff_monitor_system.lua
    libsota.lua
    libsota.util.lua

    in your root Lua folder and a folder called "bms".

    If you cannot find your lua folder, while in-game in the local chat type:

    /datafolder

    This will open up a dialog showing your SotA data folder of which one subdirectory will be the Lua folder.

    If you extracted the files into your Lua folder while in-game they will not be active yet until you either restart the game or in the local chat type:

    /lua reload

    Upon reload, you should see messages in the lua chatbox (be sure lua is checked for that tab) indicating that the addon is active.

    Updating from an Earlier Version - new 2021-09-30
    When updating from an earlier version your settings will not be overwritten. Still, it is recommended you backup the user.ini file within the lua/bms folder before updating. Simply overwrite the existing version with the new version. If you are updating to v3.03, you can delete your images folder and replace it with the new one from the zip file. I updated the image format to jpg from png to shave 7MB off the mod size. If you are updating to v3.06, you can delete your images folder and replace it with the new one from the zip file. For this version I have added an overlay system so the amount of images required is much, much less.

    First Time In-Game
    Once you have confirmed via the lua messages that the addon is active it is time to give it a try. All indicators are initially positioned in the upper left of your screen. To activate one, enter combat mode and activate one of the supported buffs. You should see the corresponding indicator in the upper left. Please note that if you call /lua reload with a buff already active it may throw the addon off until the buff expires.

    With the indicator visible you can now relocate it. To relocate an indicator, hold down the Left Control button and click the indicator. Release the mouse button but keep the Left Control button held and move the mouse to reposition the indicator. Once you have the indicator located where you desire, release the Left Control button. The new position will be remembered the next time you load the game.

    Activating/Deactivating Monitors - new 2020-07-12
    Holding the RightAlt key and pressing M will bring up the activation/deactivation screen for individual monitors.

    [​IMG]

    To deactivate a monitor click the icon and it will toggle the activation. A red monitor icon indicates that the monitor for that buff is currently deactivated. The settings are saved immediately and will be restored the next time SotA starts. You can use this screen to deactivate any skills that are not needed or conflict with your current deck and equipment. To close the configuration screen either click the X in the upper right or hold RightAlt and press M. NOTE: while in the activation/deactivate screen the icons will not show if you use a skill.

    Resetting the System- new 2020-07-12
    If somethings seems off with the monitors, hold the RightAlt key and press R to reset the buff monitor system. If the system is reset while buffs are active most indicators will not activate again for that skill until it has expired.

    Interface Scaling - new 2021-05-30
    If the icons are too small there is a configurable option in the montiors.ini file inside the bms folder. Edit the file with a text editor and update the icon scale. 1 is the starting scale so a value of 2 would be double. You can do decimals like 1.25, 1.5, 1.75. Once you update and save the file use RightAlt+R in-game to apply the new scale. Please don't hesitate to ask questions if you have an issue.

    Whats next?- updated 2020-08-02
    I would like to add support for a lot of the buff potions. I would like to eventually make different layout sets similar to different decks. It would be nice if the SotA Lua system provided information when swapping decks but unfortunately it doesn't so anything I do here will not be a seamless as I would like. I have also been thinking about a layout configuration screen where you can place all the skills without needing to cast them first. I would also like to get an interface to the scaling.

    NOTE: This module makes use of the wonderful libsota library by @CatweazleX . Starting with BMS v3.05, libsota v0.4.8 is included with the distribution. While you no longer need to download and install separately, if you do wish to visit the libsota thread, you may find the library at:

    https://www.shroudoftheavatar.com/f...lper-library-in-lua-for-shroud-in-lua.160222/
     
    Last edited: Oct 14, 2021 at 12:21 PM
    Barugon, Time Lord, Mimner and 10 others like this.
  2. Tirrag

    Tirrag Avatar

    Messages:
    467
    Likes Received:
    1,024
    Trophy Points:
    43
    Location:
    Iowa, USA / Maiden's Blush, SotA
    UPDATE (2021-10-03): v3.08 release fixing issues with pet food.

    UPDATE (2021-10-01): v3.07 release fixing issue with frenzy.

    UPDATE (2021-09-30): v3.06 release fixing incompatibilities with R94. Update to the overlay system where overlays are now separate from the skill icons.

    UPDATE (2021-09-13): v3.05 release with no fixes, but now including libsota as part of the distribution.

    UPDATE (2021-09-07): v3.04 release fixing a bug with the pet health indicator not flipping to warn.

    UPDATE (2021-08-28): v3.03 release updating the image format to jpg. Before installing the new files you may delete the bms/images folder.

    UPDATE (2021-08-27): v3.01 release fixing bug where the warn color would not trigger

    UPDATE (2021-08-26): v3.01 release updating the core to use the new player and pet buff functions. adding support for player buffs Dash and Sprint plus pet health and buffs Frenzy, Strength of Earth, Air's Embrace, Enlightenment, Bear Bites, Dragon Kibbles, Venison Jerky, Rabbit Pate'

    UPDATE (2021-08-02): v2.05 release adding support for buffs Air's Embrace, Enlightenment, Flurry, Inner Strength, Night Vision, Provoking Shout, Strength of Earth, Torpor

    UPDATE (2021-06-08): New v2.04 released (see ZIP link in initial post). I fixed an issue where the spider attack poison debuff was incorrectly being detected as the poison weapon buff.

    UPDATE (2021-05-30): New v2.03 released (see ZIP link in initial post). I introduced a scale setting in case the icons are too small and added chaotic feedback. See above for details.

    UPDATE (2021-05-29): New v2.02 released (see ZIP link in initial post). There was a bug found where if you let a buff go to red and then recast it, the timer that hides the icon was not getting reset causing the recast icon to hide.

    UPDATE (2021-05-29): New v2.01 released (see ZIP link in initial post). This release is the first based on the new buff lua functions. The core of the functionality has been rewritten and simplified. Due to having direct access to buff information there are no more conflicts between skills, warnings are accurate, and nearly any buff will work with the system.

    UPDATE (2020-07-12): New v1.04 released (see ZIP link in initial post). This release has a slew of new features including many new buffs monitored. Activation/deactivation has been consolidated into a single screen (RightAlt+M). There is a new learning mode to teach the system thresholds related to your specific configurations (RightAlt+L). There is a reset in case the system gets confused (RightAlt+R). You should not lose any settings with this release. Please read the info section above for more details. Please note that there was one restructure performed which relocated all the images into a subfolder. While it will not hurt to have images where they were prior to this revision, if you wish to cleanup the main BMS folder by removing all images please feel free to do so. If you choose to cleanup, please be very careful not to delete the monitors.ini or users.ini file.

    UPDATE (2020-06-28): New v1.01 released (see ZIP link in initial post). This release adds the warning indicator for buffs with two stages (an initial big buff, then a few seconds later it drops). It also breaks the user settings into their own file. This means that with any new release after this one you hopefully will not lose your settings. Unfortunately with this release you will need to reset any activations and reposition your indicators.

    UPDATE (2020-06-26): I noticed the settings for glancing blow were missing from the initial v1.00 release. The ZIP download has been updated but there is an updated ini file available at:

    https://shroudoftheavatar.tools/monitors.ini

    Place this in your lua/bms subfolder. You do not need this if you have updated to a higher version already. NOTE: It will overwrite your current position settings.
     
    Last edited: Oct 3, 2021
    Time Lord, FrostII, Net and 2 others like this.
  3. Tirrag

    Tirrag Avatar

    Messages:
    467
    Likes Received:
    1,024
    Trophy Points:
    43
    Location:
    Iowa, USA / Maiden's Blush, SotA
    Monitor updated. Info above.
     
    Last edited: Jun 28, 2020
    Time Lord and FrostII like this.
  4. Tirrag

    Tirrag Avatar

    Messages:
    467
    Likes Received:
    1,024
    Trophy Points:
    43
    Location:
    Iowa, USA / Maiden's Blush, SotA
    New version of the buff monitor system has been released. See above for details.
     
    Last edited: Jul 12, 2020
  5. Tirrag

    Tirrag Avatar

    Messages:
    467
    Likes Received:
    1,024
    Trophy Points:
    43
    Location:
    Iowa, USA / Maiden's Blush, SotA
    great news! buff information is now available via Lua. this means i can finally realize the full potential of this this mod :) please let me know the most important buffs to you that are not already included and i will get to adding them. this includes things like ring of fire, meteor shower, and atonal aria.
     
    Time Lord, FrostII, DavidDC and 2 others like this.
  6. Violet Ronso

    Violet Ronso Avatar

    Messages:
    2,396
    Likes Received:
    4,550
    Trophy Points:
    153
    I would say Bard songs are a SUPER important one for me, Anthem of Alacrity, Savage Sonata, Psalms of Stagnation, Melody of Mending, Rapsody of Recovery and Atonal Aria! As a group buffer I like to know when it's time to recast them (and I wonder if it's possible now to go duration left - cast time = Warning? that could be cool!)
     
    Time Lord likes this.
  7. Tirrag

    Tirrag Avatar

    Messages:
    467
    Likes Received:
    1,024
    Trophy Points:
    43
    Location:
    Iowa, USA / Maiden's Blush, SotA
    perfect thank you! you will be very happy with this next release as the bard songs are supported :) and yes warnings are now functioning for all current and new monitors. icon will turn yellow with 1/3 of the buff time remaining. the core coding is complete and i am testing it now with the existing buffs. once i feel its solid i will start adding new ones, test again, package, release!
     
    Last edited: Jun 8, 2021
  8. Tirrag

    Tirrag Avatar

    Messages:
    467
    Likes Received:
    1,024
    Trophy Points:
    43
    Location:
    Iowa, USA / Maiden's Blush, SotA
    coding and testing went well. there are now 39 buffs you can monitor all with warnings to let you know before they are going to expire. plus there are no more conflicts so they all work well together. the new list of buff monitors is below. so happy with the latest lua update. finally realizing the full potential of this mod. i hope to package release this weekend!


    Knights Grace
    Bolster Balance
    Poison Weapon
    Aetheric Feedback
    Spellbinder Stance
    Meteor Shower
    Ring of Fire
    Ignite Weapon
    Healing Grace
    Purify Burst
    Elysian Illumniation
    Earths Embrace
    Ice Field
    Soothing Rain
    Savage Sonata
    Rhapsody of Recovery
    Refrain of Resistance
    Psalm of Stagnation
    Mesmerizing Melody
    Melody of Mending
    Atonal Aria
    Anthem of Alacrity
    Parry
    Shield of Ice
    Glancing Blow
    Deflect
    Shield of Air
    Defensive Stance
    Dodge
    Douse
    Death Shield
    Immolation
    Celestial Blessing
    Purify
    Shield of Crystal
    Berserkers Stance
    Evasion
    Berserk
    Fortify Defenses
     
    Time Lord, Elgarion, FrostII and 2 others like this.
  9. Tirrag

    Tirrag Avatar

    Messages:
    467
    Likes Received:
    1,024
    Trophy Points:
    43
    Location:
    Iowa, USA / Maiden's Blush, SotA
    @Violet Ronso the new release is available in the initial post. enjoy the visibility to the bard buffs! i know i will :)
     
  10. Tirrag

    Tirrag Avatar

    Messages:
    467
    Likes Received:
    1,024
    Trophy Points:
    43
    Location:
    Iowa, USA / Maiden's Blush, SotA
    monitor update. info above.
     
  11. Duke Gréagóir

    Duke Gréagóir Legend of the Hearth

    Messages:
    5,385
    Likes Received:
    11,448
    Trophy Points:
    165
    Location:
    Dara Brae
    OM Goodness! THANK YOU for this buff system. The Bard Specialization LOVES this as now I know when my songs are ending. :)
     
    Time Lord, Elgarion, Tirrag and 2 others like this.
  12. Scanphor

    Scanphor Avatar

    Messages:
    427
    Likes Received:
    815
    Trophy Points:
    43
    Thank you so much for this! Its hard to overstate how useful this is :D
     
  13. Tirrag

    Tirrag Avatar

    Messages:
    467
    Likes Received:
    1,024
    Trophy Points:
    43
    Location:
    Iowa, USA / Maiden's Blush, SotA
    thank you all for the wonderful feedback! very happy folks find it as useful as i do :)

    with that, i released v2.04. the only thing fixed in this version is an issue with the poison weapon monitor. if you dont use it then you will not need the update. see notes above.
     
  14. Xarras

    Xarras Avatar

    Messages:
    74
    Likes Received:
    91
    Trophy Points:
    8
    Gender:
    Male
    Location:
    Wales
    Thank you for this addition to my sota enjoyment. I have long requested something like this.
    But I am disappointed in two ways.
    1 It's taken me till now to find you / it.
    2 I can't make it work.

    I downloaded
    https://www.shroudoftheavatar.com/f...lper-library-in-lua-for-shroud-in-lua.160222/
    and
    https://g2-games.com/sota/buff_monitor_system_v2.04.zip
    and unzipped them in to the lua folder where ocxtools is.

    When starting up I get this notice.

    [31/07/2021 09:48:32] [00:02] (Lua): Loaded Lua file C:\Users\xbox\AppData\Roaming\Portalarium\Shroud of the Avatar\Lua\buff_monitor_system.lua
    [31/07/2021 09:48:32] [00:02] (Lua): Loaded Lua file C:\Users\xbox\AppData\Roaming\Portalarium\Shroud of the Avatar\Lua\ocx-tools.lua
    [31/07/2021 09:48:32] [00:02] (Lua): Lua Error chunk_1:(21,10-443,5): attempt to index a nil value

    oxctools is working fine but there is no Buff Monitor so I guess the "chunk" thingamy is the Buff Monitor problem.
    I am a tech innocent so have most probably done something wrong or not done something I should have and will be embarrassed by the solution. So please accept my apologies for taking up your time in advance.

    Thank you again for this quite important addition to SotA. I look forward to it making a difference to my game play.
     
  15. Tirrag

    Tirrag Avatar

    Messages:
    467
    Likes Received:
    1,024
    Trophy Points:
    43
    Location:
    Iowa, USA / Maiden's Blush, SotA
    greetings @Xarras! thank you for giving the mod a whirl :) going to take troubleshooting it into private messaging hopefully we can get this resolved for you.
     
    Time Lord likes this.
  16. FrostII

    FrostII Bug Hunter

    Messages:
    5,459
    Likes Received:
    10,535
    Trophy Points:
    153
    Gender:
    Male
    Location:
    Pacific Northwest
    @Tirrag
    Installed BMS with Libsota today and love it ! :)

    Noticed that it does not include Enlightenment or Air's Embrace and hope that you will include them !

    Thank you for your work on this fine Lua app ! ;)

    **Edit** While fighting today, I found a couple more that would also be great to have: Flurry and Night Vision ! :)
     
    Last edited: Aug 1, 2021
    Time Lord, Tirrag and Xarras like this.
  17. Xarras

    Xarras Avatar

    Messages:
    74
    Likes Received:
    91
    Trophy Points:
    8
    Gender:
    Male
    Location:
    Wales
    oh Flurry would be quite important for my Death magery.
     
  18. Scanphor

    Scanphor Avatar

    Messages:
    427
    Likes Received:
    815
    Trophy Points:
    43
    While we're on the subject the one I use the most that isn't covered is inner strength :)
     
    Time Lord, Tirrag and Violet Ronso like this.
  19. Tirrag

    Tirrag Avatar

    Messages:
    467
    Likes Received:
    1,024
    Trophy Points:
    43
    Location:
    Iowa, USA / Maiden's Blush, SotA
    looks like we got everything worked out. thank you @Xarras for your patience while we worked through the issue :) ultimately it ended up being the libsota library placed in the wrong location.

    thank you all for the recommendations on new skills to be added. look to have these added in the near future :)
     
    Last edited: Aug 2, 2021
    Time Lord, Violet Ronso, Anpu and 2 others like this.
  20. Scanphor

    Scanphor Avatar

    Messages:
    427
    Likes Received:
    815
    Trophy Points:
    43
    Great :)
     
    Time Lord, Tirrag and FrostII like this.