Release MQ2React

drwhomphd · May 19, 2020

Redbot submitted a new resource:

MQ2React - Condition/Action execution plugin (i.e., the if-then part of MQ2Melee without the Melee)

MQ2React

MQ2React is a plugin that allows users to define actions and conditions that define when to perform those actions. Conditions are defined in MQ2 Macro syntax and actions are mq2 commands. It's up to the user to make sure their defined conditionas and reactions do not conflict with one another; mq2react does no additional action deconfliction. This is similar to the "HolyShit" and "DownShit" behavior of MQ2Melee without the additional automation behavior...

Utility - MQ2Macro extension for VSCode

This is an extension for Microsoft VisualStudio Code to enhance your MQ2 macro writing and editing experience. Microsoft's VisualStudio Code is a lightweight but extremely powerful multi-platform, multi-environment editor. If you do not have...

www.redguides.com

drwhomphd · May 21, 2020

And I'll probably change the file extension after must consternation from other devs so that it'll auto syntax highlight right.

I used notepad and notepad++ to edit while I was testing. Note that right now if you scew up the plugin will probably crash so you'll know right away if you've done a good job. That'll be fixed in the next release. I was dragging my feet to avoid having to rewrite a bunch of stuff after a code review but now have a reasonable template on how other plugins are doing it so I can maintain consistent style.

deathlock · May 21, 2020

It would be nice to build a library of the different uses, like the kiss ini library.

drwhomphd · May 21, 2020

deathlock said:
It would be nice to build a library of the different uses, like the kiss ini library.

Let's start here https://www.redguides.com/community/threads/mq2-react-collection.72469/ and if there's enough engagement I'm sure we can ask RedBot to help grow this organically.

I'm certainly curious to see how many reacts can be enabled until client processing just decides to roll over. That may also highlight the need to change how reacts are processed or how often. I had a number of discussions with Knightly during the writing of this plugin about design trade-offs. My view is right now the big locked down design is the config format. That should be scalable and readable in its current form (and changing config will break a lot of work folks would do). I think design elements that could be tweaked are the slash command interface and how the plugin queues and executes reactions (this would require no changes on behalf of the users but potentially lead to increased reliability of execution in large configs). There's things here that I just couldn't test by myself or by dangling folks Test server builds out of the proverbial trunk of my proverbial car.

LamahHerder · May 22, 2020

ty good sir, will be playing with this when i find some time to start eq again

RangerDanger13 · May 22, 2020

Looking for assistance if possible. I've tried a few times unsuccessfully to convert commands like the following but I crashed when I tried. Anyone able to convert one to show me how it would look in the new format? I will keep playing with it, just frustrated with crashing so I deleted what I did and unloaded for now.. will reattack later when not so beat.

