• You've discovered RedGuides, an EverQuest multi-boxing and scripting community 🧙‍♀️⚙️. We want you to play several EQ characters at once, come join us and say hello! 👋

  • A TLP without truebox has thawed (Very Vanilla ready)
    Frostreaver

RGMercs Class Config Editing Guide - VSC, AI, other buzzwords and acronyms

Joined
May 5, 2024
RedCents
21,819¢
RGMercs ships with default class configs for Official servers (dubbed "Live" throughout, but they are also usable on Test and TLPs), and select emu servers (EQ Might, Project Might, Project Lazarus). The default configs are designed to do well in a broad variety of situations, and we do our best to provide options to make them fit into common modes of play... but they are just the default. The best config for you is going to be one that you have adjusted to your playstyle, or the content that you do.

Players can create a custom config on the class tab (refer to in-game FAQs in the options window if needed). This will copy the currently loaded config to the mq config directory, in a place that is safe from overwrite.*

Once you've done that, there are two paths forward: Manual editing, or using an AI to assist (or do it for you). A couple quick notes:
  • Both are entirely possible for the layman. I am not a professional developer, and I picked up Lua largely from playing with RGMercs... the fever just happened to transform my tinkering into something a little grander in scale.
  • Both of them will appeal to some more than others. I'm okay with that. I am not here to debate the benefits or drawbacks.
  • A middle ground approach of using AI as a learning aid (you make the edits as the AI explains or audits) should not be dismissed!

Manual Editing
I have helped users who are armed with nothing more than "Notepad.exe" to make edits. It is doable. I would not recommend it. Lua is a well-documented language. MQ has a very well-documented API. Take advantage of it.
  • I recommend you check out Visual Studio Code (VSC). It is free. You do not have to be a super-developer-nerd-dude to use VSC. Sometimes, that doesn't even help. (edit: super-developer-nerd-dudes often use something even nerdier)
  • Once you have VSC, you absolutely want to use the Lua Language Server extension... which is kind of like the spell/grammar check and an autocomplete rolled up into one for the Lua language.
  • You also want to be using the mq definitions. Those will give you additional error control and information about TLOs (the data objects you use to make decisions in your code) and other relevant MQ information.
  • There is a wonderful extension for VSC that will install both of these for you, found HERE. Having both installed will greatly aid your ability to read the code, and edit it to your liking... the LLS will show you that you messed up a squiggly/comma/other code thingy when you fat-fingered that copy/paste. The defs will tell you when the TLO you are trying to check doesn't actually exist.

Using "AI"
This will be aimed at basic use, without paid subscriptions, using web-based solutions**. To get the best results, you will need both of the things below:
  • I have written some groundrules and pointers to help you get the results you want: in the rgmercs repo (in the docs folder), there is a file named CUSTOMIZING_WITH_AI.md. This file contains valuable information and instructions to help an AI help you when it comes to editing a class config. It references the mq docs and the mq defs, the github repo for rgmercs, etc. You should always feed this file to your solution before giving it a config to edit. We have done our best to distill this file to be super-packed with information while while staying as lean as we can, to keep token use down.
    • Already in-game? You don't need to trouble yourself with the finding a file, pasting it etc... the /rgmercs copy guide command automatically places the entire guide on your windows clipboard! Simply paste it, hit enter, and boom, done... that simple. This will also give the AI a couple other of pieces of information, such as directions to help you place an edited config exactly where it needs to be in your mq config folder when you are finished.
  • Speaking of configs... yes, you'll need that too. Custom configs are found in your mq config directory (mqconfig\rgmercs\class_configs\<server>***\<class>_class_config.Lua). Copy/paste, upload, etc... OR, yes, you guessed it:
    • You can also do that in-game! /rgmercs copy config copies your currently loaded class config directly to the windows clipboard! I would make sure you past the guide first, though.
After the edits are made, make sure that your file goes back to the mq config folder! The guide file should assist you by giving you the exact directory as a helpful reminder.

* You do not want to edit the configs in your Lua directory.. the next RGMercs update will smoosh them back into the default shape. Please use custom configs.
** I would like to point out that MacroQuest has some integration for Claude Code. I use it, and I highly recommend it. Some of my resources (such as Squire) were written almost entirely by this integration (note: quality of output will always be linked to quality and effort of input :dance: ). There are also a couple of other integration projects out there, I know Coldblooded has done some work on MQ and codex.
*** Official servers all fall under the "Live" folder.



A copy of this guide can be found in the docs folder in the rgmercs directory.
 
Last edited:
RGMercs Class Config Editing Guide - VSC, AI, other buzzwords and acronyms

Users who are viewing this thread

Back
Top
Cart