• Hail, we're RedGuides. We want you to play six (yes, 6!) EverQuest characters at once. We have scripts and a friendly community to help, please join our playstyle and say hello! 👋

Resource rules and guidelines

All resources listed on RedGuides must adhere to the policies laid out below. Violations will lead to certain doom.
These policies are an addition to our standard Terms and Rules and may change as time goes by.

Resource Listing Rules

  1. Honest description: The title reflects the software, and the description is clear and not overly promotional or negative toward others.
  2. Official Servers: Your software should respect DBG's staff and servers, and its intended use should not degrade the game for other adventurers. As a community, we've determined this includes but is not limited to warping, zoning, speed hacking, duping, and similar tools that are too often abused.
  3. Automation while at the keyboard: Your software should be designed to assist a user attending their box crew at the keyboard. This is a social game, be present!
  4. Maintain your work: Resources must be maintained to a reasonable standard as determined by users of the resource. If the author is no longer responding and/or the resource contains serious issues that go unaddressed, it may be removed altogether, marked "unmaintained", assigned a new maintainer, stripped of any monetary requests and restrictions, or any combination thereof.

Script Conventions

  • Use one command named after your script, with subcommands: /myscript pause /myscript camp. Avoid separate commands like /doshit and /stopdoingshit.
  • Delay rather than spam: All commands and requests to any official EverQuest server need to be throttled and guarded by shipped defaults.
Keep it fair: Script within normal player boundaries. For example, move near a distant mob with /nav spawn before you target it, rather than /nav target. Refresh the bazaar every few hours rather than every minute, etc.

Resource Structure

  • No garbage in the zip. Don't ship your .github folder, thumbs.db, or other cruft.

Lua Directory Structure

Lua scripts should be placed in a subfolder named after your project, and include a file named "init.lua" which starts the script. MacroQuest prefers the "init.lua" filename within a subfolder, even if alternatives exist. If you were to release a single file script, here's how you'd structure the .zip:

  • MyProjectName
    • init.lua
Users start it with /lua run MyProjectName

Libraries and Includes

Libraries and includes must be kept in a subfolder of your project. Placing them anywhere other than your project's subfolder may affect other people's projects.

  • MyLuaProjectfolder
    • init.lua
    • project.lua
    • libraryfolder
      • LIP.lua
      • include.lua
      • stack.lua

Macro Directory Structure

Macros treat the "macros" folder as root. A single file macro sits at the top of the .zip; if you use a sub-folder, the folder name becomes part of the command.

  • macro.mac
Users start it with /mac macro
  • MyMacroSubFolder
    • macro.mac
    • macro.inc
    • macro.ini.default
Users start it with /mac mymacrosubfolder/macro

LLM Usage

LLMs are fine, so long as our mods are not the first humans to read each function. Place REDGUIDES.md in your project folder and mention it to your agent to help with Lua, game quirks, and following the resource rules.
  1. You are the author. You're expected to have read every line before you hit submit. Reviewers will talk to you about your work, and if you use an LLM to respond to their questions, it will be rejected.
  2. Test it on someone else's setup. "Works for my group" isn't testing.
  3. Use a git repository for anything bigger than a button or a config. Private repos are fine as long as you give the reviewer access.
Creators: read the discussion behind these rules
Join Level 2
Back
Top
Cart

Cart

Total -