holyshit3=/if (${Spell[Falcon Strike].Stacks} && !${Me.Buff[Falcon Strike].ID}) /casting "Aurora, the Heartwood Blade"
holyshit4=/if (${Spell[Haste].Stacks} && !${Me.Buff[Haste].ID}) /casting "Dark Cloak of the Sky"
holyshit5=/if (${Target.PctHPs}<99 && ${Target.Named} && ${Me.AltAbilityReady[Empowered Blades]}) /casting "Empowered Blades" alt
holyshit6=/if (${Target.PctHPs}<99 && ${Target.Named} && ${Me.CombatAbilityReady[Arbor Stalker's Discipline]}) /disc Arbor Stalker's Discipline

Jetanroth · May 22, 2020

Could someone post an example of their INI for this by chance? It would really help alot to see one.

drwhomphd · May 23, 2020

RangerDanger13 said:
Looking for assistance if possible. I've tried a few times unsuccessfully to convert commands like the following but I crashed when I tried. Anyone able to convert one to show me how it would look in the new format? I will keep playing with it, just frustrated with crashing so I deleted what I did and unloaded for now.. will reattack later when not so beat.

holyshit3=/if (${Spell[Falcon Strike].Stacks} && !${Me.Buff[Falcon Strike].ID}) /casting "Aurora, the Heartwood Blade"
holyshit4=/if (${Spell[Haste].Stacks} && !${Me.Buff[Haste].ID}) /casting "Dark Cloak of the Sky"
holyshit5=/if (${Target.PctHPs}<99 && ${Target.Named} && ${Me.AltAbilityReady[Empowered Blades]}) /casting "Empowered Blades" alt
holyshit6=/if (${Target.PctHPs}<99 && ${Target.Named} && ${Me.CombatAbilityReady[Arbor Stalker's Discipline]}) /disc Arbor Stalker's Discipline

Try the following -- no guarantees as I can't test it. Next update to mq2react will just start yelling at you if it can't parse the YAML versus crash. Note that YAML is white space sensitive so you gotta get the tabs and spaces right.

YAML:

globals:
  GlobalExample: "${Me.CombatState.NotEqual[COMBAT]} && ${Me.PctHPs} <= 25"
  NotCasting: "!${Me.Casting.ID}"
reacts:
  DoHaste:
    action: /cast Dark Cloak of the Sky
    condition: "${Spell[Haste].Stacks} && !${Me.Buff[Haste].ID} && ${React.Global[NotCasting]}"
  EmpoweredBlade:
    action: "/alt act ${Me.AltAbility[Empowered Blades].ID}"
    condition: >-
      ${Target.PctHPs}<99 && ${Target.Named} && ${Me.AltAbilityReady[Empowered
      Blades]}
  ExampleReact:
    action: >-
      /multiline ; /echo Default Example react Disables itself when you're
      at 100%HP and out of Combat ; /delay 5 ; /react disable ExampleReact
    condition: "${Me.PctHPs} == 100 && ${Me.CombatState.NotEqual[COMBAT]}"
  FalconStrike:
    action: "/cast Aurora, the Heartwood Blade"
    condition: >-
      ${Spell[Falcon Strike].Stacks} && !${Me.Buff[Falcon Strike].ID} &&
      ${React.Global[NotCasting]}
  Hungry:
    action: /useitem Fresh Cookie Dispenser
    condition: >-
      ${FindItemCount[=Fresh Cookie]} < 5 && ${FindItemCount[Fresh Cookie
      Dispenser]} == 1
  ShrinkPet:
    action: /useitem Curious Companion Compactor
    condition: "${Pet.Height} > 2.04"
  Thirsty:
    action: /useitem Warm Milk Dispenser
    condition: >-
      ${FindItemCount[=Warm Milk]} < 5 && ${FindItemCount[Warm Milk Dispenser]}
      == 1

@Jetanroth -- the above should work as an example of the parts that matter.

The configuration file is split so that no one ever has to post the portion with their server and character names.

(Updated after finding an issue in the globals -- btw it'll reload fine if you click 'retry' at the crash screen -- next version will at least yell at you on the parser.)

Second update:

YAML:

  ArborStrike:
    action: "/disc Arbor Stalker's Discipline"
    condition: >-
      ${Target.PctHPs}<99 && ${Target.Named} && ${Me.CombatAbilityReady[Arbor
      Stalker's Discipline]}

UPDATE: The above examples with quotes will work with the latest mq2react. I have not tested any actions or conditions with commas.

drwhomphd · Jun 7, 2020

So we're going to have some fun stuff coming down the pipe here soon. I've fixed the mini-yaml library so that it properly handles lines with quotes in them. This means the next mq2react release should handle actions such as Arbor Stalker's and Huntsman's Ethereal Quiver. The big change though is you're going to need to cut and paste all your reacts into the new .yaml file that will be created from the .ini file that was used original. Upside: your text editor of choice will syntax highlight. Finally, actions are going to be a bit more aggressive in their execution. Upside: you probably won't over summon items as often; Downside: you'll want to improve your conditions to gate from over casting or casting when other things are happening. Thankfully you can easily do that by setting up a global and using the React Global TLO.

drwhomphd · Jun 15, 2020

Everyone!

With the latest VV update, you may notice mq2react is eerily quiet. The configuration file is now mq2react.yaml. Just cut and paste from the ini file (and delete the ini) and all will be right again. See my prior post.

AS OF 06/14/2020 CONFIGURATION FILE IS NOW: MQ2React.yaml

drwhomphd · Jun 15, 2020

Redbot updated MQ2React with a new update entry:

June updates

Replaced the .ini file with a .yaml. Created a SaveConfig function to wrap the serialize interface with an exception to avoid crashing on parse errors. Also wrapped serialize in an exception. Switched individual calls to parse and serialize throughout the slash functions to these load and save functions. Added single quotes to the list of tokens that mini-yaml thinks should be double quoted. Changed save and load functions so that they didn't take an argument and instead leverage the...

Read the rest of this update entry...

stig7055 · Jun 17, 2020

vsab said:
Although.. YAML? Seems like cracking a nut with a sledgehammer. Was there a pressing reason to diverge from the standard ini file format? New users to YAML will often get the syntax wrong as it's unlike anything else they are used to; indenting/whitespace being the main culprit, especially if they are not using a yaml aware code editor.

It would be worth putting in some examples for folks on here, most of which are not programmers and will not be familiar with it. I suspect there will be plenty of copy and pasting of existing commands into the file (I virtually never use in game commands with plugins for configuration). Also, working examples give people something to work with.

I have to agree, this is a nightmare to unleash on the standard non coder MQ2 user.

drwhomphd · Jun 17, 2020

stig7055 said:
I have to agree, this is a nightmare to unleash on the standard non coder MQ2 user.

Thus the creation of: https://www.redguides.com/community/threads/mq2-react-collection.72469/ (which is slowly growing including tips on how to write reacts). This should get most folks started and for the most part is is expected a lot of initial work will be copy & paste just like holys/downs are for mq2melee.

To be honest I don't think the 'bar to entry' will be any higher with the YAML as much as the required logic work, ability to leverage MQ2 syntax, and ability to lookup TLOs. I think those are going to be the bigger challenges (and mq2react isn't designed to fix that) but challenges that already exist with mq2melee.

Hylander · Jun 17, 2020

why the change to yaml? if change for upside then yes, i'll eat the learning curve, if change just for a different flavour of the same thing, then not so much

Also, is it a global yaml config file ? or is it per character ?

I am thinking of using MQ2React to fire my Rage of Rolfron (COP4) clickies on 3 characters that run CWTN plugins (zerks and BST). While they will check if they have the buff before clicking, they are all attempting to fire it at the same time. I tried to adjust their engage percentages to stagger the triggering of them but it didn't work.

Can I setup MQ2React conditions to click the Rage of Rolfrons at different ${Target.PctHPs} for different characters ?

drwhomphd · Jun 17, 2020

why the change to yaml?

It's always been yaml; originally was just with the 'ini' extension. The predominant reason is it is CONSIDERABLY easier to add and edit configurations than an ini format especially for the way mq2react is designed. Second, it allowed for a considerably cleaner implementation of the mq2react plugin. Doing what I did with the old ini format just would not work well and would not scale well without some really gnarly looking plugin code. YAML will also be a core configuration syntax for version versions of mq2, or so I hear, so I'm trying to get ahead of the curve.

Also, is it a global yaml config file ?

Global across all your characters with the ability to /react enable <react name> and disable per character.

Can I setup MQ2React conditions to click the Rage of Rolfrons at different ${Target.PctHPs} for different characters ?

Yes. There's multiple ways of doing is that I can think of so it'll be up to how you want to implement it.

vanemon · Jun 20, 2020

how to get the toon to use the wand of imperceptibility (shrink) after zoning or detecing a size <2.04

thanks for the help!

drwhomphd · Jun 20, 2020

vanemon said:
how to get the toon to use the wand of imperceptibility (shrink) after zoning or detecing a size <2.04

thanks for the help!

Take a look here: https://www.redguides.com/community/threads/mq2-react-collection.72469/
You'll see an example for the "Curious Companion Compactor", that could be changed to detect ${Me.Height} in the condition I bet.

vanemon · Jun 20, 2020

drwhomphd said:
Take a look here: https://www.redguides.com/community/threads/mq2-react-collection.72469/
You'll see an example for the "Curious Companion Compactor", that could be changed to detect ${Me.Height} in the condition I bet.

ShrinkPlayer:
action: /useitem Wand of Imperceptibility
condition: "${Me.Height} > 2.04"

does not work for me sadly....

vanemon · Jun 22, 2020

/if (${Me.Height}>=1) /useitem Wand of Imperceptibility

this works in the commandline. why not in a condition? anyone can help me out on this please?

drwhomphd · Jun 22, 2020

vanemon said:
/if (${Me.Height}>=1) /useitem Wand of Imperceptibility

this works in the commandline. why not in a condition? anyone can help me out on this please?

As long as you have all the white space correct (keep in mind, YAML is white space sensitive so you need the tabs and spaces and stuff to be correct):

Code:

reacts:
  ShrinkPlayer:
    action: /useitem Wand of Imperceptibility
    condition: ${Me.Height} >= 1 && ${FindItemCount[Wand of Imperceptibility]}

And then save it. Make sure on whatever character you want to use it on you remember to do a:
/react enable ShrinkPlayer

Sorry, I don't have that wand so I can't test out the react, but the above should work presuming you have the formatting correct in your mq2react yaml file.

Gnits · Jun 22, 2020

Can you do a multiline action?

vanemon · Jun 22, 2020

works pretty well! thanks a lot!!!

drwhomphd · Jun 22, 2020

Gnits said:
Can you do a multiline action?

You can use /multiline with all the caveats that entails (no use of /delay for example).

MetalJacx · Jun 29, 2020

Question? When I am making changes to the yaml file and do a reload. if there is a error with the one of my reacts it reset the whole file back to a template. I have lost work multiple times to this. Is there a way to stop this?

drwhomphd · Jun 30, 2020

MetalJacx said:
Question? When I am making changes to the yaml file and do a reload. if there is a error with the one of my reacts it reset the whole file back to a template. I have lost work multiple times to this. Is there a way to stop this?

I'll need to mark this down as a bug and take a look. I have a suspicion from memory why it's writing the template and just need to add in an extra check that says: "Obviously if you fail parsing there was something there so even if you don't see it after parsing because of an error, don't write the default file." Should be an easy fix/test and I'll let Redbot know when it's updated. Before this wouldn't have been caught because the plugin would just crash if you had a bad file so I missed it on initial testing.

Optimal suggestion at the moment, keep a backup of your known good mq2react.yaml file.

jande · Jun 30, 2020

drwhomphd said:
Great example showing the usage of globals!

Could the plugin perhaps have a command added to add/edit globals
I have a script that figures out what to use on my WAR discs/aa then writes the mq2melee holy's.
With the mq2react yamI cannot do it from within eq/mq2, trying to avoid having to run a script generating an ini then run an external program that adds to the yaml from the ini, possible but tedious.

e.g
/react global WARCharge "Imperator's Charge"

Then I can use ${React.Global[WARCharge]} in the conditions etc

drwhomphd · Jun 30, 2020

Sure. I'll toss it in as an issue. I need to make a minor fix for another bug as well.

UPDATE:
Code is in place for two new commands:
/react globaladd <nickname> <condition>
/react globalrem <nickname

Once I get a chance to test these and the bug my patch is attempting to solve, I'll push changes up to the repository and get a request in for the next VV rebuild.

Hylander · Jul 6, 2020

Drwhom,

started using MQ2React. Couple of things
1) if I have a syntax error (that fails to parse) in my config file, the plugin creates a new ‘default’ config file, which overwrites the previous
2) the plugin is not very chatty, can I enable a verbose mode? If for example
** I issue a /react enable hungry statement, nothing is echoed in MQ2Chat.
** I issue a /react list, I think it returns ALL configured reacts, and not just the ones enabled for that character
3) On my SK I have summon food and summon water reacts, if I am hungry or thirsty respectively. If enabled, the processing load seems heavy, coz if I issue a come to me nav command or try to start a Kiss macro, I get a “you cannot use that command right now ....“ and it takes a couple of attempts before MQ2 can squeeze in the other KA / come to me commands. MQ2 behaved similarly when I had the same configured in MQ2Melee, and I was hoping for something different here in MQ2React. Other characters have the same react enabled (and admittedly I don’t drive from them with regularity) but don’t seem to be similarly affected.

Thanks in advance,

Hylander.

drwhomphd · Jul 6, 2020

#1 -- Known bug & fixed in my development version. Need to test things out and get a push to redbot for live.
#2a -- I'll make a note and see if I can post a message in chat.
#2b -- Working as intended. It's meant to give you a list of all reacts available at the moment. (There's a potential we could add a couple hooks for enable/disable but my original intention was for most the editing to occur in the YAML file vs. the game)
#3 -- Reacts are triggered every 50 pulses or so. That's done to reduce load on the system. I plan to offer a configuration on how often they're checked in the future.

Release MQ2React

WoW was the first MMO

Well-known member

Well-known member

Member

💻❤️

Member

Saucy

Active member

Active member

Active member

Active member

Active member

Saucy

Users who are viewing this thread

Cart