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. The title of your resource listing must reflect the title of the underlying content accurately.
2. Plugin resource titles must begin with "MQ" and contain only a name thereafter, e.g. "MQ2Nav". Other resource types do not have this rule.
3. Plugins follow a different submission process than scripts, see below.
4. Official Servers: No active hacks including but not limited to warping, zoning, speed hacking, or duping. (note: These may be posted for servers that allow them, notably certain emulated servers.)
5. Official Servers: Please keep any automation focused on assisting/boxing with the user attending at least one character.
6. Executable code cannot be downloaded by your software unless explicitly requested by the user.
7. If installation or use depends on an external server, this must be clearly declared in your resource description.
8. User's privacy must be respected. If a call is made to an external server at any time by your resource, the information that is being submitted and when it will be submitted must be clearly listed in your resource description. This includes but is not limited to: character, guild, and server names.
9. Reviews may be removed if they break another rule, or if the author of the review requests removal. In all other cases they should remain untouched, and staff will not assist in their removal.

Resource File Guidelines

• Multi-file projects must be zipped.
• If your script packages more than 3 files, it must utilize a subfolder. (see below)

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. If you were to release a single file script, here's how you'd structure the .zip:

• MyProjectName
  • init.lua

To run the above script, a user would type "/lua run MyProjectName". MacroQuest prefers the "init.lua" filename within a subfolder, even if alternatives exist.

Libraries and Includes
Libraries and includes must be kept in a subfolder of your project. For example,

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

Macro Directory Structure
Macros treat the "macros" folder as root. If you want to release a single file script, here's how you'd structure the .zip:

• macro.mac

In this example, users would start your macro by typing, "/mac macro"

If you utilize a sub-folder, this is how you'd structure your zip:

• MyMacroSubFolder
  • macro.mac
  • macro.inc
  • macro.ini.default

In this example, users would start your macro by typing, "/mac mymacrosubfolder/macro"

Resource Maintener Rules

1. 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.
2. Security vulnerabilities must be addressed immediately upon discovery.
3. If someone else suggests code for a resource you maintain,

• Maintainers may assign someone as a "team" member on a resource (Team members can issue updates without review)
• Maintainers can give maintainership to someone else.

Paid Resource Rules

1. Follow all "Resource Maintainer" rules above.
2. The title of your resource listing must not include unnecessary promotional language (such as indicating a temporary sale).
3. Any price listed for your resource must accurately reflect the price paid, no hidden "fees".
4. Paid resources that are exclusive to RedGuides carry a 0% transaction fee, and payments are handled by the author. Resources that are not exclusive carry a 30% fee, payments will be handled by RedGuides, and payouts are on the first of the month.

Plugin Submission

Plugins can affect MacroQuest's stability to a greater degree than scripts, so we've implemented a few extra steps in the submission process.

1. Discuss the idea with other plugin authors and get some feedback.
2. Submit your code to a repository.
3. When it's in good shape, contact Redbot or Sic with a link to your repo.
4. Submit a merge request to the Open Vanilla repository. If you're familiar with git, you can do this yourself with the "Forking X Workflow", in which you include:
        a) the submodule
        b) an edited OpenVanilla.sln with your plugin added, as well as dependencies included. Redbot is happy to help with this.
5. The merge along with your code will be reviewed. I hope it goes well🍀